Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
App Generator committed Nov 12, 2021
2 parents 0eaca55 + ab23ce8 commit 1f3e246
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# React Flask Authentication

Open-source full-stack seed project that uses a React UI powered by a simple Flask API Server. **React Flask Authentication** sample can be used to bootstrap fast a new project using a tested `development-ready` stack or simply for eLearning purposes by beginners. For newcomers, **React** is a popular Javascript library for coding user interfaces baked by Facebook and Flask is a leading web framework written in Python.
Open-source full-stack seed project that uses a **React UI** powered by a simple **Flask API Server**. **React Flask Authentication** sample can be used to bootstrap fast a new project using a tested `development-ready` stack or simply for eLearning purposes by beginners. For newcomers, **React** is a popular Javascript library for coding user interfaces baked by Facebook and Flask is a leading web framework written in Python.

> Links
Expand All @@ -17,11 +17,11 @@ Open-source full-stack seed project that uses a React UI powered by a simple Fla

The product is built using a `two-tier` pattern where the React frontend is decoupled logically and physically from the API backend. In order to use the product in a local environment, a few simple steps are required:

- Compile and start the Flask API Backend
- `Compile and start` the **Flask API Backend**
- be default the server starts on port `5000`
- Compile and start the React UI
- `Compile and start` the **React UI**
- UI will start on port `3000` and expects a running backend on port `5000`
- Configuration (Optional)
- `Configuration` (Optional)
- Change the API port
- Configure the API port used by the React UI to communicate with the backend

Expand Down Expand Up @@ -58,7 +58,7 @@ At this point, the API should be up & running at `http://localhost:5000`, and we
$ cd react-ui
$ docker-compose pull # download dependencies
$ docker-compose build # local set up
$ docker-compose up -d # start the app
$ docker-compose up # start the app
```

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.
Expand Down Expand Up @@ -88,7 +88,7 @@ $ # Start the API
$ flask run
```

---
<br />

### Compile & start the React UI

Expand Down Expand Up @@ -176,6 +176,26 @@ authorization: JWT_TOKEN (returned by Login request)

<br />

## Product UI

> React Flask Authentication - Login
![React Flask Authentication - Login.](https://user-images.githubusercontent.com/51070104/141444378-763ca3fb-c18c-4558-9730-b42a341a7b22.jpg)

<br />

> React Flask Authentication - Icons
![React Flask Authentication - Icons.](https://user-images.githubusercontent.com/51070104/141444472-8c966396-69dc-46c3-835e-b64329fdbf7d.jpg)

<br />

> React Flask Authentication - Colors
![React Flask Authentication - Colors.](https://user-images.githubusercontent.com/51070104/141444532-46a3bcd0-841b-4725-aa82-122569cd678a.jpg)

<br />

## Links & Resources

- Ask for [Support](https://appseed.us/support) on [Discord](https://discord.gg/fZC6hup)
Expand All @@ -184,4 +204,4 @@ authorization: JWT_TOKEN (returned by Login request)
<br />

---
React Flask Authentication - Open-source full-stack seed project provided by **AppSeed [App Generator](https://appseed.us/)**
**React Flask Authentication** - Open-source full-stack seed project provided by **AppSeed [App Generator](https://appseed.us/)**

0 comments on commit 1f3e246

Please sign in to comment.