ALTA Booking Sport Arena

a Golang REST API with Echo and GORM

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Contact

About The Project

Standard Naming Convention

• FOLDER = camelCase
• FILE = snake_case
• FUNCTION = PascalCase

Feature

• Register & Login
• CRUD User
• CRUD Facility
• CRUD Category
• CRUD Venue
• CRUD Admin
• CRUD Booking & Payment

Built With

• Go as Programming Language
• Echo as Framework
• JWT Auth as Authentication
• Gorm as ORM
• MySql as Database
• Database Stored in RDS Cloud by Amazon Web Services

Usage

• Open API
• ERD
• Postman Collections

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running, follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Install Golang, Mysql, and Postman for testing
• create an .env file

  export APP_PORT=""
  export JWT_SECRET="S3CR3T"
  export DB_PORT="3306"
  export DB_DRIVER="mysql"
  export DB_NAME=""
  export DB_ADDRESS="127.0.0.1"
  export DB_USERNAME=""
  export DB_PASSWORD=""

Installation

1. Clone the repo (in Folder htdocs)

git clone https://github.com/ALTA-Booking-Sport-Arena-App/sport-arena-api.git

2. Install module with get

go get
go mod tidy

3. Run

source .env
go run main.go

4. Access via url

localhost:port

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact