Whispr

The anonymous, decentralised & end-to-end encrypted messaging application

🚧 Disclaimer: This project is still in development and is not yet ready for use 🚧

Setup

You will need:

• Node.js (latest LTS version)
• pnpm
• MongoDB

Instructions

1. Install dependencies with pnpm install. Note that you will need g++ and cmake to run a postinstall script so make sure you have those beforehand. On linux you can install them with sudo apt install g++ cmake.
2. Create a .env file in packages/api of the project with the following contents and replacing user, password, address, port and database with your MongoDB connection details:

DATABASEURL="mongodb://user:password@address:port/database?authSource=admin"

3. Generate the prisma client by running pnpm prisma:update in the root directory.
4. You can then either run the project in development mode with pnpm dev or by building the project with pnpm build and then running the production build with pnpm start.

Scripts

• pnpm run start - Run the project in production
• pnpm run dev - Run the project in development (with hot reloading)

License

This project is licensed under MIT and AGPL for the client and server respectively.

Credits

👤 Morgan Dilling "MJD"

• 💻 Website
• 🛠️ GitHub
• 📧 Email

Contributing

Contributions, issues and feature requests are welcome! Check out the Code of Conduct before contributing. For internal reasons, third-party pull requests won't be accepted until the Summer of 2024 (some exceptions may be made). Please contact me if you have any questions.