https://github.com/shayanriyaz/flask-react-boiler-plate
A collection of shell files to make a flask/react boiler plate
https://github.com/shayanriyaz/flask-react-boiler-plate
Last synced: about 2 months ago
JSON representation
A collection of shell files to make a flask/react boiler plate
- Host: GitHub
- URL: https://github.com/shayanriyaz/flask-react-boiler-plate
- Owner: ShayanRiyaz
- License: mit
- Created: 2020-11-28T20:37:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-29T05:30:10.000Z (over 4 years ago)
- Last Synced: 2025-02-09T19:57:13.311Z (3 months ago)
- Language: Shell
- Size: 12.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flask-react-boiler-plate
A collection of shell files to make a flask/react boiler plate
## Steps
### 1. ```init.sh``` for basic flask-react boiler plate
You can simply run this file by running this following command in your terminal from the root directory:
- `. init.sh`
- When prompted to eject enter `y`.
- run `. run.sh` to run the backend
- Navigate to `localhost:5000`
The shell script sets up a base React and Flask application.
**Note**: In order for the script to run without an error make sure you have atleast the following version.
| Programs | Versions| Command to check | Command to upgrade |
|---------|-|-|-|
|
| `v15.2.1`|`node --version`| `nvm install [version.number]`|
|
| `1.22.10` | `yarn --version` | `yarn upgrade --latest`|
|
| `3.8.6` |`python --version`|
|
| `20.2.3`|`pip --version` | `pip install --upgrade pip` |
*The commands above are primarily for **Linux** users. I haven't set up CI Tests yet for versions before these, so not sure if it'll work with those setups or not.*
2. To add a css framework for the `ReactJS` frontend run:
```shell
. add_react_css_framework.sh -a bootstrap
```
or
```shell
. add_react_css_framework.sh --add bootstrap
```
Currently bootstrap is the only one available in the script.
3. To add a Database to our backend run:
```shell
. add_database.sh NoSQL
```
for MongoEngine
or
```shell
. add_database.sh MySQL
```
for MySQL Alchemy. This file will set up a basic user model and necessary mongodb configurations
4. Alternatively, you can run `. run_all.sh` to run all 4 scripts in a go.