Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 1.42 KB

README.md

File metadata and controls

55 lines (44 loc) · 1.42 KB

in.orbit logo

This is the backend of the InOrbit application, developed with Node.js and Fastify, using Drizzle for ORM and PostgreSQL as the database.

About 🎯

The inorbit-api provides a RESTful API that serves as the backend for the InOrbit application's frontend.

Technologies 💻

Installation 🛠

Follow the steps below to set up and run the project locally.

Steps

  1. Clone the repository:
    git clone https://github.com/MateusFS99/inorbit-api.git
  2. Navigate to the project directory:
    cd inorbit-api
  3. Install the dependencies:
    npm install
  4. Create a .env file at the root of the project and configure the environment variables as specified in the .env.example file.
  5. Compose up the Docker Compose to use a container with PostgreSQL:
    docker compose up
  6. Run the Drizzle migrations:
    npx drizzle-kit migrate
  7. Start the server:
    npm run dev

License ®️

This project is under the MIT license. Consult the LICENSE for details.