Main Bersama API

Rental backend application for sports venues such as soccer, mini soccer, futsal, basketball, or volleyball.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

Main bersama (Play Together) is a rental backend application for sports venues such as soccer, mini soccer, futsal, basketball, or volleyball. In addition, users can also join the schedule that has been made. So, each user can play together.

Built With

• AdonisJS
• Node.js

Getting Started

Prerequisites

• Node.js v14.7.4 or higher

Installation

1. Clone the repo.

   git clone https://github.com/fahri-r/main-bersama-api.git

2. Install NPM packages.

   npm install

3. Rename .env.example into .env.

4. Set the database value in .env.

   ...
   MYSQL_HOST=localhost
   MYSQL_PORT=3306
   MYSQL_USER=lucid
   MYSQL_PASSWORD=
   MYSQL_DB_NAME=lucid
   ...

5. Create database according to MYSQL_DB_NAME. in this case I have to create a database named lucid.

6. Execute database migration.

   node ace migration:run

Usage

Once you have done the installation, let's start the local server.

node ace serve --watch

Now, Visit http://localhost:3333 and you will see a message saying "Hello World". If you want to see the API Documentation, then visit http://localhost:3333/docs.

Contributing

Contributions are what make the open source community such an amazing place to 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.

License

Distributed under the MIT License. See LICENSE for more information.