Refactor setup

Author: EliuX

.gitignore

@@ -16,4 +16,7 @@ __pycache__/
 .idea
 
 # virtual environments
-.venv
+.venv
+
+# Files generated for development
+.env

README.md

@@ -1,12 +1,39 @@
 # time-tracker-api
 
-## Set new environment in Windows
-- `mkdir .venv`
-- `python -m venv .venv`
-- `.venv\Scripts\activate.bat`
-- `pip install -r requirements/prod.txt`
-
-## Example usage in Windows
-- `export FLASK_APP=time_tracker_api` or `set FLASK_APP=time_tracker_api`
-- `flask run`
+## Setup
+
+- Create and activate the environment,
+    
+    In Windows:
+    
+    ``` 
+    python -m venv .venv
+    .venv\Scripts\activate.bat
+    ```
+        
+    In Unix based operative systems: 
+    ```
+    virtualenv .venv
+    source .venv/bin/activate
+    ```
+- Install the requirements:
+    ```
+    python3 -m pip install -r requirements/prod.txt
+    ```
+    Remember to do it with Python 3.
+
+## How to use it
+- Set the env var `FLASK_APP` to `time_tracker_api` and start the app:
+
+    In Windows
+    ```
+    set FLASK_APP=time_tracker_api
+    flask run
+    ```
+    In Unix based operative systems: 
+    ```
+    export FLASK_APP=time_tracker_api
+    flask run
+    ```
+
 - Open `http://127.0.0.1:5000/` in a browser

requirements/prod.txt

@@ -2,6 +2,4 @@ Flask==1.1.1
 flask-restplus==0.13.0
 flake8==3.7.9
 Werkzeug==0.16.1
-wrapt==1.11.2
-zipp==3.1.0
 gunicorn==20.0.4

run.py

@@ -5,4 +5,4 @@
 from time_tracker_api import create_app
 
 app = create_app()
-print("BPM Projects API server was created")
+print("BPM Projects API server was created")

time_tracker_api/errors.py

@@ -16,4 +16,4 @@ class InvalidMatch(Exception):
     """
     Errors related to an invalid match during a search
     """
-    pass
+    pass

time_tracker_api/projects/projects_model.py

@@ -77,4 +77,4 @@ def matches_search_string(search_str, project):
 
 # Instances
 # TODO Create an strategy to create other types of DAO
-project_dao = InMemoryProjectDAO()
+project_dao = InMemoryProjectDAO()