fl0zone / template-nest-pg-typeorm Goto Github PK

Backend engineering, supercharged.

Use this repository to get up and running on FL0 with the following stack:

We recommend using the provided Docker Compose configuration for local development. Our Docker configuration includes:

1. Automatically create both database and app server easily
2. Hot-reloading of code for local development
3. Production-ready minified image
4. Database admin interface using Cloudbeaver

However, you can still use this repo without Docker! See the instructions below.

1. docker compose up (initial build can take a couple of mins)
2. That's it! Visit http://localhost:8080 to see your app running

If you don't want to use Docker, make sure you have a Postgres database that you can connect to.

1. npm install
2. Copy the provided .env.example file and rename it to .env
3. npm run start:dev
4. Visit http://localhost:8080 to see your app running

Checkout our Getting Started Guide in the FL0 documentation!

If you use our Docker Compose file you have access to a local instance of Cloudbeaver. To access it, navigate to:

1. Navigate to http://localhost:8081
2. Follow the setup wizard to create your admin account
3. Add a new connection using the PostgreSQL driver and the URL below

jdbc:postgresql://db:5432/fl0-starter-db?user=admin&password=admin

If you have any questions about FL0 or this template codebase please head on over to our Discord channel.

Any issues or feature requests can be raised on the Issues page of this repo.

This template repository is MIT licensed.