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.
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.
If you found a technical bug on Say Their Names or have ideas for features we should implement, the issue tracker is the best place to share your ideas.
If you find a bug on Say Their Names and open a PR that fixes it we'll review it as soon as possible.
If you want to implement a new feature, open an issue first to discuss what it'd look like and to ensure it fits in our roadmap and plans for the app (see the trello board for planned and currently ongoing work).
Want to fix a bug or implement an agreed-upon feature? Great, jump to the local setup instructions!
With the ground rules out of the way, let's talk about the core architecture of this mono repo:
- Full-stack JavaScript: We use strapi.io as our open-source headless CMS powered by GraphQL, and React to power our frontend. Almost all of the code you'll touch in this codebase will be JavaScript.
The first step to running Spectrum locally is downloading the code by cloning the repository:
git clone https://github.com/Say-Their-Name/web.git
cd backend
# Using yarn
yarn
yarn develop
# Using npm
npm install
npm run develop
cd frontend
# Using yarn
yarn
yarn develop
# Using npm
npm install
npm run develop
React server is running here => http://localhost:3000 Strapi server is running here => http://localhost:1337
Let's have fun, let's make an impact.
To deploy this Strapi instance you'll need:
- A Heroku account for free
- A Cloudinary account for saving images for free
Once you have created these accounts you can deploy your instance by clicking on this button
Netlify
To deploy this Strapi instance you'll need:
- A Netlify account for free
Once you have created your account you can deploy your instance by clicking on this button.