Skip to content

(Backend v2) OpenBackend, based on movie-web's backend, but with some secret sauce for recommendations, and more features to come

Notifications You must be signed in to change notification settings

p-stream/backend

Repository files navigation

BackendV2

follow me on GitHub

BackendV2 is a from scratch rewrite of movie-web's backend using Nitro, and Prisma.

Deployment

There are multiple supported ways to deploy BackendV2 based on your needs:

NixPacks

  1. Install NixPacks with
# Mac
brew install nixpacks
# POSIX (mac, linux)
curl -sSL https://nixpacks.com/install.sh | bash
# Windows
irm https://nixpacks.com/install.ps1 | iex
  1. Build the backend
nixpacks build ./path/to/app --name my-app # my-app will be the container name aswell
  1. Run the container
docker run my-app

Tip

If you use a tool like Dokploy or Coolify, NixPacks support is out of the box

Railpack

Railpack is the successor to NixPacks, to run the backend via Railpack:

  1. Install Railpack

  2. Run BuildKit and set BuildKit host

docker run --rm --privileged -d --name buildkit moby/buildki

export BUILDKIT_HOST='docker-container://buildkit'
  1. Build Backend
cd ./path/to/backend
railpack build .
  1. Run Backend container
# Run manually
docker run -it backend
# Run in the background
docker run -d -it backend
  1. Verify it's running
docker ps
# You should see backend, and buildkit running

Manually

  1. Git clone the environment
git clone https://github.com/p-stream/backend.git
cd backend
  1. Build the backend
npm install && npm run build
  1. Run the backend
node .nitro/index.mjs

Setup your environment variables:

To run the backend you need environment variables setup

  1. Create .env file
cp .env.example .env
  1. Fill in the values in the .env file

Note

for postgres you may want to use a service like Neon or host your own with docker, to do that just look it up

Contributing

We love contributors, it helps the community so much, if you are interested in contributing here are some steps:

  1. Clone the repo
git clone https://github.com/p-stream/backend.git
cd backend
  1. Install Deps/Run the backend
npm install && npm run dev
  1. Set your Environment variables: check above as there is a guide for it!

  2. Make your changes! Go crazy, so long as you think it is helpful we'd love to see a Pull Request, have fun, this project is FOSS and done in my our maintainers free time, no pressure, just enjoy yourself

Philosophy/Habits for devs

Here is a general rule of thumb for what your changes and developments should look like if you plan on getting it merged to the main branch:

  • Use Prettier & ESLint: We aren't going to be crazy if it's not well formatted but by using the extensions it keeps our code consistent, which makes it a lot easier for maintainers to help merge your code
  • Keep it minimal, things like Email are out of the question, we want to keep it small, if you think that it's really needed, make an issue on our GitHub to express your interest in it, and a maintainer will confirm or deny whether we would merge it
  • Understand our tech stack, this is a generic piece of advice but if you haven't use NitroJS for example, read their docs and make sure you're familiar with the framework, it makes your code quality much better, and makes reviewing much easier

Star this repo and please follow me on GitHub!

About

(Backend v2) OpenBackend, based on movie-web's backend, but with some secret sauce for recommendations, and more features to come

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

No packages published

Contributors 13