follow me on GitHub
BackendV2 is a from scratch rewrite of movie-web's backend using Nitro, and Prisma.
There are multiple supported ways to deploy BackendV2 based on your needs:
- 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- Build the backend
nixpacks build ./path/to/app --name my-app # my-app will be the container name aswell- Run the container
docker run my-appTip
If you use a tool like Dokploy or Coolify, NixPacks support is out of the box
Railpack is the successor to NixPacks, to run the backend via Railpack:
-
Install Railpack
-
Run BuildKit and set BuildKit host
docker run --rm --privileged -d --name buildkit moby/buildki
export BUILDKIT_HOST='docker-container://buildkit'- Build Backend
cd ./path/to/backend
railpack build .- Run Backend container
# Run manually
docker run -it backend
# Run in the background
docker run -d -it backend- Verify it's running
docker ps
# You should see backend, and buildkit running- Git clone the environment
git clone https://github.com/p-stream/backend.git
cd backend- Build the backend
npm install && npm run build- Run the backend
node .nitro/index.mjsTo run the backend you need environment variables setup
- Create .env file
cp .env.example .env- 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
We love contributors, it helps the community so much, if you are interested in contributing here are some steps:
- Clone the repo
git clone https://github.com/p-stream/backend.git
cd backend- Install Deps/Run the backend
npm install && npm run dev-
Set your Environment variables: check above as there is a guide for it!
-
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
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!