shadaj / csm_web

Web applications for CS Mentors.

CSM Web Applications

This repository contains webapps that help support the infrastructure of CSM. Currently, it only holds Scheduler (our section signup and attendance system), but more are on the way.

If you're unfamiliar with CSM and/or its web applications, check out this repository's releases for a peek at what our web applications look like and what we've been working on lately.

Installing

Requirements

We don't know what specific minimum version you would need for any of the following software, but the most recent version of any of the below should work.

• Python 3.8
  • virtualenv (pip install virtualenv)
  • autopep8 (pip install autopep8)
• npm
  • prettier (npm install -g prettier)
  • eslint (npm install -g eslint; npm install -g eslint-plugin-react)
• Postgresql (brew install postgresql && brew services start postgresql)
• Heroku CLI (brew tap heroku/brew && brew install heroku)
  • Create an account on Heroku and login

Other miscellaneous requirements will be installed by the commands below.

Setup

To ensure package version consistency and avoid polluting your global package installations, we highly recommend running the server with virtualenv (pip install virtualenv).

From a terminal in the top level of the project directory, run python3 -m virtualenv venv.

To activate the environment, run source venv/bin/activate. You will need to run this command every time you open a new terminal.

Finally, run ./setup.sh. This will install additional requirements needed by the server, and set up some necessary environment variables.

Running

To start the Django server, run python csm_web/manage.py runserver and visit localhost:8000 in your browser.

Run python csm_web/manage.py createtestdata to generate some test data. If you ran ./setup.sh, this was done for you.

If you are working on the frontend:

Run npm run watch, which will automatically rebuild the JS bundle if any changes to the frontend JS are detected. Alternatively you can run npm run dev manually each time you make changes to the frontend.

Troubleshooting

setup.sh Errors

• The following errors are likely caused by some quirks in our build system - if you set up a new virtual environment through normal commands, you may run into them. The solution for all of these should be to run setup.sh (you should be able to do this even after attempting to run pip/npm commands already).
  • django.core.exceptions.ImproperlyConfigured: The SECRET_KEY setting must not be empty.
  • When installing psycopg2, console output displays ld: library not found for -lpq or similar
• During ./setup.sh or pip3 install I'm getting a psycopg2 install error that looks like this:

Error: pg_config executable not found.
    
    pg_config is required to build psycopg2 from source.  Please add the directory
    containing pg_config to the $PATH or specify the full executable path with the
    option:

• You need to install Postgres locally (see this SO post)
• During ./setup.sh, this happens after pip3 install runs

./setup.sh:41: no such file or directory: /Users/jhshi/Documents/csm/csm_web/venv/.project_dir
./setup.sh:44: no such file or directory: /Users/jhshi/Documents/csm/csm_web/venv/bin/activate
./setup.sh:47: no such file or directory: /Users/jhshi/Documents/csm/csm_web/venv/bin/activate

• This likely happens because you moved your folder after creating your virtualenv. Removing and recreating your virtualenv should fix it.

How do I access the /admin page?

• The ./setup.sh script will create a user with username demo_user and password pass. You can access it by signing in through the admin page.
• If you wish to assign admin permissions to an account that uses OAuth (such as your Berkeley email), run the following commands in the Django shell (accessible by running python3 csm_web/manage.py shell):

from scheduler.models import *
# replace "my_username" with the prefix of your Berkeley email, as in "[e-mail]"
user = User.objects.get(username="my_username")
user.is_staff = True
user.is_superuser = True
user.save()

Miscellaneous

OSX: error on running pip

Try replacing pip with pip3 instead.

OAuth errors when trying to sign in locally

Error 401: invalid_client
The OAuth client was not found.

OAuth secrets are sourced from the heroku repository: you'll need to log in to heroku, add the appropriate remote, rerun setup.sh, and then reactivate your virtualenv.

On runserver, long stack trace ending with this:

django.db.utils.OperationalError: could not connect to server: Connection refused                           
        Is the server running on host "localhost" (::1) and accepting                                       
        TCP/IP connections on port 5432?                                                                    
could not connect to server: Connection refused                                                             
        Is the server running on host "localhost" (127.0.0.1) and accepting                                 
        TCP/IP connections on port 5432?                                                                    

Your postgres server is likely not running. On a mac (which is the only platform we've done local testing on), run brew services start postgres before invoking runserver again.