Repository files navigation

Aggregate job opportunities with homeless service providers so that people can search for a job that fits their skillset.

1. Git for working with Github source code
2. Node and npm for running the web app
3. Python 2 and pip for running the web scraper

1. Clone this repo to your local drive.

   details

   1. Start a terminal app, such as Ubuntu for Windows Subsystem for Linux
   2. Create a src directory in the user's home directory and go in it

      cd && mkdir src && cd src

   3. Clone the repository

      git clone https://github.com/hackforla/jobs-for-hope

2. Change to the jobs-for-hope directory:

   cd jobs-for-hope

3. Install the node server npm depedencies:

   npm install

4. Obtain the.env file from the slack channel and place it in this directory. It contains private info (i.e., the production database connection string) that we cannot put in this public GitHub repo.

5. Change to the client directory:

   cd client

6. Install the client (React) dependencies:

   npm install

1. Runnpm start from the jobs-for-hope directory to start the node server.
2. Runnpm start from the jobs-for-hope/client directory to start the react app and open the browser.

1. Virtualenv (optional, but will be useful if you eventually want to have multiple python projects)

   show

   1. Set up virtualenv

      1. Install virtualenv using pip

         pip install virtualenv virtualenvwrapper

      2. cd into project directory

         cd jobs-for-hope/backend

      3. create the virtualenv

         virtualenv venv

         Alternative for systems where python 2.7 is not the default

         1. Specify the python location when creating the virtualenv

            virtualenv -p /usr/local/bin/path/to/python2.7 venv # use this if the system default is python3

      alternative setup using virtualenvwrapper

      1. Install virtualenv using pip

         pip install virtualenv virtualenvwrapper

      2. Create directory to hold virtual environments

         mkdir $HOME/.virtualenvs

      3. Find out where virtualenvwrapper.sh is located for next step

         which virtualenvwrapper.sh

      4. Make.bash_profile call.bashrc (reference:http://www.joshstaiger.org/archives/2005/07/bash_profile_vs.html)

         1. Add this to.bash_profile

            if [ -f ~/.bashrc ]; then  source ~/.bashrcfi

      5. Add to.bashrc

         export WORKON_HOME=$HOME/.virtualenvsexport PATH="/path/to/virtualenvwrapper:$PATH"source virtualenvwrapper.sh

      6. Start a new terminal session or call.bashrc

         source ~/.bashrc        # activate virtualenvwrapper.sh, just for the first time

      7. Create the virtualenv

         mkvirtualenv jobs-for-hope

         Alternative for systems where python 2.7 is not the default

         1. Specify the python location when creating the virtualenvmkvirtualenv -p /usr/local/bin/path/to/python2.7 jobs-for-hope # use this if the system default is python3

   2. Activate the virtualenv

      source venv/bin/activate

      for virtualenvwrapper

      workon  // list the existing virtual environments, blank if none is createdworkon jobs-for-hope  // activate virtual environment, not needed when first creating the virtualenv

   3. Do work and run python within the virtualenv

   4. Deactivate the virtualenv

      deactivate // switch back to system python

   1. All python commands should be run inside the jobs-for-hope virtualenv if you choose to set it up. You will have to make sure the virtualenv is activated before following the steps.

2. Install project dependencies

   cd backendpip install -r ./requirements.txt

3. Setup for the scrapers

   1. Download thedatabase.ini file from the slack channel into thebackend directory
   2. Dump the aws database to a file (referencedatabase.ini for values)

      pg_dump -d <database> -h <host> -U <user> -C -f jobsforhope.sql

   3. restore to the local database

      psql -h localhost -U postgres -d jobsforhope -f jobsforhope.sql

1. Switch to the backend directory

   cd backend

2. To run all the scrapers

   python scraper_runner.py

3. To run a single scraper

   python scraper_runner.py scrapers/prototypes.py

1. Use DBeaver
2. Add a postgres database connection with the .env file credentials from the slack channel.
3. The jobs are in the jobs table.