A web app that allows you to contribute to open source projects of social tech causes as a developer and promote awareness via the government representatives that could help support them. It helps contributors make an impact through tech by empowering social causes and underrepresented campaigns, and it also sends them a “thank you message” after the system verifies the contribution.
The projects assigned to us were Program Equity and SayThanks.io. SayThanks.io lets you send customized messages to developers, and Program Equity focuses on creating awareness about different under-represented campaigns.
We saw a gap in this, similar to what Program Equity is trying to fill. Just like there are different social good campaigns that go unnoticed due to unawareness, in the same way, there are multiple social good tech projects that need recognition and developers to keep it progressing. Correspondingly, there are developers who are trying to make an impact through code and are looking for such projects.
This project serves as a bridge connecting them.
- Find social good tech projects and contribute to them while tracking your progress
- Share and spread awareness about your work that is impacting those campaigns with the world and the representatives associated with that hackathon.
- Representatives and maintainers can send you custom “thank you” messages for your contribution to the cause automatically and objectively with the SayThanks.io project after confirming your commits and issues to the project.
- You can send a message to a representative in your list/area via Twitter to talk about your contribution and ways in which they can also contribute to the projects.
- Uses GitHub API to dynamically update your contribution progress.
Check this demonstration video to get the user flow -> YT Link
We are using MERN stack for the project.
- The backend uses the Node.js web application framework, Express.js app with PostgreSQL as our database.
- The frontend is a React.js app.
- We are using the Amplify project under Program Equity for Civic APIs and getting the representatives’ data.
- We are using SayThanks.io endpoints to send custom "Thank you" to users' inboxes.
Make sure you have the latest recommended version for most users of Node.js installed. The current version we use is 16.17.1 LTS.
- Clone the project
git clone https://github.com/ahn-nath/thanks_for_your_contribution_to_equity.git
- Setup front end
cd frontend
npm i
npm start
- Populate the environment variables and setup the server
cd backend
npm i
npm start
IMPORTANT You must add your own values for the frontend/env file. The values has been revoked. Please add your own GitHub personal token.
...
# GitHub API connection
GITHUB_API_TOKEN=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 # REPLACE THIS WITH YOUR OWN PERSONAL TOKEN
# Google API Civic
...
CIVIC_API_KEY=AIzaSyDHV1THTd8ybs75Hs8WG21uxvTC4ywm-BQ
This being an orientation hackathon, we were looking for an idea that could use both the projects that were assigned to us under GitHub. This project is build upon the APIs of both Program Equity and SayThanks.io which made it more special.
MIT License
Copyright (c) Nathaly Toledo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.