Skip to content

Web-based platform for student-professor collaboration.

Notifications You must be signed in to change notification settings

marianopenn-jhu/assignmintz

Repository files navigation

alt-text

Accessing the Application

The application is hosted at https://mysterious-depths-20159.herokuapp.com/home/. You must access it through Google Chrome, as we are resolving an issue with font display on other popular browsers.

Installation for Development

The application's dependencies are installed by running 'source install.sh'. In order to run this script, you must have Python 3, PostgreSQL 9.6, and pip, and React installed on your system. This script will create and initialize a virtual environment with all the required packages. It will also create a database named 'assignmintz' and initialize the database with the required tables.

Frontend Build:

  1. Install npm onto your machine
  2. Navigate to assignmintz/frontend
  3. Type 'npm run build:static' in your terminal for local development and 'npm run build:prod' for a deployment version. The transformed.js file will be placed into the static file directory for the backend.

To build and run for local development (localhost:8000/home/):

source install.sh  
source run.sh

To run tests locally:

source run_tests.sh

If you have a previously installed version of Assignmintz and intend to run the application locally, a few steps are required to get the database models lined up to the current version of development.

  1. Open psql on the command line
  2. Type in 'drop database assignmintz'
  3. Exit psql
  4. Run 'createdb -h localhost -p 5432 -U postgres assignmintz'
  5. Run update_migrations.sh

The app should now be ready to go! Navigate to 'localhost:8000/home/' to begin using the app.

Deploy Process:

  • You must have the heroku CLI installed.
  • Add the assignmintz app heroku remote with the following command:
    • heroku git:remote -a theassignmintzapp
  • Make changes to current branch
  • Run 'npm run build:prod'
  • Add/commit changes (must add and commit the transformed.js file)
  • Run 'git push heroku master'