Skip to content

Commit

Permalink
Tweaks to text.
Browse files Browse the repository at this point in the history
  • Loading branch information
epugh committed Dec 2, 2024
1 parent 7fc150f commit b61d355
Showing 1 changed file with 8 additions and 22 deletions.
30 changes: 8 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ Below is information related to developing the Quepid open source project, prima
- [IV. Debugging](#iv-debugging)
- [Debugging Ruby](#debugging-ruby)
- [Debugging JS](#debugging-js)
- [Webpacker](#webpacker)
- [Convenience Scripts](#convenience-scripts)
- [Rake](#rake)
- [Thor](#thor)
Expand Down Expand Up @@ -191,7 +190,9 @@ Runs tests for the Angular side. There are two modes for the karma tests:
* Single run: `bin/docker r rails karma:run`
* Continuous/watched run: `bin/docker r bin/rake karma:start`

**Note:** The karma tests require the assets to be precompiled, which adds a significant amount of time to the test run. If you are only making changes to the test/spec files, then it is recommended you run the tests in watch mode (`bin/docker r bin/rake karma:start`). The caveat is that any time you make a change to the app files, you will have to restart the process (or use the single run mode).
**Note:** The karma tests require the assets to be precompiled, which adds a significant amount of time to the test run.
If you are only making changes to the test/spec files, then it is recommended you run the tests in watch mode (`bin/docker r bin/rake karma:start`).
The caveat is that any time you make a change to the app files, you will have to restart the process (or use the single run mode).

### Rubocop

Expand Down Expand Up @@ -298,20 +299,6 @@ JavaScript and CSS dependencies via the Rails Asset pipeline. If you are debug
you will want individual files. So replace `//= require sprockets` with `//= require bootstrap-sprockets`.


### Webpacker
To use webpacker, that will compile javascript code into packs and will load changes faster,
you need to

```bash
bin/rails webpacker:install
```

Prior to that I had to install:

```bash
brew install mysql
```

### Debugging Splainer and other NPM packages

`docker-compose.override.yml.example` can be copied to `docker-compose.override.yml` and use it to override environment variables or work with a local copy of the splainer-search JS library during development defined in `docker-compose.yml`. Example is included. Just update the path to `splainer-search` with your local checkout! https://docs.docker.com/compose/extends/
Expand Down Expand Up @@ -516,14 +503,13 @@ You will see a updated `Gemfile.lock`, go ahead and check it and `Gemfile` into

## How does the Frontend work?

We use Angular 1 for the front end, and as part of that we use the `angular-ui-bootstrap` package
for all our UI components. This package is tied to Bootstrap version 3. We import the Bootstrap 3
CSS directly via the file `bootstrap.css`.
We use Angular 1 for the core interactive application, and as part of that we use the `angular-ui-bootstrap` package for all our UI components.
This package is tied to Bootstrap version 3.
We import the Bootstrap 3 CSS directly via the file `bootstrap3.css`.

For the various Admin pages, we actually are using Bootstrap 5! That is included via the `package.json` using NPM. See `admin.js` for the line `//= require bootstrap/dist/js/bootstrap.bundle` which is where we are including.
For the rest of Quepid, we use Bootstrap 5! That is included via the `package.json` using NPM. See `admin.js` for the line `//= require bootstrap/dist/js/bootstrap.bundle`.

We currently use Rails Sprockets to compile everything, but do have dreams of moving the JavaScript
over to Webpacker.
We currently use Rails Sprockets to compile everything, but do have dreams of moving to Propshaft, and maybe js-bundling.

## Fonts

Expand Down

0 comments on commit b61d355

Please sign in to comment.