mirror of
https://github.com/cssgunc/compass.git
synced 2025-04-11 23:00:16 -04:00
36 lines
880 B
Markdown
36 lines
880 B
Markdown
# 🧭 Compass Center's Internal Resource Management App
|
|
|
|
## 🛠 Technologies
|
|
- Next.js
|
|
- TailwindCSS
|
|
- TypeScript
|
|
- Supabase
|
|
|
|
## 📁 File Setup
|
|
```
|
|
\compass
|
|
\components // Components organized in folders related to specific pages
|
|
\pages // Store all pages here
|
|
\api // API routes
|
|
\public // Local assets (minimize usage)
|
|
\utils // Constants, Routes, Classes, Dummy Data
|
|
\styles // CSS files
|
|
```
|
|
|
|
## 🚀 To Start
|
|
Follow these steps to set up your local environment:
|
|
```
|
|
\\ Clone this repository
|
|
git clone https://github.com/cssgunc/compass.git
|
|
\\ Go into main folder
|
|
cd compass
|
|
\\ Install dependencies
|
|
npm install
|
|
\\ Run local environment
|
|
npm run dev
|
|
```
|
|
|
|
## 💡 Dev Notes
|
|
- For each task, create a branch in the format '[your name]-[ticket number]-[task description]'
|
|
- Only commit your work to that branch and then make a git request to '/main'
|