Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qrtp/solana-project-tools

Free NFT project tools for the Solana blockchain
https://github.com/qrtp/solana-project-tools

dao discord nft solana

Last synced: about 2 months ago
JSON representation

Free NFT project tools for the Solana blockchain

Awesome Lists containing this project

README 

        
# solana-project-tools



NFT 4 Cause develops opensource tools because we believe in giving back to the Solana NFT community. Our mission is to enable projects to focus their funds on developing their community and making progress on their roadmap.



The primary purpose of this repository is to enable Solana NFT project owners to assign custom Discord server roles to users holding their NFT. The Discord user navigates to a verification URL to submit their wallet for analysis, and the Discord role is immediately assigned if holding criteria is met. 



Additional services offered in the project tools suite:



1. NFT holder only voting service

1. Verified holder snapshots

1. Sales tracking

1. Sales notification bots for Twitter and Discord



Full documentation of the service features can be found on our [wiki](https://github.com/qrtp/solana-project-tools/wiki). For any questions message me on twitter [@NFT4Cause](https://twitter.com/nft4cause).



# Hosted service

We offer this project as a free hosted service at [https://verify.4cause.app](https://verify.4cause.app). Feel free to register your project on our highly available deployment across IBM and Google Clouds.



## Demonstration video

Want to see it in action? There's a [live demo on YouTube](https://www.youtube.com/watch?v=QFRDIN4athM) showing how our hosted service can be used to verify users for any Solana NFT project and assign Discord roles to a specified server.



# Deploy your own service

Keep reading if you'd like to host this project yourself :)

## Prerequisites

1. Discord knowledge

1. Discord app and bot created and added to your server

1. Proper .env file



## How to set up .env file

I'll go over every parameter of .env.example and explain what it does and how to get it.

Needless to say, rename .env.example to .env and update values as per instruction -



### UPDATE_AUTHORITY

Service level NFT token update authority that will grant user premium access to features.

### SPL_TOKEN

Additional SPL token that unlocks premium features (optional)

### RELOAD_INTERVAL_MINUTES

Interval at which revalidation is required for a project.

### REVALIDATION_MODE

Boolean value indicating if service is running in user facing mode or revalidation mode. Revalidations must be performed by standalone offline processes for performance and scaling purposes.

### MAX_FREE_VERIFICATIONS

Maximum number of verifications for a project with basic service.

### MESSAGE

The message text a user will sign to verify they own a wallet.

### BASE_URL

Base URL of your domain. For our hosted service this is [https://verify.4cause.app](https://verify.4cause.app).

### PRODUCT_NAME

Title of your service.

### UPGRADE_URL

URL for your mint where user's can buy upgrade service.

### ABOUT_URL

URL to your main project website to get information about you.

### LOGO_URL

Link to an image for the navigation banner.

### TWITTER_CONSUMER_KEY

OAUTH consumer key for connecting user's Twitter account.

### TWITTER_CONSUMER_SECRET

OAUTH consumer secret for connecting user's Twitter account.



### TWITTER_SESSION_SECRET

Any string of your choosing, used to secure user session cookie.

### COS_CONFIG

Configuration JSON for IBM Cloud Object Storage. If COS configuration is provided, files will be stored on IBM Cloud instead of the local filesystem.



#### How to get IBM Cloud Object Storage

Good news, it's free! There is [great documentation](https://cloud.ibm.com/docs/cloud-object-storage/about-cos.html#about-ibm-cloud-object-storage) with full details on how to register for IBM Cloud and get a Cloud Object Storage instance. High level steps are:



- Register for a new [cloud.ibm.com](https://cloud.ibm.com) account

- Navigate to the [Cloud Object Storage console](https://cloud.ibm.com/objectstorage/)

- Create a COS service instance

- Create an API key to access the COS service instance

- Create a COS bucket in the COS service instance



Once you have those steps complete, just fill in the configuration template below. Note, I used the `us-south` endpoint in the example below but you can use any of the global endpoints in the config.



#### Sample configuration value

If you want to use COS, use the following format but with your own data `COS_CONFIG={"instanceID":"","apiKey":"","bucket":"","endpoint":"s3.us-south.cloud-object-storage.appdomain.cloud","storageClass":"us-south-standard"}`



## Deployment



Our service is provisioned as a Docker container across IBM Cloud and Google Cloud for high availability. If you would like to roll your own deployment, feel free to choose your favorite cloud provider!



## Build Setup



```bash

# install dependencies

$ yarn install



# serve with hot reload at localhost:3000

$ yarn dev



# build for production and launch server

$ yarn build

$ yarn start



# generate static project

$ yarn generate

```



For detailed explanation on how things work, check out the [documentation](https://nuxtjs.org).



## Special Directories



You can create the following extra directories, some of which have special behaviors. Only `pages` is required; you can delete them if you don't want to use their functionality.



### `assets`



The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.



More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/assets).



### `components`



The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.



More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/components).



### `layouts`



Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.



More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/layouts).



### `pages`



This directory contains your application views and routes. Nuxt will read all the `*.vue` files inside this directory and setup Vue Router automatically.



More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/get-started/routing).



### `plugins`



The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use `Vue.use()`, you should create a file in `plugins/` and add its path to plugins in `nuxt.config.js`.



More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/plugins).



### `static`



This directory contains your static files. Each file inside this directory is mapped to `/`.



Example: `/static/robots.txt` is mapped as `/robots.txt`.



More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/static).



### `store`



This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.



More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/store).