Skip to content

Commit

Permalink
docs: update readme w extension instructions (bloom-housing#4433)
Browse files Browse the repository at this point in the history
  • Loading branch information
emilyjablonski committed Nov 25, 2024
1 parent c90836d commit 931484a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ yarn install

Configuration of each app and service is read from environment variables. There is an `.env.template` file in each app or service directory that must be copied to `.env` (or equivalent). Some keys are purposefully missing for security concerns and are internally available.

The [CSS variable autocomplete plugin](https://marketplace.visualstudio.com/items?itemName=vunguyentuan.vscode-css-variables&ssr=false#overview) will pull in all CSS variable definitions from ui-seeds for autocompletion (more setup instructions in the [public README](https://github.com/bloom-housing/bloom/blob/main/sites/public/README.md)).

The [CSS module autocomplete plugin](https://marketplace.visualstudio.com/items?itemName=clinyong.vscode-css-modules) which provides autocomplete for CSS module files.

### Running a local test server

```
Expand Down
28 changes: 28 additions & 0 deletions sites/public/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,34 @@ All from within `sites/public`:
- Copy the `.env.template` to `.env` and edit variables appropriate to your local environment
- `yarn dev:all` will start up the backend at port 3100 and the public app at port 3000

## Recommended Extension

If you're using VSCode, the [CSS variable autocomplete plugin](https://marketplace.visualstudio.com/items?itemName=vunguyentuan.vscode-css-variables&ssr=false#overview) will pull in all CSS variable definitions from ui-seeds for autocompletion.

After installing the extension, ⌘⇧P Open User Settings (JSON), and add the following configuration:

```
"cssVariables.blacklistFolders": [
"**/.git",
"**/.svn",
"**/.hg",
"**/CVS",
"**/.DS_Store",
"**/bower_components",
"**/tmp",
"**/dist",
"**/tests",
"**/node_modules/^(?!@bloom-housing).*/m"
],
"cssVariables.lookupFiles": [
"**/*.css",
"**/*.scss",
"**/*.sass",
"**/*.less",
"node_modules/@bloom-housing/ui-seeds/src/**/*.scss"
]
```

## Tests

For our public application, our tests currently consistent of a Cypress integration test suite. We are looking to add React Testing Library unit tests soon.
Expand Down

0 comments on commit 931484a

Please sign in to comment.