Skip to content

Commit 634db72

Browse files
committed
README - update DOCS
1 parent 33e27b8 commit 634db72

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,43 @@ Open-source full-stack seed project that uses a `React UI` powered by a simple `
77

88
<br />
99

10-
## Quick-start in Docker
11-
12-
> Clone/Download the source code
10+
### **Start the Flask API** via `Docker`
1311

1412
```bash
15-
$ git clone https://github.com/app-generator/react-flask-authentication.git
13+
$ cd api-server-flask
14+
$ docker-compose up --build # Start with Docker
1615
```
1716

17+
At this point, the API should be up & running at `http://localhost:5000`, and we can test the interface using POSTMAN or `curl`.
18+
1819
<br />
1920

20-
> **Start the Flask API**
21+
### **Start the React UI** (use another terminal)
22+
23+
> **Step 1** - Once the project is downloaded, change the directory to `react-ui`.
2124
2225
```bash
23-
$ cd flask-api
24-
$ docker-compose pull # download dependencies
25-
$ docker-compose build # local set up
26-
$ docker-compose up # start the app
26+
$ cd react-ui
2727
```
2828

29-
At this point, the API should be up & running at `http://localhost:5000`, and we can test the interface using POSTMAN or `curl`.
29+
<br >
30+
31+
> **Step 2** - Install dependencies via NPM or yarn
32+
33+
```bash
34+
$ npm i
35+
// OR
36+
$ yarn
37+
```
3038

3139
<br />
3240

33-
> **Start the React UI** (use another terminal)
41+
> **Step 3** - Start in development mode
3442
3543
```bash
36-
$ cd react-ui
37-
$ docker-compose pull # download dependencies
38-
$ docker-compose build # local set up
39-
$ docker-compose up # start the app
44+
$ npm run start
45+
// OR
46+
$ yarn start
4047
```
4148

4249
Once all the above commands are executed, the `React UI` should be visible in the browser. By default, the app redirects the guest users to authenticate.
@@ -67,7 +74,7 @@ The product is built using a `two-tier` pattern where the React frontend is deco
6774
### Start the Flask API
6875

6976
```bash
70-
$ cd flask-api
77+
$ cd api-server-flask
7178
$
7279
$ # Create a virtual environment
7380
$ virtualenv env

0 commit comments

Comments
 (0)