| Branch | Status |
|---|---|
| develop |  |
This project was generated with Analog, the fullstack meta-framework for Angular.
Run npm install to install the application dependencies.
Run npm start for a dev server. Navigate to http://localhost:5173/. The application automatically reloads if you change any of the source files.
Run npm run build to build the client/server project. The client build artifacts are located in the dist/analog/public directory. The server for the API build artifacts are located in the dist/analog/server directory.
Run npm run test to run unit tests with Vitest.
This repo is configured for CI via a Github Action Workflow. It builds the app, runs the linter, runs the tests, and outputs code coverage when the develop or main branches are updated.
There is a Github Action Workflow that is configured to deploy the contents of ./dist/analog/public to GitHub Pages when the main branch is updated.
This project uses Prettier to enforce code style. There are .prettierrc and .prettierignore configuration files to adjust some options. Prettier is also wired up to a pre-commit hook. This DOES slightly slow down git, as it runs the hook on staged files every time git commit is executed.
Prettier can be configured within editors so that it formats files on save, which helps minimize any changes the pre-commit hook would need to make.