Build the project from source with the following code.
python setup.py compile_assets
python setup.py sdist bdist_wheel
Install Python
Install the ASReview package
pip install -e .
Start the Python API server with the Flask development environment
export FLASK_ENV=development
asreview lab
For Windows, use
set FLASK_ENV=development
asreview lab
Install both npm and Python
Start the Python API server with the Flask development environment. Before the front end development can be started, the back end has to run as well
export FLASK_ENV=development
asreview lab
For Windows, use
set FLASK_ENV=development
asreview lab
Navigate to asreview/webapp and install the front end application with npm
cd asreview/webapp
npm install
The user interface is written in React. Start the local front end application with npm
npm start
Open the web browser at localhost:3000
Important: Ignore localhost:5000. You can also find a front end on :5000 but this is not relevant for the current front end development step.
Documentation for the ASReview project is available on https://asreview.readthedocs.io/en/latest/.
The source files are available in the docs folder of this repository. The project makes
use of Sphinx to convert the source files and docstrings into HTML
or PDF files.
Install the dependcies for rendering the documenation with
pip install -r docs/requirements.txt
Navigate into the docs folder and render the documentation (the HTML version) with
make html
Open the file docs/build/html/index.html in your web browser.
Screenshots are an important part of the ASReview documentation. When contributing screenshots, follow the guidelines below.
- Open Developers Tools in your browser (e.g. Chrome or Firefox).
- Set device dimensions to 1280x800.
- Capture screenshot with internal screenshot tool (preferred, see example).
- [OPTIONAL] Crop relevant part. Keep ratio if possible.
- Resize image to 1280x800 maximum and 960x600 minimum.
- [OPTIONAL] Use a red box to highlight relevant components.