Project starter

Project starter.

System requirements

TODO: write System requirements

Ennvironment variables

• DOCKER_NAME — project name for Docker-Compose
• WEB_HOST — localhost for dev or your-domain.com for production
• WEB_PORT — local posrt for web-service (5173 or whatever you want)
• TRAEFIK_HOST traefik.localhost for dev or traefik.your-domain.com for production
• TRAEFIK_USER — username for traefik dashboard
• TRAEFIK_PASSWORD — password for traefik dashboard
• LE_ACME_EMAIL — email fo Let'sEncrypt notifications

Services

web-service

TODO: write about web-service

traefik-service

TODO: write about traefik-service

Development

Copy .env.example into .env and fill all values.

Start project in dev-mode:

npm run dev
# or
npm run start:dev

Go to localhost in browser.

Stop project in dev-mode:

npm run stop:dev

Use in production

Configure your domain DNS-records:

A-record your-domain.com = your.server.ip.address
A-record traefik.your-domain.com = your.server.ip.address

Copy .env.example into .env and fill all values.

Start project in production-mode:

npm start

Go to your domain address in browser.

Stop project in production-mode:

npm stop

Support

Bugs

Stay in touch

• Author: Den Kochetkov
• E-mail: [email protected]
• Website: asknotbad.com

License

Apache-2.0

Copyright © 2025 Not Bad