Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glitchfix/golagobar
https://github.com/glitchfix/golagobar
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/glitchfix/golagobar
- Owner: Glitchfix
- Created: 2020-07-17T14:54:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-16T22:39:30.000Z (over 2 years ago)
- Last Synced: 2024-04-16T00:13:49.712Z (9 months ago)
- Language: Go
- Size: 39.1 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gola/Gobar
This is just a minimalistic sample application to demonstrate my coding practice in Golang and MongoDB.
This application is a subset of the needs of a cab booking platform like Gobar/Gola.
- [x] A user should be able to request a booking for a cab from pickup location A to pickup location B
- [x] A user should be able to view his past bookings
- [x] A user should be able to get cabs that are nearby.
- [x] Writing middleware for proper http error statuses
- [x] Using gin
P.S. an actual cab booking platform has way more detail than you could think of.
That usually includes of plenty of other necesary microservices, a messaging queue, socket connections, VRP engine and ofcourse some statistics to generate the price estimate.
## How to run
### Step 1
###### Initialize your mongo database with commands in the file below
```sh
dbinit.js
```
### Step 2
###### On your terminal
```sh
git clone github.com/Glitchfix/golagobar
cd golagobar
go get ./...
```
### Step 3
###### Create config.json file and configure as per sample given below
### Step 4
###### Run the following commands after setting up your config
```sh
make run
```
##### OR
```sh
make build
./golagobar
```
### Sample config.json file
```json
{
"database": {
"database": "golagobar",
"host": "DBHOST",
"port": "DBHOST",
"username": "YOUR_USERNAME",
"password": "YOUR_PASSWORD",
"authsource": "YOUR_AUTHENTICATION_SOURCE_DB"
},
"server": {
"host": "HOST_IP",
"port": "PORT"
}
}
```
### Click on the postman icon to see API documentation
[](https://documenter.getpostman.com/view/12089646/T1DjjzRK)