Skip to content

Commit

Permalink
Merge pull request #3 from flatlogic/updated_readme
Browse files Browse the repository at this point in the history
Updated readme
  • Loading branch information
Blari authored Nov 29, 2024
2 parents 1e562e4 + 884b641 commit e3e9edb
Showing 1 changed file with 30 additions and 19 deletions.
49 changes: 30 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,30 +37,41 @@ We have implemented some basic pages, so you can see our template in action.
* Login
* Error page

## Instalation
## Quick Start

1. Clone repository
```shell
git clone https://github.com/flatlogic/one-react-template
```
2. Get in the project folder
```shell
cd one-react-template
```
3. Install dependencies via npm or yarn
```shell
npm install
```
```shell
yarn
```
#### 1. Get the latest version

You can start by cloning the latest version of One React on your
local machine by running:

## Quick start
Run development server
```shell
yarn run serve
$ git clone https://github.com/flatlogic/one-react.git
```

#### 2. Run `yarn install`

This will install both run-time project dependencies and developer tools listed
in [package.json](package.json) file.

#### 3. Run `yarn start`

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser. Whenever you modify any of the source files inside the `/src` folder,
the module bundler ([Webpack](http://webpack.github.io/)) will recompile the
app on the fly and refresh all the connected browsers.

#### 3.1 Run `yarn start:backend`
Runs the app in the development mode with node-backend

#### 4. Run `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!

## Support
For any additional information please refer to [Flatlogic homepage](https://flatlogic.com).

Expand Down

0 comments on commit e3e9edb

Please sign in to comment.