Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gitcoinco/codefund

Deprecated. Please go to https://github.com/gitcoinco/code_fund_ads
https://github.com/gitcoinco/codefund

advertising funding oss phoenix sponsors

Last synced: 9 days ago
JSON representation

Deprecated. Please go to https://github.com/gitcoinco/code_fund_ads

Awesome Lists containing this project

README 

        
# CodeFund



[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors)

[![Build Status](https://travis-ci.org/gitcoinco/codefund.svg?branch=master)](https://travis-ci.org/codesponsor/web)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)



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






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



- [Fighting for Open Source Sustainability: Introducing Code Sponsor](https://medium.com/code-sponsor/fighting-for-open-source-sustainability-introducing-code-sponsor-577e0ccca025)

- [Why Funding Open Source is Hard](https://medium.com/@codesponsor/why-funding-open-source-is-hard-652b7055569d)

- [Code Sponsor + Gitcoin = OSS Sustainability](https://medium.com/gitcoin/code-sponsor-gitcoin-oss-sustainability-5684c4adf4b4)

- [Sustaining Open Source](https://startupcto.io/podcast/0-57-sustaining-open-source-w-eric-berry-codesponsor-io/)

- [Sustaining Open-Source Software through Ethical Advertising](https://devchat.tv/js-jabber/jsj-281-codesponsor-sustaining-open-source-software-ethical-advertising-eric-berry)



# Table of Contents



- [What is this?](#what-is-this)

- [Why is it open source?](#why-is-it-open-source)

- [Development](#development)

- [Road map](#road-map)

- [Code of Conduct](#code-of-conduct)

- [Contributors](#contributors)



## What is this?



This is the software behind [codefund.io](https://codefund.io/t/s/76674f2b-a37b-4bf7-8e20-25d3913f0012/). It's an [Elixir](http://elixir-lang.org) application built on the [Phoenix](http://www.phoenixframework.org) web framework, [PostgreSQL](https://www.postgresql.org), and [many](https://github.com/gitcoinco/codefund/blob/master/mix.exs#L42) [other](https://github.com/gitcoinco/codefund/blob/master/assets/package.json) 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](https://github.com/thechangelog/changelog.com),

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

1.  Clone this repository

1.  Copy `.env-sample` to `.env`

1.  Built the phoenix app into image: `docker-compose build`

1.  Install dependencies: `docker-compose run web mix deps.get`

1.  Create the database: `docker-compose run web mix ecto.create`

1.  Run the migrations: `docker-compose run web mix ecto.migrate`

1.  Seed the db: `docker-compose run web mix code_fund.seed`

1.  Run the services: `docker-compose up -d`

1.  Visit [localhost:4000](http://localhost:4000) to see CodeFund running.



#### Without Docker (native setup)



Here are some basic steps to get CodeFund running:



```shell

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



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](https://github.com/gitcoinco/codefund/issues/1)



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](https://github.com/gitcoinco/codefund/issues/new)

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](https://github.com/gitcoinco/codefund/blob/master/CODE_OF_CONDUCT.md). 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](http://www.maxmind.com).



We also use [BrowserStack](https://www.browserstack.com/) 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](https://opencollective.com/codefund).

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.



## Credits



### Financial Contributors



Thank you to all the people who have already contributed to CodeFund!




### Backers

 

Thank you to all our backers! [[Become a backer](https://opencollective.com/codefund#backer)]

 

 

### Sponsors

 

Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/codefund#sponsor))

 

 




















## Contributors



| [
Eric Berry](https://codefund.io)
[💻](https://github.com/codesponsor/web/commits?author=coderberry "Code") [📖](https://github.com/codesponsor/web/commits?author=coderberry "Documentation") [📦](#platform-coderberry "Packaging/porting to new platform") | [
Miguel Angel Gordián](http://zoek1.github.com)
[💻](https://github.com/codesponsor/web/commits?author=zoek1 "Code") [📖](https://github.com/codesponsor/web/commits?author=zoek1 "Documentation") [🚇](#infra-zoek1 "Infrastructure (Hosting, Build-Tools, etc)") [📦](#platform-zoek1 "Packaging/porting to new platform") | [
Justin Bean](http://stareintothebeard.github.io/)
[💻](https://github.com/codesponsor/web/commits?author=StareIntoTheBeard "Code") [📖](https://github.com/codesponsor/web/commits?author=StareIntoTheBeard "Documentation") [🤔](#ideas-StareIntoTheBeard "Ideas, Planning, & Feedback") [⚠️](https://github.com/codesponsor/web/commits?author=StareIntoTheBeard "Tests") | [
bakaoh](https://github.com/bakaoh)
[💻](https://github.com/codesponsor/web/commits?author=bakaoh "Code") [📖](https://github.com/codesponsor/web/commits?author=bakaoh "Documentation") | [
Samuel Volin](http://untra.io)
[💻](https://github.com/codesponsor/web/commits?author=untra "Code") [🚇](#infra-untra "Infrastructure (Hosting, Build-Tools, etc)") [🔧](#tool-untra "Tools") | [
Limon Monte](https://limonte.github.io)
[🐛](https://github.com/codesponsor/web/issues?q=author%3Alimonte "Bug reports") [💻](https://github.com/codesponsor/web/commits?author=limonte "Code") | [
Arun Kumar](https://github.com/arun1595)
[💻](https://github.com/codesponsor/web/commits?author=arun1595 "Code") [📖](https://github.com/codesponsor/web/commits?author=arun1595 "Documentation") |

| :---: | :---: | :---: | :---: | :---: | :---: | :---: |

| [
Ivan Tivonenko](https://github.com/darkdarkdragon)
[💻](https://github.com/codesponsor/web/commits?author=darkdarkdragon "Code") [⚠️](https://github.com/codesponsor/web/commits?author=darkdarkdragon "Tests") | [
Nathan Hopkins](https://twitter.com/@hopsoft)
[💻](https://github.com/codesponsor/web/commits?author=hopsoft "Code") [📖](https://github.com/codesponsor/web/commits?author=hopsoft "Documentation") | [
Erik Campobadal](https://erik.cat)
[💻](https://github.com/codesponsor/web/commits?author=ConsoleTVs "Code") |