Skip to content

A realtime chat application built using Express.js as its server-side

Notifications You must be signed in to change notification settings

rikukawano/xyz-chat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XYZ Chat 📱

Welcome to my XYZ Chat! This web application is designed to provide a seamless and interactive chat experience. Built with modern technologies like React for the frontend, Express for the backend, and Clerk for user authentication, it integrates Firebase for real-time database operations.

App Snapshot 📸

Want to see our Chat App in action? Here's a snapshot of what you can expect:

Chat App Interface

Getting Started 🚀

To get started with our Chat App, you'll need to have Node.js installed on your machine. Once you have Node.js, you can clone the repository and install the dependencies.

Installation 🔧

  1. Clone the repository:
git clone <repository-url>
  1. Navigate to the client directory and install the dependencies:
cd client
npm install
  1. Do the same for the server directory:
cd ../server
npm install

Running the Application 🏃‍♂️

To run the application, you'll need to start both the client and the server.

Starting the Client 🖥️

In the client directory, run:

npm start

This will start the React application in development mode. Open http://localhost:3000 to view it in the browser.

Starting the Server 🌐

In the server directory, run:

npm start

This will compile the TypeScript files and start the Express server on http://localhost:3001.

Features ✨

  • Real-time messaging 💬
  • User authentication and management 🔒
  • Responsive design for desktop and mobile devices 📲

Building for Production 🏗️

When you're ready to build the client for production, run:

npm run build

This will bundle the React app in production mode and optimize the build for the best performance.

Contributing 🤝

We welcome contributions! If you find a bug or have a feature request, please open an issue. If you'd like to contribute code, please submit a pull request.

License 📄

This open-source project is available under the MIT License.

Happy chatting! 🚀

About

A realtime chat application built using Express.js as its server-side

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published