CodeFund

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

Here are a few blog posts and podcasts that discuss CodeFund:

• 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?
• Development
• Road map
• Code of Conduct
• Contributors

What is this?

This is the software behind codefund.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?

We have built our careers on open source. We all owe a great debt to all open source developers who given so much of their free time and talents to help others. We were also inspired by The Changelog, who released their platform open source. Finally, we want to be a trusted partner to the developer community. To us, ad networks have always felt a bit shady. By being open source, we invite all to critique our code and ensure we are being honest.

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. Install dependencies: docker-compose run web mix deps.get
6. Create the database: docker-compose run web mix ecto.create
7. Run the migrations: docker-compose run web mix ecto.migrate
8. Seed the db: docker-compose run web mix code_fund.seed
9. Run the services: docker-compose up -d
10. Visit localhost:4000 to see CodeFund running.

Without Docker (native setup)

Here are some basic steps to get CodeFund running:

git clone git@github.com:gitcoinco/codefund.git
cd codefund/
# Optionally set the following environment variables (see .env-sample)
# config postgres in config/dev.exs
# start postgres
gem install fakes3

mix deps.get
mix ecto.create
mix ecto.migrate
mix code_fund.seed
cd assets && npm install
cd ../
mix maxmind.setup
fakes3 -r /tmp/fakes3_root -p 4567
mix phx.server

Running Tests

We use fakes3 for mocking S3 uploads so you will need to have this service running prior to running tests. You can run this and tests automatically with ./bin/run_tests

What To Consider On Your Pull Requests

1. Please run mix format prior to submitting a pull request.
2. We're working on adding typespec to the codebase. Please consider adding them to your pull requests so we can move ahead quicker.
3. Please make sure you've added, changed or removed tests accordingly for the code you've modified.
4. Consider running mix credo list --ignore readability,design,refactor to make sure your code is consistent and styled well.
5. Have fun!

Road map

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

CodeFund 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.

Attributions

This product includes GeoLite data created by MaxMind, available from http://www.maxmind.com.

Contributors

Eric Berry 💻 📖 📦	Miguel Angel Gordián 💻 📖 🚇 📦	Justin Bean 💻 📖 🤔 ⚠️	bakaoh 💻 📖	Samuel Volin 💻 🚇 🔧	Limon Monte 🐛 💻	Arun Kumar 💻 📖
Ivan Tivonenko 💻 ⚠️	Nathan Hopkins 💻 📖