home-chore-tracker / backend Goto Github PK

To fully flex 💪 our backend chops, it would be cool to migrate from SQLite to PostgreSQL. Both environments where we have deployed our backend (Heroku + Unubo) have Postgres support so this shouldn't be too difficult to do.

Possible Solution:

• yarn add pg dotenv
• add production property to knexfile.js using process.env.DB_CONNECTION_STRING for connection prop
• define the following environment variables in production:
  • NODE_ENV=production
  • DB_ENV=production
  • DB_CONNECTION_STRING=<postgres_db_url>
  • JWT_SECRET=<some_secret_maybe_uuid>
• write a scripts/setup-database.js file that uses knex to do the same thing as the db:setup script but programmatically and using production env vars
• add a script in package.json: postinstall OR prestart: node scripts/setup-database.js

References:

• Heroku Postgres: https://www.heroku.com/postgres
• Unubo Postgres: https://docs.unubo.com/data-stores/postgresql/

Just some additional ideas / issues that need to be fleshed out:

Fix:

• :id path parameter in GET, PUT, and DELETE routes (source: https://swagger.io/docs/specification/describing-parameters/#path-parameters) - fixed in 20c4859

Add:

• examples to request params (source: https://swagger.io/docs/specification/2-0/adding-examples/)
• describe API responses (source: https://swagger.io/docs/specification/2-0/describing-responses/) - done in e34c79b