About

Umamin is an open-source platform for sending and receiving anonymous confessions! Each user can create a unique link to which others could send anonymous messages! Start receiving confessions and messages →

Contributing

If you like this project, please consider giving it a star! Want to contribute? Make sure to review our code of conduct.

Contributor List

Contributing Guide

1. Fork this repository and clone your fork.
2. Create a new branch for your changes:

$ cd your_cloned_fork
$ git checkout dev
$ git checkout -b my-new-branch

3. Create a .env in apps/web file with this content:

Adjust the DATABASE_URL to your local MySQL database. Guide →

DATABASE_URL="mysql://johndoe:randompassword@localhost:3306/mydb"
NEXT_PUBLIC_GQL_ENDPOINT="http://localhost:3000/api/graphql"

NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET="mysupersecretkey"

4. Create a .env in packages/db file with this content:

DATABASE_URL="mysql://johndoe:randompassword@localhost:3306/mydb"

5. (optional) MySQL image with docker:

yarn docker:up # start up a MySQL image
yarn docker:down # stop MySQL image

6. Sync database schema:

yarn workspace @umamin/db prisma db push

Or run a migration. Guide →

7. To run locally:

# Only use yarn as your package manager
$ yarn
$ yarn dev

8. Commit your changes and push your branch:

$ git add .
$ git commit -m "chore: some changes"
$ git push origin HEAD

9. Submit a pull request on the dev branch. (resolve conflicts if present)

License

Licensed under the GPL-3.0 license.

---

Google Play and the Google Play logo are trademarks of Google LLC.