This project was generated with Angular CLI version 16.2.0.
First, run the prebuild command, to generate files that are required for the app to work
pnpm run prebuildRun ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you
change any of the source files.
Run ng generate component component-name to generate a new component. You can also
use ng generate directive|pipe|service|class|guard|interface|enum|module.
Run ng build to build the project. The build artifacts will be stored in the dist/ directory.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a
package that implements end-to-end testing capabilities.
Commit messages follow the conventional commits guidelines. This allows for automating the semantic versioning release process using semantic release
To enforce that, commitlint is used. It reads the commit messages on a PR and ensures they follow
conventional commits convention.
You can use the following run script to ensure the last commit follows the guidelines:
pnpm run commitlint:lastSemantic Release is used to automate the release process. Based on commit messages, a new major,
minor or patch release is generated for every push to main branch. For every release, a Git tag will be created, a
GitHub release will be created and a new version of the app will be published to npm public registry. All of this
is managed automatically by Semantic Release and CI/CD pipelines.
Config has been tweaked so all commits appear in the release notes. To do so,
typesof commits included are all of those defined in Conventional Changelog type defaults. But none is hidden. That list comprehends all commit types thatcommitlintwill lint.
In order to embed release information in the app, a script was created to export that kind of information using Semantic Release's JavaScript API.
To generate the release info, run
pnpm run prebuild:generate-release-fileIt will generate a release.json file in the root of the repository containing all info about releases that
Semantic Release provides.
⚠️ Next release can be fakeThe API only outputs information when a new release has to be generated. As a workaround, a fake patch release is generated in case no release was needed to get access to all that info.
To distinguish a real run from a faked run, a
fakeproperty exists in that JSON with value set totrue. The only faked properties are about next release (nextReleaseandreleasesat the moment of writing this). Info about last release remains correct even when faking the release to generate the output (lastReleaseat the moment of writing this)
⚠️ Next release can be a previewIf running the script from a branch that's not configured to trigger releases, the default API behaviour is to output no data. As a workaround, we simulate being on the
mainbranch and see what would happen in that scenario when including commits from the current branch.To distinguish a real run from a faked run, a
previewproperty exists in that JSON with value set totrue. This is because it's a simulation of this branch being merged into main branch. But you could want to merge that against another (the script could be smarter and simulate that too, but not yet :P).
⚠️ Next release can be fake and preview If both of previous situations happen at same time (commits of branch are not enough to trigger a release and branch is not one configured for releases)
Not a fan of, but it's useful to enforce conventional commits & format your code before submitting it
To use it, run
pnpm run git-hooksIt will install Git hooks via husky. Now everytime you commit, you'll be sure
commit message guidelines are enforced.
This is very useful if you can push to
maindirectly. Because there's no way to reject commits that don't follow the commit message guidelines. And once you push tomain, you cannot amend that commit as per branch protection rules.
Some metadata about the app (like title, author, theme color...) was repeated across files. So used
LiquidJS to create template files (.liquid extension). Then, created a small script to render
templates into generated files using metadata defined in metadata.ts file (and some hardcoded constants in the
generation script)
If you update some metadata in that file, run the script to update files generated from templates. Otherwise, they won't be in sync.
Automatically updating generated files is not straightforward. Doing something before/after an Angular app build runs is not an option right now. Adding a bunch of pre
npmrun scripts left thepackage.jsonfile quite cluttered. Also, won't work if issuingngcommands. So decided to leave the task to update generated files to the developer. At some point a CI check could be introduced to ensure generated files are up-to-date. Generated files are left in the repo because of that reason (and also so you can clone & run without issues). That metadata won't change often anyway.
Can only be triggered by users with write access to the repo (to prevent secrets from being leaked). Same secret is used for production access, so better keep that one safe.
Also, branch names should be short. Otherwise, the canonicalUrl may be incorrect, given we try to generate the URL following docs about it in Cloudflare Pages docs. But the exact algorithm to generate the preview URL from branch name is not published. Empirically, it is known that branch names get shorten if they exceed a certain length.
See #289 for more info.
Some fonts included are a subset of a big font file. Before doing anything, please run
pnpm run prebuild:font-subsetsTo generate them. Otherwise, those fonts won't be found and you may get some errors. Also, remember to run it if changing the glyphs included in each font. Or to add the new glyphs if you want to use more glyphs of a font.
GitHub Actions are used
In order to ease running CI/CD commands locally, the .ci directory contains a Makefile intended to contain all
commands that will be run in CI/CD pipelines. So you can test those locally easily
Just:
cd .ci && make test # for instanceAnd see how a command run in the CI/CD behaves locally. Notice your machine's state may differ from the CI/CD machine one.
To get more help on the Angular CLI use ng help or go check out
the Angular CLI Overview and Command Reference page.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent