diff --git a/README.md b/README.md index 5197358..665bd95 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,63 @@ - Redis - Nginx +## Getting Stared + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. + +### Prerequisites + +The required technologies are: + +- Node >= version 10 [Download Link](https://nodejs.org/en/download/) +- Docker >= version 18 [Download Link](https://docs.docker.com/install/) +- Yarn [Installation Link](https://yarnpkg.com/lang/en/docs/install/) + +### Installing + +For the **dev environment**, please follow the instruction below + +``` +> make download-redis +> make setup-volume +> make start-redis + +# Separate Terminal +> cd worker +> yarn install +> yarn start + +# Separate Terminal +> cd api +> yarn install +> yarn start + +# Separate Terminal +> cd client +> yarn install +> yarn start +``` + +Now, you can access + +- UI in http://localhost:3000 +- API in http://localhost:5000 +- API Jobs http://localhost:5000/api/jobs/ + +## Deployment + +For the production environment, please follow the instruction below + +``` +> make download-redis +> make setup-volume + +> make run-job-board + +# To Stop the containers +> make stop-job-board +``` + ## Authors - Ajan Lal Shrestha - [AJRedDevil](https://github.com/AJRedDevil) @@ -27,3 +84,7 @@ ## License This project is licensed under the GPL License - see the [LICENSE.md](https://gist.github.com/entry-level-software-jobs/LICENSE.md) file for details + +## Acknowledgments + +- Learnings from this [video](https://www.youtube.com/watch?v=lauywdXKEXI) diff --git a/api/package.json b/api/package.json index 7593301..c4d76a0 100644 --- a/api/package.json +++ b/api/package.json @@ -1,6 +1,6 @@ { "name": "api", - "version": "0.1.0", + "version": "1.0.0", "description": "Express REST API", "main": "index.js", "author": "Ajan Lal Shrestha", diff --git a/client/package.json b/client/package.json index 8e7f12c..41f32a4 100644 --- a/client/package.json +++ b/client/package.json @@ -1,6 +1,6 @@ { "name": "client", - "version": "0.1.0", + "version": "1.0.0", "private": true, "dependencies": { "@material-ui/core": "4.8.0", diff --git a/worker/package.json b/worker/package.json index 1d4d7c4..734fba4 100644 --- a/worker/package.json +++ b/worker/package.json @@ -1,6 +1,6 @@ { "name": "worker", - "version": "0.1.0", + "version": "1.0.0", "description": "Cron worker to fetch data", "main": "index.js", "author": "Ajan Lal Shrestha", @@ -13,4 +13,4 @@ "node-fetch": "2.6.0", "redis": "2.8.0" } -} \ No newline at end of file +}