jvniorrr/sacoverflow

Welcome to Sacoverflow's GitHub! 🚀 This project is aimed at assisting Project Managers in overviewing their organization's finances and overall management about projects and tasks within their org. The SacOverflow development team, consisting of Computer Science undergraduates from California State University, Sacramento, is behind this project.

SacOverflow

Cloud Asset Management Enhanced Launcher

Welcome to Sacoverflow's GitHub! 🚀 This project is aimed at assisting Project Managers in overviewing their organization's finances and overall management about projects and tasks within their org.
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Acknowledgments

About the Project

The SacOverflow development team, consisting of Computer Science undergraduates from California State University, Sacramento, is behind this project.

This project is aimed at assisting Project Managers in managing their team and projects. By making use of this software, supervisors or relevant stakeholders will be allowed to make more informed decisions within their organization and simplify their day-to-day task duties. This software is to be developed with the intention of being used on both Mobile and Web based platforms.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• 
• 

Installation

1. Clone the repository to your local machine and change directories into it. Stable builds will be based off the main branch.

git clone https://github.com/hashemJaber/SacOverflow.git
cd SacOverflow

2. Install the dependencies using whatever package manager you prefer.

npm install
# or
yarn install
# or
pnpm install
# or
bun install

3. Run the development server.

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Setup

1. Create a .env.local file in the root directory of the project.
2. Development phases there is a Mockaroo API key that is needed to be able to run the project. Please contact the lead for the key.
3. Add the following to the .env.local file.

MOCKAROO_API_KEY=YOUR_API_KEY

(back to top)

Features

• User Authentication (Login/Sign Up)
• Business Dashboard (Overview of finances and projects)
• Project Dashboard (Overview of project details and tasks)

Mockup Designs

• Home Page

  

• Login Page

  

• Sign Up Page

  

• Dashboard Page

  

• Projects Dashboard Page

  

• Projects Details Dashboard Page

  

API Reference

• TBD

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Acknowledgments

• Choose an Open Source License
• Img Shields
• Best-README-Template

(back to top)

Learn More

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.