Say-Their-Name / say-their-names-web

Open-source platform that raises awareness of the injustice and often forgotten names of racial inequality.
https://saytheirnames.io/
MIT License
56 stars 28 forks source link

Unit Test Workflow

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. We strive to identify and amplify verified organizations to ensure donations are reaching those who can make the most impact with it.

Prerequisites

Before you continue, ensure you have met the following requirements:

Setup

Cloning the repository:

Using HTTPS:

  git clone https://github.com/Say-Their-Name/say-their-names-web.git

Using SSH:

  git clone git@github.com:Say-Their-Name/say-their-names-web.git

Navigate to app

 cd say-their-names-web

Add Environment Variable

Create a .env file in the root of the project and copy the contents below to the newly created .env file.

REACT_APP_API_BASE_URL=https://saytheirnames.dev/api
REACT_APP_NEWS_FETCH_PROXY=https://thingproxy.freeboard.io/fetch
REACT_APP_TWITTER_URL=https://twitter.com/SayTheirName_io
REACT_APP_FACEBOOK_URL=https://www.facebook.com/Say-Their-Names-108926117523025/?modal=admin_todo_tour
REACT_APP_INSTAGRAM_URL=https://www.instagram.com/saytheirname.io
REACT_APP_GITHUB_URL=https://github.com/Say-Their-Name
REACT_APP_SLACK_URL=https://app.slack.com/client/T014JL5B3SN/C014X92G997
REACT_APP_ANDROID_URL=https://play.google.com/store/apps/details?id=io.saytheirnames.android
REACT_APP_IOS_URL=https://apps.apple.com/app/say-their-names/id1517599626

Installing Dependencies

Using NPM:

  npm install

Using Yarn:

  yarn install

Running the app

Using NPM:

  npm start

using Yarn:

  yarn start

Deploy the frontend

Netlify

To deploy this Strapi instance you'll need:

Once you have created your account you can deploy your instance by clicking on this button.

Deploy

Contributing

We heartily welcome any and all contributions that match our engineering standards! Please, check out our Contribution Guidelines to know more.

Let's have fun, let's make an impact.