Skip to content

Commit

Permalink
Readme updates from a first time installer (#213)
Browse files Browse the repository at this point in the history
* README updates.

I had some challenges getting things up and running, so here are some
README updates. Curated over a lovely session on Discord.

* .gitignore RubyMine files.

If that's okay to land in the repo? ❤️
  • Loading branch information
bjhess authored Oct 26, 2024
1 parent 9d261e1 commit 3a48ae7
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@ docs/.bridgetown-cache

.DS_Store

# Ignore RubyMine files.
.idea/

/exports
/internal
/cdn
Expand Down
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,20 @@ We have a test suite using Ruby on Rails and is intended to
provide a good demonstration of how this package can hook
into ActionText.

Contributions should be made on a feature branch in a
forked repository.

### Prerequisites

- Ruby 3.1.2
- Rails 7.0.4
- PNPM (`npm install -g pnpm`)
- Playwright
- Playwright (`npm install -g playwright`)
- Node >= 16
- Docker (Used to run a simulated S3 server)
- Overmind (Preferred, not needed)
- A Docker virtualizer ([Orbstack](https://orbstack.dev/) or
[Docker Desktop](https://www.docker.com/products/docker-desktop/))
- Overmind (Preferred, not needed `npm install -g overmind`)

### Installation

Expand All @@ -42,9 +47,19 @@ pnpm run setup

### Running the server

The easiest way to run the server is using [Overmind](https://github.com/DarthSim/overmind)
The easiest way to run the server is using [Overmind](https://github.com/DarthSim/overmind).
First start up your Docker virtualizer, then in two termainals…

Terminal 1:

```bash
pnpm run start
```

Terminal 2:

```bash
cd tests/rails
overmind start -f Procfile.dev
```

Expand All @@ -53,7 +68,7 @@ Then navigate to `localhost:5100`

#### Without Overmind

To run the server without overmind do the following in
To run the server without Overmind do the following in
seperate terminals:

```bash
Expand Down

0 comments on commit 3a48ae7

Please sign in to comment.