chemokita13 / beReal-api

A not official BeReal rest API in wich you can get all posts info, comment, upload a post...

Home Page:https://berealapi.fly.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BeReal restAPI (not official)

  • You can read API docs here (some routes are not working on swagger but only in it, yes in fetch, axios, postman...)
  • Is done by my BeReal client (but with some changes)
  • Only I want if you use it, is one star ⭐
  • Contact me for errors or explanation (my email is in my gh profile) or also in repo's discussions or iusses

How to use it

  • Just check the API docs made by swagger (but dont try to execute the examples, try it in postman or something similar)
  • API url is https://berealapi.fly.dev
  • The API is deployed in fly.io (thanks to them for the free hosting)

Local instalation

  • Download the repo:
git clone https://github.com/chemokita13/beReal-api
cd beReal-api

Docker

  • Build the image
docker build -t bereal-api .
  • Run it
docker run -p 3000:3000 bereal-api

Node (without docker)

  • Install packages and build
npm install
npm run build
  • Run it
npm run start:prod

And you will have it deployed in http://localhost:3000



Thanks for view!

About

A not official BeReal rest API in wich you can get all posts info, comment, upload a post...

https://berealapi.fly.dev


Languages

Language:TypeScript 99.4%Language:JavaScript 0.4%Language:Dockerfile 0.1%