Merge pull request #43 from ccr5/develop

New version

README.md

@@ -1,44 +1,36 @@
 # Velh-IA
 
-A New Way To Study, Learn and Have A Fun!
+**Artificial Collective consciousness:** A New Way To Study, Learn and Have A Fun!
 
 ### Summary
-1. Description
-2. The Scientific Research
-3. Project Code
-4. Colaborations
-5. Tools
-6. Usage
-7. Project Status
+1. [Description](https://github.com/ccr5/Velh-IA#description "Description") 
+2. [The Scientific Research](https://github.com/ccr5/Velh-IA#the-scientific-research "The Scientific Research")
+3. [Project Code](https://github.com/ccr5/Velh-IA#project-code "Project Code")
+4. [Colaborations](https://github.com/ccr5/Velh-IA#colaborations "Colaborations")
+5. [Contact](https://github.com/ccr5/Velh-IA#contact "Contact")
+6. [Project Status](https://github.com/ccr5/Velh-IA#project-status "Project Status")
 
 ------------
 ### Description
 This project is the environment of a scientific research called **Artificial Collective consciousness - Analysis of the Interactions between Artificial Intelligences**. 
 
 
 ### The Scientific Research 
-The goal is analyze the interactions, behaviors and results of a multi-agent system with no objective, under an uncontrolled and unknown environment, applying sociological concepts.
-
-
-It's divided in two points: 
-1. Velh-IA: It's our reasearch environment. A tic-tac-toe game with two players: Statistical Algorithm and Multi-Agente System. It will be avaliable on website and mobile app to everybody watch.
-2. Research: The article with all informations and results about what we get in Velh-IA
-
-
-You can understand how it will works [here](https://drive.google.com/file/d/1UKPZ7I5N6bp6ra51rSCFFoxtNL2clJYr/view?usp=sharing "here")
+My goal is analyze the interactions, behaviors and results of a multi-agent system with no objective, under an uncontrolled and unknown environment, applying sociological concepts.
 
+You can understand how it will works [here](https://drive.google.com/file/d/1kfG_7y3gSgmeZTSw1VOTtShz2CIvH2Fa/view?usp=sharing "here") or watching the videos on [Youtube](https://www.youtube.com/channel/UCNBSO8r0BwMNQUaNy2UQN1g "Youtube")
 
 Copyright 2020 - Matheus Nobre Gomes
 
 License: [GNU General Public License v3.0 ](https://www.gnu.org/licenses/gpl-3.0.pt-br.html "GNU General Public License v3.0 ")
 
 ### Project Code
-It has three microservice:
-* velhia.api: Express project with all routes to save or get data. Use MongoDB
-* velhia.game: Scripts, game control and all logic of this research.
-* velhia.web: React website to tell about this project, follow the game and see analysis.
+This project has three microservices:
+* [velhia.api](https://github.com/ccr5/Velh-IA/tree/master/velhia.api#velh-ia-api "velhia.api"): Express project with all routes to save and get data.
+* [velhia.game](https://github.com/ccr5/Velh-IA/tree/master/velhia.game#velh-ia-game "velhia.game"): Scripts, game workflow and all logic of this research.
+* [velhia.web](https://github.com/ccr5/Velh-IA/tree/master/velhia.web#velh-ia-website "velhia.web"): React website to show infos and results about this project. You can follow the game and see all analysis.
 
-Each microservice has a readme document to explain how its works.
+Each microservice has a readme document to explain better.
 
 ### Colaborations
 I'm inviting you to help me in this project on Github and watch the development:
@@ -48,11 +40,14 @@ I'm inviting you to help me in this project on Github and watch the development:
 ### Contact
 To more informations:
 
+Phone: (55) 11 99566-0126
 E-mail: matt-gomes@live.com
 
 LinkedIn: https://www.linkedin.com/in/mattnobre/
 
 ------------
 ### Project Status
 
+**Launch:** Configuration of server and services for making the website available on the internet.
+
 **Velhia App:** View on my smartphone the starting field, the current game and the most interesting information relevant to the players and the possible analysis of the research in addition to informing the purpose

velhia.api/README.md

@@ -1,17 +1,17 @@
 # Velh-IA API
 
-Where all data is saved
+Where all data is managed
 
 ### Sumary
-1. Description
-2. Structure
-3. Language and tools
-4. Requirements
-5. Usage
+1. [Description](https://github.com/ccr5/Velh-IA/tree/master/velhia.api#description "Description")
+2. [Structure](https://github.com/ccr5/Velh-IA/tree/master/velhia.api#structure "Structure")
+3. [Language and tools](https://github.com/ccr5/Velh-IA/tree/master/velhia.api#langauge-and-tools "Language and tools")
+4. [Requirements](https://github.com/ccr5/Velh-IA/tree/master/velhia.api#requirements "Requirements")
+5. [Usage](https://github.com/ccr5/Velh-IA/tree/master/velhia.api#usage "Usage")
 
 ------------
 ### Description
-This is a microservice to provide a web app to save and get data to show or make analysis.
+This is a microservice to provide a RESTFul API to save and get data to show or make analysis.
 
 ### Structure
 * tests: all project's test
@@ -39,4 +39,5 @@ This is a microservice to provide a web app to save and get data to show or make
 ### Usage
 1. run cd velhia.api
 2. run yarn
+3. Change environment variables
 3. run yarn serve 

velhia.game/README.md

@@ -0,0 +1,41 @@
+# Velh-IA GAME
+
+Where all data is managed
+
+### Sumary
+1. [Description](https://github.com/ccr5/Velh-IA/tree/master/velhia.game#description "Description")
+2. [Structure](https://github.com/ccr5/Velh-IA/tree/master/velhia.game#structure "Structure")
+3. [Language and tools](https://github.com/ccr5/Velh-IA/tree/master/velhia.game#langauge-and-tools "Language and tools")
+4. [Requirements](https://github.com/ccr5/Velh-IA/tree/master/velhia.game#requirements "Requirements")
+5. [Usage](https://github.com/ccr5/Velh-IA/tree/master/velhia.game#usage "Usage")
+
+------------
+### Description
+This is a microservice where all magic happens. All scripts, function and flow to simulate the research environment are here. 
+
+### Structure
+* classes: All used class to organize the project
+* config: all project configuration (Ex: Database Connection, Routes)
+* errors: All used custom exceptions 
+* handlers: Used functions to manage the project
+* logs: log files
+* tests: all project's test
+* validations: All functions to validate the project status 
+
+### Language and Tools
+1. Pandas
+2. Numpy
+3. Pytest
+4. Python
+
+### Requirements
+1. Velh-IA API
+2. Python
+3. Virtualenv
+
+### Usage
+1. run cd velhia.game
+2. run virtualenv venv
+3. run pip install -r requirements.txt
+3. Change environment variables
+3. run python main.py

velhia.web/README.md

@@ -3,11 +3,11 @@
 Where all data is showed
 
 ### Sumary
-1. Description
-2. Structure
-3. Language and tools
-4. Requirements
-5. Usage
+1. [Description](https://github.com/ccr5/Velh-IA/tree/master/velhia.web#description "Description")
+2. [Structure](https://github.com/ccr5/Velh-IA/tree/master/velhia.web#structure "Structure")
+3. [Language and tools](https://github.com/ccr5/Velh-IA/tree/master/velhia.web#langauge-and-tools "Language and tools")
+4. [Requirements](https://github.com/ccr5/Velh-IA/tree/master/velhia.web#requirements "Requirements")
+5. [Usage](https://github.com/ccr5/Velh-IA/tree/master/velhia.web#usage "Usage")
 
 ------------
 ### Description
@@ -17,16 +17,17 @@ This is a microservice to provide a web page to tell about Velh-IA and show what
 It uses create-react-app template. click [Here](https://create-react-app.dev/docs/getting-started/ "Here") to see more details
 
 ### Language and Tools
-1. Javascript
+1. Typescript
 2. NodeJS
 3. ReactJS
+4. Jest
 
 ### Requirements
 1. Velh-IA API
-2. Npm
+2. Yarn
 3. NodeJS
 
 ### Usage
 1. run cd velhia.web
-2. run npm install
-3. run npm start
+2. run yarn
+3. run yarn start