koiic / project-tracker

check api endpoint documentation: https://flask-project-tracker.herokuapp.com/api/v1/swagger.json

Project Tracker

This is a project and task management tool built with flask and postgresql .

Description

The Project Tracker application keeps tracks of users tasks based on priority/ and also gives the manager the ability to assign task.

Key Application features

1. Manage Projects
2. Manage Task
3. Assign User to projects and tasks

Technology Used

• Python(Flask)
• Postgresql
• Docker
• SQLALCHEMY
• MARSHMALLOW

Implementation Details

1.ENDPOINTS

- creating a new project (POST)
    - url : https://flask-project-tracker.herokuapp.com/api/v1/projects
    - example request data  
        - `{
            "title":"user management pipeline",
             "description": "user authentication",
             "due_date": "2020-07-23 00:00:00",
              "assignees": [1,2] -> user Id 
         }`
       
- creating a new task (POST)
  - url : https://flask-project-tracker.herokuapp.com/api/v1/tasks
    - example request data 
        - `{
            "title":"create a new authenticate user",
             "description": "user authentication",
             "due_date": "2020-07-23 00:00:00",
             "projectId": 1
              "assignees": []
         }`
         
 - update task (PATCH)
  - url : https://flask-project-tracker.herokuapp.com/api/v1/tasks/{task_id}
    - example request data 
        - `{
            "title":"update title"
         }`
         
- update project (PATCH)
    - url : https://flask-project-tracker.herokuapp.com/api/v1/projects/{project_id}
        - example request data 
            - `{
                "title":"update project"
             }`
             
 - register user (POST)
  - url : https://flask-project-tracker.herokuapp.com/api/v1/auth/register
    - example request data 
        - `{
            "name":"test user",
             "email": "[email protected]",
              "password":"test"
         }`

- authenticate user (login) (POST)
  - url : https://flask-project-tracker.herokuapp.com/api/v1/auth/login
    - example request data 
        - `{
             "email": "[email protected]",
              "password":"test"
         }`
         
 - get all projects (GET)
    - url : https://flask-project-tracker.herokuapp.com/api/v1/projects
    
- get single projects (GET)
    - url : https://flask-project-tracker.herokuapp.com/api/v1/projects/{project_id}
    
 - get all tasks (GET)
    - url : https://flask-project-tracker.herokuapp.com/api/v1/tasks
    
- get single tasks (GET)
    - url : https://flask-project-tracker.herokuapp.com/api/v1/tasks/{task_id}

Development set up

##### BACKEND SET UP
 -   Clone the favorite-things repo and cd into it:
        git clone https://github.com/koiic/project-tracker.git
    
-   CD into the project-tracker folder 

-   Create a .env file using the sample from .env.sample

-   Check that python 3 is installed:

    -> python --version
        . Python 3.7

-   Install pipenv:

    ```
    brew install pipenv
    ```

-   Check pipenv is installed:

    -> pipenv --version`
        . pipenv, version 2018.6.25
    
-   Check that postgres is installed:


    -> postgres --version
       .  postgres (PostgreSQL) 12.2


-  create virtual environment and  Install dependencies:

    -> pipenv shell
    -> pipenv install



-   Make a copy of the .env.sample file  and rename it to .env and update the variables accordingly:

    FLASK_ENV = "development" # Takes either development, production, testing
    DATABASE_URI = "postgres://YOUR_DB_USER:YOUR_DB_PASSWORD@YOUR_HOST/YOUR_DATABASE_NAME" # Development and production mySql db uri
    TEST_DATABASE_URI = "mysql+pymsql://YOUR_DB_USER:YOUR_DB_PASSWORD@YOUR_HOST/YOUR_TEST_DATABASE_NAME" # Testing mySql db uri
    JWT_SECRET_KEY_STAGING = "" # your prefered secret key
    API_BASE_URL_V1 = "" # The base url for V1 of the API
    

-   initiliaze db and Apply migrations:

    -> flask db init or python manage.py db init
    
    -> flask db upgrade or python manage.py db upgrade
    
    -> flask db migrate or python manage.py db migrate



-   Run the application with either commands:

    -> python manage.py runserver 
    or
    -> flask run


-   Deactivate the virtual environment once you're done:
        -> exit

Set Up Development With Docker

1. Download Docker from here
2. Set up an account on Docker
3. Install Docker after download
4. Go to your terminal run the command docker login
5. Input your Docker email and password

To setup for development with Docker after cloning the repository please do/run the following commands in the order stated below:

• cd <project dir> to check into the dir
• docker-compose build to build the application images
• docker-compose up -d to start the api after the previous command is successful

The docker-compose build command builds the docker image where the api and its postgres database would be situated. Also this command does the necessary setup that is needed for the API to connect to the database.

The docker-compose up -d command starts the application while ensuring that the postgres database is seeded before the api starts.

To stop the running containers run the command docker-compose down

Step taken to autolint code

For the server side I made use of PYLINT:
    this is a linting tool for python that help me follow the python style guide