my.orbit 🪐

Technologies • Getting Started • Routes • Collaborators

my.orbit is an application that serves as your personal companion in achieving your goals. With it, you can chart your own cosmic course, setting goals and monitoring each step towards success.

🎨 Layout

💻 Technologies

🚀 Getting started

Prerequisites

• NodeJS ^20.17.0
• Docker
• bitnami/postgresql

Cloning

git clone https://github.com/MarlonVictor/myOrbit.git

Environment Variables

Use the .env.example as reference to create your configuration file

Only in the first entry of the project

cd server

npm install

docker compose up -d

npx drizzle-kit generate
npx drizzle-kit migrate

npm run seed

cd web

npm install

Starting

cd server

npm run dev

cd web

npm run dev

📍 Application Routes

route	description
/	main page with all CTOs and list of goals

📍 API Endpoints

route	description
GET /pending-goals	brings list of all registered goals
GET /summary	List the goals completed on their respective days
POST /goals	create a new goal
POST /completions	mark the goal as completed on day
DELETE /completions/:id	unmark goal as completed on the day

🤝 Collaborators

Marlon Victor

Diego Fernandes

License 📃

This project is under MIT license