From 5b3836b2cb9fc578542ddb5e58187ffb2917333f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Geonizeli?= Date: Sun, 10 Jul 2022 19:01:20 -0300 Subject: [PATCH] add setup instructions --- README.md | 4 +++- client/README.md | 7 +++++-- server/README.md | 10 ++++++++++ 3 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 server/README.md diff --git a/README.md b/README.md index a0957d2..c0e192b 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ -# todo-list \ No newline at end of file +# Setup + +Please, check client/README.md and server/README.md for instructions \ No newline at end of file diff --git a/client/README.md b/client/README.md index b58e0af..d26ba76 100644 --- a/client/README.md +++ b/client/README.md @@ -1,6 +1,9 @@ -# Getting Started with Create React App +## Requirements +- Node.js >= 16 +- npm or yarn -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +## Setup +- Download dependencies with `yarn install` ## Available Scripts diff --git a/server/README.md b/server/README.md new file mode 100644 index 0000000..c836b45 --- /dev/null +++ b/server/README.md @@ -0,0 +1,10 @@ +## Requirements +- Docker and docker-compose +- Node.js >= 16 +- npm or yarn + +## Setup commands +- Start postgres and redis with `docker-compose up` +- Download dependencies with `yarn install` +- Build build the project with `yarn build` +- Start the project with `yarn start`