-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Kochu-Media is a next-generation social media platform designed for users to post photos with captions, save posts, and engage with interactive content. Built with modern technologies like React, Appwrite, and Tailwind CSS, Kochu-Media aims to provide a seamless user experience with a feature-rich platform.
This wiki provides a detailed guide on how to get started with Kochu-Media, its features, and how to contribute.
- Users can upload and share images with descriptive captions.
- Images are stored securely using the Appwrite backend.
- Users can save posts for future reference using the bookmark feature.
- Each user has a customizable profile that displays their posts and saved content.
- The app uses Three.js and React-Three/Fiber for unique, immersive visual experiences.
- Users get real-time updates through toasts and alerts using Radix UI Toast.
- React: Frontend framework for building a dynamic user interface.
- Framer Motion: Smooth animations and transitions.
- Radix UI: Accessible, customizable UI components for dialogues, toasts, and more.
- Three.js & React-Three/Fiber: Rendering 3D graphics for immersive user experiences.
- Tailwind CSS: Utility-first CSS framework for fast styling.
- React Router: Client-side routing for navigating between pages.
- Lucide Icons & Tabler Icons: Rich library of icons for a modern look.
- Appwrite: Backend-as-a-Service that handles authentication, file storage, and database.
- React Query: For state and server data management.
- React Dropzone: For efficient file uploads.
- Zod: Schema-based validation library.
- Tailwind Merge: For combining Tailwind class names.
- Clsx: Utility for conditionally joining class names.
Kochu-Media utilizes Appwrite for the backend services. Below are the key APIs:
-
Authentication API:
- Sign Up/Sign In: Users can register and log in with their credentials.
- Session Management: Authentication tokens are managed securely.
-
File Storage API:
- Allows users to upload images and retrieve them for their posts.
-
Database API:
- Manages posts, captions, and user data in a secure and scalable way.
- Initial release.
- Core features:
- Photo posting with captions.
- Save and bookmark posts.
- Basic user profile functionality.
- Integration with Appwrite for authentication and storage.
- Initial 3D visualization components with React-Three/Fiber.
Upcoming features include better profile customization, social interaction (likes/comments), and performance optimization.
We welcome contributions from the community. If you would like to help improve Kochu-Media, please follow the steps below:
- Fork the Repository: Create a personal fork of the Kochu-Media repository.
-
Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b my-new-feature
- Make Changes: Implement your changes, following the project's coding standards.
- Test: Ensure that all changes are tested locally before submitting a pull request.
- Submit a Pull Request: Once your changes are ready, submit a PR for review.
- Please adhere to the coding standards.
- Ensure the UI and UX remain clean and intuitive.
- All pull requests will be reviewed and may require revisions before merging.
- You can open an issue in the Issues tab for bugs, feature requests, or general suggestions.
- The upcoming phases include enhancing the user profile functionality, adding social interaction features like likes and comments, and optimizing performance.