Skip to content

Commit

Permalink
Updated Readme.md with build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mmigge authored Feb 27, 2020
1 parent f8efcf6 commit b07b9db
Showing 1 changed file with 7 additions and 63 deletions.
70 changes: 7 additions & 63 deletions client_mobile/README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,12 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Supporting Bike Missions : Visualising air quality information in situ : Client Mobile

## Available Scripts
The Client Stationary corresponds to the application running on the sensorbike. <br> This repository contains all resources needed to use the webserver as well as instructions how they have to be deployed.

In the project directory, you can run:
## Clone and creating a production build
* Clone the Github project with `git clone https://github.com/mmigge/VAQIIS.git` <br>

### `npm start`
* Navigate into the `VAQIIS/client_mobile/` folder and run `npm run build`

Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Using the production build

The page will reload if you make edits.<br />
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

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.

The build is minified and the filenames include the hashes.<br />
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

### Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

### Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

### Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

### Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

### `npm run build` fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
After a successful build, the entire build folder must be moved to the Templates folder of the [VAQIIS Webserver](https://github.com/Thiemann96/VAQIIS_WebServer). These resources are later used by the Flask server running on Raspberry Pi to display data to users.

0 comments on commit b07b9db

Please sign in to comment.