diff --git a/README.md b/README.md index 41b7df7..5baaa51 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,25 @@ The purpose of this project is to build a web application that enables subscribing to notifications when new products are published on various ad based marketplaces. The MVP will be only based on OLX.ba -### Setup +## Setup -1. Create postgres docker image +### Setup with npm commands + +1. Run setup script +`npm run setup` +this will create and run postgres image and then execute migrations + +2. Install packages +`npm install` + +3. Run app +`npm start` to run app without restart on changes or +`npm run start-mon` to run app with automatic restart on code change + + +### Manual setup + +1. Create postgres docker image `docker build -t marketalerts .` 2. Run postgres image with