BCO Portal Local Deployment

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

BCO_API:

1. Clone the GitHub Repository
   1. Open Terminal, enter the 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
   3. If run successfully, should observe the following:
      
6. Create a super user for the API: python3.9 manage.py createsuperuser
   1. Follow the prompts
7. python3.9 manage.py runserver 8000:
   
   1. Once see the messages as shown in the figure above, go to http://localhost:8000/api/admin/ on the local browser to see if BCO API is set up successfully

UserDB

1. Clone the GitHub Repository
   1. Open Terminal, enter the following commands:
      1. git clone https://github.com/biocompute-objects/userdb
      2. cd userdb/
2. Switch to the desired branch: e.g. git switch 22.10
3. Enter the repository, create a virtual environment, and install the required packages:
   1. pyenv local 3.9.4
   2. python3.9 -m venv env
   3. source env/bin/activate
   4. python -m pip install -r requirements.txt
4. Modify the Config file: vim portalusers/settings.py
5. Make migrations: python3.9 manage.py migrate
6. Create a super user for the API: python3.9 manage.py createsuperuser (Note: this step can be skipped if superuser is already created or not superuser account is not necessary)
7. Run server: python3.9 manage.py runserver 8181
   1. If ran successfully, you should observe as shown in the following figure:
      
   2. Once see the messages as shown in the figure above, go to http://localhost:8181/users/admin/ on the local browser to see if BCO API is set up successfully (Note: If it worked you should be able to login using the SuperUser credentials you created above)

Portal Deployment Instructions

1. Clone the repository
   1. git clone https://github.com/biocompute-objects/portal
   2. cd portal/
2. Switch to the desired branch: e.g. git switch 22.10
3. Install packages with either of the following commands:
   1. npm install
   2. npm install --legacy-peer-deps
4. Edit /portal/src/App.js line 87 based on your need :
   1. For local, sending = hostnames.local
   2. For the test site, sending = hostnames.test
   3. For the production site, sending = hostnames.production
5. Start running: npm run start