PeerNotes (In Progress)

Repository for a course project of CS4675/CS6675 at Georgia Institute of Technology.

Advisory for Contributors

• Please do not commit any code to the main branch directly
• Use feature branches, ideally with your name and the feature it is for mentioned in the branch name eg. feature_aman_login
• Raise a PR once you are ready and have checked your code for errors.
• Mention a bullet point summary for all the features you are pushing as part of the PR within the description to ease the review process

Getting Started

Frontend

For our frontend we are using React + Vite + TypeScript!

• React -> JavaScript Framework for creating reactive user interfaces.
• Vite -> Development environment / build tool. Gives us access to features like hot reload, bundling, and plugins.
• TypeScript -> A superset of JavaScript allowing for static types.

Here's how to set up + run the frontend environment:

1. Download and install Node.js v18+ Check your node version:

node -v

2. Clone the repo using Git
3. Install dependencies

cd frontend
npm install

4. Start the development server

npm run dev

5. Visit http://localhost:5173