MinervaLMS - Backend

Backend team repository of Minerva Learning Management System (LMS). Developed by a group of students of Universidad Nacional de Colombia using Django.
Domain · Report Bug · Request Feature

Table of Contents

1. About The Project
   1. Built With
2. Getting Started
   1. Prerequisites
   2. Installation
3. Contributing
4. License
5. Contact

About The Project

This project serves as the core system for the Minerva project. It's designed with scalability and maintainability in mind, ensuring it can handle increased usage. Anticipating around 5000 users annually.

Built With

Are you able to review our requirements outlined in the pyproject file. This document provides a comprehensive overview of the specifications we are seeking.

(Back to top)

Getting Started

Here's a guide on how to set up our project locally. This step-by-step walkthrough will assist you in configuring the project on your local environment for seamless development and testing.

Prerequisites

In order to effectively work with this project, it's necessary to install certain software components. Follow these steps:

• Ensure you have Python 3.X installed, with the appropriate version specified in pyproject

  sudo apt install python3.11.4

Nice to have:

• Consider adding an SSH key for seamless connection with GitHub. This small step can greatly enhance your experience by simplifying authentication processes and streamlining your interactions with the platform. Look this tutorial if you want

Installation

1. Clone the repo

   git clone https://github.com/MinervaLMS/backend.git

2. Install poetry

   curl -sSL https://install.python-poetry.org | python3 -

   For a proper installation on your operating system, we recommend following this tutorial
3. Initialize the Poetry environment by navigating to the correct project path and executing the command below:

    poetry shell

   • This installs the default Python version on your computer for the environment. If you prefer to use a different version, you can install that version on your computer and then proceed with the following steps:

     poetry env use 3.11.4

4. Install the required dependencies by running the following command:

   poetry install

5. We recommend configuring the pre-commit functionality within the Poetry environment, especially if you won't be using it in other repositories. However, you also have the option to set it up globally on your PC by installing pre-commit system-wide.

     poetry add -D pre-commit

     pre-commit install

(Back to top)

Contributing

If you want to contribute in this project

1. Clone the Project
2. Create your Feature Branch

   git checkout -b feature/AmazingFeature

3. Commit your Changes

   git commit -m 'Add some Amazing feature'

4. Push to the Branch

   git push origin feature/AmazingFeature

5. Open a Pull Request

(Back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(Back to top)

Contact

• Project Link: https://github.com/MinervaLMS/backend

(Back to top)