Squelette (french for Skeleton) is a quickstart template designed to simplify the process of creating web services in Go. Its goal is to provide developers with a well-structured project layout, essential dependencies, and configuration files.
-
Clone the repository:
git clone https://github.com/shivanshkc/squelette.git cd squelette
-
Replace
squelette
with your desired project name in all files and directories. -
Rename the
cmd/squelette
folder to your desired project name. -
Delete the
CHANGELOG.md
file. -
Create a configs file by running:
cp configs/configs.sample.yaml configs/configs.yaml
-
Run using:
make run
The Makefile
includes several commands to streamline common tasks:
make build
: Build the project.make run
: Compile and run the project.make image
: Build the container image of the project.make container
: Run an application container.make test
: Run tests for the project.make lint
: Run linters to check code quality.
TODO