skill-test-tci

Football Standings

A simple RESTFUL API that provides endpoints to manage football leagues.

Prerequisites

• Go 1.19.3 or higher.
• Swaggo.
• Migrate.

Installation

• Clone this repository.
• Rename .env.example file to .env and change the variable value with your desired value.
• Next, run the below command to migrate the database schema.

migrate -database "mysql://root:{YOUR_MYSQL_PASSWORD}@tcp(localhost:{YOUR_PORT})/{YOUR_DB_NAME}" -path db/migrations up 

NOTE: Replace {YOUR_MYSQL_PASSWORD}, {YOUR_PORT}, {YOUR_DB_NAME} with the corresponding value in your .env file.

• Then run this command to synchronize all the dependencies.

go mod tidy

• After that run the command below to generate the required files for swaggo.

swag init

• Finally, run the project.

go run .

Usage

Open your browser and go to http://localhost:3000/swagger/index.html.

NOTE: Replace the 3000 with your defined PORT value in your .env file.

Meta

Hanif Naufal – @Digisata – hnaufal123@gmail.com

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

Contributing

1. Fork this repository.
2. Create your own branch (git checkout -b fooBar).
3. Commit your changes (git commit -am 'Add some fooBar').
4. Push to the branch (git push origin fooBar).
5. Create your awesome Pull Request.