On The House 🍜

On the House is a homemade food recipe aggregation web application inspired by the concept of online food recipe websites and blogs, while also implementing the features of popular forums such as Reddit. It would allow users to upload images and recipes of their own home cooked meals, while also providing the ability to comment and rate other users' meals based on an upvote and downvote function.

Live Demo 🖥️

Note: Our deployed web application uses cookies that are necessary to function properly

On The House was deployed on Firebase and can be accessed here.

API Documentation 🚀

Postman was used to verify API endpoint functionality. Several test cases were executed to determine correct behavior, and ensure POST, GET, DELETE and PATCH requests were working as expected.

Please refer to the following documentation for the endpoints used on the project:

1. Comments

2. Posts

3. Users

4. Upvotes

To Run Locally 👨‍💻

Note: that proper authentication is required through firebase login in order to run locally

1. cd frontend
2. npm i
3. npm start
4. cd backend/functions
5. firebase login
6. npm i
7. firebase serve -p 5001