-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from Tarungupta18/Tarungupta18-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
100 additions
and
116 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,140 +1,124 @@ | ||
| # StayFinder 🏠🌍 | ||
| # StayFinder 🏠✨ Accommodation Marketplace | ||
|
|
||
| <div align="center"> | ||
| <img src="https://img.shields.io/badge/Properties-200%2B-blue?style=for-the-badge" alt="Properties Badge"/> | ||
| <img src="https://img.shields.io/badge/Monthly%20Users-500%2B-success?style=for-the-badge" alt="Users Badge"/> | ||
| <img src="https://img.shields.io/badge/Media%20Uploads-1000%2B-brightgreen?style=for-the-badge" alt="Media Uploads Badge"/> | ||
| </div> | ||
|
|
||
| ## 🚀 Tech Stack | ||
|
|
||
| <div align="center"> | ||
| <img src="https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black" alt="React"/> | ||
| <img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white" alt="Node.js"/> | ||
| <img src="https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=express&logoColor=white" alt="Express"/> | ||
| <img src="https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white" alt="MongoDB"/> | ||
| <img src="https://img.shields.io/badge/Cloudinary-3448C5?style=for-the-badge&logo=cloudinary&logoColor=white" alt="Cloudinary"/> | ||
| <img src="https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=json-web-tokens&logoColor=white" alt="JWT"/> | ||
| <img src="https://img.shields.io/badge/Tailwind%20CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white" alt="Tailwind CSS"/> | ||
| </div> | ||
|
|
||
| ## 🌟 Project Highlights | ||
|
|
||
| ### 🏆 Impactful Metrics | ||
|
|
||
| | Metric | Achievement | | ||
| |--------|-------------| | ||
| | 🏘️ Total Property Listings | 200+ Unique Properties | | ||
| | 👥 Monthly Active Users | 500+ Travelers | | ||
| | 📸 Media Assets | 1000+ Images & Videos | | ||
| | 🚀 Development Efficiency | 95% Task Completion | | ||
| | ⏱️ Feature Delivery Speed | 25% Improvement | | ||
|
|
||
| ## 💡 Unique Value Proposition | ||
|
|
||
| StayFinder is more than just an accommodation platform. It's a revolutionary marketplace that: | ||
|
|
||
| - 🎯 **Intelligent Property Discovery** | ||
| - Comprehensive property listings | ||
| - High-resolution media showcase | ||
| - Detailed property information | ||
|
|
||
| - 🔒 **Secure & Transparent** | ||
| - JWT-based authentication | ||
| - Verified user profiles | ||
| - Secure transaction management | ||
|
|
||
| - 🌐 **User-Centric Design** | ||
| - Intuitive interface | ||
| - Responsive across devices | ||
| - Seamless booking experience | ||
|
|
||
| ## 🔍 Problem We Solve | ||
|
|
||
| Traditional accommodation platforms often struggle with: | ||
| - ❌ Limited property visibility | ||
| - ❌ Complex booking processes | ||
| - ❌ Inconsistent property information | ||
| - ❌ Poor media representation | ||
|
|
||
| **StayFinder transforms this by providing:** | ||
| - ✅ Comprehensive property showcases | ||
| - ✅ Simple, intuitive booking | ||
| - ✅ Verified property details | ||
| - ✅ High-quality visual representations | ||
|
|
||
| ## 🏅 Competitive Advantages | ||
|
|
||
| 1. **Media-Rich Listings** | ||
| - Cloudinary-powered image management | ||
| - 1000+ high-resolution media assets | ||
| - Enhanced property visualization | ||
|
|
||
| 2. **Robust Authentication** | ||
| - JWT-based secure login | ||
| - Monthly login capacity: 500+ users | ||
| - Multi-layer security protocols | ||
|
|
||
| 3. **Agile Development Approach** | ||
| - 95% task completion rate | ||
| - 25% faster feature delivery | ||
| - Continuous improvement model | ||
|
|
||
| ## 🚀 Quick Start | ||
|
|
||
| ## Overview | ||
|
|
||
| StayFinder is a comprehensive full-stack accommodation marketplace built using the MERN (MongoDB, Express.js, React, Node.js) stack, designed to provide an intuitive platform for property listings and bookings. | ||
|
|
||
| ## 🌟 Key Features | ||
|
|
||
| - **Extensive Property Marketplace** | ||
| - 200+ property listings | ||
| - Comprehensive property details and media showcase | ||
|
|
||
| - **Robust User Management** | ||
| - Secure authentication using JWT | ||
| - 500+ monthly logins | ||
| - Role-based authorization | ||
|
|
||
| - **Media Management** | ||
| - Cloudinary integration | ||
| - 1,000+ images/videos storage | ||
| - High-quality property visual presentations | ||
|
|
||
| - **Development Excellence** | ||
| - Agile methodology implementation | ||
| - 95% task completion rate | ||
| - 25% improvement in feature delivery speed | ||
|
|
||
| ## 🚀 Technologies Used | ||
|
|
||
| ### Frontend | ||
| - React | ||
| - Vite | ||
| - React Router | ||
| - Tailwind CSS | ||
| - Axios | ||
|
|
||
| ### Backend | ||
| - Node.js | ||
| - Express.js | ||
| - MongoDB | ||
| - Mongoose | ||
| - JWT (JSON Web Tokens) | ||
| - Cloudinary | ||
| - Bcrypt.js | ||
|
|
||
| ## 📦 Prerequisites | ||
|
|
||
| - Node.js (v16+ recommended) | ||
| - npm or Yarn | ||
| - MongoDB | ||
| - Cloudinary Account | ||
|
|
||
| ## 🔧 Installation | ||
|
|
||
| ### Clone the Repository | ||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/yourusername/StayFinder.git | ||
| cd StayFinder | ||
| ``` | ||
|
|
||
| ### Backend Setup | ||
| ```bash | ||
| # Install backend dependencies | ||
| cd api | ||
| npm install | ||
| ``` | ||
|
|
||
| Create a `.env` file in the backend directory with the following variables: | ||
| ``` | ||
| MONGODB_URI=your_mongodb_connection_string | ||
| JWT_SECRET=your_jwt_secret | ||
| CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name | ||
| CLOUDINARY_API_KEY=your_cloudinary_api_key | ||
| CLOUDINARY_API_SECRET=your_cloudinary_api_secret | ||
| ``` | ||
|
|
||
| ### Frontend Setup | ||
| ```bash | ||
| # Install frontend dependencies | ||
| cd client | ||
| npm install | ||
| ``` | ||
|
|
||
| ## 🖥️ Running the Application | ||
|
|
||
| ### Start Backend (Development) | ||
| ```bash | ||
| # Start backend server | ||
| cd api | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ### Start Frontend (Development) | ||
| ```bash | ||
| # Start frontend development | ||
| cd client | ||
| npm run dev | ||
| ``` | ||
|
|
||
| ## 🌐 Deployment | ||
|
|
||
| ### Backend Deployment | ||
| ```bash | ||
| cd api | ||
| npm start | ||
| ``` | ||
|
|
||
| ### Frontend Build | ||
| ```bash | ||
| cd client | ||
| npm run build | ||
| ``` | ||
|
|
||
| ## 📈 Performance Highlights | ||
|
|
||
| - **User Authentication**: 500+ monthly logins | ||
| - **Property Listings**: 200+ properties | ||
| - **Media Storage**: 1,000+ images/videos | ||
| - **Development Efficiency**: 95% task completion | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create your feature branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
| ## 🤝 Community & Contributions | ||
|
|
||
| ## 📄 License | ||
| **Star** ⭐ the repo if you find it valuable! | ||
|
|
||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
| [Contribution Guidelines](CONTRIBUTING.md) | ||
|
|
||
| ## 📞 Contact | ||
| ## 📊 Roadmap | ||
|
|
||
| Tarun Gupta - tkg21430@gmail.com | ||
| - [ ] Advanced search filters | ||
| - [ ] Machine learning recommendations | ||
| - [ ] Multi-language support | ||
| - [ ] Enhanced user review system | ||
|
|
||
| Project Link: [https://github.com/Tarungupta18/StayFinder](https://github.com/Tarungupta18/StayFinder) | ||
| ## 📞 Connect | ||
|
|
||
| ## 🙏 Acknowledgments | ||
| [](http://linkedin.com/in/tarungupta18) | ||
| [](https://portfolio-one-iota-78.vercel.app/) | ||
|
|
||
| - [React](https://reactjs.org/) | ||
| - [Express.js](https://expressjs.com/) | ||
| - [MongoDB](https://www.mongodb.com/) | ||
| - [Cloudinary](https://cloudinary.com/) | ||
| *Reimagining travel accommodation, one stay at a time* 🌍🏨 |