This document exists to try and help you find stuff in the codebase and get you caught up on where stuff is and how it works.

figma: https://www.figma.com/design/snmEoRUgfjAZYSc6hqySkY/Wireframes-for-Jupiter?node-id=3702-917&node-type=CANVAS&t=ri3ZiZ9kTAupRHHJ-0

General Resources

• MDN

• Nextjs

• React

• trpc

• Drizzle

• Tailwind (Cheatsheet)

Project Map

Everything is mostly located in a few different locations

• app

  • Contains all the routes for the website, you can read more about routing with next.js app router here.

  • Components only used for one route can also be put here.

• components

  • react components

• server

  • has stuff for backend with trpc and db access with drizzle

• utils

  • general code that doesn’t fit anywhere else.

Getting Started

Please make sure you have NodeJS v18.0.0 and git installed

Then start by cloning the repository to your local machine.

git clone https://github.com/UTDNebula/jupiter.git

Next, navigate to the project directory and install the dependencies.

cd jupiter
npm install

Make sure you have a .env file in the root of the project. If you do not, copy the .env.example file and rename it to .env

if you need help setting up environment variables post in #jupiter-chat or dm me.

To start the dev server run

npm run dev