Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.62 KB

README.md

File metadata and controls

83 lines (56 loc) · 3.62 KB
Raw

NFT website template

This is a simple website template for getting NFT information directly from chain. It uses wallet (like metamask) to assure NFT connection.

Acquire website files

Basic

If you have no experience with git and would still like to use our template file to enable your freshly deployed NFT collection, feel free to click the green button "Code" on the upper right corner of this website and then selecting "Download ZIP". Once downloaded, the zip file includes all files you need to display your NFT collection. Before that happens you need to configure the file, as explained in Configure section.

Advanced

  1. Fork the repo
  2. Configure js/env.js
  3. Make changes to the website (optional)
  4. Deploy files to Apillon hosting

Configure

Before the template can interact with the Smart Contract you have deployed via UI, it needs to be manually configured.

To configure the template, do the following:

  1. Open the template folder "js"
  2. Locate env.js file within the js folder
  3. Open the env.js file in code editor
  4. Change the first line by entering your smart contract address between parenthesis
  5. Select the chain version by commenting and uncommenting the right chain

Example:

const contractAddress = ""; // Paste the address of the NFT collection between the parenthesis

// uncomment the chain you are using by deleting the slashes
// const chainId = "0x507"; // Moonbase
// const chainId = "0x504"; // Moonbeam
// const chainId = "0x250"; // Astar

Once you have updated the js/env.js file, save it. Now the website files are ready to be deployed. ​

Preview the website on your computer

Before uploading the website to Apillon hosting, feel free to edit the code, add any customization or just review whether everything works as expected.

To preview the website on your computer you need to serve a http server from the root folder of the website. For example, you can run node package http-server from root folder like this:

npx http-server

Deploy to Apillon Hosting

Deploy entire project according to this documentation: Wiki

Basic

  1. If not already, register to Apillon.io
  2. Log in to Apillon console and create new Hosting bucket inside your project.
  3. Select all files of your website (as configured in the previous step) and use drag&drop action to pull the files into the Hosting bucket
  4. Once the files are uploaded, push them to Staging and finally to the Production
  5. Add your custom domain (as displayed in the dashboards UI)
  6. Review your newly deployed website

Advanced

To deploy your NFT website to Apillon Hosting you should:

  1. Clone this repository and configure it to your needs.
  2. If not already, register to Apillon.io
  3. Log in to Apillon console and create new Hosting bucket inside your project.
  4. In settings, create an API KEY with storage permissions. Write down API key and API secret.
  5. In your github repository setup actions secrets (variables)
    • WEBSITE_UUID : copy UUID from hosting bucket on Apillon dashboard
    • APILLON_API_KEY : your previously created API key
    • APILLON_API_SECRET : your previously created API secret

Now everything should be ready. When you will push to master branch, your website should start deploy to Apillon IPFS hosting. Monitor progress on Apillon.io dashboard. After some time you'll be able to get IPNS url and also setup your own domain.

You can change behavior of the automatic deployment by editing /.github/workflows/deploy.yml.