Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvinsjoy/chat
This is a realtime chat application built using React, Vite, and Appwrite.
https://github.com/alvinsjoy/chat
appwrite chat realtime vite
Last synced: about 2 months ago
JSON representation
This is a realtime chat application built using React, Vite, and Appwrite.
- Host: GitHub
- URL: https://github.com/alvinsjoy/chat
- Owner: alvinsjoy
- Created: 2024-09-17T16:17:44.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T20:16:42.000Z (2 months ago)
- Last Synced: 2024-10-26T07:24:41.676Z (about 2 months ago)
- Topics: appwrite, chat, realtime, vite
- Language: JavaScript
- Homepage: https://chatappwrite.vercel.app
- Size: 5.53 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chat Application
This is a realtime chat application built using React, Vite, and Appwrite.
## Table of Contents
- [Working](#working)
- [Features](#features)
- [Installation](#installation)
- [Scripts](#scripts)
- [Environment Variables](#environment-variables)
- [License](#license)
## Working
## 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](https://nodejs.org)
- [NPM](https://www.npmjs.com)
- [Git](https://git-scm.com)
### Steps
1. Clone the repository:
```sh
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](#environment-variables) section for more info):
```env
VITE_HOST=http://localhost:5173
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:
```sh
npm install
npm run dev
```
Open 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_HOST`: Defines the base URL for the application. It is used to construct the verification URL for email verification.
- `VITE_API_ENDPOINT`: Defines the API endpoint for Appwrite (default: ).
- `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.