BCO Portal Local Deployment

From BCOeditor Wiki
Revision as of 19:07, 4 October 2022 by Twang9 (talk | contribs)
Jump to navigation Jump to search

In order to work with BCO API locally, please follow the following steps to set up:

Mac OS:

  1. Clone the GitHub Repository
    1. Open Terminal, enter following commands:
      1. git clone https://github.com/biocompute-objects/bco_api
      2. cd bco_api
  2. Switch to the latest release branch:
    1. git switch 22.10
  3. Enter the repository, create a virtual environment, and install the required packages:
    1. pyenv local 3.9.4 (Note: will show as pyenv: command not found if already installed)
    2. python3.9 -m venv env
    3. source env/bin/activate (activated virtual environment by showing (env) (base) MacBook-Pro-3:bco_api)
    4. python -m pip install -r requirements.txt (if installation failed, make sure you are in the correct path: /Users/Username/bco_api)
  4. Modify Configuration file
    1. Once in the virtual environment, make sure you are on the path:/Users/Username/bco_api
    2. Edit the server.conf file: vim bco_api/bco_api/server.conf
  5. Quick check to make sure the server can run
    1. cd bco_api/bco_api (Note after this command, should under path /Users/Username/bco_api/bco_api)
    2. Make migrations: python3.9 manage.py migrate
  • If run successfully, should observe the following:
    Screen Shot 2022-10-04 at 15.05.22.png