Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix readme #91

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,42 @@
# microsetta-adminname: microsetta-admin CI
# microsetta-admin
An admin interface to support The Microsetta Initiative

## Installation
Other projects should be installed first.<br>
https://github.com/biocore/microsetta-interface.git <br>
https://github.com/charles-cowart/microsetta-private-api.git

Create a new `conda` environment containing `flask` and other necessary packages:
```
conda create --name test-microsetta-admin python=3.7
```

Once the conda environment is created, activate it:
```
conda activate test-microsetta-admin
```

Ensure that the `conda-forge` channel has been added to the conda install and run:
```
conda install --yes --file ci/conda_requirements.txt
```

Install additional requirements using pip:
```
pip install -r ci/pip_requirements.txt
```

Install vi 'make' command and 'Makefile'.
```
make install
conda activate test-microsetta-admin
```

before make test, add:
Lastly, add nodejs.
```
conda install -c conda-forge nodejs
```

To run unittests:
```
make test
```