Mood Tracker Application (Twilio Hackathon Submission)
About
Name TBD: Twilio Hackathon Project Entry using SMS and a web app to track mood trends while in quarantine and allowing for ways, via SMS, to reach out to others for help
Set up
Requirements
- Node.js
- PostgreSQL
- A Twilio account - sign up
Twilio Account Settings
This application should give you a ready-made starting point for writing your own appointment reminder application. Before we begin, we need to collect all the config values we need to run the application:
| Config Value | Description |
|---|---|
| Account Sid | Your primary Twilio account identifier - find this in the Console. |
| Auth Token | Used to authenticate - just like the above, you'll find this here. |
| Phone number | A Twilio phone number in E.164 format - you can get one here |
Local development
After the above requirements have been met:
- Clone this repository and
cdinto it
git clone git@github.com:jaysonjphillips/mood-tracker-app.git
cd mood-tracker-app- Install dependencies
yarn- Set your environment variables
yarn bootstrap See Twilio Account Settings to locate the necessary environment variables.
- Run the application
yarn develop- Navigate to http://localhost:3000
That's it!
Coding Standards
TODO:
- Add specific linter strategies and approaches here.
- Add command for running all linting/code checks and indivudual ones as well
Tests
You can run the tests locally by typing:
yarn testCloud deployment
Additionally to trying out this application locally, you can deploy it to a variety of host services. Here is a small selection of them.
Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.
| Service | |
|---|---|
| Heroku |  |
| Glitch |  |
| Zeit |
Contributing
TBD (TODO: Establish Code of Conduct, Contributors Policy)
License
Disclaimer
No warranty expressed or implied. Software is as is.