https://github.com/max-programming/whim
Whim is a simple and secure app for sharing secret messages anonymously. The messages are encrypted and are vanished after being read. No account required.
https://github.com/max-programming/whim
Last synced: 6 months ago
JSON representation
Whim is a simple and secure app for sharing secret messages anonymously. The messages are encrypted and are vanished after being read. No account required.
- Host: GitHub
- URL: https://github.com/max-programming/whim
- Owner: max-programming
- License: mit
- Created: 2025-07-03T19:39:09.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-08-02T14:25:44.000Z (6 months ago)
- Last Synced: 2025-08-02T16:28:31.341Z (6 months ago)
- Language: TypeScript
- Homepage: https://whim.day
- Size: 821 KB
- Stars: 18
- Watchers: 0
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Whim - The Secret Sharing App
Whim is a simple and secure app for sharing secret messages anonymously. The messages are end-to-end encrypted and are vanished after being read. No account required.
You can try it out at [whim.day](https://whim.day)
## Running it locally
### Option 1: With Docker (No Bun installation required)
If you prefer not to install Bun on your machine, you can run the entire development environment using Docker:
#### Prerequisites
- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
#### Installation
Clone the repository:
```bash
git clone https://github.com/max-programming/whim.git
cd whim
```
#### Set up environment variables
```bash
cp .env.sample .env
```
Edit `.env` with your preferred values for development.
#### Run with Docker
```bash
docker-compose -f docker-compose.dev.yml up
```
The app will be available at `http://localhost:3000`. Your code changes will be automatically reflected thanks to volume mounting.
To stop the development server:
```bash
docker-compose -f docker-compose.dev.yml down
```
### Option 2: Local Development with Bun
#### Prerequisites
- [Bun](https://bun.sh/) (for package management and running the app)
> Or Node with NPM, Yarn or PNPM is also fine
#### Installation
Clone the repository and install dependencies:
```bash
git clone https://github.com/max-programming/whim.git
cd whim
bun install
```
#### Fill in the .env file
```bash
cp .env.sample .env
```
#### Run the migrations
```bash
bun run db:migrate
```
#### Running the App
Start the development server:
```bash
bun run dev
```
The app will be available at `http://localhost:3000` (or your configured port).
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under the MIT License.