Skip to content

Latest commit

 

History

History
188 lines (115 loc) · 5.91 KB

README.md

File metadata and controls

188 lines (115 loc) · 5.91 KB
Raw

bloom-parse-server

This is the database backend for bloomlibrary.org, using the parse-server module.

Here is the full Parse Server guide.

Set Up For Local Development

  1. Make sure you have Node 16.13.

    node --version

  2. Clone this repo and go into its directory, and install or update the dependencies (use npm, not yarn):

    npm install

  3. Install mongodb server

  4. Give mongodb a blank directory to work with (create it first if it doesn't exist), and run it:

    path/to/mongod.exe --dbpath c:\temp\mongodata

  5. Start up this server:

    npm start

    Or, to debug, open bloom-parse-server in vscode, F5 (Debug: Launch via NPM). Note that this sets the masterKey to "123", via an environment variable.

  6. Setup or update the schema:

    curl -X POST -H "X-Parse-Application-Id: myAppId" -H "X-Parse-Master-Key: 123" -d "{}" http://localhost:1337/parse/functions/setupTables

    You should get

    {"result":"SetupTables ran to completion."}

    and see the tables in the dashboard.

  7. Run Parse Dashboard:

    Go to http://localhost:1337/dashboard

    You will be required to log in.

    For write access:

    • username = "master"
    • password = the master key ("123")

    For read-only access:

    • username = "readonly"
    • password = the read-only master key ("ro")

Dashboard

See above for setting up the dashboard locally.

Public dashboards:

You will be required to log in.

For write access:

  • username = "master"
  • password = the master key

For read-only access:

  • username = "readonly"
  • password = the read-only master key

Sample Queries

curl -X POST \
  -H "X-Parse-Application-Id: myAppId" \
  -H "Content-Type: application/json" \
  -d '{}' \
  http://localhost:1337/parse/functions/hello

Deployment

Notes below on Azure Setup are relevant to deployment, but I wanted to separate out the exact steps a developer would go through to deploy changes.

develop branch

Once changes have been pushed to the develop branch,

  1. Go to the Azure portal (portal.azure.com). Access must be granted by LTOps.
  2. Open the bloom-parse-server-develop app service.
  3. Open Deployment slots.
    • Note that steps 2 and 3 can be skipped by opening the staging app service directly.
  4. Open bloom-parse-server-develop-staging.
  5. Open "Deployment Center" for the staging app service.
  6. Wait until your changes have been successfully deployed (check the status column).
  7. Repeat steps 2 and 3.
  8. Click Swap.
  9. Review settings changes to make sure no app service settings are getting changed accidentally.
  10. Click Swap.
  11. Deployment and restart of the service can take several minutes.
    • During this time, the dashboard and library part of the website will be down.

Note that changes in the develop branch will be automatically deployed to the unittest instance.

master branch

Once changes have been merged to the master branch,

  1. Follow the same steps as develop except the app service names are

    • bloom-parse-server-production
    • bloom-parse-server-production-staging

modifying the schema

Once the changes have been deployed, you can run the setupTables function in main.js to modify the schema. See notes there.

Azure Setup

We are running three different services:

  • bloom-parse-server-unittest
  • bloom-parse-server-develop
  • bloom-parse-server-production

Each is backed by a single mongodb at mongodb.com. This is how they were made:

  1. Create the mongodb on mongodb.com, making sure to select Azure and the same data center. Failing to do this increases response times.

  2. In Azure, create a new "Web App" App Service

  3. In Azure:App Service:Application Settings:App Settings, create these settings:

    • DATABASE_URI

    • APP_ID

      • you make this up.

    • MASTER_KEY

      • you make this up

    • SERVER_URL

      • https://[azure app service name].azurewebsites.net/parse

        • Note: Don't leave off that /parse in the SERVER_URL!

    • MAILGUN_API_KEY

      • mailgun.com "Sending API key" with description "parse-server"

    • EMAIL_BOOK_EVENT_RECIPIENT

      • the email address to receive new book notifications

    • EMAIL_REPORT_BOOK_RECIPIENT

      • the email address to receive book concern reports from bloomlibrary.org users

    • publicServerURL

      • probably obsolete now that we don't use the built-in email feature; currently the same as SERVER_URL

  4. In the App Service's Deployment settings, add a slot for staging and point that staging app service at this github repository, with the appropriate branch. A few minutes later, parse-server will be running on the staging app service. Note that Azure apparently does the npm install automatically, as needed. The staging app service automatically redeploys when github notifies it of a check in on the branch it is watching. The staging app service can then be swapped out with the live one. See the deployment section above for detailed steps.

  5. We never touch the schema using the Parse Dashboard or letting queries automagically add classes or fields. Instead, we set up the schema using a Cloud Code function setupTables. If you haven't set up the database already, follow instructions shown above under "Setup or update the mongodb Schema". Use Azure:App Service:Log stream to monitor progress. Note: During one setup, I found this can be flaky, perhaps because I jumped the gun. So instead I did the curl post for functions/testDB, which worked. Then I tried functions/setupTables again, and this time it worked.

  6. TODO: Backup, Logging setup.