diff --git a/README.md b/README.md index 98060b3..f83743f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ [![Netlify Status](https://api.netlify.com/api/v1/badges/9527e4dc-1bb2-40ef-b6eb-8515b91579bf/deploy-status)](https://upbeat-agnesi-aad3fb.netlify.com/) -## Requirement list +# Table of Contents + +1. [Requirements](#Requirements) +2. [Software Used](#Software-used) +3. [Installation](#Installation) + 1. [Local](#Local) + 2. [Docker](#Docker) + 3. [Netlify](#Netlify) + +## Requirements - [X] Create React web app - [X] It should have fields for giving start date, end date and access token as arguments to the app. @@ -60,10 +69,11 @@ To deploy this app on a Docker enabled system, you can follow the following step 1. Make sure docker is enabled on your system. To install Docker on your machine, you can use the following guides: [Linux Machine (Ubuntu)](https://www.linux.com/tutorials/how-install-and-use-docker-linux/), [Windows 10](https://www.how2shout.com/how-to/how-to-install-docker-on-windows-10.html) or [Mac OSX](https://docs.docker.com/docker-for-mac/install/). 2. Clone this repository with `git clone git@github.com:BlackChaosNL/Demo-App.git` -3. Build the image to use later: `docker build . -t _jv_dashboard` -4. Start the image with the command: `docker run _jv_dashboard` +3. Navigate to this folder, and open up a bash terminal, or windows powershell. +4. Build the image to use later: `docker build . -t _jv_dashboard` +5. Start the image with the command: `docker run -d _jv_dashboard` 1. To change the default port `:80`, to a custom one, you can add `-p 3000:80` after the previous command. -5. The application should now be hosted on `localhost:$PORT`. Where the `$PORT` is either `:80` or the custom port given by you. +6. The application should now be hosted on `localhost:$PORT`. Where the `$PORT` is either `:80` or the custom port given by you. ### Netlify