Club Back-End

A RESTful API for club information (events, projects, sign-ins, etc) that is used for the club website, bots, and any future projects related to administration.

The project goals and roadmap can be found here.

Getting Started

We will use Docker to develop and deploy the code.

Installing

Install Docker and Docker compose.

Running

To run the app

docker-compose up

Note: The first time, you might have to add the --build flag to the end of the previous command

And go to localhost:3001 or 192.168.99.100:3001 if you're using Docker Toolbox on Windows.

To run updated code, you can press "Ctrl-C" in the terminal or type

docker-compose down

Built With

Rust - a (wonderful) systems programming language
Rocket Framework - a web framework for Rust
PostgreSQL - an open source relational database
Diesel - An extensible ORM and Query Builder for Rust (to interact with PostgreSQL)

Contributing

Please read CONTRIBUTING.md for how to work on the project and the DESIGN.md file to understand more about the technologies we use and how it all fits together.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.