vas3k.club

(โ˜… 933)

No bullshit IT community with private membership

  • .dockerignore
  • .editorconfig
  • .gitignore
  • .prettierrc
  • .python-version
  • docker-compose.production.yml
  • docker-compose.test.yml
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • Makefile
  • manage.py
  • pyproject.toml
  • README.md
  • setup.cfg
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/vas3k/vas3k.club

Downloads the entire project code from GitHub to your computer.

cd vas3k.club

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose up --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

make test # needs Postgres + Redis (easiest: docker compose up -d postgres redis)

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd frontend

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

python manage.py runserver

Starts the Django development server.

โœ… If it runs without errors and prints output in the terminal, it worked.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make run-dev # Django on :8000

Compiles the code based on the generated build configuration to produce an executable.

make run-queue # django-q workers

Compiles the code based on the generated build configuration to produce an executable.

make build-frontend # one-shot webpack build

Compiles the code based on the generated build configuration to produce an executable.

make migrate

Compiles the code based on the generated build configuration to produce an executable.

make test # backend

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation