jlonardi/node-template

Ready to use template for applications using Auth0 and Postgresql

node-template

Basic node application ment to be a template for a node app which uses Auth0 and Postgresql. Ment to be forked for other projects in order to avoid writing the necessary boilerplate.

Development

The following are the instrocution to make the run the appication on your local machine

Database

The database is Postgres and runs in a docker container. To start the database run

npm run start-database

or alternatively

docker-compose up -d db

Application

To run the application in watch-mode for development

npm run dev

and go to http://localhost:3000

Building

To build the project for example for deployment

npm run build

The application can be run inside a docker container. The containers are build using Dockerfile. To run the app with docker

docker-compose up -d ui

NOTE ABOUT THE DATABASE URL

If your DATABASE_URL refers to 127.0.0.1, which is the loopback adapter (more here). This means "connect to myself".

When running both applications (without using Docker) on the same host, they are both addressable on the same adapter (also known as localhost).

When running both applications in containers they are not both on localhost as before. Instead you need to point the web container to the db container's IP address on the docker0 adapter - which docker-compose sets for you.

Change:

127.0.0.1 to CONTAINER_NAME (e.g. db)

Example:

DATABASE_URL: postgres://username:[email protected]:5432/mydatabase

to

DATABASE_URL: postgres://username:pgpassword@db:5432/mydatabase