AliIbrahim996/footballClub

Football players management application

Table of Contents

1. Requirements
2. Getting-start
3. Contact

Requirements

1. Python 3.8

2. Doxygen 1.9

3. Pycharm( recomended )

Getting-start

This is the instruction you need to build and use the project.

1. Clone the repo

  git clone https://gitlab.scase.local/ali.ibrahim.2/football_club.git
  cd football_club

2. Run install_dependencies.bat in order to create and install all the requried environment application needed in the projct or use cmd in the project directory and write these instructions

   python -m venv venv
  venv\Scripts\activate.bat && python -m pip install -r requirements.txt && python manage.py migrate && python manage.py seed --mode=refresh

these instructions are decrpiped as follow:
    1) venv\Scripts\activate.bat: used to activate environment
    2) python -m pip install -r requirements.txt: used to install all the required apps from requirement.txt file
    3) python manage.py migrate to migrate all models to the databse.
    4) manage.py seed --mode=refresh it is a command that we use to refresh the database and clear all the previous data.

3. Run runserver.bat to Run the application or use cmd in the project directory and write this line

   venv\Scripts\activate.bat && python manage.py runserver

4. Run make_docs.bat to generate html documentation file or open cmd in the project directory and write

    mkdir docs
    cd docs
    mkdir player
    mkdir app
    cd ..
    doxygen config_player_doxy
    doxygen config_app_doxy

Contact

Ali Ibrahim - eng.aliibrahim.96@outlook.com ©