omjao/giveth-2

Giveth 2.0 MVP

master staging

Giveth v2

🚀 Quick start

Giveth-2 is a reimagined version of the "Giveth donation application". Users leverage the Ethereum blockchain to distribute and track their donations or enable unstoppable funding for their campaign.

The projects aims to simplify the application's options to enable new users without blockchain experience a frictionless experience.

The project is currently in heavy development and does not offer all functionality that is needed for an MVP state (first release goal).

If you want to contribute, pls say hello to us in chat - https://giveth.io/join

Uses

• Gatsby
• Apollo GraphQL
• Tor.us
• Theme UI

Setup

1. Clone and install the backend server

   In order to develop locally you need to clone the backend server as well. We are using https://github.com/topiahq/impact-graph for this. Please follow the readme of impact-graph to install it. For more detailed instructions specific to giveth2 please refer to this gist.

2. Clone and install the frontend (this repo) First, please star and follow this repository.

   git clone [email protected]:Giveth/giveth-2.git
   cd giveth-2
   npm i

3. Set up the development environment

   cp .env.example .env.development

   To get the necessary information for local development, please ask in giveth-2 developer chat

4. Start developing.

   • Make sure that the backend server is running (Step1)

   • To take advantage of linting presets, please use VSCODE:

     • Select File -> Open Workspace
     • Navigate into the giveth-2 directory
     • Open the workspace filegiveth2-full-stack.code-workspace
     • Install recommended extensions (Prettier and StandardJS plugins)

   • Start up the local development server.

   gatsby develop

5. Open the source code and start editing!

   Your site is now running at http://localhost:8000!

   Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

   Save your changes and the browser will update in real time!

Contributor Guide

1. Like, star and fork the repo if you want to help with visibility
2. Have a look at the issue board and choose something to work on
3. Before starting any work, please at least say "Hi" on the giveth2-dev/Giveth2 construction office channel (see chat links here: https://giveth.io/join)
4. Even better, after introducing yourself pls join the next DEV Call (usually Sunday 17:30 CEST, but watch announcements in the discord channel)
5. Please ask somebody
6. If you found the project via a Gitcoin bounty, please make sure to check the issue every few days until completion (Gitcoin requires some proof of life checks)
7. Please start a new branch on your fork named with the feature/fix you want to attempt and make a pull request when you are confident everything is ready to publish

Gitflow

master only for PR's and noncritical hotfixes like typo's after merging - deploys to https://v2.giveth.io

New features should be pushed to a new branch named $featurename (No develop or release branches currently, but at least develop will be added in the future to have a proper staging environment)

Styling

Styling should be done in cooperation with senior contributors so a minimum of new styles is introduced locally. As a rule of thumb: all styles that are used more than once or are not very specific to one component should be added in the Theme UI definitionsrc/gatsby-plugin-theme-ui/index.js whenever possible and additionally to a gatsby page we use to collect all defined styles src/pages/viewstyles.js to quickly check consistency. Please refer to some examples in the code to see how we deal with styles. Local overrides and extensions should be done via sx prop or emotionJS.

Code conventions

• as mentioned above contributor code should be linted with StandardJS
• React components for into the folder /src/components and component filenames should be written in Camel case.