Home

Welcome to the Contributary wiki!

Contributary is a web application to help open source connect with the open source community.

The web application serves the purpose of providing an interface designed to help make the search for open source projects and issues as easy as possible.

Roadmap

What exists in the current repository is only a POC and is only intended to be run locally and at this time is only intended as a POC.

1. The short term goal is to deploy a version of the POC into a live environment via CI / CD and add some features / styles to it.
2. There will then be a beta / feedback period.
3. The long term goal (TBD) will be to improve data topology management (more automated) as well as provide users a sign in option to unlock additional features gained by having access to their GitHub profile, like starred repos, avatar, activity stream, etc.

Throughout, the goal will always be to provide a great browse and search experience to help users find the projects and communities their looking for. 💙

Table of Contents

To learn more about how it all works, check out the docs in our wiki:

• Onboarding Guide TODO - General information about the project and how to contribut
• Application Design (TODO) - An overview of the application's functions and behaviors as well as any available design assets
• Data Topology (TODO) - Details the data sources used and how it all comes together for the user
• Technical Architecture (TODO) - How all the pieces fit together (frontend, data topology, infrastructure)
• API Design (TODO) - How data is exposed to API Gateway for the frontend to consume (e,g. topology data, access to data from the GitHub API)
• Release Management (TODO - Deployment and release workflows)