Skip to content

Latest commit

 

History

History
151 lines (96 loc) · 4.83 KB

DEVELOPMENT.md

File metadata and controls

151 lines (96 loc) · 4.83 KB

DEVELOPMENT

Build project

Build the project from source with the following code.

python setup.py compile_assets
python setup.py sdist bdist_wheel

Development workflow

Git Submodules

Some demo datasets are included as a submodule. Directory asreview/tests/citation-file-formatting is cloned from citation-file-formatting.

Examples:

  • To clone the full repository with submodules in one line, add --recursive flag:

    git clone --recursive git://github.com/asreview/asreview.git

  • To update the submodule, you would still need to follow the contribution guide in the submodule repository. And then create a PR for the main repository with the updated submodule commit.

Back end

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

Front end

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.

Please make use of Prettier (https://prettier.io/docs/en/install.html) to format React/Javascript code. Use the following code to format all files in the webapp folder.

cd asreview/webapp
npx prettier --write .

Documentation

Sphinx docs

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 dependencies for rendering the documentation 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.

Broken links

Navigate into the docs folder and check for broken links with:

make linkcheck

Extra information: https://www.writethedocs.org/guide/tools/testing/#link-testing

Screenshots

Screenshots are an important part of the ASReview documentation. When contributing screenshots, follow the guidelines below.

  1. Open Developers Tools in your browser (e.g. Chrome or Firefox).
  2. Set device dimensions to 1280x800.
  3. Capture screenshot with internal screenshot tool (preferred, see example).
  4. [OPTIONAL] Crop relevant part. Keep ratio if possible.
  5. Resize image to 1280x800 maximum and 960x600 minimum.
  6. [OPTIONAL] Use a red box to highlight relevant components.

EXPERIMENTAL: One Click Deploy for ASReview LAB

You can deploy ASReview LAB right now in one click on any of these clouds providers:

❗❗❗ ASReview doesn't have builtin authentication. You are responsible for the authentication and security of the server yourself.

Release instructions

Docker

A Docker image is created when a tag or a commit to master is pushed. The workflow docker.yml builds images for platforms linux/amd64 and linux/arm64. If, for some reason, the image is not built, you can build manually with the commands below. Find the manual instructions at https://docs.docker.com/docker-hub/ and https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry. Replace the version numbers below by the version you want to push.

ASReview LAB

docker build -t asreview/asreview .
docker build -t asreview/asreview:1.0 .
docker push ghcr.io/asreview/asreview
docker push ghcr.io/asreview/asreview:1.0