Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/react-flask-authentication
React Flask Authentication - Open-Source Full-stack Project | AppSeed
https://github.com/app-generator/react-flask-authentication
appseed authentication flask react
Last synced: 3 months ago
JSON representation
React Flask Authentication - Open-Source Full-stack Project | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/react-flask-authentication
- Owner: app-generator
- License: other
- Created: 2021-11-11T10:25:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-11T18:34:29.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T04:43:30.622Z (3 months ago)
- Topics: appseed, authentication, flask, react
- Language: Python
- Homepage: https://blog.appseed.us/react-flask-authentication/
- Size: 557 KB
- Stars: 81
- Watchers: 4
- Forks: 29
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - app-generator/react-flask-authentication - React Flask Authentication - Open-Source Full-stack Project | AppSeed (Python)
README
# [React Flask Authentication](https://blog.appseed.us/react-flask-authentication/)
Open-source full-stack seed project that uses a `React UI` powered by a simple `Flask API Server`. **[React Flask Authentication](https://blog.appseed.us/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.
- 👉 [React Flask Authentication](https://react-flask-authentication.appseed-srv1.com/) - LIVE Demo
- 👉 LIVE [Support](https://react-flask-authentication.appseed-srv1.com/) via [Discord](https://discord.gg/fZC6hup) - provided by AppSeed
## ✨ **Start the Flask API** via `Docker`
```bash
$ cd api-server-flask
$ docker-compose up --build # Start with Docker
```
At this point, the API should be up & running at `http://localhost:5000`, and we can test the interface using POSTMAN or `curl`.
## ✨ **Start the React UI** (use another terminal)
> 👉 **Step 1** - Once the project is downloaded, change the directory to `react-ui`.
```bash
$ cd react-ui
```
> 👉 **Step 2** - Install dependencies via NPM or yarn
```bash
$ npm i
// OR
$ yarn
```
> 👉 **Step 3** - Start in development mode
```bash
$ npm run start
// OR
$ yarn start
```
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.
After we register a new user and signIN, all the private pages become accessible.
## ✨ General Information
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**
- be default the server starts on port `5000`
- `Compile and start` the **React UI**
- UI will start on port `3000` and expects a running backend on port `5000`
- `Configuration` (Optional)
- Change the API port
- Configure the API port used by the React UI to communicate with the backend
## ✨ Manual build
> 👉 **Start the Flask API**
```bash
$ cd api-server-flask
$
$ # Create a virtual environment
$ virtualenv env
$ source env/bin/activate
$
$ # Install modules
$ pip install -r requirements.txt
$
$ # Set Up the Environment
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
$
$ # Start the API
$ flask run
```
> 👉 **Compile & start the React UI**
```bash
$ cd react-ui
$
$ # Install Modules
$ yarn
$
$ # Start for development (LIVE Reload)
$ yarn start
```
### Configuration (Optional)
> Change the port exposed by the Flask API
```bash
$ flask run --port 5001
```
Now, the API can be accessed on port `5001`
> Update the API port used by the React Frontend
**API Server URL** - `src/config/constant.js`
```javascript
const config = {
...
API_SERVER: 'http://localhost:5000/api/' // <-- The magic line
};
```
## ✨ API
For a fast set up, this [POSTMAN](https://docs.appseed.us/boilerplate-code/api-server/api-unified-definition) definition can be used.
> **Register** - `api/users/register` (**POST** request)
```
POST api/users/register
Content-Type: application/json
{
"username":"test",
"password":"pass",
"email":"[email protected]"
}
```
> **Login** - `api/users/login` (**POST** request)
```
POST /api/users/login
Content-Type: application/json
{
"password":"pass",
"email":"[email protected]"
}
```
> **Logout** - `api/users/logout` (**POST** request)
```
POST api/users/logout
Content-Type: application/json
authorization: JWT_TOKEN (returned by Login request)
{
"token":"JWT_TOKEN"
}
```
## ✨ Product UI
> React Flask Authentication - Login
> React Flask Authentication - Icons
> React Flask Authentication - Colors
## ✨ Links & Resources
- Ask for [Support](https://appseed.us/support) on [Discord](https://discord.gg/fZC6hup)
- See for [React Starters](https://appseed.us/apps/react) - index provided by AppSeed
---
**[React Flask Authentication](https://blog.appseed.us/react-flask-authentication/)** - Open-source full-stack seed project provided by **[AppSeed](https://appseed.us/)**