Go to file
Meliora Ho 172661cbc5
Merge pull request #1 from cssgunc/mel-GEN-14-code-architecture-setup
Organized files and added basic components
2024-02-10 14:32:52 -05:00
compass Changed app routing 2024-02-07 01:28:08 +00:00
README.md Reorganized file setup 2024-02-04 21:43:40 +00:00

🧭 Compass Center's Internal Resource Management App

🛠 Technologies

  • Next.js
  • TailwindCSS
  • TypeScript
  • PostgreSQL

📁 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'