Chat Application

This is a realtime chat application built using React, Vite, and Appwrite.

Table of Contents

• Working
• Features
• Installation
• Scripts
• Environment Variables
• License

Working

chat.mp4

Features

• User authentication
• Email verification
• Real-time messaging
• Delete messages
• Protected routes
• Responsive design

Installation

To get this project up and running locally, follow these step-by-step instructions.

In order to install and run this project locally, you would need to have the following installed on your local machine.

• Node.js
• NPM
• Git

Steps

1. Clone the repository:

   git clone https://github.com/alvinsjoy/Chat.git
   cd Chat

2. Create a .env.local file in the root directory and add your environment variables (see the environment variables section for more info):

   VITE_API_ENDPOINT=https://cloud.appwrite.io/v1
   VITE_PROJECT_ID=
   VITE_DATABASE_ID=
   VITE_COLLECTION_ID_MESSAGES=

3. Install the dependencies and run the development server:

   npm install
   npm run dev

   Open http://localhost:5173 to view in the browser.

Scripts

• npm run dev: Start the development server.
• npm run build: Build the app for production.
• npm run lint: Run ESLint to check for linting errors.
• npm run preview: Preview the production build locally.

Environment Variables

The following environment variables are required:

• VITE_API_ENDPOINT: Defines the API endpoint for Appwrite (default: https://cloud.appwrite.io/v1).
• VITE_PROJECT_ID: The unique identifier for your Appwrite project.
• VITE_DATABASE_ID: The identifier for the database being used.
• VITE_COLLECTION_ID_MESSAGES: The identifier for the collection (e.g., a collection named "messages") within the database used to store the messages.

License

This project is licensed under the MIT License. Feel free to customize it further based on your specific requirements.