https://github.com/blesten/recipe-app
A React Native app for discovering, saving, and organizing recipes with easy search and step-by-step instructions
https://github.com/blesten/recipe-app
authentication backend clerk-auth firebase frontend mobile-app mobile-development react-native typescript
Last synced: 3 months ago
JSON representation
A React Native app for discovering, saving, and organizing recipes with easy search and step-by-step instructions
- Host: GitHub
- URL: https://github.com/blesten/recipe-app
- Owner: blesten
- License: mit
- Created: 2024-10-12T12:31:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-05T03:35:36.000Z (over 1 year ago)
- Last Synced: 2025-01-21T04:18:46.696Z (over 1 year ago)
- Topics: authentication, backend, clerk-auth, firebase, frontend, mobile-app, mobile-development, react-native, typescript
- Language: TypeScript
- Homepage:
- Size: 2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Cook It
An awesome recipe application based on mobile
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
## 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.
### Built With
Main technology used to built this application are listed below:
* [React Native](https://reactnative.dev/)
* [Cloudinary](https://cloudinary.com/)
* [Typescript](https://www.typescriptlang.org/)
* [Firebase](https://firebase.google.com/)
## 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
## 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
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
LinkedIn: [Stanley Claudius](https://www.linkedin.com/in/stanleyclaudius)
Project Link: [https://github.com/blesten/recipe-app](https://github.com/blesten/recipe-app)
## Acknowledgments
Special thanks to:
* [Othneildrew](https://github.com/othneildrew/) for providing an amazing README template.
[forks-shield]: https://img.shields.io/github/forks/blesten/recipe-app.svg?style=for-the-badge
[forks-url]: https://github.com/blesten/recipe-app/network/members
[stars-shield]: https://img.shields.io/github/stars/blesten/recipe-app.svg?style=for-the-badge
[stars-url]: https://github.com/blesten/recipe-app/stargazers
[issues-shield]: https://img.shields.io/github/issues/blesten/recipe-app.svg?style=for-the-badge
[issues-url]: https://github.com/blesten/recipe-app/issues
[license-shield]: https://img.shields.io/github/license/blesten/recipe-app.svg?style=for-the-badge
[license-url]: https://github.com/blesten/recipe-app/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/stanleyclaudius