pixie

ShibHouse

Re-taking voice conversations to the moon 🚀
Explore the docs »

View Demo · Report Bug · Request Feature

What is this folder

This folder is called pixie (/ˈpɪksi/), it is currently used for our Next.js frontend.

It's live on 👉 shibhouse.tv

Folder structure

Here you find how we organize our files and folders

Folder	Description
auth	Contains everything related to Authentication, such as Firebase config, Private/Public routes and the AuthContext
components	Contains various page components such as Navbar, Footer, LoadingScreen ...
contexts	Contains the most used React.Contexts like PeerContext
forms	Contains Login/Register forms components
hooks	Contains various hooks like usePeer hook
interface	Contains TypeScript common used interfaces
lib	Contains various most used functions like createRoom, isChatCommand, getBrightColor and much more
modules	Contains various organised page components such as sidebars
pages	Contains the whole website pages (Default Next.JS Folder for routing)
styles	Contains the CSS files
utils	Contains other useful components like SEO.tsx

How to run locally

Clone the repository

git clone https://github.com/azizbecha/shibhouse.git

Install dependencies

npm install

Add Firebase app config:

1. Go to /auth folder and create a file named config.ts then add this piece of code and don't forget to replace the xxxxxxxxxxxxxxxxxxxxxxxxxxxxx's with your credentials

export const firebaseConfig = {
    apiKey: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    authDomain: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    projectId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    storageBucket: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    messagingSenderId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    appId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    measurementId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
};

2. On the same file, you need to add hCaptcha site key which you can get it from https://hcaptcha.com and add it like the following:

export const hCaptchaConfig = {
  siteKey: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx", // replace this with yours
  devKey: "10000000-ffff-ffff-ffff-000000000001" // this will be used when working in localhost only
}

Run the project

cd shibhouse
cd pixie

Or

npm run web

if you are in the /shibhouse folder.