the-forum

Live

The Forum is a forum site that is so revolutionary that it will transform your expectation of forum site in future. How? You have to experience yourself.

Getting Started

Prerequisites

1. Download and install Node.js
2. Download and install Yarn (v1)

Installing

1. Clone this repo.

   git clone https://github.com/malcolm-kee/the-forum.git
   

2. Install all the dependencies

   yarn
   

3. Add a .env.local file in project root (next to .env file) with all the similar parameters specified in .env file. Those parameters are obtained from your Firebase project config.

Runing Local Development Server

yarn start

Running Tests

To run the tests in watch mode, use

yarn test

Else, run the tests and generating code coverage report with:

yarn test:ci

Deployment

Build frontend bundle with

yarn build

which will generates a build folder with all the static files for the application. You can deploy those files in anywhere that can host static files.

Else, if you wish to deploy everything (including Firebase Functions), you need to install Firebase CLI globally and then run the following command in project root:

firebase deploy

Built With

• React
• TypeScript
• Firebase for authentication, database, and hosting.
• Tailwind as CSS frameworks
• Create React App for build pipeline, test framework setup, and ESLint configuration