Project Documentation

Welcome to the project documentation repository! This repository contains all the necessary documentation to understand the scope, objectives, and development process of the project.

---

Getting Started

1. Set up a Python virtual environment:

   python -m venv venv
   

2. Activate the virtual environment:

   • On Windows: bash

     venv\Scripts\activate
     

   • On macOS/Linux: bash

     source venv/bin/activate
     

3. Install dependencies: bash

   pip install -r requirements.txt
   

4. Preview the documentation locally: bash

   mkdocs serve
   

5. Publish the documentation to GitHub Pages: bash

   mkdocs gh-deploy
   

---

Documentation Structure

• docs/ : Contains the Markdown files for the documentation.
• docs-setup/ : Contains guides for setting up and configuring MkDocs.
• venv/ : Python virtual environment (ignored by .gitignore).

---

Figma Mock up

To view the figma mock up. https://www.figma.com/design/mekw4aX7PdemxaueDHPllO/Egalitarian-Project?node-id=1-2&t=eApYyPvfMsNYNdKK-1

---

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0) . For more details, see the LICENSE file.

---

Contributing

If you would like to contribute, please read the contribution guide.

---

Support

For questions or issues, please open an issue in the GitHub repository.