https://github.com/kentcdodds/react-workshop-app
An abstraction for all my React workshops
https://github.com/kentcdodds/react-workshop-app
Last synced: about 1 year ago
JSON representation
An abstraction for all my React workshops
- Host: GitHub
- URL: https://github.com/kentcdodds/react-workshop-app
- Owner: kentcdodds
- License: mit
- Created: 2020-02-26T07:34:13.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2022-10-17T19:30:14.000Z (over 3 years ago)
- Last Synced: 2025-03-30T09:05:37.300Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://kentcdodds.com/workshops
- Size: 403 KB
- Stars: 149
- Watchers: 4
- Forks: 37
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-projects - react-workshop-app - An abstraction for all my React workshops ⭐151 `TypeScript` (📦 Legacy & Inactive Projects)
README
@kentcdodds/react-workshop-app
An abstraction for all my React workshops
---
[![Build Status][build-badge]][build]
[![Code Coverage][coverage-badge]][coverage]
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]
[![All Contributors][all-contributors-badge]](#contributors-)
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]
## The problem
I have several repositories for
[my React workshops](https://kentcdodds.com/workshops)
## This solution
This is a set of common abstractions I found useful in those workshop
repositories
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Issues](#issues)
- [🐛 Bugs](#-bugs)
- [💡 Feature Requests](#-feature-requests)
- [Contributors ✨](#contributors-)
- [LICENSE](#license)
## Installation
This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's `dependencies`:
```
npm install --save @kentcdodds/react-workshop-app
```
## Usage
This is intended to be used with create-react-app (but it doesn't have to be).
```javascript
// src/index.js
import codegen from 'codegen.macro'
// eslint-disable-next-line
codegen`module.exports = require('@kentcdodds/react-workshop-app/codegen')`
// src/setupTests.js
import '@kentcdodds/react-workshop-app/setup-tests'
```
Then you'll need to have those directories set up. Probably easiest to look at
one of my repos that use this.
## Issues
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
label._
### 🐛 Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
[**See Bugs**][bugs]
### 💡 Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.
[**See Feature Requests**][requests]
## Contributors ✨
Thanks goes to these people ([emoji key][emojis]):
Kent C. Dodds
💻 📖 🚇 ⚠️
Wojciech Matuszewski
💻 ⚠️
Zac Jones
💻
Marco Moretti
💻 ⚠️
Amr A.Mohammed
💻
Gustavo Borges Michel
🐛
Joyancefa
💻
Markus Lasermann
💻 ⚠️
Marc-Antoine Ferland
💻
Peter Hozák
💻 ⚠️
Dan Overton
💻
Artem Zakharchenko
💻
0xnoob
🐛
Joey Cardosi
💻
This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!
## LICENSE
MIT
[npm]: https://www.npmjs.com
[node]: https://nodejs.org
[build-badge]: https://img.shields.io/github/workflow/status/kentcdodds/react-workshop-app/validate/main?logo=github&style=flat-square
[build]: https://github.com/kentcdodds/react-workshop-app/actions?query=workflow%3Avalidate
[coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/react-workshop-app.svg?style=flat-square
[coverage]: https://codecov.io/github/kentcdodds/react-workshop-app
[version-badge]: https://img.shields.io/npm/v/@kentcdodds/react-workshop-app.svg?style=flat-square
[package]: https://www.npmjs.com/package/@kentcdodds/react-workshop-app
[downloads-badge]: https://img.shields.io/npm/dm/@kentcdodds/react-workshop-app.svg?style=flat-square
[npmtrends]: http://www.npmtrends.com/@kentcdodds/react-workshop-app
[license-badge]: https://img.shields.io/npm/l/@kentcdodds/react-workshop-app.svg?style=flat-square
[license]: https://github.com/kentcdodds/react-workshop-app/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/kentcdodds/react-workshop-app/blob/master/other/CODE_OF_CONDUCT.md
[emojis]: https://github.com/all-contributors/all-contributors#emoji-key
[all-contributors]: https://github.com/all-contributors/all-contributors
[all-contributors-badge]: https://img.shields.io/github/all-contributors/kentcdodds/advanced-react-hooks?color=orange&style=flat-square
[bugs]: https://github.com/kentcdodds/react-workshop-app/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Abug
[requests]: https://github.com/kentcdodds/react-workshop-app/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement
[good-first-issue]: https://github.com/kentcdodds/react-workshop-app/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement+label%3A%22good+first+issue%22