README.md

CookBook

A meals recipe app built with the React and Redux frameworks. It showcases meals accoring to their categories and each meal contains instructions on how to prepare also included is a Youtube video.

Table of Contents

• User Features
• Built With
• Technologies Employed
• Live Preview
• Required Installations
• App Installation
• Future Features
• License
• Author
• Acknowledgements

User Features

• A user can view all meals which are grouped by categories.
• The user can filter search based on the meal catgeory of choice.
• A user can navigate throught the three pages of the site:

• Category Page
• Meal Page
• Recipe Page

Built With

• VsCode
• Windows

Technologies Employed

• React Hooks
• Redux Store
• React Routers
• Jest auto watch
• CSS Modules

LIVE PREVIEW

• Here is a link to the live version of the app - https://muunchit.herokuapp.com/

• You can watch a live demostration of the project using this link - https://www.loom.com/share/2296d8cf689548d0ad0babc6096c8f70

REQUIRED INSTALLATIONS

• npm

Installation of This Repository

Clone the Repository,

your@pc:~$ git clone https://github.com/mikenath223/Cook-book-app.git

Go to the downloaded folder

your@pc:~$ cd Cook-book-app/

Install all packages

your@pc:~$ npm install

Start the server

your@pc:~$ npm start

The app will open on your local host port 3000.

Run tests

Run all tests

your@pc:~$ npm test

Run specific tests

your@pc:~$ npm test src/tests/<testfile>

Future Features

• Do more work on the front-end section of the project.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Authors

Michgolden Ukeje

• Github: @mikenath223
• Twitter: @Michgolden_Nath
• Linkedin: Ukeje Michgolden
  

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgements

• Microverse
• The Odin Project