Iggy Social Template

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/

Delete mirror.yml in the .github folder

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.

Change GitHub settings (needed only for build.yml)

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.

.env

Create a .env file from .env.example.

Make sure to also enter these vars in your hosting settings!

Hosting

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=netlify

You can also set these in the Nuxt config file (nuxt.config.ts).

4everland

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.

GIFs (Tenor)

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).

Image upload (Spheron/IPFS)

To support image uploads on IPFS please create a key/token on Spheron Storage: https://app.spheron.network/#/storage

Then add this key (and your bucket ID/name) to your environment variables:

SPHERON_BUCKET_NAME=
SPHERON_STORAGE_TOKEN=

Image uploads via Spheron work only if you have Netlify/Vercel background functions enabled (see netlify/functions/imageUploader.js).

Image upload fallback

It is recommended to use ImageKit as the fallback option, in case Spheron 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=

Customize

Project-specific settings in nuxt.config.ts
CSS files in the /public/css/ folder
Favicon and cover/preview images in /public/img/ folder

Setup

Make sure to install the dependencies:

# yarn
yarn install

# npm
npm install

# pnpm
pnpm install --shamefully-hoist

Development Server

Start the development server on http://localhost:3000

npm run dev

Or run Netlify dev server on http://localhost:8888 (to get link previews):

netlify dev

Production

Build the application for production:

npm run generate

Locally preview production build:

npm run preview

Checkout the deployment documentation for more information.

Testing

Orbis test group:

https://app.orbis.club/group/kjzl6cwe1jw145e1i1agcrjp9375sjpyyk7imu281koehrpve0pr46lvr5e9xco

wuarg/iggy-social-frontend