https://github.com/kuclap/kuclap-review
Back-end service for management review (https://api-review.kuclap.com).
https://github.com/kuclap/kuclap-review
docker github-actions golang heroku mgo modd mux pipeline staging toml vegeta
Last synced: 25 days ago
JSON representation
Back-end service for management review (https://api-review.kuclap.com).
- Host: GitHub
- URL: https://github.com/kuclap/kuclap-review
- Owner: KUclap
- License: mit
- Created: 2020-10-07T08:00:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T15:34:35.000Z (about 3 years ago)
- Last Synced: 2025-06-25T01:14:26.699Z (11 months ago)
- Topics: docker, github-actions, golang, heroku, mgo, modd, mux, pipeline, staging, toml, vegeta
- Language: Go
- Homepage: https://api-review.kuclap.com
- Size: 28.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
KUclap Back-End
## Overview
This repository is KUclap back-end source code which is written in golang for implementing a web API and using it access to the database 🚀.
### Documentation
Postman Collection 📝
URL : https://www.getpostman.com/collections/79cb50bda1b010277ac9
### Built With 🔧
- [Golang](https://golang.org/)
- [mgo.v2](https://godoc.org/gopkg.in/mgo.v2)
## Getting Started
To get a local copy up and running follow these simple steps 🎉.
### Prerequisites
Install these prerequisites ✅ .
- Go
- Docker
### Installation
1. Clone the repo
```sh
git clone https://github.com/KUclap/KUclap-review.git
```
2. Install packages
```sh
go get ./...
# or
go mod download
```
## Development / Usage
Use `modd` for live reloading by follow this command 😎 .
```sh
make gomodd
```
## Deployment
### Staging
This command is for deploying to Heroku 🤒 (Stagging Environment).
```sh
make deploy-to-staging
```
### Pre-Production
Merge commits from master into pre-prod-release branch. The pipeline will deploy to Gandalf's server (DigitalOcean droplet) automatically 🤮.
```sh
git checkout pre-prod-release
git pull origin master
...
git push
```
### Production
Like Pre-Production 😬, Merge commits from master into release branch. The pipeline will deploy to Gandalf's server (DigitalOcean droplet) automatically 😳 .
```sh
git checkout release
git pull origin master
...
git push
```
## Note 🌶
- For more details about commands, Please read `Makefile`.
- `.github/workflows` is used for storing pipeline script for automated deployment.
- You have to install `heroku` CLI for deploying image to staging.
- Heroku only detects docker image (Dockerfile) which filename starting with 'D' capital letter.