Developer Guide

This page describes how to set up the project locally for development.

We will need to set up an Elasticsearch instance with encryption so we can access the security features. The instructions on setting that up can be found here: https://www.elastic.co/guide/en/elasticsearch/reference/current/configuring-tls-docker.html

Please read the loading data page for more information on how to populate the database.

You can start your own redis server through docker containers:

docker run --name some-redis -d redis

Clone Alhena's graphQL repository:

git clone https://github.com/shahcompbio/alhena-graphql

Go into the directory and install the dependencies:

cd alhena-graphql
yarn install

Add an .env file:

REDIS_HOST=localhost
REDIS_PORT=6379
ES_USER=elastic
ES_PASSWORD=PleaseChangeMe
ELASTICSEARCH_NODE=https://localhost:9200

Then start the development server.

yarn start

Following the URL http://localhost:4000 should bring you to the GraphQL playground, where you can enter queries.

Clone Alhena React repository:

git clone https://github.com/shahcompbio/alhena.git

Install the dependencies:

yarn install

Then start the development server.

yarn start

This should automatically open http://localhost:3000 on your browser. If not, then navigate to that URL.

Provide feedback