jorgeavaldez / champagne

near protocol social media engagement campaign linkdrop service

champagne

Quick Start

To run this project locally:

Prerequisites: Make sure you've installed docker

# install deps
yarn

# Deploy smart contracts
yarn build:contract && yarn dev:deploy:contract

# Start in docker
docker-compose up

Now you'll have a local development environment backed by the NEAR TestNet!

Go ahead and play with the app and the code. As you make code changes, the app will automatically reload.

Exploring The Code

• Contracts live in contracts.near-linkdrop, a submodule pointing to this repo
• pages contains a list of Next.js pages and api routes
• src contains components and helper modules for talking to the blockchain and social networks

Deploy

Every smart contract in NEAR has its own associated account. When you run yarn dev, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how.

Step 0: Install near-cli (optional)

near-cli is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local node_modules folder when you ran yarn install, but for best ergonomics you may want to install it globally:

yarn install --global near-cli

Or, if you'd rather use the locally-installed version, you can prefix all near commands with npx

Ensure that it's installed with near --version (or npx near --version)

Step 1: Create an account for the contract

Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as your-name.testnet, you can deploy your contract to champagne.your-name.testnet. Assuming you've already created an account on NEAR Wallet, here's how to create champagne.your-name.testnet:

1. Authorize NEAR CLI, following the commands it gives you:

   near login

2. Create a subaccount (replace YOUR-NAME below with your actual account name):

   near create-account champagne.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet

Step 2: set contract name in code

Modify the line in src/config.js that sets the account name of the contract. Set it to the account id you used above.

const CONTRACT_NAME = process.env.CONTRACT_NAME || 'champagne.YOUR-NAME.testnet'

Step 3: deploy!

One command:

yarn deploy

As you can see in package.json, this does two things:

1. builds & deploys smart contract to NEAR TestNet
2. builds & deploys frontend code to GitHub using gh-pages. This will only work if the project already has a repository set up on GitHub. Feel free to modify the deploy script in package.json to deploy elsewhere.

Troubleshooting

On Windows, if you're seeing an error containing EPERM it may be related to spaces in your path. Please see this issue for more details.

---

This React app was initialized with create-near-app

champagne's Issues

Where are the contracts?

yarn build:contract && yarn dev:deploy:contract doesn't work

As a user, I should be able to initialize a campaign with a set list of links that can be used to claim near

As a user, I should be able to list all of my campaigns

As a user, I should be able to schedule a tweet post to go out on campaign start date

As a user, I would like to see analytics on engagement on a tweet after campaign start date

Create linkdrop users after logging in with wallet

Allow campaign creation after initializing linkdrop user

Add smart contracts from other repo here as a submodule

As a user, I would like to see a list of recent followers after a campaign start date

If the campaign started, any time they load it, we should try to just show all recent followers since the beginning of the campaign. Maybe store them in the database and pick up from the most recent one.

Display list of currently logged in social auth accounts

So we know which ones are logged in. We may also need to display something about refresh token expiration