A light weight interface to obtain weather forecast information
- JavaScript
- Node.js v.20+
- Git
- release-please
- commitlint
- BabelJS
- [ESLint] (https://eslint.org/)
- Webpack 5
- React 18
- @svgr/webpack
- From your command line shell (Bash or Zsh), in a directory of your choice, enter the following command, to create a folder called "andy-client":
git clone https://github.com/wingedearth/andy-client.git
- Enter
cd andy-client
to enter the folder. - Enter
yarn
to run yarn, which will install the local NPM package dependencies. If you do not have yarn installed globally on your machine, then first enternpm i -g yarn
to install yarn.
- Enter
yarn build:dev
on the command line to build/transpile application with Webpack watch mode. - Enter
yarn dev
on the command line (in a different tab) to start application.
- Enter
yarn start
to build and start the server
When the server is available, use the /version endpoint to see app information.
From conventionalcommits.org:
The commit message should be structured as follows:
[optional scope]:
[optional body]
[optional footer(s)] The commit contains the following structural elements, to communicate intent to the consumers of your library:
fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.
Merging code to the master branch will auto generate or update a Release PR. When ready to bump the application version, simply merge the Release PR in GitHub. This will also update the changelog.