Code Sponsor

Code Sponsor is an sponsorship platform to help fund open source projects and developers. Learn more at https://codesponsor.io

Here are a few blog posts and podcasts that discuss Code Sponsor:

• Fighting for Open Source Sustainability: Introducing Code Sponsor
• Why Funding Open Source is Hard
• Code Sponsor + Gitcoin = OSS Sustainability
• Sustaining Open Source
• Sustaining Open-Source Software through Ethical Advertising

Table of Contents

• What is this?
• Why is it open source?
• Install
• Road map
• Code of Conduct
• Contributors

What is this?

This is the software behind codesponsor.io. It's an Elixir application built on the Phoenix web framework, PostgreSQL, and many other great open source efforts.

Why is it open source?

A few reasons:

1. We love open source. Our careers (and livelihoods) wouldn't be possible without open source. Keeping it closed just feels wrong.
2. Phoenix is really great, but it's young enough in its lifecycle that there aren't too many in-production, open source sites for people to refer to as examples or inspiration. We want to throw our hat into that ring and hopefully others will follow.
3. We know open sourcing the platform will lead to good things from y'all (such as bug reports, feature requests, and pull requests).

Development

Using Docker

1. Setup a complete docker and docker-compose installation
2. Clone this repository
3. Copy .env-sample to .env
4. Built the phoenix app into image: docker-compose build
5. Create the database: docker-compose run web mix ecto.create
6. Run the migrations: docker-compose run web mix ecto.migrate
7. Seed the db: docker-compose run web mix code_sponsor.seed
8. Run the services: docker-compose up -d
9. Visit localhost:4000 to see code sponsor running.

Without Docker (native setup)

Here are some basic stemps to get Code Sponsor running:

git clone [email protected]:codesponsor/web.git
cd web/
# Optionally set the following environment variables (see .env-sample)
# config postgres in config/dev.exs
# start postgres
mix deps.get
mix ecto.create
mix ecto.migrate
mix code_sponsor.seed
cd assets && npm install
cd ../
mix phx.server

Road map

We have a road map of what we are going to implement next.

Code Sponsor Q1 Goals

If you wish to add features that are not on the road map, you're very welcome to do so. We encourage you to create an Issue before coding, so we can all discuss the relevance to the community.

Please keep in mind that the focus is to create a great platform, so we might not implement/accept all the suggested features.

Code of Conduct

Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributors

Eric Berry 💻 📖 📦	Miguel Angel Gordián 💻 📖 🚇 📦