Iggy Social is a Web3 Social frontend website based on the Iggy Social template. It uses Orbis SDK and Ceramic Network in the background. For usernames it uses Punk Domains.
Demo 1 (Netlify): https://demo.iggy.social/ Demo 2 (Vercel): https://demo2.iggy.social/
The mirror.yml file is just for the purpose of mirroring this repo to other git servers (for backup reasons). You don't need this in your cloned project.
Build.yml is optional, it builds the projects, and stores the built code on the build branch. You can then use this branch for cheap deployment on 4everland (for example) - see instructions below.
In your repository, go to Settings -> Actions -> General. Select Read and write permissions. Also make sure you have the necessary env vars in your Settings.
If you do not need build.yml, delete it and ignore these instructions.
Create a .env file from .env.example.
Make sure to also enter these vars in your hosting settings!
We recommend to use Netlify for hosting the site. Netlify allows you to easily deploy the site from this repo (or from a fork of this repository).
Make sure to use the the npm run generate command instead of npm run build for build instructions on Netlify.
If you want to use optional features such as GIFs and image upload, make sure to enter proper environment variables (see .env.example).
Make sure to also select the proper serverless functions services in your environment variables, for example:
FILE_UPLOAD_SERVICE=netlify
LINK_PREVIEW_SERVICE=netlifyYou can also set these in the Nuxt config file (nuxt.config.ts).
4everland is a decentralized hosting provider which stores your website on IPFS.
If you have your code on GitHub, the build.yml script will build your app via GitHub Actions and create a build branch.
Make sure you add all the necessary env vars (tenor etc.) to the organization variables for actions on GitHub.
Also make sure you have Workflow permissions on the organization level on GitHub set to read & write.
Then, when you create a project on 4everland, make sure you select the build branch.
And in the build section delete the command and set build folder to empty (or ./). The preset can be set to Other. No install command is needed either.
If you want to have GIF search implemented, create your own Tenor API Key on Google Cloud Console. Follow the instructions here: https://developers.google.com/tenor/guides/quickstart.
Then enter the key in environment variables (TENOR_KEY).
To support image uploads, create an Arweave Wallet (e.g. here: https://arweave.app/) and send some AR to it.
Then go to the wallet settings and download Backup Keyfile.
In this file you'll find 10 different variables, enter these into your .env file:
ARWEAVE_KTY=
ARWEAVE_N=
ARWEAVE_E=
ARWEAVE_D=
ARWEAVE_P=
ARWEAVE_Q=
ARWEAVE_DP=
ARWEAVE_DQ=
ARWEAVE_QI=Also make sure these variables are set on your hosting provider (Netlify, Vercel, etc).
It is recommended to use ImageKit as the fallback option, in case Arweave has technical issues.
For this to work, create an account at ImageKit.io and add these environment variables to your project:
IMAGEKIT_ENDPOINT=
IMAGEKIT_PUBLIC_KEY=
IMAGEKIT_PRIVATE_KEY=- Project-specific settings in
nuxt.config.ts - CSS files in the
/public/css/folder - Favicon and cover/preview images in
/public/img/folder
Make sure to install the dependencies:
# yarn
yarn install
# npm
npm install
# pnpm
pnpm install --shamefully-hoistStart the development server on http://localhost:3000
npm run devOr run Netlify dev server on http://localhost:8888 (to get link previews):
netlify devBuild the application for production:
npm run generateLocally preview production build:
npm run previewCheckout the deployment documentation for more information.
Orbis test group:
https://app.orbis.club/group/kjzl6cwe1jw145e1i1agcrjp9375sjpyyk7imu281koehrpve0pr46lvr5e9xco