README.md

Note: This repository has been archived

This project was developed under a previous phase of the Yale Digital Humanities Lab. Now a part of Yale Library’s Computational Methods and Data department, the Lab no longer includes this project in its scope of work. As such, it will receive no further updates.

Flask React Boilerplate

Simple boilerplate for a Flask backend and React client including:

• ES6 transpiling via Webpack
• Hot module reloading via Webpack Dev Server
• State management via Redux
• Tests via Pytest and Jest
• Linting via Pylint and Eslint
• Travis CI for automatic testing and linting

Dependencies

To install the boilerplate dependencies, you can run:

git clone https://github.com/YaleDHLab/flask-react-boilerplate
cd flask-react-boilerplate
npm install --no-optional
pip install -r requirements.txt

Quickstart

Once the dependencies are installed, you can start the api with the following command:

npm run production

That will start the server on port 7082. To run the development server with hot module reloading, run:

npm run start

That will start the webpack dev server on port 7081.

Tests

To run the Javascript tests (located in src/tests/), run:

npm run jest

To run the Python tests (located in server/tests/), run:

pytest

Linting

To lint the Javascript files (located in src), run:

npm run lint-js

To lint the Python files (located in server), run:

npm run lint-py