https://github.com/shellyda/project-software-engineering
Me passa a receita aí? (receita.ai) platform allows users to explore a wide range of recipes shared by a community of food lovers. Users can contribute by sharing their own recipes, providing feedback through comments, and rating the recipes they try. Project for software engineering course at CIn/UFPE.
https://github.com/shellyda/project-software-engineering
atomic-design cypress cypress-tests eslint husky jest nextjs plop-generators prettier tailwindcss unit-testing vercel-deployment
Last synced: 5 months ago
JSON representation
Me passa a receita aí? (receita.ai) platform allows users to explore a wide range of recipes shared by a community of food lovers. Users can contribute by sharing their own recipes, providing feedback through comments, and rating the recipes they try. Project for software engineering course at CIn/UFPE.
- Host: GitHub
- URL: https://github.com/shellyda/project-software-engineering
- Owner: Shellyda
- License: mit
- Created: 2024-08-05T01:15:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T14:12:00.000Z (about 1 year ago)
- Last Synced: 2025-05-14T18:11:33.835Z (9 months ago)
- Topics: atomic-design, cypress, cypress-tests, eslint, husky, jest, nextjs, plop-generators, prettier, tailwindcss, unit-testing, vercel-deployment
- Language: TypeScript
- Homepage: https://project-software-engineering-tauojw2a1-shellydas-projects.vercel.app/
- Size: 5.48 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Me passa a receita aí? (receita.ai) 🍴👩🍳👨🍳
[]()
[](https://github.com/Shellyda/project-software-engineering/issues)
[](https://github.com/Shellyda/project-software-engineering/pulls)
[](/LICENSE)
Welcome to **Me passa a receita aí?** _(receita.ai)_, a platform where users can share their favorite recipes, leave comments, and rate recipes shared by others.
Our platform aims to create a vibrant community of food enthusiasts who can discover, share, and enjoy a wide variety of recipes.
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Overview
**Me passa a receita aí?** platform allows users to explore a wide range of recipes shared by a community of food lovers. Users can contribute by sharing their own recipes, providing feedback through comments, and rating the recipes they try.
### Design work
- [Figma Project](https://www.figma.com/design/EyvP26g5FvODnRLuW8YIkn/Receita.ai?node-id=0-1&t=pjLzGqzsqdiTv0yA-1)
## Features
- **Recipe Sharing:** Users can create and share their recipes with the community.
- **Commenting:** Engage with other users by leaving comments on their recipes.
- **Rating System:** Rate recipes to help highlight the best ones in the community.
- **User Profiles:** Each user has a profile where they can manage their shared recipes, comments, and ratings.
- **Recipe Categories:** Browse recipes by categories such as desserts, main courses, appetizers, etc.
- **Search Functionality:** Easily find recipes based on ingredients, titles, or categories.
## Tech Stack
- **Frontend:** [Next.js](https://nextjs.org/)
- **Backend:** [Supabase](https://supabase.com/) - for database, authentication, and real-time API.
- **Database:** [Supabase](https://supabase.com/) (PostgreSQL) for the backend API.
- **Authentication:** Supabase Auth (OAuth, Magic Links, etc.)
- **Hosting:** [Vercel](https://vercel.com/) for frontend, [Supabase](https://supabase.com/) for backend.
## Prerequisites
- [Node.js](https://nodejs.org/)
- [yarn](https://yarnpkg.com/)
- [Supabase](https://supabase.com/) account
**obs.:** you can choose `npm` or `pnpm` to run scripts instead `yarn` too
## Installation
To run the platform locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/Shellyda/project-software-engineering.git
cd project-software-engineering
```
2. **Install dependencies:**
```bash
yarn install
```
3. **Start the development servers:**
```bash
yarn run dev
```
4. **Access the platform:**
- Navigate to `http://localhost:3000` for the frontend.
## Usage
Once the platform is up and running, you can start exploring recipes, post your own, and interact with other users. Make sure to create an account to unlock all features.
## Contributing
We welcome contributions from the community. If you would like to contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feat/your-feature`).
3. Commit your changes (`git commit -m "feat: add some feature"`).
4. Push to the branch (`git push origin feat/your-feature`).
5. Open a Pull Request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
## Contact
- Alysson Ramos - ajsr@cin.ufpe.br
- José Basilio - jbsn3@cin.ufpe.br
- Shellyda Barbosa - sfsb2@cin.ufpe.br
- Vituriano Xisto - vox@cin.ufpe.br
For questions or suggestions, feel free to contact us!
---
We hope you enjoy using **Me passa a receita aí?** and find it to be a valuable resource in your culinary journey!
Happy cooking! 🍴👩🍳👨🍳