Hello and welcome! This is a template repository made for convenience to others by ninjaninja140!
This is an empty template to be repurposed when cloned/forked/imported to be used as the base template for another type of application or for whatever use-case you may use.
To begin on your own project, you can either fork this repository and begin your project or you could select this repository at bracketed/templates-scratch as a template when creating a new repository or you could just clone it and work locally!
Just remove the docker folder and the entrypoint.sh file and you should be good to go!
You may also need to remove the validate.yml and ci.yml files as they use Docker to check if the project can be compiled with Docker.
This project has been pre-configured to use biome with Biome binaries in the biome folder.
You can change my current Biome config in the biome.json file, or you can delete it to use another linter.
This project was set up with Docker for convenience to others and myself.
If you do not wish to use Docker in this project, ignore this and go to the If you aren't using Docker sub-section of the Setup & Install section.
If you are using Docker in this project, I have pre-prepared a Dockerfile, change this to your best suit if necessary.
All docker-related content for this project has been set up in the docker folder, which includes development compose files, production compose files and a Dockerfile for building your project.
If you don't already, install Docker Engine or Docker Desktop onto the device you are using to test locally or deploy on.
Production commands:
- Building the full project:
docker compose -f docker/prod/main.compose.yaml build - Running the full project:
docker compose -f docker/prod/main.compose.yaml up -d - Building only services:
docker compose -f docker/prod/services.compose.yaml build - Running only services:
docker compose -f docker/prod/services.compose.yaml up -d
Development commands:
- Building the full project:
docker compose -f docker/dev/main.compose.yaml build - Running the full project:
docker compose -f docker/dev/main.compose.yaml up -d - Building only services:
docker compose -f docker/dev/services.compose.yaml build - Running only services:
docker compose -f docker/dev/services.compose.yaml up -d(Command automatically runs on boot with VSC for development environments)
If this fails for whatever reason, please try troubleshoot it yourself before opening an issue.
If you haven't already, please build your project before running. Refer to the Building sub-section that should be just above on how to build your project.
Refer to the section above regarding the new deployment commands.
Thank you for using my templates! If you like to use them frequently, why not consider sponsoring or tipping me! My GitHub Sponsors profile is at https://github.com/sponsors/ninjaninja140!
