Giter Club home page Giter Club logo

recipe-book's Introduction

How to run

Frontend

To start the front-end go into the frontEnd folder:

cd frontEnd

And then start it with:

npm run dev

Server

To run the server go to the server folder:

cd server

And then start it with:

npm start

Documentation

For the project realization the following technologies have been used:

  • ReactJS
  • React Router (for a SPA approach)
  • Axios (to better handle API calls and errors)

About the functionalities

Main Page

The main page is made of three main components:

  • Navbar
  • Recipe List
  • Sidebar

Navbar

Through the navbar thanks to react routing is possible to visit the webapp's pages using a single-page-application approach.

Recipe List

The recipe list is showing as default the whole dateset of recipes present in the given API, divided in groups to reduce the browser load. Is possible to see the other recipes using the buttons at the bottom.

Sidebar

The sidebar makes possible for the use to filter the shown recipes using the given fields. To make less possible for the user to make errors, and to get a more modern UI, for all the field exept the name it has been chosen to show some selectable options or a slider.

Add Recipe

Through the "Add" button of the Navbar is possible for the user to visit the Add recipe page. Here the user can add all the details of his favourite recipe.

Some important details for this section are:

  • It's possible to load an image, see it, and delete it.
  • It is possible to add and delete recipe ingredients
  • A maximum of four ingredients are shown to avoid crowding the interface

Future implementations

The webapp here shows some basic functionalities, but here I would like to give some possible future implementations:

  • A working add recipe operation (at the moment only in UI)
  • A recipe detail page
  • A profile page
  • The chance for the user to save his favourite recipes
  • Some animations to make the UX more enjoyable
  • Filter the recipes by category
  • A more robust error handling and responsiveness

recipe-book's People

Contributors

j0hnnygee avatar

Watchers

 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.