james/roda-templates
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases 2 Wiki Activity

Expanded setup instructions in Readme.

Browse source
This commit is contained in:
James 2024-11-01 14:52:56 -05:00
parent 14f1f3daa6
commit 5a91e0d0dd
1 changed files with 37 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -14,6 +14,17 @@ Next Roda app template iterations will add database, then authentication.
## Setup ## 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 ### 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. 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 apt install ruby ruby-rack puma ruby-erubi ruby-tilt ruby-sequel ruby-sqlite3 rake
sudo gem install roda rack-unreloader 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' bundle config set --local path 'vendor/bundle'
cd my-project
bundle install 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 ## Run it
In the project root directory: In the project root directory: