A Chat bot app
View App»

Project Planning board in Pivotal Tracker
UX Design on whimsical
UI/UX design on Figma

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Acknowledgements

About The Project

A simple chat bot app to demonstrate my understanding of react, socket io, firebase authetication, and Google Map API integrations.

Built With

• Node
• React
• Chakra UI
• Redux tool-kit
• Firebase
• Socket io
• Google Maps API

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

• yarn

npm install --global yarn

Installation

1. Clone the repo

git clone https://github.com/caleb-42/chat-app.git

2. Install NPM packages

yarn install

3. Create your env file named .env at the root of the project

REACT_APP_NODE_ENV=development
PORT=3000
REACT_APP_API_KEY=<FIREBASE API KEY>
REACT_APP_AUTH_DOMAIN=<FIREBASE AUTH DOMAIN>
REACT_APP_PROJECT_ID=<FIREBASE PROJECT ID>
REACT_APP_STORAGE_BUCKET=<FIREBASE STORAGE BUCKET>
REACT_APP_MESSAGING_SENDER_ID=<FIREBASE MESSAGING SENDER ID>
REACT_APP_APP_ID=<FIREBASE APP ID>
REACT_APP_SOCKET_ENDPOINT=<FIREBASE SOCKET ENDPOINT>
REACT_APP_GOOGLE_API_KEY=<GOOGLE API KEY> // activate Geocoding API & Maps JavaScript API

4. Run Tests (Used Jest and Puppeteer)

yarn test

Usage

To get started, please refer to the Hosted App

Acknowledgements

Used the following free services

• Netlify
• Github
• Pivotal Tracker