Skip to content

Commit

Permalink
Add information about nodejs dependency.
Browse files Browse the repository at this point in the history
Closes #26
  • Loading branch information
dmitryrck committed Oct 28, 2022
1 parent 8099995 commit c4423a5
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,17 @@ Keeps track of membership to a society.
### Prerequisites

* Ruby (See `.ruby-version` for the version you have to install)
* Nodejs (for building assets, not required for production)
* Postgres

### Set-up

Clone this repository and run the following from the working directory:

bin/setup
yarn install

This will install dependencies and create a development and test database.
This will install dependencies, create a development and test database, and install nodejs dependencies.

### Start

Expand All @@ -25,6 +27,9 @@ To start a local server, run:

By default, this will start a local webserver on [http://localhost:3000](http://localhost:3000)

And

yarn build --watch

## Testing

Expand All @@ -42,8 +47,8 @@ Voting can be enabled by setting a `VOTE_URL_TEMPLATE` environment variable.

When set, a message will appear on the home page, and members will be able to get a unique link emailed to them through a form, which substitutes `%token%` in the URL template with each member's unique `voting_token`.

## Maintenance
## Deployment

### Upgrading Rails
To deploy this app you need Nodejs to compile the assets, but only Ruby to run the production server.

Follow the [Upgrading Rails Guide](https://guides.rubyonrails.org/upgrading_ruby_on_rails.html) which, as of May 10, 2020 suggests updating each Rails version incrementally and running `bin/rails app:update` to compare new defaults.
Heroku should identify you need those two dependencies, if it does not, please refer to the [Buildpacks](https://devcenter.heroku.com/articles/buildpacks) documentation.

0 comments on commit c4423a5

Please sign in to comment.