Ever wondered when you complete an assignment and do not know how well you're doing compared to other students? Introducing Codetierlist!
We provide students an opportunity as the leading place to test their code, to know their progress compared to their peers while they are working on their assignments, making coding more interactive, fun, and easier.
On Codetierlist, instructors can create new projects (assignments) for students. In each project, students are able to upload their own test cases and code. How well students do will be based on the accuracy of the students code in their own test cases, this will be shown in a tier list for students to see.
- 🔒 Login features: Students and instructors can login to their accounts to access their respective features.
- 🥇 Tierlist with real time updates: Continuously updating the accuracy of each students code and repositioning them
- 🤫 Safety and Independent working: While students do provide their test cases and code to rank their progress, specific implementation details are never shown to other students. This is done to ensures students work independently, and to prevent Academic Offenses.
- 📚 Timeline of submissions: student submissions are stored using git and commit history is viewable
For increased horizontal scalability, Codetierlist uses a separate job runner container to handle the processing of student submissions. This job runner can be run on a separate machine from the main Codetierlist application, and there can be multiple job runners connected to the main Codetierlist application.
At least one job runner must be running for Codetierlist to function properly. Otherwise, uploads will not be processed. Furthermore, the main Codetierlist application ("core application") must be running for the job runner to connect to it.
The job runner must also have access to the Redis server that are run by the core application. The job runner must be configured with the corresponding Redis password. Ideally, the Redis server should not be exposed to the public internet, so the job runner should be run on the same network as the Redis server.
Moreover, it is ideal that the job runner is run on a machine with a high number of CPU cores, as the job runner is CPU-bound. It is also recommended to run the core application on a separate machine from the job runner, to prevent the job runner from hogging too many resources from the core application.
Typically, GitHub Actions CI/CD pipelines are used to deploy the Codetierlist application to a cloud provider or on-premises server. The Codetierlist application is deployed using Docker containers, and the job runner is deployed using Docker containers as well.
- Docker
- Docker Compose
- Make
- Node.js (for development)
To start the run the containers needed to run Codetierlist, clone the repository onto the machine you want to run Codetierlist on.
Then, run the following command in the root directory of the project:
make prod_up # starts core application
make runner_up # starts the job runnerTo tear down the docker containers, run:
make prod_down # stops core application
make runner_down # stops the job runnerAfter running the docker containers, go to http://localhost:3555/ to visit the site.
To set up Intellisense for VSCode, or any other IDE that supports TypeScript code completion, run the following command in the root directory of the project:
make init # runs npm ci on all packagesTo start the run the containers needed to run Codetierlist, run the following command in the root directory of the project:
make dev_up # starts core application
make runner_up # starts the job runnerTo tear down the docker containers when finished with development, run:
make dev_down # stops core application
make runner_down # stops the job runnerAfter running the docker containers, go to http://localhost:3555/ to visit the site.
Dev containers are available for use with Visual Studio Code or the JetBrains suite of IDEs. These containers are pre-configured with the necessary tools to run Codetierlist locally for development of the frontend or backend.
Codetierlist is free and open-source software licensed under the LGPL-3.0 License.
You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository.
LGPL-3.0 License © 2023 Codetierlist Contributors