react-flask-boilerplate

Boilerplate for setting up new React Projects running on a simple Flask webserver, built with Gulp and Watchify

Requirements

• Python 3.4+
• Node 0.10.25+
• npm
• virtualenvwrapper 1.11.6+
• git
• git-flow

Installs

• Flask
• React
• Gulp
• Browserify
• Watchify

Installation instructions

1. Clone this repository with a new project name

    git clone https://github.com/Eighty20/react-flask-boilerplate new_project
   

2. Create a new repository on github or bitbucket with the same name

3. Enter the directory you just created

    cd new_project
   

4. Set the remote origin of your project to the new repository and push

    git remote set-url origin https://github.com/Eighty20/new_project
    git push -u origin master
   

5. Set up git flow

    git flow init -d
   

6. Checkout the develop branch

    git checkout develop
   

7. Set up a new python virtual environment

    mkvirtualenv --python=/usr/bin/python3 training
   

8. If your virtual environment is not immediately activated, enter it with

    workon training
   

9. Install the required python packages

    pip install -r requirements.txt
   

10. Install the required node modules

     npm install
    

Running the app

1. In a new terminal, in the project folder, run gulp

    gulp
   

2. In another terminal, start the webserver

    ./run.sh
   

3. In a browser, navigate to http://localhost:5000

4. Read the documentation on each of the technologies to figure out where to go from there.

Installation instructions for windows (with conda)

Requirements

• Python 3.4+
• Node 0.10.25+
• npm
• git

Installs

• Flask
• React
• Gulp
• Browserify
• Watchify

1. Clone this repository with a new project name

    git clone https://github.com/Eighty20/react-flask-boilerplate new_project
   

2. Create a new repository on github or bitbucket with the same name

3. Enter the directory you just created

    cd new_project
   

4. Set the remote origin of your project to the new repository and push

    git remote set-url origin https://github.com/Eighty20/new_project
    git push -u origin master
   

5. Set up git flow

    git flow init -d
   

6. Checkout the develop branch

    git checkout develop
   

7. Set up a new python virtual environment

    conda create -n training
   

8. Activate your virtual environment

    activate training
   

9. Install the required python packages

    conda install --yes --file req.txt
   

10. Install the required node modules

     npm install
    

Running the app

1. In a new terminal, in the project folder, run gulp

    gulp
   

2. In another terminal, start the webserver

    ./run.cmd
   

3. In a browser, navigate to http://localhost:5000

4. Read the documentation on each of the technologies to figure out where to go from there.