2ofclubsapp/server repository overview

⁠

2ofClubs Server

⁠Finding the perfect club for you!

⁠

Introduction⁠ • Installation⁠ • Documentation⁠ • Blog⁠ • Contact⁠ • Honorable Mentions⁠ • License⁠

⁠Introduction

2ofClubs is a web app for helping students find clubs that suit their preferences.

• Easy to Use!

• Explore anywhere

⁠Installation

2ofClubs-Server is available as a Docker Container⁠ on Docker Hub⁠

⁠Deployment using Docker

1. Pull the latest image from Docker Hub:

docker pull 2ofclubsapp/server

1. Run docker-compose Make sure your version of Docker supports docker-compose v3.3 or later

docker-compose up --build -d

1. The server should be listening and serving on port 8080

You can check out our full installation guide⁠, app requirements and more on our website.

⁠Configuration

• By default, the 2ofClubs-Server is listening and serving on port 8080. This can be changed in the docker-compose.yaml file.
• App environemnt variables can be set in app.env
• Database environment variables can be set in db.env

⁠Documentation

Our documentation can be found here⁠

⁠Blog

Checkout our blog⁠ for updates and changes!

⁠Contact

You can contact us through these channels:

• Email⁠
• Github Issues⁠

⁠Contributing

• Properly document⁠ and format⁠ your Go Code.
• If you're submitting a feature request or PR, please follow their associated templates

For any code that can be reworked/improved upon, feel free to submit a PR

⁠Honorable mentions

Thank you so much for your help and guidance! We couldn't have done this without you!

Nicholas Hawkes⁠ and Michael Liut⁠

⁠License

The 2ofClubs-Server is MIT licensed⁠