Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mateusfs99/inorbit-api
Node.js API of In.Orbit application.
https://github.com/mateusfs99/inorbit-api
docker drizzle-orm fastify node-js postgresql zod-validators
Last synced: 4 days ago
JSON representation
Node.js API of In.Orbit application.
- Host: GitHub
- URL: https://github.com/mateusfs99/inorbit-api
- Owner: MateusFS99
- License: mit
- Created: 2024-09-10T03:17:35.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2024-09-14T21:24:11.000Z (19 days ago)
- Last Synced: 2024-09-29T07:20:58.703Z (4 days ago)
- Topics: docker, drizzle-orm, fastify, node-js, postgresql, zod-validators
- Language: TypeScript
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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 💻
- [Node](https://nodejs.org)
- [Typescript](https://www.typescriptlang.org)
- [Fastify](https://fastify.dev)
- [Docker](https://www.docker.com/)
- [Zod](https://zod.dev)
- [Drizzle](https://orm.drizzle.team/)
- [PostgreSQL](https://www.postgresql.org/)
## Installation 🛠
Follow the steps below to set up and run the project locally.
### Steps
1. Clone the repository:
```bash
git clone https://github.com/MateusFS99/inorbit-api.git
```
2. Navigate to the project directory:
```bash
cd inorbit-api
```
3. Install the dependencies:
```bash
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:
```bash
docker compose up
```
6. Run the Drizzle migrations:
```bash
npx drizzle-kit migrate
```
7. Start the server:
```bash
npm run dev
```
## License ®️
This project is under the MIT license. Consult the [LICENSE](LICENSE) for details.