Skip to content

Commit

Permalink
Some notes for future devs
Browse files Browse the repository at this point in the history
  • Loading branch information
avdata99 committed Oct 2, 2023
1 parent 78288f0 commit 4a7a807
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions script/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Set up this project for local development

This project requires Ruby to run so you'll need to install it.
With Ubuntu, this will be:

```bash
sudo apt install ruby ruby-dev
```

Then you'll need to install the dependencies.
To avoid permission error and not use sudo for the next commands, you can install the gems in your home directory:

```bash
export OD_GEMS=$HOME/.odgems
export GEM_HOME=$OD_GEMS/ruby/2.7.0
export PATH=$OD_GEMS/bin:$PATH
bundle config set --local path "$OD_GEMS"
bundle install
```

And run locally overriding the `host` config value:

```bash
bundle exec jekyll serve --watch --incremental --trace --host=localhost
```

0 comments on commit 4a7a807

Please sign in to comment.