Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 1.74 KB

README.md

File metadata and controls

39 lines (23 loc) · 1.74 KB

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.
Spoiler alert: we have no idea what they mean and we're often too anxious to speak up (especially in a group setting).

— Emma Bostian 🐞 (@EmmaBostian) August 11, 2020

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

  1. enusre you have node and npm installed
  2. clone or fork this repo

Frontend

  1. move to the frontend directory
  2. traverse to the root project directory and run npm install

Backend

  1. move to the backend directory
  2. ensure that you have mongodb installed
  3. traverse to the root project directory and run npm install
  4. create an environment variable called shorthandskey and set it to any value. this is our private key to sign json web tokens
  5. 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.