Skip to content
This repository has been archived by the owner on Jul 19, 2023. It is now read-only.

Commit

Permalink
docs: Update with installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
AjanShrestha committed Dec 24, 2019
1 parent 3a04b14 commit fc69362
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,71 @@
- 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)

## 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)

0 comments on commit fc69362

Please sign in to comment.