Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove duplication of prerequisites and testing in docs #1596

Merged
merged 3 commits into from
Aug 3, 2023
Merged

Remove duplication of prerequisites and testing in docs #1596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
319ee57
Remove duplication of prerequisites and testing in docs
BenSturmfels Jul 10, 2023
3767a90
Reinstate Ubuntu dependency
BenSturmfels Jul 28, 2023
420e0c5
Note differences to bin/rspec
BenSturmfels Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 10 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ All new backend code and React components should be well tested.

## Prerequisites

- Node 14
- Node.js 14 (we require 14 because we want the full internationalization built-in)
- Yarn
- PostgreSQL 10 or 12
- PostgreSQL 12 (10 probably works)
- Ruby 2.7
- Ubuntu 18.04, 20.04, 22.04 or equivalent
BenSturmfels marked this conversation as resolved.
Show resolved Hide resolved

Expand Down Expand Up @@ -66,17 +66,9 @@ and create an issue with your test design or run test sessions for

### Installation prep

Houdini requires a few pieces of software be installed, as well as some optional
pieces which make development much easier.

These include:

- PostgreSQL 12 (10 probably works)
- NodeJS 14 (we require 14 because we want the full internationalization built-in)
- Ruby 2.7.6

There a few optional tools which make working on Houdini
easier
Houdini requires a few pieces of software be installed as mentioned in
Prerequisites above, as well as some optional pieces which make development much
easier. The optional tools include:

- RBENV - rbenv is a version manager tool for the Ruby programming language on
Unix-like systems. It is useful for switching between multiple Ruby versions on
Expand Down Expand Up @@ -222,9 +214,13 @@ To verify everying is set up correctly, you can try running through the Ruby
test cases:

```bash
./bin/rails spec
bin/rails spec
```

(You can also run `bin/rspec`, which provides the full feature set of rspec such
as `--next-failure` and `--only-failures`, but does not set up a test database
when it doesn't exist.)

You should expect to see the output of the test execution,
including messages about pending test cases, and
eventually get the output to the effect of below:
Expand Down
17 changes: 0 additions & 17 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
# Getting Started

## Dependencies

---

You'll need to have the following dependencies installed:

* Ruby 2.7
* Node 14
* Yarn
* PostgreSQL 10 or 12

## Local Config

---
Expand Down Expand Up @@ -94,12 +83,6 @@ variable. For example:

`NODE_ENV=development bin/rake assets:precompile`

## Testing

---

Run `bundle exec rspec` to run test suite.

## Formatting

We are using [Standard](https://github.com/testdouble/standard) that is a
Expand Down