planner

(β˜… 104)

πŸ—“ the main codebar site

  • .dockerignore
  • .editorconfig
  • .gitignore
  • .haml-lint.yml
  • .overcommit.yml
  • .rspec
  • .rubocop.yml
  • .rubocop_todo.yml
  • .ruby-version
  • AGENTS.md
  • config.ru
  • CONTRIBUTING.md
  • crowdin.yml
  • docker-compose.override.yml.example
  • docker-compose.yml
  • Dockerfile
  • Gemfile
  • Gemfile.lock
  • LICENSE
  • Makefile
  • mise.local.toml.example
  • mise.toml
  • PARAMS_EXPECT_MIGRATION_ANALYSIS.md
  • Procfile
  • Rakefile
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/codebar/planner

Downloads the entire project code from GitHub to your computer.

cd planner

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Ruby Ruby is required to use gem.
brew install mise postgresql imagemagick

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

gem install bundler

Installs the package published on RubyGems directly.

βœ… 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 -d --build

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.

4. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
bundle install

Installs the Ruby libraries listed in the Gemfile.

bundle exec rake db:create db:prepare db:test:prepare

Type this command into your terminal and run it.

bundle exec rake setup:check

Type this command into your terminal and run it.

bundle exec rails server

Type this command into your terminal and run it.

bundle exec rspec

Type this command into your terminal and run it.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

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

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.
// repository documentation