Skip to content

readme.md

Latest commit

 

History

History
32 lines (23 loc) · 1.14 KB

readme.md

File metadata and controls

32 lines (23 loc) · 1.14 KB

Orakel

A fully open-source tournament platform.

Warning: This is still heavily in development.

Orakel is a tournament platform (similar to Challonge or Battlefy), which can be self-hosted and expanded, and is fully open source.

Usage:

TODO

Development:

The project is built up in two parts: the frontend-client and the backend-server.

Client development

All client code is inside client. The client is written using Vue V3 & vuetify.

An development server can be ran using yarn serve.

Server development

All server code is inside server. The server is written using TypeScript & Express, with MongoDB as a database.

An development server can be ran using yarn dev.

API documentation can be found here.

Motivation:

  • Boredom
  • Limited functionality / extensibility of already available tournament platforms
  • Learning new technologies like Vue, MongoDB
  • Learning how to build nicely looking UIs

External code used:

These are other sources that I've used, which are not noted inside the package.json's