Skip to content

Commit

Permalink
fix(start.sh): add regtech-cleanup-api (#950)
Browse files Browse the repository at this point in the history
## Changes

- adds the new `regtech-cleanup-api` to `start.sh` and the README.md

## How to test this PR

1. Try running `yarn update` and see if it works now on checking and
updating `regtech-cleanup-api`
  • Loading branch information
billhimmelsbach authored Sep 20, 2024
1 parent 7045b12 commit 1e179c4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ A small app to explore Typescript, Vite and React.
1. Install Node v16.9+: `nvm install && nvm use`
1. Enable [corepack](https://yarnpkg.com/getting-started/install): `corepack enable`.
1. [Docker](https://docs.docker.com/get-docker/) engine version 1.13.0+ with docker compose version 3.0+ support needs to be installed to run all the containerized support services.
1. Have the five repos [sbl-frontend](https://github.com/cfpb/sbl-frontend), [sbl-project](https://github.com/cfpb/sbl-project), [regtech-user-fi-management](https://github.com/cfpb/regtech-user-fi-management), [sbl-filing-api](https://github.com/cfpb/sbl-filing-api/), and [regtech-mail-api](https://github.com/cfpb/regtech-mail-api) as **sibling directories**.
1. Have the six repos [sbl-frontend](https://github.com/cfpb/sbl-frontend), [sbl-project](https://github.com/cfpb/sbl-project), [regtech-user-fi-management](https://github.com/cfpb/regtech-user-fi-management), [sbl-filing-api](https://github.com/cfpb/sbl-filing-api/), [regtech-mail-api](https://github.com/cfpb/regtech-mail-api), and [regtech-cleanup-api](https://github.com/cfpb/regtech-cleanup-api) as **sibling directories**.

```
code-root
├── regtech-cleanup-api
├── regtech-mail-api
├── regtech-user-fi-management
├── sbl-filing-api
Expand All @@ -26,7 +27,7 @@ A small app to explore Typescript, Vite and React.
```

1. Make sure to `git pull` in each of the five directories to have the latest commits.
1. Make sure to `git pull` in each of the six directories to have the latest commits.
1. Create a `.env` based on the [ENV-GUIDE.md](./ENV-GUIDE.md).
1. At the `sbl-frontend` command line, run `yarn start`. This script uses `docker-compose` to start up Docker containers of all of the project components (User management, API, Frontend) to get you up and running.
1. At the `sbl-frontend` command line, run `yarn seed` to generate the necessary mock data in the backend systems.
Expand Down
2 changes: 1 addition & 1 deletion start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ if [ $? -ne 0 ]; then
fi

# Define the names of the directories to check
directories=("sbl-frontend" "sbl-project" "regtech-user-fi-management" "regtech-mail-api" "sbl-filing-api")
directories=("sbl-frontend" "sbl-project" "regtech-user-fi-management" "regtech-mail-api" "sbl-filing-api" "regtech-cleanup-api")

# Loop through the directories and check if each exists
for dir in "${directories[@]}"; do
Expand Down

0 comments on commit 1e179c4

Please sign in to comment.