MySchool API

API for the MySchool app scaffold, built on top of Parse Server. To start, run npm install to install all necessary packages, and then run

npm start

The server expects the following environment variables:

• APP_ID - Parse Server App ID to use
• MASTER_KEY - Parse Server Master Key to use
• MONGODB_URI - URL of the MongoDB instance to use
• CALENDAR_SERVER_URL - URL of the calendar server that provides school calendar and athletics information. See Calendar Server for more information.
• GOOGLE_CLIENT_ID - the Client ID for Google Sign In
• SCHOOL_DOMAIN - the web domain name for the school (e.g. "myschool.org")

The server also accepts additional optional environment variables:

• DASHBOARD_CONFIG - optional stringified JSON object to configure the Parse Dashboard. See the Parse Dashboard Wiki for more information. If this variable is specified, a Parse Dashboard is mounted at /dashboard.
• SERVER_URL - the URL this server is running from (defaults to http://localhost:1337)
• PORT - the port to run from (defaults to 1337)
• IOS_PUSH_CERT - the name of the iOS push certificate .p12 file (e.g "cert.p12") in the project
• IOS_PUSH_PASSPHRASE - the password for the iOS push certificate
• IOS_BUNDLE_ID - the bundle ID of the iOS client

Scheduled Scripts

There are also multiple scheduled scripts that are run at different intervals (or manually) to keep everything up to date. These scripts can be run using the runLocal.js script (see below).

###updateCalendars.js### This script, to be run every 10 minutes (or more frequently if possible), keeps CalendarEvent and AthleticsEvent data up to date using data from the Calendar Server. It also notifies interested users if any athletics events change.

###updateAthleticsTeams.js### This script, to be run only once per year, (or more often if needed), clears out all existing AthleticsTeam data (including corresponding AthleticsEvents) and replaces them with new, empty AthleticsTeam objects based on the Calendar Server data.

Push Notifications (iOS)

To configure push notifications for an iOS client, simply replace MySchoolPushCertificate.p12 with your own iOS push certificate, and provide the certificate passphrase and app bundle ID as environment variables (see above).

Testing and Debugging

It's also easy to run different server configurations and debugging options using the runLocal.js file. This file relies on a companion runLocal.json file with the server info in the following format:

{
	"configs": {
		// config object map
	},
	"dashboard": {
		// dashboard config
	},
	"googleClientId": "...",	// google sign in client ID
	"schoolDomain": "myschool.org"	// school domain
}

where "configs" maps to a dictionary of server names to server config objects, and "dashboard" maps to a Parse Dashboard config object as a JSON string. Each config object must have an "appId", "masterKey", "calendarServerUrl" and "mongoUri" field.

With this companion file, this script takes 2-3 command line arguments:

	node runLocal.js FILE_NAME SERVER_NAME DEBUG_OPTION

• FILE_NAME - the name of the file to run
• SERVER_NAME - must match a configuration object in "configs" above. Runs that server configuration.
• DEBUG_OPTION - if "debug", runs using node-debug instead of the default nodemon. Optional.

The included package.json file relies on runLocal.js to run various server configurations. Take a look to see what different npm commands are built in.

Additional Tidbits

There is a commitAndPushAll.sh script included, which if run, will commit and push the entered file changes to both staging and master. It will ask for a commit message on launch. Note that you will need to add any untracked files before running this script.