2020-02-19 00:48:30 +01:00
2020-02-25 20:16:26 +01:00
2020-02-12 20:03:51 +01:00
2020-02-12 20:03:51 +01:00
2020-02-12 20:03:51 +01:00
2020-02-25 23:54:15 +01:00
2020-02-25 23:54:15 +01:00
2020-02-25 23:54:15 +01:00
2020-02-25 23:54:15 +01:00

Netlify Status

Requirement list

  • Create React web app
  • It should have fields for giving start date, end date and access token as arguments to the app.
  • App should make HTTP GET request to the API to fetch chat counts between those two given dates.
  • The dashboard should render three values from the API.
  • The dashboard should render a Paginated List.
  • Stores start date, end date and token in localStorage so they are already populated if user comes back to app later time.
  • Static type checking using Typescript.
  • Documentation on how to run and build/install if needed.
  • The application running and accessible somewhere (for example in AWS)

Software used

# Software Reason
1 React Requirement.
2 React Router To route between different components, a react router is used.
3 TypeScript To make use of static types, I made use of TypeScript
4 Bootstrap To structure the front-end, bootstrap is used.
5 Axios To communicate with external API's, I added Axios.
6 FontAwesome To communicate actions to the user, I have added some relatable icons for actions.
7 react-bootstrap-table2-* To get a paginated table, React Bootstrap Table 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.
To deploy this, scroll down to 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.

NOTE: The background used for this software is owned by www.univ-cotedazur.fr. I take no right or ownership to this background, as this piece of software is for personal use only.

Installation

Local

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits, you will also see any lint errors in the console.

yarn build

Builds the app for production to the build folder.
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!

Docker

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), Windows 10 or Mac OSX.
  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
    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.

Netlify

  1. Fork this project to your own GitHub account.
  2. Create an account on Netlify.
  3. Click on New site from Git.
  4. Click on GitHub under Continuous Deploy.
  5. Give Netlify access to your account by accepting the prompt from GitHub.
S
Description
Demo app for an application
Readme 5.2 MiB
Languages
TypeScript 90.9%
HTML 3.9%
CSS 3.6%
Dockerfile 1.6%