RecipeBox is a full-stack web application built with RedwoodJS that allows users to share and browse recipes. Users can create an account, post their favorite recipes, and search for recipes by title, description, and ingredients. The application includes user authentication, CRUD operations, social sharing, and accessibility features.
-
User Authentication: Allow users to create an account, log in, and log out. Only authenticated users can create new recipes, edit their own recipes, and delete their own recipes.
-
Recipe CRUD: Allow users to create, read, update, and delete recipes. Each recipe has a title, a description, a list of ingredients, and a set of instructions for how to prepare the dish.
-
Search and Filter: Allow users to search for recipes by title, description, and ingredients. Also, allow users to filter recipes by cuisine type (e.g., Italian, Mexican, Indian).
-
Social Sharing: Allow users to share recipes on social media platforms like Facebook and Twitter.
-
User Profiles: Each user has a profile page where they can see all the recipes they have posted, as well as their personal information like name, email, and profile picture.
-
Accessibility: The website is designed with accessibility in mind, with appropriate headings, alt text for images, and keyboard navigation.
To get started with RecipeBox, follow these steps:
- Clone this repository to your local machine:
git clone https://github.com/Software-Savants/recipebox.git - Install the dependencies:
cd recipebox yarn install - Start the development server:
yarn rw dev - Open your browser and navigate to
http://localhost:8910to view the application.
To deploy RecipeBox to a hosting provider like Netlify or Vercel, follow the instructions in the RedwoodJS Deployment Guide.
Contributions to RecipeBox are welcome! To contribute, follow these steps:
-
Fork this repository to your own account.
-
Create a new branch:
git checkout -b my-new-feature -
Make your changes and commit them
git commit -am 'Add some feature -
Push to the branch:
git push origin my-new-feature -
Submit a pull request.
RecipeBox is licensed under the MIT License. See LICENSE for more information.