Employee_Manager_APP

This is an aplication (API) intended to manage employee's information and reports.

Table of contents

• General info
• Setup

General info

In order to run the program in your local environment, remember to fill in your personal information for the user and password to access the methods implemented in the API. These are related with the environment variables: 'admin_key' and 'password'.

Python version used in this project: Python 3.8.10

The information about the extensions used in python are in the requirements.txt file.

Setup

• cloning repository

  $ git clone https://github.com/CristianoR12/Employee_Manager_APP.git

• Prepare the virtual environment:

  # Linux
  sudo apt-get install python3-venv    # If needed
  Activating: python3 -m venv env
  Activating: source env/bin/activate

• Enter your IDE (e.g. VSCode) - in case it is the VSCode

  python3 -m pip install --upgrade pip
  python3 -m pip install flask

• Install all requirements:

  python3 -m pip install -r requirements.txt

• Fill in the information for the admin_key and password (['admin_key'] and ['password'] with the environment variables)

• Start project (since the required port is the 8000)

  flask run -h localhost -p 8000