Ctrix Chat is a real-time chat application built with React and Firebase. It allows users to sign in, create chat rooms, and communicate with each other instantly.
- User Authentication: Sign up and sign in using Firebase Authentication.
- Real-time Chat: Send and receive messages instantly in chat rooms.
- Create Chat Rooms: Users can create new chat rooms to talk with friends.
- Giphy Integration: Share GIFs in your conversations using the Giphy API.
- Responsive Design: A clean and responsive UI built with Chakra UI.
- Frontend: React, Chakra UI
- Backend: Firebase (Authentication, Firestore)
- State Management: React Context API
- Routing: React Router
- GIFs: Giphy API
- Node.js (v14 or later)
pnpm(ornpm/yarn)
-
Fork the repository
-
Clone your fork
git clone https://github.com/your-username/Ctrix-Chat-App.git
-
Navigate to the project directory
cd Ctrix-Chat-App -
Install dependencies This project uses
pnpm. If you havepnpminstalled, run:pnpm install
Alternatively, you can use
npmoryarn:npm install # or yarn install -
Set up Firebase
- Create a new project on the Firebase Console.
- Add a new web app to your Firebase project.
- Copy your Firebase configuration.
- Create a
.envfile in the root of the project and add your Firebase config:For Development REACT_APP_FIREBASE_DEV_API_KEY=your-api-key REACT_APP_FIREBASE_DEV_AUTH_DOMAIN=your-auth-domain REACT_APP_FIREBASE_DEV_PROJECT_ID=your-project-id REACT_APP_FIREBASE_DEV_STORAGE_BUCKET=your-storage-bucket REACT_APP_FIREBASE_DEV_MESSAGING_SENDER_ID=your-sender-id REACT_APP_FIREBASE_DEV_APP_ID=your-app-id REACT_APP_GIPHY_API_KEY=your-giphy-api-key For Production REACT_APP_FIREBASE_API_KEY=your-api-key REACT_APP_FIREBASE_AUTH_DOMAIN=your-auth-domain REACT_APP_FIREBASE_PROJECT_ID=your-project-id REACT_APP_FIREBASE_STORAGE_BUCKET=your-storage-bucket REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your-sender-id REACT_APP_FIREBASE_APP_ID=your-app-id REACT_APP_GIPHY_API_KEY=your-giphy-api-key - You will also need to get a Giphy API key from the Giphy Developer Portal.
-
Run the development server
pnpm start
The app will be available at
http://localhost:3000.
make sure to check npm run build if it worke
Contributions are welcome! Please see the CONTRIBUTING.md file for details on how to get started.
This project is licensed under the MIT License - see the LICENSE file for details.