Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
resolves #41
  • Loading branch information
yuxunn authored Jul 25, 2024
1 parent f310eae commit c592319
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# EKAC - One Stop Recipe Website

* To launch the website locally, clone the repository, `cd` into the `frontend`folder before running `npm run start`.
* To access the deployed website, go to https://ekac-437bc.web.app/ This website is preliminary deployed as of 01/07/2024.
* To access the deployed website, go to https://ekac-437bc.web.app/ This website is preliminary deployed as of 25/07/2024.

## Vision
* Clean, homely UI that welcomes all users. Ekac focuses on ensuring that users are able to navigate through the website easily.
Expand All @@ -16,3 +16,17 @@
* React (frontend)
* Firebase (Backend + storage)
* BotPress (ChatBot integration)

## Pages
* My Recipes page: View recipes that you have created. Favourite, Edit, View or Delete your recipes.
* Favourites page: View recipes that you favourited from your recipes page, or the community page.
* Profile page: Customise your avatar and view your user profile.
* Community page: View recipes posted by all users on the platform.
* Courses page (Work in progress): View courses organised by users.

## Other Notable Features
* Ratings: Upvote or Downvote recipes that you have tested. This will contribute to the overall popularity rating of that recipe.
* Filter: Filter recipes according to their types or date created.

## About the project
* EKAC is a 2 month long passion project, built with the intention to improve my web development skills. I had a lot of fun trying out new technology, and going through the trial and error process whilst working on this web application. Feel free to test out the website, and have a good day ahead! :)

0 comments on commit c592319

Please sign in to comment.