Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
grpineiro authored Nov 29, 2021
1 parent 850c895 commit 8924fed
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Educati
An educational game platform for children.

## About this project
We are a development team formed by 5 friends who met at the university, in the Computer Science course. We united with a common goal: to foster education and learning for children and young people, bringing a more dynamic and interesting way to learn through digital games.

Based on this, our main mission is to use this tool to instigate and develop skills such as attention, imagination, concentration and logical reasoning, in addition to stimulating motor skills, also enabling the return of pleasure when acquiring knowledge.

## Installation
### Requirements
- NodeJS
- MongoDB
### How to run
1) Clone this project and enter and enter the backend folder.
2) Create an .env file containing the fields:

~~~env
DB_HOST=
DB_NAME=
TOKEN_KEY=
~~~
4) Fill in the fields with information from your MongoDB database and also a secret key for the token.
5) Run the server using the command "npm run dev" or "yarn dev" inside the backend folder. In the frontend folder type the command "npm run start" or "yarn start".

0 comments on commit 8924fed

Please sign in to comment.