/shapeitapp

Shape Up for GitHub Projects

Primary LanguageJavaScript

This is a Next.js project bootstrapped with create-next-app.

Getting Started

  1. If the Github project you want to connect does not already exist, navigate to your Github profile and create a new Project using the URL https://github.com/users/[your-username]/projects/.
  2. Login to https://shapeit.app/ and follow the provided steps to connect your Github project.
  3. Add some Bets to you project.

Scopes

  1. In order to collect scopes a Bet must follow a certain template, we recommend to use this one.
  2. Add this github workflow to your project as well.

Examples:

Contribute

Create a file called .env.local with the following lines:

GITHUB_CLIENT_ID=xxxx
GITHUB_CLIENT_SECRET=xxxx
GITHUB_REDIRECT_URI=https://localhost:3000/api/auth/callback/github
GITHUB_TOKEN=xxxx
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=yyyyy
NEXT_PUBLIC_SITE_URL=http://localhost:3000/

To get a GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET go to your Github settings and create a new OAuth app. GITHUB_TOKEN is needed to access public project without authentication.

You can create a new personal token here. Make sure it has, at least, the following scopes: public_repo, read:project, read:user.

Then, run the development server:

npm install
npm run dev

Tests

npm run cypress:run

Open http://localhost:3000 with your browser to see the Shape Up application.

How to use

Check this guide

Roadmap

https://shapeit.app/projects/org/shapeitapp/1

Pitch a new feature request