Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.04 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.04 KB

say-their-name-node-service

Say Their Name Node service that handles URL shortenings and meta data handlings

Say Their Names ✊🏿

Overview

Welcome to the Say Their Names project. Our aim is to build an open-source platform that raises awareness of the injustice and often forgotten names of racial inequality at the hands of law enforcement. We strive to identify and amplify verified organizations to ensure donations are reaching those who can make the most impact with it.

Contributing

We heartily welcome any and all contributions that match our engineering standards!

That being said, this codebase isn't your typical open source project because it's not a library or package with a limited scope — it's our entire product.

How to run?

  • Docker
  1. git clone repo
  2. cd into the folder
  3. build docker image docker build -t say-their-name-node-service .
  4. run docker docker run -p 3000:3001 say-their-name-node-service
  • Local
  1. git clone repo
  2. cd into the folder
  3. npm install
  4. nodemon index
  5. use it