Welcome to Kelvin Documentation
Kelvin is a web-based educational platform built around automated code evaluation. It provides tools for teachers to create programming tasks and for students to complete them, with possible immediate feedback on their submissions.
Getting Started
This documentation is designed to help you get started with Kelvin, whether you are a developer looking to contribute to the project or an educator aiming to utilize its features for teaching programming.
To start using Kelvin, you can explore the following sections:
- Installation Guide: Instructions on how to set up Kelvin on your local machine or server.
- Developer's Guide: Information for developers interested in contributing to the Kelvin project.
- Teacher's Guide: A comprehensive guide for educators on how to create and manage programming tasks.
- Student's Guide: A guide for students on how to navigate and use the Kelvin platform effectively.
Contributing to the Documentation
We are excited to have you on board! If you would like to contribute to this documentation, you can simply follow these steps:
- Pull kelvin repository:
git pull https://github.com/mrlvsb/kelvin - Change working directory to docs:
cd docs - Install dependencies:
npm ci - Start the development server:
npm start - Open the documentation in your browser at
http://localhost:3000and start editing the files in thedocsdirectory.