Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/capitalone/acronym-decoder

Acronym Decoder
https://github.com/capitalone/acronym-decoder

acronyms angular angular5 chrome-extension chrome-extensions decoder tool typescript

Last synced: about 17 hours ago
JSON representation

Acronym Decoder

Awesome Lists containing this project

README 

        
## Drinketh from the Cup of Knowledge!

Whether you've been with your organization one day or one decade, we are all always running into terms and acronyms that we just don't get. Maybe it's an industry or line of business you're not too familiar with. Maybe it's an acronym that someone just made up and started using the other day. Maybe it's a typo!



Whatever it is, Acronym-Decoder (A-D!) aims to help you get through the alphabet soup. It's a fairly simple tool that highlights words that you have a definition for, then lets you pull up those definition(s) with a click of the mouse.



## Run Local Server

* Go [here](https://nodejs.org/en/download/) to download the latest version of nodejs. Follow the steps on the website to download the appropriate version according to your machine

* Download this project by clicking 'Code' on the top right of the website, then click 'Download ZIP'. Follow the image for any further guidance necessary.

![](readme-assets/download.png)

* Open the project with your favorite text editor and enter the following commands in the terminal.

* `npm install`

* `npm run build`

* Visit `chrome://extensions` on your chrome browser

* Enable Developer mode and click Load unpacked as seen in the image below

![](readme-assets/loading.png)

* Select the `dist/` folder in your project directory



Note: modifications to content-script files will require you to refresh the extension from [chrome://extensions](chrome://extensions)



## Build



* `npm install`

* `npm run build`



## Configuration



All of the configurable variables live within the [config.json](https://github.com/capitalone/acronym-decoder/blob/master/src/config.json) file. Change each property depending on your specific need to shape how the app will look and function. The changes you make here will propogate throughout the app.



## Setting up your terms and acronyms



### Local Glossary: 

You can set up your terms and acronyms by inserting them into the `glossary.json` file.

The format of the file should stay the same as the example that lives in there currently. Make sure all your terms and acronyms match that format so the app can read them with no issues. 



### Remote Glossary:

You can also setup a database and backend and host your terms/acronyms on a server. This feature is off by default. 

Make sure to replace the `lookupApiUrl` in the `config.json` file with the server URL.

Also you need to make sure that the toggle for `enableRemoteLookup` is set to `true` on the `config.json` file to enable remote lookup. If for any reason the API fails, the app will fallback to local glossary. 

Host permissions can optionally be added the `host_permissions` attribute to `manifest.json` file. 



## Contributors:

We welcome your interest in Capital One’s Open Source Projects (the “Project”). Any Contributor to the project must accept and sign a CLA indicating agreement to the license terms. Except for the license granted in this CLA to Capital One and to recipients of software distributed by Capital One, you reserve all right, title, and interest in and to your contributions; this CLA does not impact your rights to use your own contributions for any other purpose.



[Link to Individual CLA](https://docs.google.com/forms/d/e/1FAIpQLSfwtl1s6KmpLhCY6CjiY8nFZshDwf_wrmNYx1ahpsNFXXmHKw/viewform)



[Link to Corporate CLA](https://docs.google.com/forms/d/e/1FAIpQLSeAbobIPLCVZD_ccgtMWBDAcN68oqbAJBQyDTSAQ1AkYuCp_g/viewform)



This project adheres to the [Open Source Code of Conduct](https://developer.capitalone.com/single/code-of-conduct/). By participating, you are expected to honor this code.



### Modernization contributors:



[@Frank Zhou](https://github.com/fpmc1)



[@Eric Li](https://github.com/@ericliau1)



[@Samyak Jain](https://github.com/@samyakjain11)



### Project creators:

[@Ahmad Ibrahim](https://github.com/amadib)



[@Basim Partovi](https://github.com/baspartovi)



[@Jason Yeomans](https://github.com/YeomansIII)



## Troubleshooting

* Having issues installing Acronym-Decoder?

* Or for any other problems/questions:



Create an issue on our repo and let us know. We're always here to help!



## License



    Copyright 2021 - 2023 Capital One Services, LLC



    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at



       http://www.apache.org/licenses/LICENSE-2.0



    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.