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 organization.
Report Bug
·
Request Feature
Table of Contents
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.
[Place holder for testing instructions.]
- 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- Install the dependencies using your preferred package manager.
npm install
# or
yarn install
# or
pnpm install
# or
bun install- Run the development server.
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev- Create a
.env.localfile in the root directory of the project. - Development phase where there is a Mockaroo API key that is needed to be able to run the project. Please contact the lead for the key.
- Add the following to the
.env.localfile.
MOCKAROO_API_KEY=YOUR_API_KEY- User Authentication (Login/Sign Up)
- Business Dashboard (Overview of finances and projects)
- Project Dashboard (Overview of project details and tasks)
- 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).
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devOpen http://localhost:3000 with your browser to see the result.
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.
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!
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.