algoristas / api

Algorists dashboard API
4 stars 1 forks source link

Algoristas API

This repo contains the API for the Algoristas' dashboard.

Running app on docker

Run the following command for building the image:

docker build -t algoristas-api .

Followed by:

docker run -p 8080:8080 algoristas-api

This last command will run the application inside the container and will expose the port 8080. You can test the API by querying localhost at 8080.

Test API endpoints

curl localhost:8080/v1/results
curl -i localhost:8080/v1/problems/sets
curl -i localhost:8080/v1/standings

Code Review guidelines

You can read Code Review Comments for more info about how to add comments in Go code.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

git pull
git checkout -b your_branch
git add *all_files_to_add*
git commit
git push origin your_branch

Then, go to GitHub to make a pull request