Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kallepan authored Dec 27, 2023
1 parent fc626db commit b41d89a
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@
This is a generic backend for a REST API written in GoLang. It uses the [Gin](https://github.com/gin-gonic/gin) framework. It is meant to be used as a starting point for a new project. It includes basic modules for logging, configuration, database, and authentication. It also includes a Dockerfile for building a Docker image. The Docker image is based on [Scratch](https://hub.docker.com/_/scratch/).

## Usage
- Launch the devcontainer using the preconfigured files
- Now launch `hack/launch.dev.sh` to start the webserver in development mode
- Tests can be run using `hack/test.sh` if the devcontainer is running.
- Launch the devcontainer using the preconfigured files.
- Use VSCode to launch the debug task.

0 comments on commit b41d89a

Please sign in to comment.