Skip to content

More-Recipes provides a platform for users to share the awesome and exciting recipe ideas they have invented or learnt. Suppose a user comes up with a recipe, he/she can post it on More-Recipes and get feedback in form of reviews and votes from other users who explore that recipe. Users can also keep a list of their favorite recipes on the appli…

License

Notifications You must be signed in to change notification settings

FredDominant/more-recipe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Maintainability Coverage Status

More-Recipes

Introduction

More-Recipes provides a platform for users to share the awesome and exciting recipe ideas they have invented or learnt.
Suppose a user comes up with a recipe, he/she can post it on More-Recipes and get feedback in form of reviews and votes from other users who explore that recipe. Users can also keep a list of their favorite recipes on the application

Technologies


  1. Nodejs
  2. Postgresql
  3. Express
  4. Sequelize
  5. React
  6. Redux

API Documentation

The full documentation for all api end point can be found here

Features

  1. User can create account and log in to use app
  2. Add recipe
  3. View or Modify the recipe he/she added
  4. Delete the recipe he/she added
  5. Add a recipe to favourites
  6. A recipe listing or catalog page that allows viewers to search for recipes. It also shows popular recipes.
  7. Upvote a recipe
  8. downvote a recipe
  9. Add reviews to a recipe
  10. A User can add recipe as favourite.
  11. User's profile page
  12. Update profile
  13. A page, where logged in users can view a list of their favourite recipes
  14. Users can change their password or reset it if forgotten.

Limitations


This project has some limitations. The most notable ones are:

  1. Users cannot view other user's profile or see personal/favorite recipe list.
  2. Users cannot deactivate their accounts

Demo


View the web client live here

Test


This app uses the following for testing:

  • For server-side testing run npm run test:report.
  • For client-side testing run npm run client

How to Install


  1. Clone the repo and enter directory
git clone [email protected]:noblemajesty/more-recipes.git && cd more-recipes
  1. Install the project's dependecies
npm install
  1. Create .env file and copy content of .env.sample to it and provide the appropriate values
cp .env.sample .env
  1. Start the server
npm run server
  1. Navigate to your browser and view the app on http://localhost:5050/

Contributing to the project


  • Fork this repository to your github account
  • Clone the repository - git clone https://github.com/{your_username_goes_here}/dman.git
  • Create your feature branch - git checkout -b {feature, chore or bug}-short_feature_desscription
  • Commit your changes - git commit -m “{commit_message_goes_here}“ or git commit for the interactive interface
  • Push to the remote branch - git push origin {your_branch_name_as_described_above}
  • Open a pull request

FAQ


What language was used to develop this application?

This is a full stack Javascript application with client side in React/Redux

Who can contribute?

You, Me, Her, Him, They, Them, Us. Anybody!

Author


Fred Adewole(@Fred_Amare)

License


This is licensed for your use, modification and distribution under the MIT license.

About

More-Recipes provides a platform for users to share the awesome and exciting recipe ideas they have invented or learnt. Suppose a user comes up with a recipe, he/she can post it on More-Recipes and get feedback in form of reviews and votes from other users who explore that recipe. Users can also keep a list of their favorite recipes on the appli…

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published