zcash-grant-system/backend

Grant.io Backend

This is the backend component of Grant.io.

Environment Setup

Run the following commands to bootstrap your environment. Note: db setup is configured in .env when running locally. SQLLite is used by default in /tmp/

# Get python in a virtual environment
virtualenv -p python3 venv
source venv/bin/activate

# Install python requirements
pip install -r requirements/dev.txt

# Create environment variables file, edit as needed
cp .env.example .env

If you want emails to work properly, you'll both need a SendGrid secret api key in .env, and if you’re running Python 3.6+ on macOS, you'll need to fix your certificates.

Database Setup

Once you have installed your DBMS, run the following to create your app's database tables and perform the initial migration

flask db migrate
flask db upgrade

Running the App

Depending on what you need to run, there are several services that need to be started

If you just need the API, you can run

flask run

Deployment

To deploy

export FLASK_ENV=production
export FLASK_DEBUG=0
export DATABASE_URL="<YOUR DATABASE URL>"
flask run       # start the flask server

In your production environment, make sure the FLASK_DEBUG environment variable is unset or is set to 0.

Shell

To open the interactive shell, run

flask shell

By default, you will have access to the flask app.

Running Tests

To run all tests, run

flask test

Migrations

Whenever a database migration needs to be made. Run the following commands

flask db migrate

This will generate a new migration script. Then run

flask db upgrade

To apply the migration.

For a full migration command reference, run flask db --help.

Commands

To create a proposal, run

flask create_proposal "FUNDING_REQUIRED" 1 123 "My Awesome Proposal" "### Hi! I have a great proposal"

External Services

To decode EIP-712 signed messages, a Grant.io deployed service was created https://eip-712.herokuapp.com.

To adjust this endpoint, simply export AUTH_URL with a new endpoint value:

export AUTH_URL=http://new-endpoint.com

To learn more about this auth service, you can visit the repo here.

S3 Storage Setup

1. create bucket, keep the bucket name and region handy

2. unblock public access Amazon S3 > BUCKET_NAME > Permissions > Public access settings

3. set the CORS configuration, replace HOST_NAME with desired domain, or * to allow all
   Amazon S3 > BUCKET_NAME > Permissions > CORS configuration

   <?xml version="1.0" encoding="UTF-8"?>
   <CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
        <CORSRule>
            <AllowedOrigin>HOST_NAME</AllowedOrigin>
            <AllowedMethod>GET</AllowedMethod>
            <AllowedMethod>POST</AllowedMethod>
            <AllowedMethod>PUT</AllowedMethod>
            <AllowedHeader>*</AllowedHeader>
        </CORSRule>
   </CORSConfiguration>
   

4. create IAM Policy, replace BUCKET_NAME with correct name.

    {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Effect": "Allow",
                "Action": [
                    "s3:PutObject",
                    "s3:PutObjectAcl",
                    "s3:GetObject",
                    "s3:DeleteObject"
                ],
                "Resource": [
                    "arn:aws:s3:::BUCKET_NAME/*"
                ]
            }
        ]
    }
   

5. create IAM user with programatic access (Access key) and assign that user the policy created above

6. copy the user's Access key ID, Secret access key, bucket name & bucket region to private .env, see .env.example

Social Verification (oauth)

These instructions are for development, for production simply replace all hostnames/ips/ports with the proper production hostname.

1. Create Github oauth app https://github.com/settings/developers

   1. select tab OAuth Apps > click New OAuth App button
   2. set Homepage URL to http://localhost:3000
   3. set Authorization callback URL to http://localhost:3000/callback/github
   4. save Client ID and Client Secret to .env GITHUB_CLIENT_ID & GITHUB_CLIENT_SECRET respectively.

2. Create Twitter oauth app https://developer.twitter.com/en/apply/user

   1. click Create an App
   2. set Website URL to a valid URL, such as http://demo.grant.io
   3. check the Enable Sign in with Twitter option
   4. set Callback URLs to http://127.0.0.1:3000/callback/twitter
   5. fill out other required fields
   6. after create, select Keys and tokens tab
   7. save Consumer API key and Consumer API secret key to .env TWITTER_CLIENT_ID & TWITTER_CLIENT_SECRET respectively.

3. Create Linkedin oauth app https://www.linkedin.com/developer/apps/new

   1. set Website URL to http://localhost:3000
   2. fill out other necessary fields & submit
   3. select the Authentication tab in app details
   4. check the r_basicprofile box under Default Application Permissions
   5. Under OAuth 2.0 > Authorized Redirect URLs add http://localhost:3000/callback/linkedin
   6. click update button
   7. save Client ID and Client Secret to .env LINKEDIN_CLIENT_ID & LINKEDIN_CLIENT_SECRET respectively.