Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 1.55 KB
Raw

Contribute to pay.party

The directories that you'll use are:

packages/react-app/
packages/hardhat/
packages/backend/

The project was created by members of the moonshot collective using the scaffold-eth template repository.

Quick Start

Running the app requires setting up proper enviroment variables, and node (<=v16.13.0). See the .sample.env in the directories for more information on creating .env's. You will need access to a mongodb connection string, an etherscan-like block explore api key, and RPC key.

  1. Navigate to the root directory after cloning the repository.

    git clone https://github.com/moonshotcollective/pay.party.git
cd pay.party

  2. install your dependencies

    yarn install

  3. start a hardhat node

    yarn chain

  4. deploy the contract to the hardhat node

    yarn deploy

  5. run the api

    yarn api

  6. run the app

    yarn start

Making a pull request

Each time you begin a set of changes, ensure that you are working on a new branch that you have created as opposed to the main of your local repository. By keeping your changes segregated in this branch, merging your changes into the main repository later will be much simpler.

💬 Support Chat

🙏 Please check out our Moonshot Collective telegram!

Join the telegram support chat 💬 to ask questions and find others building with 🏗 scaffold-eth!