Skip to content

Commit

Permalink
Updated client README
Browse files Browse the repository at this point in the history
  • Loading branch information
rennemannd committed May 17, 2020
1 parent 0b0ee90 commit e8a65d4
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 51 deletions.
69 changes: 19 additions & 50 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,37 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Client

[React.js](https://reactjs.org/) application which represents the entire browserside client. Filestructure is standard for a [create-react-app](https://github.com/facebook/create-react-app) application with some minor changes. Any component which represents an entire page is categorized under the [views](/src/views) folder.

<br />

## Setup

The only setup required is running `yarn` to install project dependencies

<br />

## Available Scripts

In the project directory, you can run:

### `yarn start`

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

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

### `yarn test`
### `yarn start-build`

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.
Stars a basic http server (using [http-server](https://www.npmjs.com/package/http-server)) which serves the build folder on [http://localhost:3000](http://localhost:3000) .

### `yarn build`

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

### `yarn 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
<br />

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

### `yarn build` fails to minify
Section on fixing issue where yarn build does not minify: https://facebook.github.io/create-react-app/docs/troubleshooting#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
Section on code splitting, worth considering at some point: https://facebook.github.io/create-react-app/docs/code-splitting
2 changes: 1 addition & 1 deletion client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"start-build": "http-server build -p 3000",
"build": "react-scripts build",
"eject": "react-scripts eject"
},
"eslintConfig": {
Expand Down

0 comments on commit e8a65d4

Please sign in to comment.