Skip to content

benji011/yggdrasil

Repository files navigation

About

Yggdrasil is a (currently pre-beta) public chatroom created using CRA powered by Firebase.

What can you do with it?

You can enter a chatroom or create one yourself. But there are restrictions for each user (mostly due to me being cheap and hosting the Database on a free tier plan so I don't have a lot of storage for now)

Installation

  1. First you need to set up Firebase. Please refer to the following docs before running the app:
  1. Install and start the local server
yarn && yarn start
  1. Access http://localhost:3000

Contributing

Please see CONTRIBUTING.md

Testing

  • As this is an app I built for fun, I haven't really begun adding tests (yet). If you would like to contribute (refer to CONTRIBUTING.md), feel free to send a pull request :)
  • Manual testing should be done locally. Please see Firebase settings on how to configure the app on the backend.

TODO

  • Add unit & E2E tests

About

A public open chatroom written in TypeScript using CRA & Firebase

Resources

Stars

Watchers

Forks

Packages

No packages published