shorthands
An open source service to help new recurits navigate company specific acronyms and other terms.
star this repo ⭐
why?
I came across this tweet by
When onboarding new team members, please define acronyms.
— Emma Bostian 🐞 (@EmmaBostian) August 11, 2020
Spoiler alert: we have no idea what they mean and we're often too anxious to speak up (especially in a group setting).
and this reply to the tweet
I see this happen way too much. An engineer on my team actually created a web app for the company called IDK where you can search terms. He did that when he first started!
— Ryan Burgess (@burgessdryan) August 11, 2020
and I thought that a solution to this could be helpful to people and it's a good way for me to practice.
Getting Started
- enusre you have node and npm installed
- clone or fork this repo
Frontend
- move to the frontend directory
- traverse to the root project directory and run npm install
Backend
- move to the backend directory
- ensure that you have mongodb installed
- traverse to the root project directory and run npm install
- create an environment variable called shorthandskey and set it to any value. this is our private key to sign json web tokens
- run the server using node index.js
Contribute to the Project
add new stuff, modify new stuff, suggest changes to the system or UI design, just about anything, all suggestions welcome.