rushilwiz/compass
1
0
Fork 0
mirror of https://github.com/cssgunc/compass.git synced 2025-04-10 06:10:17 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added emojis

Browse Source
This commit is contained in:
Meliora Ho 2024-02-04 02:47:26 +00:00
parent 3f4f6be682
commit bb9278008e
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,25 +1,24 @@
# Fall 2023 - Spring 2024: A Notion-UI website to speed up data lookup for Compass Center # 🧭 Fall 2023 - Spring 2024: A Notion-UI Website for Compass Center Data Lookup
## Technologies ## 🛠 Technologies
Next.js, TailwindCSS, Typescript, PostgreSQL - Next.js
- TailwindCSS
- TypeScript
- PostgreSQL
## File setup ## 📁 File Setup
``` ```
\compass \compass
\components \components // Components organized in folders related to specific pages
should organize the components on folders pointing to the specific pages it is displayed \pages // Store all pages here
\pages \api // API routes
store all pages \public // Local assets (minimize usage)
\api \routes // Routing logic
\public \styles // CSS files
local assets - try to minimize them
\routes
routing logic
\styles
css files go here
``` ```
## To start ## 🚀 To Start
Follow these steps to set up your local environment:
``` ```
\\ Clone this repository \\ Clone this repository
git clone https://github.com/cssgunc/compass.git git clone https://github.com/cssgunc/compass.git
@ -31,6 +30,6 @@ npm install
npm run dev npm run dev
``` ```
## Dev notes ## 💡 Dev Notes
- For each task, create a branch in the format '[your name]-[ticket number]-[task description]' - 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' - Only commit your work to that branch and then make a git request to '/main'