https://github.com/jarvma18/app-docker-compose-template

Ready template for dockerized application
https://github.com/jarvma18/app-docker-compose-template

api backend docker docker-compose jest knexjs nodejs nodemon postgresql typescript

Last synced: 5 days ago
JSON representation

Ready template for dockerized application

• Host: GitHub
• URL: https://github.com/jarvma18/app-docker-compose-template
• Owner: jarvma18
• License: mit
• Created: 2024-03-02T10:52:27.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-07T09:45:52.000Z (4 months ago)
• Last Synced: 2024-08-02T18:42:01.426Z (3 months ago)
• Topics: api, backend, docker, docker-compose, jest, knexjs, nodejs, nodemon, postgresql, typescript
• Language: TypeScript
• Homepage:
• Size: 113 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# app-docker-compose-template

Purpose of this project is to offer ready template for dockerized application.

Some key elemets in this template is Node.js application with typescript and automatic build with nodemon.

Data storage is PostgreSQL container with persistent volume for data storage.

Some ready libraries are included for example knex for the database actions.

I may implement frontend part to this project as well.

## Initial preparations

* Install Docker

* Install Docker compose

* Run migrations to latest level if you want that the test api works (see the "Helpful commands" section)

Docker & Docker compose versions that have been tested with this:

```

docker -v

Docker version 24.0.7, build afdd53b

docker compose version

Docker Compose version v2.23.0-desktop.1

```

## How to run

```

docker compose build && docker compose up

```

You can test the initial app by opening your browser and typing in localhost:3000

![](localhost3000.png)

## Frontend

I suggest that you create frontend without docker.

It could be for example react + next.js project in the root that makes requests to app container.

I see that the docker environment for frontend would not be important because in prod it would be served differently,

so without docker there is lesser amount of complexities to handle in dev environment.

## Helpful commands

```

// Run psql

docker compose exec app-db psql -h localhost -U postgres

// Run knex init for ts

docker compose exec app knex init -x ts

// Create migration file

docker compose exec -w /usr/src/data app knex migrate:make migration_name -x ts

// Run migrations

docker compose exec -w /usr/src/data app knex migrate:latest

docker compose exec -w /usr/src/data app knex migrate:rollback --all

docker compose exec -w /usr/src/data app knex migrate:up

docker compose exec -w /usr/src/data app knex migrate:down

// Create seed file

docker compose exec -w /usr/src/data app knex seed:make seed_name

// Run seeds

docker compose exec -w /usr/src/data app knex seed:run

```