Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HendrikSchmidt committed May 15, 2024
1 parent b012f43 commit a5907a3
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,23 +109,22 @@ npm run start --workspace="packages/<app-name>"
Do the following steps to add a new application to this Monorepo.

1. Create a new directory under `packages/`
2. Add the application code there
3. Depending on the tack stack, make sure that:
2. Depending on the tech stack, make sure that:
- shared dependencies are configured in the top-level [package.json](./package.json)
- the `tailwind.config.js` uses the top-level [tailwind.preset.js](./tailwind.preset.js)
- the `tsconfig.json` extends the top-level [tsconfig.base.json](./tsconfig.base.json)
- the `postcss.config.cjs` uses the
4. The new project needs at least:
3. The new project needs at least:
- a `package.json` which defines the project specific dependencies an implements the following scripts:
- `build`: build the application for production
- `test`: run unit tests
- `test:e2e`: run e2e tests
- `test:a11y`: run a11y tests
- `tests`: run all tests
- a `Dockerfile` which builds a Docker container from your application (and if needed a `Dockerfile.dockerignore`)
4. Add the application code. It should now be able to import shared components.
5. Before proceeding with the next step, make sure the infrastructure of the application is in place.
Follow the steps in the [digitalcheck-apps-infra README.md](https://github.com/digitalservicebund/digitalcheck-apps-infra).
6. Add the new project to the list in the [pipeline.yml](./.github/workflows/pipeline.yml) workflow at the `build-and-deploy` step.
6. Add the new package to the list in the [pipeline.yml](./.github/workflows/pipeline.yml) workflow at the `build-and-deploy` step.
7. You are done! The new application will be build and deployed on commit.

## Contributing
Expand Down

0 comments on commit a5907a3

Please sign in to comment.