https://github.com/xebec19/shiny-parakeet
project in go
https://github.com/xebec19/shiny-parakeet
Last synced: 4 months ago
JSON representation
project in go
- Host: GitHub
- URL: https://github.com/xebec19/shiny-parakeet
- Owner: Xebec19
- License: gpl-3.0
- Created: 2022-10-02T03:54:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-12T07:28:43.000Z (over 2 years ago)
- Last Synced: 2025-01-08T04:37:16.169Z (5 months ago)
- Language: Go
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shiny-parakeet
# Requirements
## Technical Requirements
1. go 1.19
2. [golang-migrate](https://github.com/golang-migrate/migrate) for migrating database
3. Postgresql
## Other requirement
1. Please find example.env in root and add required values and rename it as app.env
# How to set up
## with Docker
1. Pull postgres image
```
docker pull postgres:12-alpine
```
2. Create container for database
```
make postgres
```
3. Create database in container
```
make createdb
```
4. Migrate database
```
make migrateup
```
5. Install dependencies
```
go mod tidy
```
6. Test application
```
make test
```
7. Run application
```
make server
```
## Without docker
1. Migrate database
```
make migrateup
```
2. Install dependencies
```
go mod tidy
```
3. Test application
```
make test
```
4. Run application
```
make server
```
# API Documentation (POSTMAN)
Please find API Documentation in [./wiki](https://github.com/Xebec19/shiny-parakeet/tree/main/wiki) folder
# Swagger Documentation
Please find documentation in [./docs](https://github.com/Xebec19/shiny-parakeet/tree/main/docs) folder