Skip to content

NFM-Studios/project-olly

Repository files navigation

Project Olly

Build Status All Contributors

About the project

Project Olly is an online esports tournament hosting platform written in Python 3 using the Django web framework. It began as a closed source commercial product until November 2019 when it was re-released under the MPL2.0 license (see license.md)

Roadmap

  • Single Eliminations Tournaments (Live - improvements coming soon)
  • Leagues (Live - improvements coming soon)
  • UserProfiles (completed)
  • Support Tickets (completed)
  • News Posts (completed)
  • Match System (Live - improvements coming soon)
  • Team system - team invites, captains (completed - improvements coming soon)
  • PayPal Store for processing some payments (completed)
  • Double Elimination Tournaments (planned)
  • Ladders (planned)

Installation

  1. Clone the repository! You need the code, it won't just magically work without it. git clone https://github.com/NFM-Studios/project-olly.git
  2. Install docker and docker-compose. Follow the instructions here and here
  3. Copy .env.example to .env and edit using the guidance in the file
  4. Copy Caddyfile.example to Caddyfile and change example.com to your domain and email.example.com to your email address
  5. Run docker-compose up -d
  6. A user was automatically created with the username admin and the password ChangeMe! DON'T FORGET TO CHANGE THE PASSWORD!
  7. How easy was that!?

Designs and Template

Project Olly allows you to throw in your front end templates without having to mess with any backend code! It's simple!

Use our templates in project-templates as a base, then set template_path in .env to wherever you stored your custom templates

Contributors ✨

Thanks goes to these wonderful people (emoji key):


mulveyben1

💻

rjh05

💻

Cameron Riu

💻

Mike M.

⚠️ 💻 🚇 📖

Steven Young

🚇 🤔 💻

tkenney124

💻

This project follows the all-contributors specification. Contributions of any kind welcome!