Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/igorhoffmann/gms-app

👨‍💻 REST API for Gym Management System
https://github.com/igorhoffmann/gms-app

clean-ar docker dockerfile dokcer-compose gin go golang golang-api golang-examples golang-jwt golang-jwt-a golang-migrate golang-rest jwt jwt-authentication makefile rest-api sql sqlx

Last synced: about 1 month ago
JSON representation

👨‍💻 REST API for Gym Management System

Host: GitHub
URL: https://github.com/igorhoffmann/gms-app
Owner: igorhoffmann
Created: 2022-07-09T09:50:16.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2022-08-25T12:04:57.000Z (about 2 years ago)
Last Synced: 2024-10-11T00:33:31.114Z (about 1 month ago)
Topics: clean-ar, docker, dockerfile, dokcer-compose, gin, go, golang, golang-api, golang-examples, golang-jwt, golang-jwt-a, golang-migrate, golang-rest, jwt, jwt-authentication, makefile, rest-api, sql, sqlx
Language: Go
Homepage:
Size: 105 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# REST API "Gym Management System" on Go

The application implements a service for sending methods GET, POST, DELETE, PUT to interact with the database, which is described in this file. Additionally implemented authorization and authentication using jwt.

## API:

### POST /auth/sign-up

Creates new user

##### Example Input:
```
{
"username": "UncleBob",
"password": "cleanArch"
}
```

### POST /auth/sign-in

Request to get JWT Token based on user credentials

##### Example Input:
```
{
"username": "UncleBob",
"password": "cleanArch"
}
```

##### Example Response:
```
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1NzEwMzgyMjQuNzQ0MzI0MiwidXNlciI6eyJJRCI6IjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMCIsIlVzZXJuYW1lIjoiemhhc2hrZXZ5Y2giLCJQYXNzd29yZCI6IjQyODYwMTc5ZmFiMTQ2YzZiZDAyNjlkMDViZTM0ZWNmYmY5Zjk3YjUifX0.3dsyKJQ-HZJxdvBMui0Mzgw6yb6If9aB8imGhxMOjsk"
}
```

### POST /api/info

Creates new info

##### Example Input:

###### Case instructor:
```
{
"first_name": "Marlon",
"last_name": "Brando",
"relationship": "istructor",
"phone": "+380000000000",
"date_of_birth": "03.04.1998",
"salary": 3000
}
```
###### Case member:
```
{
"first_name": "Steven",
"last_name": "Jobs",
"relationship": "member",
"phone": "+380000000001",
"date_of_birth": "07.08.2000",
"membership_id": 1,
"expires_at": "16.11.2022"
}
```

### GET /api/info

Returns all user info

##### Example Response:
```
{
"info": [
{
"id": 1
"first_name": "Marlon",
"last_name": "Brando",
"middle_name": "",
"relationship": "istructor",
"phone": "+380000000000",
"date_of_birth": "03.04.1998",
"date_of_registry": "16.08.2022",
"hire_date": "16.08.2022",
"salary": 3000
}
]
}
```

### DELETE /api/info

Deletes info by ID:

##### Example Input:
```
{
"id": "1"
}
```

## Requirements
- go 1.18
- docker & docker-compose
- postman (for testing)

## To launch an application:

```
make build && make run
```

If the application is running for the first time, you need to apply migrations to the database:

```
make migrate
```

## Test data

You can simply copy and paste the contents of the file in the terminal, opening the desired database.

If you're using Git Bash on Windows and don't have a ```make``` command in the terminal, I recommend this guide.

## Application testing

The postman folder contains a collection for testing the application. Postman download link.

### P.s.
Inspired by Maksim Zhashkevych.