Grandma's Cookbook is a recipe-sharing web application that allows users to browse and contribute recipes. The application is hosted on Github at https://github.com/One-Stop-Shopping/Grandmas-Cookbook.
- React
- Express
- Node
- PostgreSQL
- AWS S3
- View recipes by category or search by keyword to query recipes from an API or web-scraping
- Add new recipes
- Edit or delete existing recipes
- User authentication for recipe contributors
- Mobile-friendly design
To run the application locally, follow these steps:
- Clone the repository:
git clone https://github.com/One-Stop-Shopping/Grandmas-Cookbook.git - Navigate to the project directory:
cd Grandmas-Cookbook - Install the required packages:
npm install - Start the application:
npm start - Navigate to http://localhost:3000 in your web browser
Once the application is running, you can browse recipes by category or search for recipes using the search bar. To add a new recipe, click the "Add Recipe" button and fill out the form. To edit or delete an existing recipe, navigate to the recipe and click the "Edit" or "Delete" button (note that only the original contributor of a recipe can edit or delete it).
Contributions are welcome and appreciated! If you would like to contribute to the project, please follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b my-new-feature - Make your changes and commit them:
git commit -am 'Add some feature' - Push your changes to your fork:
git push origin my-new-feature - Create a new Pull Request