Skip to content

ankushKun/gitraven

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitRaven

or should I say get(git) revenue(raven)? 😉

GitRaven is a Blockchain based issue bounty platform. Here maintainers can create bounties for their issues and contributors can claim them. The bounty amount is then transferred to the contributor's account once the issue is closed and accepted by the maintainer.

Index

Project Setup

Prerequisites

  • Node.js (Latest LTS release, nvm preferred)
  • Typescript + Solidity knowledge

Tech Used

Fork & Clone the repository

git clone git@github.com:<YOUR_USERNAME>/gitraven.git
cd gitraven

Here you will find two folders:

  • nextapp containing the Next13 webapp
  • contracts containing all the solidity smart contracts

Install dependencies

cd nextapp
npm i

Setup environment variables

Create a .env file in the nextapp folder and add the following variables:

WC_PROJECT_ID=WALLET_CONNECT_PROJECT_ID
GITHUB_ID=GITHUB_OAUTH_APP_ID
GITHUB_SECRET=GITHUB_OAUTH_APP_SECRET
NEXTAUTH_URL=URL_FOR_THE_WEBAPP
NEXTAUTH_SECRET=RANDOM_STRING_FOR_SESSIONS

You can get the WC_PROJECT_ID from wallet connect by creating a new project.

You can get the GITHUB_ID and GITHUB_SECRET from github by adding a new app.

NEXTAUTH_URL is the URL where you will be running the app. For example, http://localhost:3000 for development or https://somedomain.com.

NEXTAUTH_SECRET is a random string that will be used for session management. You can generate one using random key gen.

Run the app

npm run dev

This will start the app in development mode. You can access it at http://localhost:3000.

Contributing

Contributions to enhance the webapp or any smart contract is highly appreciated. Please raise an issue before making any PRs.

License

CC BY-NC-SA 4.0 CC BY-NC-SA 4.0

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

See LICENSE for details.