README.md

POW! — the privacy-first menstrual cycle journal

An open-source and end-to-end encrypted menstrual cycle journal for those who value privacy.

For a paid hosted version head on over to usepow.app.

Team

Core

• Senior dev: @raae [Github] · @raae [Twitter]
• Junior dev: @olavea [Github] · @OlaHolstVea [Twitter]
• and our Intern (6🦄) responsible for coffee and merch.

Contributors

• You?

Roadmap

A high level roadmap can be found in the roadmap issue and curren work can be found in the kanban board.

Demo

Todo:

• Set up demo.usepow.app

Screenshots

Todo:

• Take screenshots when demo is done

Contributing

Contributions are always welcome!

Todos:

• Create contributing.md
• Add/Create a code of conduct

Tech Stack

Client: Gatsby, Redux Toolkit, MaterialUI

Serverless: Netlify functions Express style

Backend: Userbase

Hosting: Netlify

Change Log

User facing changes are documented at usepow.app/changelog.

Deployment

Netlify is continuously deploying the main branch. It is also possible to trigger a build manually through the Netlify interface for those who have access.

Run Locally

Clone the project

  git clone [email protected]:raae/pow-app.git

Go to the project directory

  cd pow-app

Install dependencies

  npm install

Create `.env.development

  cp .env.example .env.development

Create accounts (Userbase etc) and add the variables necessary

• or ask @raae for her development ones

Start the server

  npm run develop

Feedback

If you have any feedback, please reach out to us at [email protected], start a discussion or create an issue.

Support

For support, email [email protected].

Sponsoring and the backstage

Check out the official POW! Backstage where you may buy us a coffee and more.

License

GNU GPLv3

---