Welcome to the Otaku Community project! This is a web-based platform that enables anime enthusiasts to chat in real-time across different groups and channels. Built with Firebase for authentication and database, it provides a seamless experience for anime fans to connect, share, and discuss their favorite topics.
- User Authentication: Secure sign-up and login using Firebase Authentication.
- Real-Time Chat: Users can chat in real-time across multiple groups or channels.
- Anime Groups: Create, join, and participate in discussions tailored to specific anime genres, series, or topics.
- Responsive UI: Built using modern frameworks and responsive design for a smooth experience.
- Firebase Integration: Real-time database and authentication services provided by Firebase.
- Frontend:
- TypeScript (92.4%)
- JavaScript (5.3%)
- HTML (2.0%)
- CSS (0.3%)
- Tools & Frameworks:
- Vite: Fast development environment.
- Tailwind CSS: Utility-first CSS framework for quick styling.
- Firebase: For real-time database and user authentication.
- Package Management:
- npm: Package manager for JavaScript.
Follow these steps to set up and run the project locally:
- Node.js (v14 or higher)
- npm (v6 or higher)
- Firebase account and project setup
- Clone the repository:
git clone https://github.com/Kartikesh001/your-repository-name.git
- Navigate to the project directory:
cd your-repository-name
- Install dependencies:
npm install
- Setup Firebase:
- Add your Firebase configuration to
firebase.ts
or the relevant file. - Enable E-Mail Authentication and Firestore Database in Firebase Console.
- Add your Firebase configuration to
- Start the development server:
npm run dev
- Open your browser and navigate to:
http://localhost:5173
The project is deployed on Netlify. You can access it here: otaku-community.netlify.app
To deploy your own version:
- Connect your GitHub repository to Netlify.
- Configure environment variables if required.
We welcome contributions! Follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Commit your changes:
git commit -m "Add your feature description"
- Push to your branch:
git push origin feature/your-feature-name
- Submit a Pull Request.
This project is licensed under the MIT License. See the LICENSE
file for details.
For any queries or suggestions, feel free to connect:
- GitHub: Kartikesh001
- Website: Otaku Community