Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nealarch01/payaco
💰 Money transfer REST API developed in Go with Gorilla/Mux and PostgreSQL
https://github.com/nealarch01/payaco
go golang gorilla-mux json jwt money-transfer postgresql rest-api
Last synced: 9 days ago
JSON representation
💰 Money transfer REST API developed in Go with Gorilla/Mux and PostgreSQL
- Host: GitHub
- URL: https://github.com/nealarch01/payaco
- Owner: nealarch01
- License: mit
- Created: 2022-11-26T08:17:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-20T01:43:40.000Z (about 2 years ago)
- Last Synced: 2024-06-21T07:46:17.708Z (7 months ago)
- Topics: go, golang, gorilla-mux, json, jwt, money-transfer, postgresql, rest-api
- Language: Go
- Homepage:
- Size: 8.58 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Payaco
A simple money transfer REST API.
### Disclaimer: This is all play/fake money!!
# Table of Contents:
1. [Technology Stack](#techstack)
2. [Initializing the Database](#initializing-the-database)
3. [Running the RestAPI](#running-the-rest-api)
4. [API Documentation](#api-endpoints)
5. [Useful Resources](#useful-resources)
## Tech Stack
- **Language:** Go
- **Framework:** GorillaMux
- **Database:** PostgreSQL (Version: 15.0)
- **Additional Technologies:** JSON Web Tokens (JWTs)
- **Architecture:** Model-View-Controller (MVC)
### Additional Information:
- The server does not use HTTPS
- The default port (specified in main) is 8001
- All endpoints except "/" will return application/json
## Initializing the database
- Create a PostgreSQL instance at any port (this project uses 4323)
- A shell script ```setup.sh``` was provided and can be found in the database directory. Change the port number to your instance and run it. The shell file will create a database named "development", the tables, and populates it with sample data.
- Note: this shell script uses zsh, if you use bash, modify the binary.
## Running the REST API
You may use ```go run main.go``` (assuming you are inside ./rest-api directory).
Alternatively, another shell script was provided that compiles the program into an executable and immediately runs if successful.
Note: navigate into ```./rest-api/pkg/models/database.go``` and change your connection string if you are using a different port or database name.
## API Endpoints
You may find the endpoint documentations at:
[Payaco API Documentation (Postman)](https://documenter.getpostman.com/view/21072555/2s8YsxtqoY)
## Useful Resources:
- [Go Rest API youtube](https://youtu.be/jFfo23yIWac)
- [Gorilla/Mux](https://github.com/gorilla/mux#middleware)
- [Go database/sql documentation](https://pkg.go.dev/database/sql)
- [GoJWT Documentation](https://pkg.go.dev/github.com/golang-jwt/jwt/v4)
- [Storing currency PostgresSQL](https://stackoverflow.com/questions/15726535/which-datatype-should-be-used-for-currency)
- [URL Params](https://stackoverflow.com/questions/46045756/retrieve-optional-query-variables-with-gorilla-mux)
- [Middleware](https://www.turing.com/kb/building-middleware-for-node-js)
- [Sample data generator](https://www.mockaroo.com)