Skip to content

Commit e3e9edb

Browse files
authored
Merge pull request #3 from flatlogic/updated_readme
Updated readme
2 parents 1e562e4 + 884b641 commit e3e9edb

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

README.md

+30-19
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,41 @@ We have implemented some basic pages, so you can see our template in action.
3737
* Login
3838
* Error page
3939

40-
## Instalation
40+
## Quick Start
4141

42-
1. Clone repository
43-
```shell
44-
git clone https://github.com/flatlogic/one-react-template
45-
```
46-
2. Get in the project folder
47-
```shell
48-
cd one-react-template
49-
```
50-
3. Install dependencies via npm or yarn
51-
```shell
52-
npm install
53-
```
54-
```shell
55-
yarn
56-
```
42+
#### 1. Get the latest version
43+
44+
You can start by cloning the latest version of One React on your
45+
local machine by running:
5746

58-
## Quick start
59-
Run development server
6047
```shell
61-
yarn run serve
48+
$ git clone https://github.com/flatlogic/one-react.git
6249
```
6350

51+
#### 2. Run `yarn install`
52+
53+
This will install both run-time project dependencies and developer tools listed
54+
in [package.json](package.json) file.
55+
56+
#### 3. Run `yarn start`
57+
58+
Runs the app in the development mode.
59+
60+
Open http://localhost:3000 to view it in the browser. Whenever you modify any of the source files inside the `/src` folder,
61+
the module bundler ([Webpack](http://webpack.github.io/)) will recompile the
62+
app on the fly and refresh all the connected browsers.
63+
64+
#### 3.1 Run `yarn start:backend`
65+
Runs the app in the development mode with node-backend
66+
67+
#### 4. Run `yarn build`
68+
69+
Builds the app for production to the build folder.
70+
It correctly bundles React in production mode and optimizes the build for the best performance.
71+
72+
The build is minified and the filenames include the hashes.
73+
Your app is ready to be deployed!
74+
6475
## Support
6576
For any additional information please refer to [Flatlogic homepage](https://flatlogic.com).
6677

0 commit comments

Comments
 (0)