https://github.com/osamaesmail/phone-list-be
https://github.com/osamaesmail/phone-list-be
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/osamaesmail/phone-list-be
- Owner: osamaesmail
- Created: 2021-11-06T14:51:18.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-11T04:27:05.000Z (over 3 years ago)
- Last Synced: 2025-01-23T01:14:03.606Z (5 months ago)
- Language: Go
- Size: 58.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# phone-list-be
# Architecture
based on 4 layer
* Model
* Repository
* Service
* Handler
## Features
- [x] containerized using `docker` and `docker-compose`
- [x] API Documentation using `swagger` (auto generated)
- [x] `pagination`
- [x] Middlewares `CORS`, `Logger`, `Recover`
- [x] Unit tests
- [ ] Benchmark
- [ ] Code Docs
## Requirements
* using docker
* docker
* docker-compose
* without docker
* golang (tested on `go1.17.2`)
## Run using docker
* don't forget `.env` file
* run `docker-compose up -d`
* open http://localhost:5001/swagger/index.html
## Run without docker
* don't forget `.env` file
* run `go run main.go`
* open http://localhost:5001/swagger/index.html
## Run tests
* run `make test`