jam-dev-utilities

(β˜… 535)

Lightweight utils set - fast and open-source. It's got cmd+k search & everything's client-side. No ads, your data stays local.

  • .dockerignore
  • .eslintrc.yml
  • .gitignore
  • .npmrc
  • .nvmrc
  • .prettierrc
  • components.json
  • config.jest.json
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • eslint.config.mjs
  • jest.config.ts
  • jest.setup.ts
  • LICENSE
  • next.config.mjs
  • package-lock.json
  • package.json
  • postcss.config.mjs
  • README.md
  • tailwind.config.ts
  • tsconfig.json

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/jamdotdev/jam-dev-utilities

Downloads the entire project code from GitHub to your computer.

cd jam-dev-utilities

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman python-setuptools

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
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 --build

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

docker compose up -d

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

docker build -t jam-dev-utilities .

Builds a runnable image based on the Dockerfile.

docker run -p 3000:3000 jam-dev-utilities

Runs the built image as an actual container.

βœ… 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.

4. 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.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

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.

Pulled directly from this repo's README.

// repository documentation