Skip to content

noah-mydn/beast

Repository files navigation

BEAST Real-Time Chat App

BEAST is a real-time chat application built using the MERN stack (MongoDB, Express, React, Node.js). It allows users to create accounts, authenticate locally, and engage in real-time conversations with other users.

Features

  • User authentication: Users can create accounts and log in securely using local authentication.
  • Real-time messaging: Users can send and receive messages in real-time with other users.
  • Online user status: Users can see the online status of other users in the chat.
  • Responsive design: The app is built with MUI for a responsive and user-friendly interface.

Tech Stack

The following technologies were used to develop BEAST:

  • MongoDB: A NoSQL database for storing user data, chat messages, and other information.
  • Express: A backend web application framework for handling HTTP requests and routing.
  • React: A JavaScript library for building user interfaces.
  • Node.js: A JavaScript runtime environment for executing server-side code.
  • Socket.io: A library for enabling real-time communication between the server and clients.
  • MUI (Material-UI): A popular React UI framework for designing stylish and responsive interfaces. Deployment

Demo

A live demo of the BEAST app is available at https://beast-chat.onrender.com.

To run the app locally, follow these steps:

  • Clone the repository: git clone https://github.com/your-username/beast-chat-app.git
  • Install dependencies: cd beast-chat-app and npm install && cd ./client && npm install && npm run build
  • Configure environment variables: Create a .env file in the root directory and provide the necessary environment variables, such as database connection URL and JWT secret.
  • Start the development server: npm run dev

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please feel free to submit a pull request or open an issue in the GitHub repository.

Screenshots

Login

Login Page Login Page

Register

Register Page Register Page

Chat interface

Chat Interface Chat Interface

Thank you for using BEAST! Happy chatting!