Skip to content

jack3898/imageboard

Repository files navigation

Imageboard

Inspired by some online image boards (a lot being questionable 😂), I thought it would be a fun project to make my own. Make it great on mobile, written in TypeScript.

I plan to use this as more of a personal photo hosting solution for myself but others are welcome to try this out.

WIP

This project is a bit WIP! Rough edges are inevitable and big breaking changes are too.

Here is a super early sneak peek.

Install

Development via local

  • Clone this repo
  • Copy and rename ".envexample" to ".env" and fill in the correct values
  • Install Volta (https://volta.sh/)
    • ℹ️ Volta will read this application and auto-pick the best version of Node and npm to use that has been tested during development previously.
  • Run npm install on this package
  • Using Docker, run docker run --name postgres -v postgresdata:/var/lib/postgresql/data -e POSTGRES_PASSWORD=password -p 5432:5432 -d postgres, to spin up a database
    • ℹ️ For local dev, make sure the DB port is exposed to localhost
    • ℹ️ Update the values in the command if required to match your .env
  • Run npm run nx run @internal/server:migrate to initialize the database
  • Run npm run dev to launch all services
  • Visit the site on localhost:5173!

You will need to make an account on the sign up page to log in.

Prod build via Docker Compose

⚠️ Currently not working since migration from mongodb to postgres. Check back soon!

  • Clone this repo
  • Install Docker with Docker Compose
  • Copy and rename ".envexample" to ".env" and fill in:
    • NGROK_AUTHTOKEN
    • NGROK_DOMAIN
    • FRONTEND_PORT set to 80 (this is proxied so do not worry about no encryption)
  • Run docker build -t imageboard:latest -f .docker/Dockerfile . --build-arg UNSAFE_BACKEND_URL=https://your_ngrok_domain.com
  • Run docker-compose up
  • Visit the site!

Note: Reverse proxy config will come later

Note: K8s/Helm will come later

About

Another taggable imageboard project.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published