From 8924fed089f89a37a3e1be03649141161fa25c2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20Pi=C3=B1eiro?= Date: Mon, 29 Nov 2021 15:22:11 -0300 Subject: [PATCH] Create README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c81f05d --- /dev/null +++ b/README.md @@ -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".