Giter VIP home page Giter VIP logo

grillchat's Introduction

A chat application built on top of the Subsocial blockchain ๐Ÿ”—.

Grill offers a smooth and simple onboarding and user experience while still leveraging the power of blockchain technology.


production-build

--- ## How to integrate Grill into your app ๐Ÿค

It's now simpler than ever before to have an anonymous, on-chain chat right in your application ๐ŸŽ‰.

Read the integration guide to get started.

How to run Grill locally ๐Ÿƒโ€โ™‚๏ธ

Requirements:

  • Node.js v18.0.0 or higher
  • Yarn (you can use npm/pnpm if you want to)

1. Install dependencies

yarn

2. Setup environment variables

Copy the local example env file to .env

cp .env.local.example .env

3. Run the server

yarn dev

Congrats ๐ŸŽ‰, you can now access the app at http://localhost:3000

Theme Customization ๐ŸŽจ

All of the colors used in this project are provided in the globals.css file in RGB format. You can change the colors in this file to customize the theme of the app according to your needs.

Environment variables ๐ŸŒŽ

Below is the list of environment variables that you can use to customize your chat, based upon your needs and the needs of your community.

Name Description Required?
SERVER_MNEMONIC Wallet mnemonic of the server, in order to send automatically users Energy Yes
CRUST_IPFS_AUTH IPFS auth for using a Crust bucket Yes
IPFS_PIN_URL URL for Crust IPFS pinning service Yes
USER_ID_SALT Salt for user address encryption, which is used for analytics (which can be disabled) No
NEXT_PUBLIC_SPACE_IDS Your space ID(s). All the posts in these space(s) will be listed as topics. You can use multiple space IDs, separated by a comma. The first space ID will be recognized as the main space ID, where you can access the home page in / route, but for the other space IDs homepage, you can access it using /[spaceId]. You can read on how to manage your space here Yes
MODERATION_URL Moderation API url. Current moderation API: https://moderation.subsocial.network/graphql Yes
NEXT_PUBLIC_AMP_ID Amplitude analytics ID (disabled if no ID is provided) No
NEXT_PUBLIC_SQUID_URL Squid URL for fetching historical data. If provided, some of the data will be fetched using squid instead of blockchain No
NEXT_PUBLIC_COMMUNITY_HUB_ID Hub Id that will be used as community hub. If provided, community creation feature will be enabled No
NEXT_PUBLIC_GA_ID Google Analytics ID (disabled if no ID is provided) No

How to Manage Your Space

Grill home page contains list of topics for user to choose from. This topics are listed from all the posts in a subsocial space. You can create space in Subsocial chain.

You can add chat rooms into your space by creating posts inside it. After you created your post, you can check that it is listed in Grill by going to https://grillapp.net/c/{your space id}.

grillchat's People

Contributors

coinrefco avatar dependabot[bot] avatar iv1310 avatar mckrava avatar olehmell avatar omidasadpour avatar samchuk-vlad avatar siman avatar teodorus-nathaniel avatar tusharojha avatar yung-beef avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.