This repository contains common configurations for building web apps at Temple & Webster.
This repo is managed as a monorepo that is composed of many npm packages, where each package has its own README and documentation describing usage.
| Name | NPM | Size |
|---|---|---|
| webster-babel |  |
 |
| webster-eslint |  |
 |
| webster-postcss |  |
 |
| webster-prettier |  |
 |
| webster-stylelint |  |
 |
| webster-typescript |  |
 |
pnpm install && pnpm buildAll workspaces
Run commands across all workspaces. This uses turbo run <command>.
| Command | Runs |
|---|---|
pnpm changeset |
Adds a new changelog entry |
pnpm lint |
Lints all workspaces |
pnpm test |
Tests all workspaces |
pnpm type-check |
Build types and check for type errors |
pnpm clean |
Remove generated files |
pnpm format |
Format files with prettier |
This repository has a CLA-Bot running which will ask contributors to sign a Contributor License Agreement (CLA).
Temple & Webster has also adopted a Code of Conduct that we expect contributors to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
There are many ways to contribute, some of which are:
- Filing bug reports
- Requesting new features or packages via an issue
- Improving the existing codebase by picking up an issue, improving tests, or furthering documentation
If your change affects the public API of any packages within this repository (i.e. adding or changing arguments to a function, adding a new function, changing the return value, etc), please ensure the documentation is updated, and a changelog is added to reflect this. Documentation is in the README.md files of each package. If further documentation is needed please communicate via a GitHub issue.
The packages in this repository are used in mission-critical production scenarios. As such, we do not merge any untested code.
To run the full test suite, simply run pnpm test.
The release process currently involves some manual steps to complete. Once your PR has been merged, our team will orchestrate when to cut a new release.
Note Version numbers in package.json files should never be altered manually. This will be done via scripts as part of the release process.
MIT © Temple & Webster, see LICENSE.md for details.