The CritiqueCraze is a platform where users can discover, review, and discuss everything. This platform allow to encompass reviews on a wide range of topics, offering users the ability to share their insights and opinions on different subjects.
- User authentication: Users can create an account, log in, and log out to access personalized features.
- Entity management: Users can add entities to their collection, including details such as title, author, description, and cover image.
- Entity reviews: Users can provide ratings and reviews for entities and view reviews from other users.
- User profiles: Users have their own profiles displaying their added entities, reviews, and other relevant information.
- Search functionality: Users can search for entities based on title, author, or keywords.
- Responsive design: The application is optimized for various screen sizes, ensuring a seamless experience across devices.
- Frontend: React, Redux Toolkit
- Backend: Node.js, Express.js
- Database: MongoDB with Mongoose
- Authentication: JSON Web Tokens (JWT)
- Image storage: AWS S3 (Simple Storage Service)
- External APIs: (Optional) Integration with entity-related APIs for additional details and information.
To get started with the CritiqueCraze application, follow the instructions below.
- Node.js (version >= 12.0.0)
- MongoDB database
-
Clone the repository:
git clone https://github.com/ankur-357/place-talks.git
-
Navigate to the project directory:
cd place-talks
-
Install the dependencies:
npm install
-
Start the development servers for the client and the server:
- Open a terminal and navigate to the client folder:
cd client
- Start the development server:
npm start
- Open another terminal and navigate to the server folder:
cd server
- Start the development server:
npm run dev
- The application will be accessible at
http://localhost:3000
(frontend) andhttp://localhost:5000
(backend).
Contributions are welcome! To contribute to the project, follow the steps below:
- Fork the repository
- Create a new branch
- Make your changes
- Commit your changes
- Push your changes to the branch
- Submit a pull request
- Wait for your pull request to be reviewed and merged
- Celebrate! ๐
- (Optional) Consider starring the repository! โญ
- (Optional) Consider following me on GitHub! ๐
- (Optional) Consider contributing again! ๐
- (Optional) Consider sharing the project with your friends! ๐จโ๐ฉโ๐งโ๐ฆ
- (Optional) Consider tweeting about the project! ๐ฆ
This project is licensed under the terms of the MIT License. See the LICENSE file for details.