Mantis

Management Web Application with Dynamic Functionality

Requirements (Prerequisites)

Tools and packages required to successfully install this project. For example:

• Python 3.8 and up
• pip
• pipenv

Installation

A step by step list of commands / guide that informs how to install an instance of this project.

    pipenv shell
    pipenv sync

Create and source the .env files

See included in the repo the .env sample file to create your .env file with all secret keys required :

    cd mantisapi
    source .env
    export DJANGO_SETTINGS_MODULE=mantisapi.settings.dev

Run the server

To start the django server run the following command:

    python manage.py runserver

Features

Here are the features of this project.

• Django admin dashboard configured
• Web application with dynamic functionality
• Etc Etc......

Preparing to make a pull request

When making a pull request, please make sure to include the following:

• A detailed description of the changes you are making
• A test-plan for the changes
• Run the pre-commit hook to ensure that the changes are valid
• Run the tests to ensure that the changes are working as expected
• Commit the changes
• Push the changes to the remote repository

How to run pre-commit hook

To run the pre-commit hook, run the following command:

    pre-commit install
    pre-commit run --all-files

Deployment Notes

Coming soon.

Authors

The Glencoe Software Canada Team:

Dami Adesola -> Project Manager

Milo GoodFellow -> Software Developer

Eric Scholtz -> Software Developer

Alex Hemphill -> Software Developer

Calvin Foote -> Software Developer

License

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This project is licensed under the GPL License - see the LICENSE.md file for details

Mantis © Glencoe Software