Git Product home page Git Product logo

more-recipes-1's Introduction

Build Status Coverage Status Maintainability codecov

More-Recipes

More-Recipes is a full stack web application that provides a platform for users to share their awesome and exciting recipe ideas they have invented or learnt.

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

Functionalities


Users are grouped into 2 categories:

Non Registered Users:

  • Create an account (Sign up)
  • View Featured Recipes
  • View all Recipes
  • View a single Recipe
  • Search for a Recipe

Registered Users:

  • Sign in as a user
  • Create Recipe
  • Update created Recipes
  • Delete Created Recipes
  • Upvote a Recipe
  • Downvote a Recipe
  • Add a recipe as Favourite
  • View all created Recipe
  • View all favourited Recipe
  • Remove upvote on a Recipe
  • Remove downvote on a Recipe
  • Remove Recipe from favourite
  • Add Review for a Recipe
  • View Profile
  • Update Profile
  • View Featured Recipes
  • View all Recipes
  • View a single Recipe
  • Search for a Recipe

Limitations


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

  1. Users cannot view other user's profile
  2. Users cannot view other user's favourited recipes or created recipes
  3. Users cannot change their password or reset password if forgotten
  4. Users cannot deactivate their account

How to Install


  1. Clone the repository and change directory into the folder

git clone https://github.com/missating/More-Recipes.git && cd more-recipes

  1. Install project dependencies

npm install

  1. Create a .env file and copy comtent of .env.sample to it and provide the appropraite values

  2. Look at this file config.json and read this to setup postgres/sequelize to create a Database then run migration

npm run migration

  1. Then start the server

npm run start:dev

  1. Navigate to your browser to view the app on http://localhost:3000

Demo


View the application here

Test


The application uses the following for Testing:

  • Backend Test npm run test:server

  • FrontEnd Test npm run test:client

FAQ


  • What language was used to develop this application ?

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

  • Who can contribute ?

Anyone

Author


Nkoyo Ating miss__ating

License


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

more-recipes-1's People

Contributors

missating avatar

Watchers

James Cloos avatar Michael Umanah avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.