README
¶
Books Data System
This section is still in progress.
Functionalities
This section is still in progress.
Prerequisites
Running this project locally assumes you have installed version of Go 1.19 or higher.
In order to make sure your environment is set up properly run the following command:
go version
If you don't have your local installation of Go follow the installation guide from: https://go.dev
Running the Project
Clone the project
git clone https://github.com/tchorzewski1991/bds.git
Go to the project directory
cd bds
Install dependencies
make tidy
Start books-api service locally
make run
Shutdown books-api service
ctrl+c
Clean up project directory
make clean
License
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
services/books-api/handlers
Package handlers contains all the handler functions and routes supported by the web api.
|
Package handlers contains all the handler functions and routes supported by the web api. |
|
base
|
|
|
logger
Package logger provides a helper function responsible for encapsulating logger construction.
|
Package logger provides a helper function responsible for encapsulating logger construction. |
|
business
|
|
Click to show internal directories.
Click to hide internal directories.