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:

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

Setup a complete docker and docker-compose installation
Clone this repository
Copy .env-sample to .env
Built the phoenix app into image: docker-compose build
Install dependencies: docker-compose run web mix deps.get
Create the database: docker-compose run web mix ecto.create
Run the migrations: docker-compose run web mix ecto.migrate
Seed the db: docker-compose run web mix code_fund.seed
Run the services: docker-compose up -d
Visit localhost:4000 to see CodeFund running.

Without Docker (native setup)

Here are some basic steps to get CodeFund running:

git clone [email protected]: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

Please run mix format prior to submitting a pull request.
We're working on adding typespec to the codebase. Please consider adding them to your pull requests so we can move ahead quicker.
Please make sure you've added, changed or removed tests accordingly for the code you've modified.
Consider running mix credo list --ignore readability,design,refactor to make sure your code is consistent and styled well.
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.

We also use BrowserStack to help us ensure that the ethical ad placements are above the fold on different browsers.

Financial Contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.