bereal-wrapped

KO | EN

gitlite — search

#hacktoberfest #react #ai #go #machine-learning #rust #deep-learning #linux #docker #macos #security #mcp #openai #open-source

(★ 9)

📹 Generate a custom timelapse of all your memories from BeReal. (Fork from @theOneAndOnlyOne, huge shoutout for taking this on!)

bereal-wrapped Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BeReal Wrapped

**NOTE:** This is a fork of [BeReel](https://github.com/theOneAndOnlyOne/BeReel); please go give the original creator a star!

(Below is mostly quoted; deployment instructions and edits, TBD, are new.)

Miss the time-lapse recap feature from BeReal? Introducing BeReal Wrapped, a website (or CLI) interface to generate one.

* Fetch memories for a specific year
* Create a time-lapse that syncs with a `.wav` audio

## Usage

Ways to use this project.

### Web

Go to [this](https://bereal.michaeldemar.co) URL.

### CLI

Clone and set up the repository. (Instructions are below.)

Then run `make cli` from the root.

Eventually, this may be repackaged into a `pip` install.

### Docker (CLI)

Run the following command, after launching Docker.

```plaintext
docker pull michaelfromyeg/bereal-wrapped-cli

docker run -it --rm \
    -v /some/path/to/songs:/app/songs \
    -v /some/path/to/videos:/app/bereal/static/videos \
    --name bereal-wrapped-cli bereal-wrapped-cli
```

When it asks for a song path, you'll only be able to use `/app/content/song.wav`. I'm working on making it work with your local file system.

## Development

Follow these instructions to get your project up and running.

### Prerequisites

Make sure you have the following installed on your machine.

* [Python](https://python.org/downloads/) 3.11
* [pip](https://pip.pypa.io/en/stable/installation/)

If you are missing either (and are on macOS or Linux), run

```plaintext
brew install python@3.11
```

### Development Setup

First, create a virtual environment.

```plaintext
python3.11 -m venv env

source env/bin/activate
```

Run all required libraries and run the app:

```bash
pip install --upgrade pip
pip install -r requirements/dev.txt

mypy --install-types

make run
```

The Flask app will be available on [http://localhost:5000](http://localhost:5000). Multiple folders will be created to pull image data from your memories.

### Docker Setup

#### Docker Setup, Web

First, run `docker build -f Dockerfile -t bereal-wrapped-server .`.

Then, run it locally with `docker run -p 5000:5000 -it --rm --name bereal-wrapped-server bereal-wrapped-server`.

#### Docker Setup, CLI

First, run `docker build -f Dockerfile.cli -t bereal-wrapped-cli .`.

Then, run it locally with the following command.

```plaintext
docker run -it --rm \
    -v /some/path/to/songs:/app/songs \
    -v /some/path/to/videos:/app/bereal/static/videos \
    --name bereal-wrapped-cli bereal-wrapped-cli

# e.g.,

docker run -it --rm \
    -v ~/code/bereal-wrapped/content/songs:/app/songs \
    -v ~/code/bereal-wrapped/export:/app/bereal/static/videos \
    --name bereal-wrapped-cli bereal-wrapped-cli
```

To push the image, do the following.

```plaintext
docker tag bereal-wrapped-cli:latest michaelfromyeg/bereal-wrapped-cli:latest

docker push michaelfromyeg/bereal-wrapped-cli
```

### Deployment

Opted for Digital Ocean. Cheap, easy, and supports `docker-compose`.

### Project Structure

* `main.py` the main flask app and drives webpage and API requests
* `combine_images.py` processes photos to be used for the slideshow
* `generate_slideshow.py` rendering time-lapse video and audio

## Remarks

This project wouldn't be here without the amazing work by [chemokita13](https://github.com/chemokita13/beReal-api). Please give him a star.

This app is to be run **locally** as to comply with user security laws and privacy. Under no cases does this app store metadata elsewhere.

The app utilizes a third-party API which may not follow the terms and conditions set by BeReal; all videos and images produced from this app are to be considered personal use and should only use accounts owned by the user.

If BeReal has particular issues with this project, do not hesitate to reach out to myself or the downstream fork's creator.

## License

Distributed under the MIT License. See `LICENSE` for more information.

bereal-wrapped

bereal-wrapped Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bereal-wrapped

bereal-wrapped Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README