Skip to content

Latest commit

 

History

History
119 lines (83 loc) · 5.4 KB

README.md

File metadata and controls

119 lines (83 loc) · 5.4 KB
Raw

Typing SVG

TastyTrails is more than just recipes — it’s a vibrant social network where food lovers can connect, discover, and share the unique flavors of their cultures. A platform for passionate food enthusiasts to dive into a world of tastes!

🌟 Stars 🍴 Forks 🐛 Issues 🔔 Open PRs 🔕 Close PRs
Stars Forks Issues Open Pull Requests Close Pull Requests

🚀 Project Overview

TastyTrails is designed to offer an immersive experience for discovering and contributing to diverse recipes. The sleek frontend, built with ReactJS, Tailwind CSS, and TypeScript, ensures a visually captivating and user-friendly interface. On the backend, Node.js, Express.js, and MongoDB power robust data handling and API functionality for smooth performance.

For GSSOC24-Ext Contributors
For GSSOC24-Ext Mentors

⚙️ Tech Stack

🌐 Frontend:

  • ReactJS
  • Tailwind CSS
  • TypeScript

🖥️ Backend:

  • Node.js
  • Express.js
  • MongoDB

📁 Folder Structure

The project is structured as follows:

  • frontend/: Contains files for frontend development.
  • backend/: Includes the backend code and configurations.

✨ For GSSOC24-Ext Contributors

Welcome to GSSOC24 Extended and TastyTrails! ✨
We’re thrilled to have you onboard, guided by our Project Admin Alfiya! 🎉 Congratulations on joining this exciting journey.

TastyTrails is in its early development phase, and there’s plenty of room for everyone to contribute. Whether you’re a beginner or an advanced developer, there are opportunities to make meaningful contributions! If you’re not sure where to start, check out the tasks below and refer to the CONTRIBUTING.md file to set up the project locally.

🔍 Non-Technical Tasks

  • Improve CONTRIBUTING.md with detailed guidelines on setup and conduct.
  • Create templates for Issues and Pull Requests.
  • Propose engaging content for the website.

🛠️ Technical Features

Please do not open issues for under-development features as they will be closed under duplicate issues

  • Add OAuth - Google 🔑: Add support for secure Google login. (Under development)
  • Follow - Unfollow feature 👥: Let users follow fellow food enthusiasts. (Under development)
  • Recipe Like - Unlike Feature ❤️: Enable liking and unliking recipes. (Under development)
  • Implementation of Chat System 💬: Implement a real-time chat feature. (Under development)
  • Add Lazy loading for Images 🖼️: Optimize image load times. (Completed)

Feel free to open an issue for any of the tasks above or suggest your ideas. You can also propose bug fixes, new features, or improvements.

🏷️ Contribution Labels

  • Level 1: Bug fixes or small changes.
  • Level 2: Feature improvements.
  • Level 3: New feature implementations.

🚨 Contribution Guidelines

Issues are assigned on a first come, first serve basis.

Any changes related to the design of the website must have a design proposal or reference first.

Pull requests (PRs) should only be raised for assigned issues.

Start working on the issue only after it is assigned to you.

When raising PRs, make sure to tag the issue by using the format: fixes #issue_number

👀 Our Contributors

  • We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating this project to greater heights.
  • Make sure you show some love by giving ⭐ to our repository.

🎉 Join the Culinary Adventure!

Whether you’re contributing code, improving documentation, or suggesting new features, your involvement matters. We value contributions that help you learn and grow, not just for gaining points. Let's make TastyTrails a flavorful success — one contribution at a time!

All the Best! 💫 Happy Coding & Cooking! 🍳