Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thetnaingtn/go-dermacare-service
Just another REST API.
https://github.com/thetnaingtn/go-dermacare-service
docker gin mongodb rest-api
Last synced: about 1 month ago
JSON representation
Just another REST API.
- Host: GitHub
- URL: https://github.com/thetnaingtn/go-dermacare-service
- Owner: thetnaingtn
- Created: 2022-05-22T12:54:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-19T17:16:37.000Z (11 months ago)
- Last Synced: 2024-11-14T14:23:19.174Z (about 1 month ago)
- Topics: docker, gin, mongodb, rest-api
- Language: Go
- Homepage:
- Size: 183 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Backend Service for Derma Care Store
## Available Services
### User
- Signup(`/signup`) POST
- Signin(`/signin`) POST
### Product
- Query Products(`/products`) GET
- Query Product By Id(`/products/:id`) GET
- Create Product(`/products`) POST
- Update Product(`/products/:id`) PUT
- Delete Product(`/products/:id`) DELETE
### Category
- Query Categories(`/categories`) GET
- Create Category(`/categories`) POST
- Update Category(`/categories/:id`) PUT
- Delete Category(`/categories/:id`) DELETE
### Order
- Query Orders(`/orders`) GET
- Create Order(`/orders`) POST
## Local Development
This project use [air](https://github.com/cosmtrek/air) to live reload. If you are familiar with `nodemon` the concept is same but `air` is built with Go.
Rename .air.example.toml to .air.toml and modify `DB_HOST` and `DB_NAME` properly.
```
full_bin = "DB_HOST=localhost:27017 DB_NAME=dermacare ./tmp/main"
```
Then run
```
make generate-private-key && make generate-public-key
```
to generate `public` and `private` keys pair. After that, you can just run `air` in the root of your project directory.
## Running inside container
To run the application inside container you need to do these things.
1. Copy `.env.example` inside `zarf/docker` to `.env` file.
2. Create a docker network called `dermacare` by running this command `docker create network dermacare`.
3. Since containers(one for `database` and one for `application`) are running within the same network, they can connect each other by their name. update the `DB_HOST` inside `.env` to
```
DB_HOST=db:27017
DB_NAME=YOUR_DB_NAME
```
> Note `db` is come from `services` name which declare inside `docker-compose.yaml`.
4. Run `make start`. This command will build `dermacare-service:tag` image and will start the application.
5. Server is running on port `3000`.
## Running Tests
Unit tests can be run for specific folder or can be run at root level. To run unit test for specific folder, go to the folder and enter command
```
go test -v
```
> Note `-v` flag is for verbose
To run all unit tests run this command at root level
```
make test
```
## TODO
* Add Unit Test for Data Layer.
* Support search(filter) in all query services.
* Indexing on email fields to prevent duplicate email.
* Add other services
1. Analytic, Summary
2. Excel Export
* Rotating Secret
* Embed Admin UI to Binary