-
Notifications
You must be signed in to change notification settings - Fork 274
docs: cookbook shoutout ready #1672
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mdjastrzebski
merged 7 commits into
callstack:main
from
vanGalilea:docs/cookbook-shoutout-ready
Sep 30, 2024
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8c6006a
update cookbook app libs. and fix navigation to network requests exam…
464ce90
Update cookbook/README.md
vanGalilea 9793544
Update README.md (2)
vanGalilea 32c522a
Update Cookbook's Intro. sec. in docs
5e9d7f3
Merge remote-tracking branch 'origin/docs/cookbook-shoutout-ready' in…
603ae4f
upload readme banner
60c1c91
arranging readme assets
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,30 @@ | ||
# RNTL Cookbook | ||
<p align="center"> | ||
<img alt="banner" src="https://github.com/user-attachments/assets/9f34e38a-32a1-422a-a906-9428036fcd85"> | ||
</p> | ||
|
||
This example app gathers recipes from | ||
the [RNTL Cookbook](https://callstack.github.io/react-native-testing-library/cookbook). | ||
# React Native Testing Library Cookbook App | ||
Welcome to the React Native Testing Library (RNTL) Cookbook! This app is designed to provide developers with a collection of best practices, ready-made recipes, and tips & tricks to help you effectively test your React Native applications. Whether you’re just starting out with testing or looking to deepen your skills, this cookbook offers something for everyone. | ||
|
||
Each recipe described in the Cookbook should have a corresponding code example screen in this repo. | ||
|
||
Note: | ||
Since examples will showcase usage of different dependencies, the dependencies in `package.json` | ||
file will grow much larger that in a normal React Native. This is fine 🐶☕️🔥. | ||
|
||
## Running the App | ||
1. Clone the repo `git clone [email protected]:callstack/react-native-testing-library.git` | ||
2. Go to the `examples/cookbook` directory `cd examples/cookbook` | ||
3. Install dependencies `yarn` | ||
4. Run the app `yarn start` | ||
5. Run the app either on iOS or Android by clicking on `i` or `a` in the terminal. | ||
|
||
## How to Contribute | ||
We invite all developers, from beginners to experts, to contribute your own recipes! If you have a clever solution, best practice, or useful tip, we encourage you to: | ||
|
||
1. Submit a Pull Request with your recipe. | ||
2. Join the conversation on GitHub [here](https://github.com/callstack/react-native-testing-library/issues/1624) to discuss ideas, ask questions, or provide feedback. | ||
|
||
## Screenshots From the App | ||
| Home Screen | Phonebook with Net. Req. Example | | ||
| ------ | ----- | | ||
|  |  | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,29 @@ | ||
# Introduction | ||
|
||
This cookbook is intended to showcase best practices, tips & tricks, and ready-to-use recipes for using React Native Testing Library. | ||
Welcome to the **React Native Testing Library (RNTL) Cookbook**! | ||
This app is your go-to resource for learning how to effectively test React Native applications. | ||
It provides a collection of **best practices**, **ready-made recipes**, and **tips & tricks** to | ||
simplify and improve your testing workflow. Whether you’re a beginner just getting started or a | ||
seasoned developer looking to sharpen your | ||
skills, the Cookbook has something for everyone. | ||
|
||
We invite you to contribute your favorite recipes to the Cookbook. More info [here](https://github.com/callstack/react-native-testing-library/issues/1624). | ||
## What's Inside the Cookbook? | ||
|
||
The Cookbook is currently organized into **three main chapters**: | ||
|
||
- **Basic Recipes**: A great starting point, covering essential testing scenarios such as async | ||
operations and custom render functions. | ||
- **Advanced Recipes**: More complex scenarios like network requests and in the future, navigation | ||
testing and more. | ||
- **State Management Recipes**: Best practices for testing state management libraries | ||
|
||
Each recipe includes a clear explanation along with a corresponding code example to help you get | ||
hands-on with testing. Checkout | ||
the [Cookbook App](https://github.com/callstack/react-native-testing-library/tree/main/examples/cookbook#rntl-cookbook) to see the | ||
recipes in action. | ||
|
||
## What's Next? | ||
|
||
Join the conversation | ||
on [GitHub](https://github.com/callstack/react-native-testing-library/issues/1624) here to discuss | ||
ideas, ask questions, or provide feedback. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.