From 5a91e0d0ddc6a74bcac0f568f4946b599cbddcbb Mon Sep 17 00:00:00 2001 From: james Date: Fri, 1 Nov 2024 14:52:56 -0500 Subject: [PATCH] Expanded setup instructions in Readme. --- README.md | 40 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 37 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 159cce8..ca3abc2 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,17 @@ Next Roda app template iterations will add database, then authentication. ## Setup +### Get git + +``` +sudo apt install git +git config --global user.email "myemail@gmail.com" +git config --global user.name "Full Name" +git config --global credential.helper "cache" + +git clone https://path/to/project.git +``` + ### Prereq installs Will need ruby; install it via package manager or a ruby manager like rbenv/ruby-build. Will need the roda gem, and then an application server such as puma (recommended), gunicorn, or passenger. My examples will use system ruby and puma. @@ -25,18 +36,41 @@ With this example, will basically just ignore the project's Gemfile. Debian 12 ``` sudo apt install ruby ruby-rack puma ruby-erubi ruby-tilt ruby-sequel ruby-sqlite3 rake sudo gem install roda rack-unreloader + +cd my-project ``` -#### Option 2: Bundler +#### Option 2a: Bundler system package -Run the bundle command from the project's root directory +Run the bundle install command from the project's root directory ``` -sudo apt install ruby ruby-bundler +sudo apt install ruby ruby-bundler ruby-dev gcc pkgconf make g++ bundle config set --local path 'vendor/bundle' + +cd my-project bundle install ``` +#### Option 2b: Bundler system gem (recommended) + +Similar to above but might as well use the gem install to get the latest bundler. The Debian apt packaged bundler is currently a bit outdated and missing some features compared to the latest. + +``` +sudo apt install ruby ruby-dev gcc pkgconf make g++ +echo 'gem: --no-document' >> ~/.gemrc +sudo cp ~/.gemrc /root/ +sudo gem install bundler +bundle config set --local path 'vendor/bundle' + +cd my-project +bundle install +``` + +#### Option 3: Rbenv Ruby + +Todo + ## Run it In the project root directory: