https://github.com/benji6/moodtracker
A serverless and offline-first PWA that lets you track your mood
https://github.com/benji6/moodtracker
journal mindfulness mood-journal mood-tracker moodjournal moods moodtracker offline progressive-web-app pwa serverless tracker wellbeing
Last synced: 10 days ago
JSON representation
A serverless and offline-first PWA that lets you track your mood
- Host: GitHub
- URL: https://github.com/benji6/moodtracker
- Owner: benji6
- License: mit
- Created: 2020-04-07T07:22:55.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T12:55:24.000Z (7 months ago)
- Last Synced: 2024-09-17T05:33:58.913Z (7 months ago)
- Topics: journal, mindfulness, mood-journal, mood-tracker, moodjournal, moods, moodtracker, offline, progressive-web-app, pwa, serverless, tracker, wellbeing
- Language: TypeScript
- Homepage: https://moodtracker.link
- Size: 15.1 MB
- Stars: 44
- Watchers: 6
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MoodTracker
[](https://github.com/benji6/moodtracker/actions/workflows/main.yml)
[](https://app.netlify.com/sites/benji6-moodtracker/deploys)
## About
MoodTracker is a free and open source web app that aims to help you understand yourself better. Track your emotional landscape, keep a mood journal, time your meditations, keep a meditation log and gain new insights into yourself. It's simple to use, works offline and because it runs in your browser you can use it across all your devices!
[Check it out here](https://moodtracker.link)
The MoodTracker UI was built using a component library I made called [Eri](https://github.com/benji6/eri).
## Getting started
### Dependencies required on host machine
- [Node.js](https://nodejs.org) (version specified in [.nvmrc](/client/.nvmrc))
- [Python](https://www.python.org) (latest version 3.x)
- [Poetry](https://python-poetry.org/docs/) (latest version 1.x)
### Install project dependencies
```sh
make init
```
### Run frontend locally
```sh
make start
```
### Test application locally
You will need to be running the client locally on the default port for the end-to-end tests to pass and you will need credentials for a registered user on the platform that you can use to set the `CYPRESS_MOODTRACKER_TEST_USER_EMAIL` and `CYPRESS_MOODTRACKER_TEST_USER_PASSWORD` environment variables.
```sh
make test
```
### Deploy
#### Backend and infrastructure
Majority of the infrastructure is managed with AWS CloudFormation (via [Troposphere](https://troposphere.readthedocs.io)). Firebase, secrets and a few AWS things that aren't well supported have been done manually.
```sh
make deploy
```
**N.B. making changes to the API doesn't trigger a new deployment, but you can trigger a manual deployment by copying the value of the `ApiGatewayDeployCommand` output and running that.**
#### UI
Continuously deployed with [Netlify](http://netlify.com).
**N.B. Icons are stored in version control and are generated by running `npm run icons` in the `/client` dir.**