Updated README.md

README.md

@@ -1,11 +1,47 @@
-WIP
+# TIQUET 
 
-### How to start the dev server
+Tiquet is an open source project management tool focused on the kanban methodology.
+
+## Instalation
+
+#### Requirements to run this project.
+- **NodeJS** 12.18.3
+- **Python** 3.8.1
+- **PostgreSQL** 11.9
+
+#### How to initialize the project
 
-```
 Initialize server environment, install client and server dependencies.
-bash initialize_dev.sh
 
-Run client & server dev servers.
-bash start_dev.sh
-```
+```
+../project_dir
+
+$ bash initialize_dev.sh
+```
+
+#### How to start the application in development
+
+You can execture the start_dev bash on the project folder to initialize both at the same time.
+
+
+```
+../project_dir
+
+$ bash start_dev.sh
+```
+
+But if you rather to start them independiently.
+
+
+```
+../project_dir/client
+
+$ npm start
+```
+
+```
+../project_dir/server
+
+$ source env/scripts/activate
+$ python run.py
+```

client/README.md

@@ -0,0 +1,17 @@
+## Client
+
+#### Start server
+
+```
+../project_dir/client
+
+$ npm start
+```
+
+#### Build
+
+```
+../project_dir/client
+
+$ npm run bundle
+```

server/README.md

@@ -0,0 +1,27 @@
+## Server
+
+#### Technologies
+- **Python** 3.8.1
+- **PostgreSQL** 11.9
+- **Flask** 1.1.2
+- **SQLAlchemy (ORM)** 1.3.19
+
+#### How to run tests
+
+❗ Make sure you installed all the dependencies and activated the python environment
+
+Tests are made with Pytest library, 
+
+```
+../project_dir/server
+
+$ pytest
+```
+
+#### Start server
+
+```
+../project_dir/server
+
+$ python run.py
+```