nfm-studios/project-olly

Sports Event Management at it's finest. Like tuxedo fine

Project Olly

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!

project-olly's Issues

Tournament DateTime field reset when you try to and edit a tournament

Describe the bug
There are no default values for the datetime fields when editing a tournament

To Reproduce
Steps to reproduce the behavior:

1. Create a tournament - setting a datetime
2. Click on edit tournament
3. See error

Expected behavior
The default value for the field should be the value the tournament is currently set to, however it's entirely blank.

Add statistics for user profiles

Better sorting

Especially for leaderboards. Wow that is a mess

Add session-management

Setup script

If you look at the installation process it's fairly lengthy, a simple script could help with this.

Support traditional sports

Don't limit the event management to just esports, allow other sports such as Hockey, Baseball, Soccer, etc. to manage leagues, tournaments, all within Project Olly

Add default game, platform, and sport choices to database - via setup script

Simply add some default values for these fields within the setup script.

Database cleanup script

• Expired team invites. Where expired = True
• Teams with 0 members
• Closed support tickets - when update datetime > ?days
• System log events - older than ?days

SingleTournament Tests

Currently the unit tests for the SingleTournaments app are non existent, and for being such a core functionality adding tests could help improve development

Object based slides

This will allow site admins to create and remove slides, rather than having the amount hard coded

Allow for sorting of store product objects

Allow Staff to disable User match reports

Via the staff panel when creating a tournament/league or modifying a match, allow the staff to disable user reports for the entire tournament/league or the specific match.

"num" instead of "pk" in teams/urls

Can't create teams from staff panel

Publish is allowed to be blank but not null when creating news post

Docker compose and NGINX container

Stock template bracket styling is missing

Somehow amidst the static file consolidation the css styling for brackets was removed and the styling for brackets are now non functional.

add a footer to stock templates and implement object based social info

Double Elimination Tournaments

*DateTimeFields in Staff:Tournaments are broken*

Unable to Create or modify tournaments with form validation on.

Users request registration for tournament

Along the lines of invite only, except the staff could allow users to request to join. A staff member would have to accept the request for the team to be added.

Remove Multi tenant middleware

Allow captains of a team to make wager requests

Currently only founders of a team can do this, have had some permissions issue in the past with captains not getting permission but players getting permission somehow.

Match history on profile page

Allow Staff to manually add users to a team

From within the staff:edit_team functionality

Send user an email if they are invited to join a team

Allow staff to reset all users XP

Unable to make object based slides via staff panel

User Scrims

Better option for custom templates

Likely with an env variable(?) and a mapped path

There are no front end templates or views for FAQ

Show number of disputed matches in staff panel

Simply at the staff panel homepage, show the number of matches that are currently marked as disputed, in doing so it will be easier and faster for staff to pickup on a disputed match and help resolve said issue.

Careers/Applications functionality

Support:Knowledge Base

Allow staff to create an FAQ/Knowledge Base section to answer common questions, etc.

Auto-generate slug for news posts

Swap login form to use email addresses instead of usernames

Exception Middleware

Add confirmation to dangerous actions in staff panel

When doing dangerous actions (like deleting something) there should be a confirmation dialog as with resetting XP (see

project-olly/staff/templates/staff/profiles/users.html

Line 70 in ea5b75f

<td><a href="{% url 'staff:reset_xp' %}" onclick="return confirm('Are you sure you want to reset XP for all users?\nThis cannot be undone!')" class="btn btn-danger">Reset XP for all users</a></td>

)

Single Tournament Bracket template

Currently the size of the tournament determines the predefined template that is used. Templates for sizes, 4, 8, 16, 32, 64, 128 are currently supported. However to support larger size tournaments and for ease of template modifications eliminating this down to one single more dynamic template can help.

Update email templates

Some templates are using outdated tags and information. They should be updated and fixed.

Leagues

Update contrib

reorganize file structure & rename templates

Migrate permissions system to Django's built in

Object Based User Permissions

Allow for staff with superadmin access to be able to modify and create roles and specify what they have permission to do within the staff panel.

Add travis badge to readme

Validate Usernames

validators.ASCIIUsernameValidator and validators.UnicodeUsernameValidator
validate usernames upon registration are using proper characters.

Add 2FA

Implement Country Flags for teams in brackets

We are already utilizing a package to add a CountryField in the database, however this package also supports images.
With this being said this is a simple addition in the template, where looping through each team - simply add additional template tags to show the teams flag (if applicable)

User Notification System