Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dipto0321/foody-recipe-app-fe

A simple food recipe listing directory. The food you love. :hamburger:
https://github.com/dipto0321/foody-recipe-app-fe

chakra-ui formik hacktoberfest react typescript typescript-react

Last synced: 28 days ago
JSON representation

A simple food recipe listing directory. The food you love. :hamburger:

Awesome Lists containing this project

README

        

# foody-recipe-app-fe

![foody_recipe_app_banner](foody_recipe_app_banner.png)

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![Netlify Status](https://api.netlify.com/api/v1/badges/1fab89e6-ba10-4b3d-97c3-a4d36322c351/deploy-status)](https://app.netlify.com/sites/foody-recipe-app/deploys)
![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/dipto0321/foody-recipe-app-fe/react)
![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/dipto0321/foody-recipe-app-fe/typescript)
![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/dipto0321/foody-recipe-app-fe/formik)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dipto0321/foody-recipe-app-fe)
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/dipto0321/foody-recipe-app-fe/master)
![GitHub](https://img.shields.io/github/license/dipto0321/foody-recipe-app-fe)

A simple food recipe listing directory. The food you love.

## Table of Contents

- [foody-recipe-app-fe](#foody-recipe-app-fe)
- [Table of Contents](#table-of-contents)
- [Background](#background)
- [Install](#install)
- [Usage](#usage)
- [`yarn start`](#yarn-start)
- [`yarn test`](#yarn-test)
- [`yarn build`](#yarn-build)
- [API](#api)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)

## Background

## Install

In the project directory, run:

```
yarn install
```

## Usage

In the project directory, you can run:

### `yarn start`

Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn build`

Builds the app for production to the `build` folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

## API

Check [foody-recipe-app-api](https://github.com/dipto0321/foody-recipe-app-api) to learn more about the API

## Maintainers

[@dipto0321](https://github.com/dipto0321)

## Contributing

See [the contributing file](contributing.md)!

PRs accepted.

## License

MIT © 2020 Dipto Karmakar