BCO Portal Local Deployment: Difference between revisions

Revision as of 19:02, 4 October 2022

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

Mac OS:

Clone the GitHub Repository
1. Open Terminal, enter following commands:
  1. git clone https://github.com/biocompute-objects/bco_api
  2. cd bco_api
Switch to the latest release branch:
1. git switch 22.10
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)

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

@@ Line 8: / Line 8: @@
 # Switch to the latest release branch:
 ## <code>git switch 22.10</code>
+#Enter the repository, create a virtual environment, and install the required packages:
+##<code>pyenv local 3.9.4</code> (Note: will show as pyenv: command not found if already installed)
+##<code>python3.9 -m venv env</code>
+##<code>source env/bin/activate</code> (activated virtual environment by ''showing (env) (base) MacBook-Pro-3:bco_api'')
+##<code>python -m pip install -r requirements.txt</code> (if installation failed, make sure you are in the correct path: /Users/Username/bco_api)
+#Modify Configuration file
+##Once in the virtual environment, make sure you are on the path:/Users/Username/bco_api
+##Edit the server.conf file: <code>vim bco_api/bco_api/server.conf</code>