jjvijgen/Demo-App
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Jeroen Vijgen
2020-02-25 23:56:54 +01:00
parent 17b85fafd7
commit 02abca6f4f
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -5
View File
@@ -7,10 +7,11 @@
- [X] App should make HTTP GET request to the API to fetch chat counts between those two given dates. - [X] App should make HTTP GET request to the API to fetch chat counts between those two given dates.
- [X] The dashboard should render three values from the API. - [X] The dashboard should render three values from the API.
- [X] The dashboard should render a Paginated List. - [X] The dashboard should render a Paginated List.
- [X] Stores start date, end date and token in localStorage so they are already populated if user comes back to app later time. - [X] Stores `start date`, `end date` and `token` in localStorage so they are already populated if user comes back to app later time.
- [X] Static type checking using Typescript. - [X] Static type checking using Typescript.
- [X] Documentation on how to run and build/install if needed. - [X] Documentation on how to run and build/install if needed.
- [X] The application running and accessible somewhere (for example in AWS) - [X] The application running and accessible somewhere (for example in AWS)
- [ ] Virtualisation of existing data.
## Software used ## Software used
@@ -25,7 +26,7 @@
7 | react-bootstrap-table2-* | To get a paginated table, React Bootstrap Table is used. | 7 | react-bootstrap-table2-* | To get a paginated table, React Bootstrap Table is used. |
8 | Yarn | To manage dependencies, yarn is used. | 8 | Yarn | To manage dependencies, yarn is used. |
9 | Docker | To run the software containerized in a bigger infrastructure, I have introduced a Dockerfile. <br> To deploy this, scroll down to [Docker](#Docker) and follow these steps. | 9 | Docker | To run the software containerized in a bigger infrastructure, I have introduced a Dockerfile. <br> To deploy this, scroll down to [Docker](#Docker) and follow these steps. |
10 | Netlify | To host the SPA, I made use of Netlify so people have easy access to the demo subject. | 10 | Netlify | To host the SPA, I made use of Netlify so people have easy access to the demo subject. <br> To host a copy of the SPA, I have included directions on how to under [Netlify](#Netlify) |
**NOTE**: The background used for this software is owned by www.univ-cotedazur.fr. **NOTE**: The background used for this software is owned by www.univ-cotedazur.fr.
@@ -51,13 +52,13 @@ The page will reload if you make edits, you will also see any lint errors in the
Builds the app for production to the `build` folder.<br /> Builds the app for production to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance. It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes. Your app is ready to be deployed by copying these files to a hosting! The build is minified and the filenames include the hashes. Your app is ready to be deployed by copying the `/build` folder to a hosting!
### Docker ### Docker
To deploy this app on a Docker enabled system, you can follow the following steps: To deploy this app on a Docker enabled system, you can follow the following steps:
1. Make sure docker is enabled on your system. To install Docker on a few different machines, you can click on: [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/). 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` 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` 3. Build the image to use later: `docker build . -t _jv_dashboard`
4. Start the image with the command: `docker run _jv_dashboard` 4. Start the image with the command: `docker run _jv_dashboard`
@@ -71,4 +72,8 @@ To deploy this app on a Docker enabled system, you can follow the following step
3. Click on `New site from Git`. 3. Click on `New site from Git`.
4. Click on `GitHub` under `Continuous Deploy`. 4. Click on `GitHub` under `Continuous Deploy`.
5. Give Netlify access to your account by accepting the prompt from GitHub. 5. Give Netlify access to your account by accepting the prompt from GitHub.
6. 6. You can now search the repositories you would like deployed. We would like to use `Demo-App`.
7. Set your build options now, and press finish.
You should now be redirected to the dashboard for the Demo-App, your app is now deploying. Here you can find the unique URL where the demo project is hosted, it has the following setup: `https://upbeat-agnesi-aad3fb.netlify.com`.