Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.06 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.06 KB
Raw

UVIC API

Started with VikeLabs' StudySpaceFinder, this project provides an API for University of Victoria data, allowing future projects to access and utilize this information.

Core dependencies

  • Golang (v1.20)
    • Chi: a small and simple router.
  • Docker.

Get started

  • Start a dev server with docker!

    docker compose up # no hot reload, use air instead (see below)

  • If Docker is not an option, assume Go is installed:

    go mod tidy # sync dependecies
go install github.com/cosmtrek/air@latest # for hot reload
air # start the server

  • Server listens at http://localhost:8080.

Contributing

This project is open source and contributions are welcome. If you encounter a bug or have a feature request, please open an issue on the GitHub repository.

License

This project is licensed under the GNU GPLv3 License. See the LICENSE file for details.