django-rit-grasa
stable

About:

  • About this project
    • High level project description
    • Objectives
      • Families
      • Program providers
      • GRASA and Monroe County staff
    • Project team
  • Features and Systems
    • Families
      • Search for different events.
      • Apply filters to better discover events that interest a user.
      • Find information to learn more about a specific event.
    • Program Providers
      • Add new events with specific metadata into system for approval by administrators.
      • Update information for existing events in system for approval by administrators.
    • GRASA and Monroe County Staff
      • Review and approve submitted events.
      • Confirm new provider accounts.
    • All users
      • Mobile-friendly user interface.
  • Open source licenses

User Documentation:

  • Base System
    • Change password
      • Admin User
      • Provider User
    • Update email
      • Admin User
      • Provider User
  • Event Curation System
    • How to invite a Provider to sign up
      • 1. Click View Providers button from Admin Portal:
      • 2. Click Invite Provider button in upper-right corner:
      • 3. Enter email and click Send Invite:
      • 4. Wait for registration
    • How to review Provider account registrations
      • View pending accounts
      • Approve an account
      • Reject an account
    • How to review and publish Events
      • View pending Events
      • Approve an Event
      • Reject an Event
    • How to create a new Event
      • Add new Event
      • How to write strategically
    • How to edit an existing Event
      • Requirements
      • 1. Edit from event list
      • 2. Wait for Administrator approval
    • How to register a Provider account
      • 1. Get an invitation
      • 2. Complete registration form
      • 3. Wait for Administrator approval
      • 4. Log in
  • Search System
    • How to search for Events
      • Make a keyword search
      • Apply filters
      • Other notes about Search System
    • How to share an Event

Admin Documentation:

  • Deployment architecture
  • Admin quick start guide
    • Dependencies
    • Set up database
    • Install your configuration
    • Container host set-up
    • Start Event Locator
      • Run initialization script
    • Stop Event Locator
    • Restart Event Locator
  • Third-party APIs
    • Geocoding service: MapQuest API
      • How it is used
      • How to acquire API access
      • Cost considerations
    • Email/SMTP service
  • Upgrade guide
    • Why you might want to upgrade
    • Database Concerns
    • How To Actually Upgrade

Developer Documentation:

  • How to: Add new dependencies / libraries
    • Set up a Pipenv shell
    • Installing dependencies for testing
    • Installing dependencies for the team
    • FAQ
      • When testing dependencies, should pip or pip3 be run?
  • How to: Conduct user testing
    • Background
    • Questionnaire
    • Tasks
      • Admins
      • Providers
      • Families
    • Template
  • How to: Exec into a container
    • Background
    • Pre-requirements
    • Commands
  • How to: Rebuild search indexes
    • Background
      • Development note
    • Pre-requirements
    • Commands
  • Create new dev environment
    • Requirements
    • Setup
    • Run project with docker-compose
      • Run docker-compose in detached mode
    • Open in web browser
  • Refresh existing dev environment
    • Create a fresh environment
    • Initial app configuration
  • Troubleshooting
    • Q: On Fedora, Pipenv fails with MySQL config error
    • Database changes during development
django-rit-grasa
  • Docs »
  • Search
  • Edit on GitHub

© Copyright 2019, RIT Team Platypus Revision 83173ee4.

Built with Sphinx using a theme provided by Read the Docs.