Skip to content

Latest commit

 

History

History
172 lines (118 loc) · 5.86 KB

README.md

File metadata and controls

172 lines (118 loc) · 5.86 KB
Raw

Kickback Dapp

Dev guide

Currently only frontend is open sourced. If you are working on the integration and need to connect to our backend, please contact Kickback team.

Contribution Style guide

At Kickback we adhere to some basic front-end coding style guides, so if you are looking to contribute, please follow these rules

Styles

Styles are added via the library emotion, which is a styled-component style library. You can add a new styled component using the @emotion/styled library

import styled from '@emotion/styled'

const CallToAction = styled('div')`
  background: 'green';
  color: 'red';
`

Styles can be kept in the same file as the component you're adding them into unless they are being reused somewhere else, in that case they can be abstracted out of the file and imported like a normal component.

Components

Components need to be inside the components folder. We are currently migrating to functional components and hooks, so all new components must be functional components and use hooks if they need state or access to external APIs. Do not use arrays to group sibling JSX, instead use the short fragment syntax <></>

function Component({}){
  return (
    <>
      <Button>This is a button</Button>
      <OtherComponent />
    </>
  )
}

Importing and exporting

For imports, we use the ES6 import syntax over commonJS. We first import all npm packages first, such as React, Emotion or Apollo. Then we group imports based on what they are and separate them with a space.

import React from 'react'
import { useQuery } from 'react-apollo'

import { GET_PROFILE } from 'graphql/queries'
import { SET_PROFILE } from 'graphql/mutations'

import Button from 'components/Button'

For exports, we generally have one default export for components. If it makes sense to have multiple exports in a component, we generally separate than component into a new file. The only exception is a group of reusable styled components that have no specific hierarchy, such as Buttons or Inputs.

//Normal component

export default function SomeComponent(){
  // component internals
}
//reusable components

export const Button1 = styled('button')`
`

export const Button2 = styled('button')`
`

Variable declaration

Generally we use const for everything, especially styled components. Any variable that needs to be reassigned will use let. var is not used at all throughout the code base. All variables are camel cased, unless they are a constant, in which they capitalised and snake cased. If the constant is used throughout the project, abstract the constant to an appropriate file level that all components or files can import it without going up and down the file try (should only need to go up the file tree to find the constant).

const Component = styled('div')`

`

function SideBar(){
  const CONSTANT_VALUE = 42
  let reassignableVar = null
  const { data } = useQuery(QUERY) // most destructured values will use const unless otherwise needed
  
  // rest of the component
}

File Naming

  • All components are Pascal Cased
  • All Javascript files that aren't components are camel cased
  • Anything that isn't a component are also camel cased

Connecting to external data sources (blockchain and backend)

Currently Kickback injects data into it's React front-end using the Apollo GraphQL library. To connect to the blockchain, we use a client-side resolver that connects to web3. This way our app does not need to know how it is connecting to the blockchain, that is all handled by our data library Apollo. In the same way, we also connect to our back-end via Apollo, which does not require anything apart from the graphql queries and mutations.

Setup

Clone the repo and install dependencies

git clone https://github.com/wearekickback/app.git
cd app
yarn

Generate src/config/env.json

yarn setup --rinkeby

Start the development server

yarn start

Test creating a event locally

Automated E2E tests with cypress (Not available to public)

Make sure the locally environment is up and running with local contract, ganache and server. When run ganache, run it with 500 accounts ganache-cli --accounts 500 -b 3

Run the seeding script to deploy some seed parties

$ yarn run seedParty
Creating admin profile
Deployed new party at address: 0x073c8E6c4653a150178D4Cdf501e455e55C26BA4
New rsvp 0x5656d12b67Cca4CF8d300a6d7f541bAb0965E443 at party 'Super duper'at address: 0x073c8E6c4653a150178D4Cdf501e455e55C26BA4
New rsvp 0xb37E1D697753Ee89D572d6Cf56DEfCDfb55236D5 at party 'Super duper'at address: 0x073c8E6c4653a150178D4Cdf501e455e55C26BA4
Admin account adm1547825705218 already exists
Deployed new party at address: 0xf4d12F3e5CA4D66C2196942135FDa78c8f3A90d1
New rsvp 0xb37E1D697753Ee89D572d6Cf56DEfCDfb55236D5 at party 'Super duper 2'at address: 0xf4d12F3e5CA4D66C2196942135FDa78c8f3A90d1
New rsvp 0x5656d12b67Cca4CF8d300a6d7f541bAb0965E443 at party 'Super duper 2'at address: 0xf4d12F3e5CA4D66C2196942135FDa78c8f3A90d1
Seeding parties complete!
Ready to run cypress tests
✨  Done in 14.11s.

NOTE: If the output does not show contract addresses, there is a possibility that the web3 version you are using may have a bug. If the bug is not fixed, try to manually change the web3 js code as described here

$ yarn run cypress:open

Seed script must be re-run to test again.

Deploying to xdai env manually

vercel login
vercel switch wearekickback
vercel -f --local-config .deploy/now.xdai.json --public --prod