Skip to content

ArpitRathore2020/sherlock-s-eye

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 

Repository files navigation

Sherlock's Eye

Sherlock's Eye is a dynamic platform designed for information sharing and anonymous chats. Built with a modern tech stack including MongoDB, Express.js, React.js, and Node.js, this project offers a robust framework for users to engage in discussions, share insights, and connect anonymously. With features such as sentiment analysis, upvotes, downvotes, customizable themes, and more, it provides a seamless and interactive experience for users.

Features

  • Upvotes and Downvotes: Users can express their opinion on posts by upvoting or downvoting them, contributing to the community-driven nature of the platform.

  • Sentiment Analysis: The platform incorporates sentiment analysis to gauge the overall sentiment of posts, fostering constructive discussions and promoting positive engagement.

  • Anonymous Chats: Users have the option to engage in anonymous chats, facilitating open communication and exchange of information without revealing their identity.

  • MongoDB Integration: Leveraging MongoDB for data storage ensures efficient handling of large volumes of data while maintaining scalability and flexibility.

  • Tailwind.css Styling: Tailwind.css is utilized for front-end styling, enabling sleek and responsive design for an enhanced user experience.

  • Customizable Themes: The platform offers dark and light themes, allowing users to personalize their browsing experience according to their preferences.

  • Responsive Design: The platform is designed to be fully responsive, ensuring a consistent and optimal experience across devices of all sizes.

  • User Authentication: User authentication functionality is implemented to ensure secure access to the platform and protect user privacy.

Tech Stack

  • Frontend: React.js
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Styling: Tailwind.css

Getting Started

To get started with Sherlock's Eye, follow these steps:

  1. Clone the repository to your local machine.
  2. Install the necessary dependencies using npm install.
  3. Configure your MongoDB database connection.
  4. Run the backend server using npm start.
  5. Navigate to the frontend directory and run the React development server using npm start.

Contributing

Contributions are welcome! If you would like to contribute to the project, please fork the repository and submit a pull request with your proposed changes. Be sure to follow the contribution guidelines and maintain code quality standards.

License

This project is licensed under the MIT License, allowing for free use, modification, and distribution. Refer to the LICENSE file for more details.

Acknowledgements

Special thanks to the developers and contributors who have helped shape and improve Sherlock's Eye. Your efforts are greatly appreciated and contribute to the success of the project.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages