wizard

See also the related API spec: https://github.com/intermine/wizard-api-specs/

To run

Requirements

git
Node and npm (ideally installed via nvm)
The InterMine Compose server.

Clone and start the wizard

git clone git@github.com:intermine/wizard.git
cd wizard
npm install
npm start

Visit localhost:3000 to see the wizard, or localhost:3000/dev for quick links to all the wizard pages

Developing

If you're developing and would like the server to auto-restart after you've changed a server-side js file, run this instead of npm start

npx nodemon bin/www

Building the wizard

Webpack glues all of the disparate js files into a single built js in the dist folder.

Build once:

  npm run build

Build, and refresh when changes are made:

npm run dev

task	command
build js	`npm run build`
generate docs	`npm run generate-docs`
dev: rebuild and refresh server when changes are made	`npm run dev`
dev: refresh server which files are changed	`npm run refreshServer`
dev: rebuild on js filechange	`npm run watchBuild`

Running on a different port

Dev:

PORT=SOMEPORT npx nodemon bin/www

Prod:

PORT=SOMEPORT npm start

Linting

Check the code using:

npm run lint

To automatically fix errors:

npm run lint-fix

Running Test

npm run cypress:test

Note: To run the test docker must be installed in your system and running before the test begins.

Docker

Use the script :)

If you do not have the wizard and configurator cloned in the same parent directory as the wizard, run:

  ./bin/init-dependencies.sh

then

    ./bin/startup.sh

Or follow the steps below.

Build docker image

docker build -f Dockerfile -t intermine/wizard:latest .

Run wizard in a docker container

docker run --rm -p 9992:8080 --env COMPOSE_PORT=9991 intermine/wizard:latest

Replace the value of COMPOSE_PORT with the port on which Intermine Compose is running. You can visit wizard at localhost:9992

Note: Wizard expects other InterMine Cloud components. If Other InterMine Cloud components are not running, then Wizard will throw errors. If you do not have InterMine Cloud components already running locally, then use the docker-compose.yml file to start wizard with rest of the InterMine Cloud in docker containers. Instructions for this is in the next section.

Docker Compose

Start wizard with all other InterMine Cloud components using docker compose.

docker-compose up --build --force-recreate

You can visit wizard at localhost:9992

intermine / wizard

readme