Jeffrey-Fazal / base-world-creator

A way to create your own world

Readme

Installation

Clone repo and npm install

Libraries

• React Router
  • Made by Remix which also a UI library that makes things faster

Documentation

React Router Guide

Pages

mindmap
    root((pages))
        Public
            Home (/)
            Story (/story)
        User
            CreatorHome (/creator)
            PlayerHome (/player)
            Profile (/profile)
        Auth
            Login (/login)
            SignUp (/signup)

React, Firebase and Authentication

Firebase needs to be iniated before sharing the login state.

Routes

Routed are located at src > app.js

Components

StoryBoard - used to display story from db

Styling

• Can add themes from DaisyUI by modifying the tailwinds.config.js themes array and the html data-theme in index.html https://daisyui.com/docs/themes/

Dev Notes

• Moved from using a vite react + tailwindscss server to doing everything manually
• Code may be less dry, but at least it'll work (hopefully.)

Todos

• Decide on default export (e.g sign out) or namespaced export (most things)