Lexos Bootcamp - WheatonCS/Lexos GitHub Wiki

This page describes how to set up Github and install PyCharm and the necessary Python libraries required to work on the Lexos project.

1. Create User on Linux Box

  1. Get a csadmin to authorize creation of a new account.
  2. Create a username and password
  3. All members of Lexos team must now be added to the Wheaton CS Organization.

2. Download PyCharm Professional

  1. Open terminal (ctrl-alt-t).
  2. Enter sudo snap install pycharm-professional --classic
  3. Create Jetbrains Student Account
    1. Create Account
    2. Create new account using your Wheaton Email
  4. Open PyCharm
  5. Log into your student account

3. Download and install Anaconda 3

on Linux

  1. Go to Download Anaconda
  2. Select download anaconda python 3 for your Operating System
  3. Open terminal (ctrl-alt-t) and enter:
  4. bash Anaconda3-5.1.0-Linux-x86_64.sh
  5. check your anaconda is properly installed
> python --version
Python 3.6.4 :: Anaconda, Inc.

install on Windows with installer

  1. Go to Download Anaconda
  2. Select download anaconda python 3 for your Operating System
  3. Double click the installer to install, make sure to add anaconda to your path
  4. check your anaconda is properly installed
> python --version
Python 3.6.4 :: Anaconda, Inc.

install on Windows with choco

  1. Make sure you have installed chocolatey package manager, you can find the install guide here
  2. Run PowerShell (recommended) or Command Prompt as administrator and type choco install anaconda3 --params="/AddToPath:1"
  3. check your anaconda is properly installed
> python --version
Python 3.6.4 :: Anaconda, Inc.

4. Generate your SSH Key

Follow the Steps in This Link ignore this step if you want to use Git Credential Manager for Windows

5. Add SSH Key to your GitHub

Follow the Steps in This Link ignore this step if you want to use Git Credential Manager for Windows

6. Clone ToyRepo and Lexos Repositories

on Linux

  1. On your terminal, go to the directory where you want to have the repository.
  2. It is best to have the repository on your Desktop.
    1. Copy the SSH from the github page. Refer to the image.
    2. Then on your terminal, go to the Desktop directory and clone the repos.
> cd Desktop
> git clone [email protected]:WheatonCS/ToyRepo.git
> git clone [email protected]:WheatonCS/Lexos.git

on Windows

  1. Install all the tools using chocolatey package manager, run PowerShell as administrator:
> choco install nodejs git git-credential-manager-for-windows 
> refreshenv
  1. clone these repos, You CANNOT use the ssh link, you can only use the https link
> cd Desktop
> git clone https://github.com/WheatonCS/Lexos
> git clone https://github.com/WheatonCS/ToyRepo

7. Install Python packages and Javascript libraries

  1. Install the requirements.txt which is the python-packages:
> cd Lexos
> python -m pip install -r requirements.txt
  1. Install Javascript library:
> cd lexos/frontend
> npm install

8. Setup Project Interpreter

  1. Go to Pycharm --> then go to the settings under the file menu.

  2. On the settings window choose the project option on the left and choose the project interpreter.

  3. Once you click on project interpreter you will be directed to a new window similar to the one below:

    Click on the gear icon to add on the project interpreter which will take you to another window where you have to change the name of your python interpreter under the Conda environment.

  4. Change the name of the python interpreter by clicking on the gear icon which will take you to the window below:

    change the name to /home/username/anaconda3/bin/python then click OK and then apply the changes.

  5. The final step is to get back on the python interpreter window and change the name of the project interpreter.

    When you click on show all it will take you to another window where you can edit the name for project interpreter.

    Change the name of the project interpreter to the same as you see on the image above. After applying the changes this will complete necessary changes needed to setup your project interpreter.

Infographic for GitHub Pushing/Pulling/Merging/Committing