Donations Revealed
Corporations have made headlines with big pledges recently – tracking how much they'd be to the average person.
View the Website »
Explore the dataset
·
Report Bug
·
Request Feature
Table of Contents
- Table of Contents
- About The Project
- Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgements
About The Project
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g- Gatsby CLI
npm install gatsby-cli -g- Airtable
Make a copy of our base, and make a note of your Airtable API key, and your Base ID.
You can find your API key under your profile
And you can find your Base ID under help
Installation
- Clone the repo
git clone https://github.com/jamrants/donations.git- Install NPM packages
npm install- Add Environment Variables
Create a file named .env.development in the root of the repo, and add the following info:
AIRTABLE_KEY=`yourAirtableKey`
BASE_ID=`yourBaseId`
- Run Gatsby
gatsby developUsage
This will be filled out at a later date
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
We're using the Gitflow Workflow. Because Github Actions doesn't let us run our CI on a fork, please work off of the Develop branch so we can make sure Master doesn't break.
- Fork the Project
- Checkout the Develop Branch (
git checkout develop) - Create your Feature Branch (
git branch feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request to the Develop Branch
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Project Link: https://github.com/jamrants/donations