@speedcubing/cola

Speedcubing Online's server.


Keywords
social, website, social-network, websites
License
MIT
Install
npm install @speedcubing/cola@0.0.23

Documentation

Speedcubing Online

A(n open source) hub for online speedcubing competitions!

Structure

  • cookie: The front end of the website.
  • cola: The server, API and authentication system.
  • donut: The client side API toolkit for Node.js
  • snowcone: Speedcubing Online's NxN official scramble generator.
  • pie LEGACY: The server, API and authentication system of the website.

Branches

  • staging: Used to test and experiment with updates.
  • production: The branch that's code is used for the actual website.

Testing and Contributing

Before contributing to the project, please build and test the part of the project you were working on. If you modified multiple parts of the project, you can run the following commands on Windows/Linux/MacOS:

# Windows CMD
build

# Windows Powershell
./build

# Linux/MacOS Shell
./build.sh