Skip to content

Home

Jump to bottom
Aaron shiel edited this page Jun 28, 2021 · 4 revisions

Welcome to the mentor-admin wiki!

Preparing your environment for development

  1. Install WSL 2 on windows (Ubuntu): https://docs.microsoft.com/en-us/windows/wsl/install-win10#manual-installation-steps
  2. Install node.js in ubuntu (version 14.17): https://github.com/nodesource/distributions/blob/master/README.md#debinstall
  3. Confirm successful node install: $ node --version
  4. Install Docker in ubuntu: https://docs.docker.com/docker-for-windows/wsl/
  5. Install docker-compose in ubuntu: https://docs.docker.com/compose/install/
  6. Update C:\Windows\System32\drivers\etc\hosts to contain "127.0.0.1 local.mentorpal.org" (no quotations)
  7. Download and install Visual Studio Code: https://code.visualstudio.com/
  8. Within visual studio, find the extensions tab in the left toolbar and search for and install "Remote - WSL"

Your dev environment is ready. You may begin working on mentor-admin (among other repos)

  1. Within your WSL terminal (e.g. ubuntu) clone the mentor-admin repository: https://github.com/mentorpal/mentor-admin.git
  2. You can view/edit code inside visual studio by executing this command from the mentor-admin root directory: $ code .

After making changes to the repository and you would like to view/test your changes in the integrated app:

  1. Clone the mentorpal beanstalk app: https://github.com/mentorpal/mentorpal.org-beanstalk-app
  2. Open the beanstalk app in visual studio and within docker-compose.yml, look under "services" to find "admin", change the value for "image" from "uscictdocker/mentor-admin:x.y.z" to "mentor-admin:latest"
  3. Startup a docker daemon and leave it running (in its own terminal): $ sudo dockerd
  4. Build a new mentor-admin docker image (run this from the mentor-admin root directory): $ sudo make docker-build
    • This command may take a few minutes to finish, and must finish before moving on
  5. In the beanstalk repo root, run: $ sudo make run
    • This command may take a few minutes to finish, and must finish before moving on
  6. Open your preferred web browser and go to "local.mentorpal.org/admin"
Clone this wiki locally