Cook It

An awesome recipe application based on mobile
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

Welcome to the Cook It Github repository! Here, you'll find the source code for our sleek and sophisticated recipe application. Built with modern technologies and a focus on user experience, our application aims to provide users with an effortless recipe searching experience.

back to top

Built With

Main technology used to built this application are listed below:

• React Native
• Cloudinary
• Typescript
• Firebase

back to top

Getting Started

To get started with this project locally, follow below steps:

Prerequisites

Make sure you have your device emulator, React Native, and package manager (either npm or yarn) installed

FYI: This project uses yarn as the server package manager, but you're free to use npm too.

Installation

Below steps will guide you through the local installation process of this application

1. Clone the repo

   git clone https://github.com/blesten/recipe-app.git
   

2. Complete the constant.ts variable at /utils directory Rename constant.example.ts file at /utils directory become constant.ts, then fill the value for every key. Below is the guideline for filling the .env value:
   

   Key	What to Fill	Example Value
   FB_API_KEY	Your Firebase API key	Stdsdddd
   FB_AUTH_DOMAIN	Your Firebase auth domain	testapp-12345ssxyz.firebaseapp.com
   FB_PROJECT_ID	Your Firebase project ID	testapp-12345-abc
   FB_STORAGE_BUCKET	Your Firebase storage bucket	testapp-1lklkf.acb
   FB_MESSAGING_SENDER_ID	Your Firebase messaging sender ID	123982389132
   FB_APP_ID	Your Firebase app ID	2:344342:web:jfsdlfjdsfabc123
   CLOUDINARY_CLOUD_NAME	Your Cloudinary cloud name	abc1234
   CLOUDINARY_USER_PRESET	Your Cloudinary preset ID to store user avatar	123abc
   CLOUDINARY_DISH_PRESET	Your Cloudinary preset ID to store dish image	123abc

3. Open your terminal and cd to the root directory, then run yarn install to install all the application dependencies
4. After installing the dependencies, make sure you have your device emulator ready, then run yarn start at the terminal to start the application

back to top

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

back to top

License

Distributed under the MIT License. See LICENSE.txt for more information.

back to top

Contact

LinkedIn: Stanley Claudius

Project Link: https://github.com/blesten/recipe-app

back to top

Acknowledgments

Special thanks to:

• Othneildrew for providing an amazing README template.

back to top