Giter Club home page Giter Club logo

chaos-chat-app's Introduction

Chaos ChatRoom App

Chaos ChatRoom is a real-time chat application built using React and Firebase. It allows users to join chat rooms, send messages, and interact with others in real-time.

ScreenShot

Chaos ChatRoom App Screenshot

Features

  • User authentication with Firebase Authentication.
  • Create and join chat rooms.
  • Real-time messaging with Firebase Realtime Database.
  • User avatars and display names.
  • Responsive design for various devices.

Getting Started

Prerequisites

  • Node.js installed on your machine.
  • A Firebase project set up. You can create one here.

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/chaos-chatroom.git
  2. Change to the project directory:

    cd chaos-chat-app
  3. Install Dependencies:


    Using npm:

    npm install firebase
    
    npm install firebase react-firebase-hooks
  4. Configure Firebase:

    Create a Firebase project on the Firebase Console. Copy your Firebase project's configuration object from the Firebase Console to src/firebase/firebase.js. Start the Development Server:

  5. Start the Development Server:

    npm start
  6. Access the App:

    Open your web browser and visit http://localhost:3000 to access the app locally.

Deployment

  • To deploy the app to production, follow these steps:
  1. Update package.json:

    Modify the homepage field in package.json to match your production URL:

    // package.json
    
    "homepage": "https://yourusername.github.io/chaos-chatroom"
     // package.json
    
    "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject",
    "predeploy": "npm run build", //Add
    "deploy": "gh-pages -d build" //Add
    }
  2. Deploy to GitHub Pages:

    Run the following command to build and deploy the app:

    npm run deploy

    This will publish your app to the specified production URL.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:

  • Fork the repository.
  • Create a new branch for your feature or bug fix.
  • Make your changes and commit them with clear commit messages.
  • Push your changes to your fork.
  • Create a pull request to the original repository's main branch.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

Special thanks to the React and Firebase communities for their fantastic tools and documentation. This project is inspired by the desire to learn and build real-time applications.

Happy chatting!

chaos-chat-app's People

Contributors

ayushx309 avatar

Stargazers

HarmitKalal avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.