https://github.com/n4ze3m/real-me
Open source BeReal
https://github.com/n4ze3m/real-me
bereal
Last synced: 3 months ago
JSON representation
Open source BeReal
- Host: GitHub
- URL: https://github.com/n4ze3m/real-me
- Owner: n4ze3m
- License: mit
- Created: 2022-10-03T18:00:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T04:27:58.000Z (over 2 years ago)
- Last Synced: 2025-01-21T01:15:35.320Z (5 months ago)
- Topics: bereal
- Language: TypeScript
- Homepage: https://real-me.vercel.app
- Size: 491 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Real Me
> Currently demo is not working
Just another social network. Inspired from BeReal
## Features
- [x] User registration
- [x] User login
- [x] User profile
- [x] Upload Real
- [x] Real feed both friends and public
- [x] Friend request
- [x] Friend list
- [x] Notifications
- [] Search
- [] User profile edit
## Getting Started
In order to run this project you need to have Supabase and Courier API keys. You can get them from [Supabase](https://supabase.io) and [Courier](https://courier.com).
### Prerequisites
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/)
- [Supabase](https://supabase.io)
- [Courier](https://courier.com)
- [Redis](https://redis.io/)
### Installing
*Note*: For detailed instructions on how to install and run this project, please refer to the [SETUP](SETUP.md) file.
1. Clone the repository
```bash
git clone https://github.com/n4ze3m/real-me.git
```
2. Install dependencies
```bash
yarn
```
3. Create a `.env` file from `.env.example` and fill in the required values
```bash
cp .env.example .env
```
4. Start the development server
```bash
yarn dev
```
## Built With
- [Next.js](https://nextjs.org/)
- [Supabase](https://supabase.io)
- [Courier](https://courier.com)
# License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
# Contributing
If you want to contribute to this project, please read the [CONTRIBUTING](CONTRIBUTING.md) file for details.
# Attribution
This project is inspired by [BeReal](https://bereal.com) and is not affiliated with them in any way.