Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raae/pow-app

Take charge of your menstrual cycle with POW! — the privacy-first menstrual cycle journal
https://github.com/raae/pow-app

femtech gatsbyjs indiehackers

Last synced: 3 months ago
JSON representation

Take charge of your menstrual cycle with POW! — the privacy-first menstrual cycle journal

Awesome Lists containing this project

README

        

# 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](usepow.app).

[![AGPL License](https://img.shields.io/badge/license-AGPLv3-blue.svg)](http://www.gnu.org/licenses/agpl-3.0)

## Team

### Core

- Senior dev: [@raae [Github]](https://www.github.com/raae) · [@raae [Twitter]](https://www.twitter.com/raae)
- Junior dev: [@olavea [Github]](https://www.github.com/olavea) · [@OlaHolstVea [Twitter]](https://www.twitter.com/OlaHolstVea)
- and our Intern (6🦄) responsible for [coffee and merch](https://ko-fi.com/usepow).

### Contributors

- You?

## Roadmap

A high level roadmap can be found in the
[roadmap issue](https://github.com/raae/pow-app/issues/170)
and curren work can be found in [the kanban board](https://github.com/raae/pow-app/projects/3).

## Demo

Todo:

- [ ] Set up [demo.usepow.app](https://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](https://www.gatsbyjs.com/), [Redux Toolkit](https://redux-toolkit.js.org/), [MaterialUI](https://material-ui.com/)

**Serverless:** Netlify functions [Express style](https://www.serverless.com/blog/serverless-express-rest-api)

**Backend:** [Userbase](https://userbase.com/)

**Hosting:** [Netlify](https://www.netlify.com/)

## Change Log

User facing changes are documented at [usepow.app/changelog](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

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

Go to the project directory

```bash
cd pow-app
```

Install dependencies

```bash
npm install
```

Create `.env.development

```bash
cp .env.example .env.development
```

Create accounts (Userbase etc) and add the variables necessary

- or ask @raae for her development ones

Start the server

```bash
npm run develop
```

## Feedback

If you have any feedback, please reach out to us at [email protected], start [a discussion](https://github.com/raae/pow-app/discussions) or [create an issue](https://github.com/raae/pow-app/issues).

## Support

For support, email [email protected].

## Sponsoring and the backstage

Check out the official [POW! Backstage](https://ko-fi.com/usepow) where you may buy us a coffee and more.

## License

[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0)

---

![Logo](https://my.usepow.app/logo.png)