Giter VIP home page Giter VIP logo

codefund's Introduction

CodeFund

All Contributors Build Status Waffle.io - Columns and their card count

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:

Table of Contents

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. 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_fund.seed
  8. Run the services: docker-compose up -d
  9. 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 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_fund.seed
cd assets && npm install
cd ../
mix maxmind.setup
mix phx.server

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.

Contributors


Eric Berry

πŸ’» πŸ“– πŸ“¦

Miguel Angel GordiΓ‘n

πŸ’» πŸ“– πŸš‡ πŸ“¦

Justin Bean

πŸ’» πŸ“– πŸ€” ⚠️

bakaoh

πŸ’» πŸ“–

Samuel Volin

πŸ’» πŸš‡ πŸ”§

Limon Monte

πŸ› πŸ’»

Arun Kumar

πŸ’» πŸ“–

codefund's People

Contributors

stareintothebeard avatar coderberry avatar arku avatar untra avatar limonte avatar zoek1 avatar bakaoh avatar

Stargazers

 avatar

Watchers

James Cloos avatar Aditya Anand M C avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.