# ambassadorconventions > Ambassador Conventions ====================== Latest version **0.14.11** (published 2022-07-22) · 0 weekly downloads ## Install ```sh npm install ambassadorconventions pnpm add ambassadorconventions yarn add ambassadorconventions bun add ambassadorconventions ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; large bundle; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.14.11 | | Published | 2022-07-22 | | First published | 2021-06-10 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Node | 10.11.0 | | Dependencies | 11 | | Unpacked size | 13.3 MB | | Known vulnerabilities | 0 (+15 in 2 direct dependencies) | | Install scripts | yes | | Maintainers | ambassador | ## Links - npm: https://www.npmjs.com/package/ambassadorconventions - npm.io page: https://npm.io/package/ambassadorconventions ## Dependencies (11) - [bower](https://npm.io/package/bower.md) ^1.8.12 - [moment](https://npm.io/package/moment.md) ^2.29.1 - [morgan](https://npm.io/package/morgan.md) ^1.10.0 - [multer](https://npm.io/package/multer.md) ^1.4.2 - [express](https://npm.io/package/express.md) ^3.21.0 - [body-parser](https://npm.io/package/body-parser.md) ^1.19.0 - [compression](https://npm.io/package/compression.md) ^1.7.4 - [jasmine-core](https://npm.io/package/jasmine-core.md) ^3.7.1 - [jshint-stylish](https://npm.io/package/jshint-stylish.md) ^2.1.0 - [node-localstorage](https://npm.io/package/node-localstorage.md) ^2.1.6 - [connect-modrewrite](https://npm.io/package/connect-modrewrite.md) ^0.10.2 ## Recent versions - 0.14.11 (latest) — 2022-07-22 - 0.14.10 — 2021-06-10 ## README Ambassador Conventions ====================== [ ![Circle CI Status for GetAmbassador/ambassador-conventions](https://circleci.com/gh/GetAmbassador/ambassador-client.svg?style=shield&circle-token=d8458a09c88aa541c37a7d45b471f48c14cb6a71)](https://circleci.com/) A UX and design pattern library for all Ambassador apps. Inspired by [Mailchimp's Pattern Library](http://ux.mailchimp.com/patterns). A living version of the [Ambassador style guide](https://getambassador.box.com/s/6k2j3we60zouor1qrbie). Convention >An agreement between two or more states, often more, concerning matters of common interest. While supposedly used for lesser matters than embraced in a treaty, it often deals with important subjects indeed – international postal and copyright laws, for example, of the law of the sea. [Source](http://www.ediplomat.com/nd/glossary.htm) ## Getting the conventions site running Make sure you `cd` to your favorite directory. Then we'll clone the conventions repo: $ git clone git@github.com:GetAmbassador/ambassador-conventions.git Move into the project: $ cd ambassador-conventions Install Git hooks: $ ln -s ../../git-hooks/prepare-commit-msg .git/hooks/prepare-commit-msg $ ln -s ../../git-hooks/pre-push .git/hooks/pre-push The `pre-push` hook requires re-initialization of the repo: $ git init Make sure the `pre-push` hook is executable: $ chmod +x .git/hooks/pre-push If Node is not installed on your machine it will need to be installed. Install instructions are [here](http://nodejs.org/download/) Install nvm using the following command: $ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.30.1/install.sh | bash Quit the terminal and reopen it so you have access to nvm. To make sure you have Node version `10.11.0` installed enter the following commands: $ nvm install 10.11.0 $ nvm alias default 10.11.0 You can verify that the correct version of Node was installed using the following command: $ node -v To make sure you have npm version `6.4.1` installed enter the following command: $ [sudo] npm install npm@6.4.1 -g You can verify that the correct version of npm was installed using the following command: $ npm -v Rebuild node-sass using the following command: $ npm rebuild node-sass Install Node packages: $ npm install If Bower is not installed on your machine it will need to be installed: $ npm install -g bower Install Bower packages: $ bower install You dev area should now be all set! You should now be able to start a local webserver and view the site using: $ grunt serve Once grunt serve has started you should be able to access the site at [http://localhost:9000/](http://localhost:9000/) If grunt fails on Error: Cannot find module 'liftoff', I found a workaround to be using nvm to install node v14.16.1, then install grunt-cli globally and grunt locally: $ nvm install 14.16.1 $ npm install -g grunt-cli $ npm install grunt Then you can switch back to version `10.11.0`, and retry starting the server with: $ nvm use default $ grunt serve If you have a port conflict with 9000 you may need to adjust the port used in the Gruntfile to an unused port or disable/stop the application using port 9000 on your machine. #### Local Testing To run tests locally, run `grunt test:local` ### Releasing When you are ready to release a new version of Ambassador Conventions please follow this procedure. 1. Update the version in bower.json. 2. `grunt build` 3. Create a new issue in [conventions-bower](https://github.com/GetAmbassador/conventions-bower) for the new version. 4. Copy `dist/ga-conventions.min.js`, `dist/ga-conventions.templates.min.js`, `dist/ga-conventions.css`, `dist/ambassador/styles/` and `dist/components` over to your new branch for [conventions-bower](https://github.com/GetAmbassador/conventions-bower) 5. Update the version in bower.json on [conventions-bower](https://github.com/GetAmbassador/conventions-bower). 6. If any bower components have been added be sure to include them in the conventions-bower bower.json. 7. If any dependencies have been updated, be sure to update them in conventions-bower bower.json 8. Push and merge on conventions-bower. 9. Create a tag on conventions-bower for the new version. `git tag -a v0.1.0 -m 'Releasing v0.1.0'` 10. Create a tag on ambassador-conventions for the new version. `git tag -a v0.1.0 -m 'Releasing v0.1.0'` 11. Create a new release in conventions-bower following the naming convention of previous releases `Ambassador Conventions - vX.X.X` --- _Source: https://npm.io/package/ambassadorconventions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._