https://github.com/jabolol/raven
See your friends BeReals without posting and more!
https://github.com/jabolol/raven
bereal deno typescript
Last synced: 12 days ago
JSON representation
See your friends BeReals without posting and more!
- Host: GitHub
- URL: https://github.com/jabolol/raven
- Owner: Jabolol
- License: mit
- Created: 2023-08-05T14:48:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T19:01:27.000Z (over 1 year ago)
- Last Synced: 2024-05-02T13:14:48.620Z (over 1 year ago)
- Topics: bereal, deno, typescript
- Language: TypeScript
- Homepage: https://raven.deno.dev/
- Size: 19.6 MB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# raven
A tweaked custom [`BeReal`](https://bereal.com/) client built from the ground up
with a focus on features and performance.
# logging in
Currently, raven is hosted on [Deno Deploy](https://deno.com/deploy) at the URL
[raven.deno.dev](https://raven.deno.dev). You can use it by visiting that URL
and logging in with your BeReal account. You'll need to have a BeReal account to
use raven.
# features
- [x] see others' BeReals **without** posting your own
- [x] **screenshot** without notifying the other person
- [x] save the **original** BeReal and realMojis to your device
- [x] user **profiles** with detailed information
- [x] worldwide **usage** statistics per route
- [x] profile tab with **all** of your friends and realMojis
- [x] **dark** and **light** mode support
- [x] **responsive** design for mobile and desktop
- [x] **fast** and **lightweight** (100 lighthouse score)
- [x] react to **all** BeReals at once (does not overwrite your reactions)
# screenshots
# development
Install deno if you haven't already:
```sh
curl -fsSL https://deno.land/x/install/install.sh | sh
```
Clone the repo:
```sh
git clone git@github.com:Jabolol/raven.git .
```
Create and fill in the `.env` file:
```sh
# GitHub API token for fetching the commit changelog
GITHUB_TOKEN=
# Google Analytics tracking ID (Optional)
GA4_MEASUREMENT_ID=
```
Run the development server:
```sh
deno task start
```
Format and lint the code before committing:
```sh
deno fmt && deno lint
```
# license
This project is licensed under the [MIT License](./LICENSE). A copy of the
included license should be provided alongside the source code. If not, you can
find it [here](https://opensource.org/licenses/MIT).