Welcome to the frontend repository of our Reddit Clone, developed as part of the Software Engineering course at Cairo University Faculty of Engineering! This project is a comprehensive endeavor by a large team of 18 students, aimed at replicating the core functionalities of Reddit. Our objective is to provide users with a platform to create posts, comment, upvote, and engage in discussions on various topics. The frontend is built using React, ensuring a smooth and responsive user experience.
Our team is composed of dedicated students divided into specialized sub-teams to handle different aspects of the project:
Frontend Team (6 students): Focused on building the user interface and ensuring a seamless user experience. Backend Team (5 students): Responsible for developing the server-side logic, database management, and API integration. Testing Team (2 students): Ensured the reliability and quality of the application through rigorous testing procedures. Cross-Platform Team (5 students): Worked on ensuring the application’s compatibility across various platforms and devices. DevOps Team (1 student): Managed deployment, continuous integration, and infrastructure to support the development process.
- User Authentication: Sign up, log in, and log out functionalities with secure authentication.
- Post Creation: Users can create, edit, and delete posts with rich text formatting.
- Commenting System: Engage in discussions by adding, editing, and deleting comments on posts.
- Upvoting and Downvoting: Vote on posts and comments to express approval or disapproval.
- Subreddits: Create and join communities based on interests and topics.
- Search and Navigation: Easily search for posts, comments, and subreddits with an intuitive navigation system.
- Responsive Design: Optimized for both desktop and mobile devices to ensure accessibility and usability across different screen sizes.
- React: For building the user interface components and managing the application state.
- React Router: To handle navigation and routing within the application.
- Redux: For state management, providing a predictable state container.
- Axios: For making HTTP requests to the backend API.
- Material-UI: As the primary design framework to create a clean and modern user interface.
- Formik and Yup: For form management and validation.
- React Hook Form: For handling form inputs and validation with minimal re-renders.
- Sass: For writing clean and maintainable CSS.
To get started with the development or to run the project locally, follow these steps:
- Clone the repository:
git clone https://github.com/Team4-DevWave/Frontend.git
- Navigate to the project directory:
cd Frontend - Install dependencies:
npm install
- Start the development server:
npm start
The application should now be running on http://localhost:3000.
We welcome contributions from the community! If you'd like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch with a descriptive name.
- Make your changes and commit them with clear messages.
- Push your changes to your forked repository.
- Open a pull request to the main repository.
Please make sure to follow our Code of Conduct and Contributing Guidelines.
This project is licensed under the MIT License. Feel free to use, modify, and distribute this project as per the terms of the license.
Thank you for checking out our project! If you have any questions or feedback, please feel free to open an issue or contact us directly.