Nutshell app

Repository protocols

• Never push directly to the master branch
  • development merges into staging
  • staging merges into master
  • Both are hooked up to CI through GH actions
• All merges are done through pull-requests
  • Merges are never done by the code author
• Plain text file formats are strongly preferred ( markdown > docx, svg > ai)

Requirements

• Node.js version 12 (use nvm)
• Expo client

Usage

• Clone this repo
• Install dependencies with npm i
• Install npm i -g expo-cli
• Log into expo with expo login
• Start with npm run android/ios/web.

To preview app on phone, use the Expo app.

Testing: npm test based on Jest.

To implement

Based on your app you will have to edit:

• modules/push.js to implement savePushToken based on your needs

While developing

• npm run refresh to kill expo client through adb on Android
• npm run stage to deploy to staging channel

Environment variables

Environment variables in .env file are mandatory. Empty strings are allowed (and disable the service). You may use a separate .env.production. There is an overview of variables in the .env.example file.

Notes

Questions I want to ask the data:

• What Nutshells have my friends written that I have not yet read?
• Who do I follow?
• Who follows me?
• Give me all my Nutshells