https://github.com/epicweb-dev/web-forms
Learn the primary mechanism for interactivity on the web.
https://github.com/epicweb-dev/web-forms
epicweb-dev kcd-edu workshop
Last synced: 6 months ago
JSON representation
Learn the primary mechanism for interactivity on the web.
- Host: GitHub
- URL: https://github.com/epicweb-dev/web-forms
- Owner: epicweb-dev
- License: other
- Created: 2023-07-10T20:40:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-13T17:08:30.000Z (6 months ago)
- Last Synced: 2025-05-13T18:25:19.313Z (6 months ago)
- Topics: epicweb-dev, kcd-edu, workshop
- Language: TypeScript
- Homepage: https://www.epicweb.dev/workshops/professional-web-forms
- Size: 16.7 MB
- Stars: 207
- Watchers: 2
- Forks: 63
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - epicweb-dev/web-forms - Learn the primary mechanism for interactivity on the web. (TypeScript)
README
Professional Web Forms
Learn the primary mechanism for interactivity on the web.
In this workshop, we'll learn how to use forms on the web to create highly dynamic and interactive experiences for our users.
[![Build Status][build-badge]][build]
[![GPL 3.0 License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
## Prerequisites
- Some
[experience with JavaScript](https://kentcdodds.com/blog/javascript-to-know-for-react)
- Some [experience with React](https://kcd.im/beginner-react)
- Some [experience with Node.js](https://nodejs.dev/en/learn)
- [Full Stack Foundations workshop](https://github.com/epicweb-dev/full-stack-foundations)
(or similar experience)
## System Requirements
- [git][git] v2.18 or greater
- [NodeJS][node] v20 or greater
- [npm][npm] v8 or greater
All of these must be available in your `PATH`. To verify things are set up
properly, you can run this:
```shell
git --version
node --version
npm --version
```
If you have trouble with any of these, learn more about the PATH environment
variable and how to fix it here for [windows][win-path] or
[mac/linux][mac-path].
## Setup
This is a pretty large project (it's actually many apps in one) so it can take
several minutes to get everything set up the first time. Please have a strong
network connection before running the setup and grab a snack.
Follow these steps to get this set up:
```sh
git clone https://github.com/epicweb-dev/web-forms.git
cd web-forms
npm run setup
```
If you experience errors here, please open [an issue][issue] with as many
details as you can offer.
## Exercises
You'll find all the exercises in the `exercises` directory. The structure of the
workshop apps is described below, but most of the time you should be able to
simply run the app and navigate around the different exercises using the
application (there are even buttons to open the right exercise file right in
your editor).
The purpose of the exercise is **not** for you to work through all the material.
It's intended to get your brain thinking about the right questions to ask me as
_I_ walk through the material.
## Running the app
To get the app up and running (and really see if it worked), run:
```shell
npm start
```
Now open your browser to the address that's logged out for you and you're good
to get started!
## Running the tests
The test script in the `package.json` runs the tests on the solutions (these
should all pass). To run the tests against your own work, you simply open the
problem page and click the "Test" tab.
## Launching your editor
The application has several buttons which will launch your editor to the right
file. There are a lot of files in this workshop so you'll be using this feature
a lot to get to the right place at the right time.
This should just work™️ (it looks at your currently running processes and
chooses the editor based on that). If it doesn't guess correctly, create a
`.env` file in the root of this project and add an environment variable called
`EPICSHOP_EDITOR` with the value being set to the path to your editor's
executable. For example, if you're using VS Code on Windows, you'd add this to
your `.env` file:
```
EPICSHOP_EDITOR='"C:\Program Files\Microsoft VS Code\bin\code.cmd"'
```
Make certain that if the path includes spaces that you wrap the path in quotes
as above (note the use of single quotes wrapping the double quotes!).
The value of `EPICSHOP_EDITOR` should be the command that you would run in your
terminal to open your editor from the command line. This means, the first thing
should be the path to the executable for your editor (or the command if you have
one in your `PATH`). So you may be able to get away with doing something as
simple as this:
```
EPICSHOP_EDITOR=code
```
## Exercises
- `exercises/*.*/README.md`: Exercise background information
- `exercises/*.*/*.problem.*/README.*.md`: Problem Instructions
- `exercises/*.*/*.problem.*/*.tsx`: Exercise with Emoji helpers 👈 You spend
most of your time here.
- `exercises/*.*/*.solution.*/*.tsx`: Solved version
The purpose of the exercise is **not** for you to work through all the material.
It's intended to get your brain thinking about the right questions to ask me as
_I_ walk through the material.
## Helpful Emoji 🐨 🦺 💰 📝 🦉 📜 💣 💪 🏁 👨💼 🚨
Each exercise has comments in it to help you get through the exercise. These fun
emoji characters are here to help you.
- **Kody the Koala** 🐨 will tell you when there's something specific you should
do
- **Lily the Life Jacket** 🦺 will help you with any TypeScript-specific parts
of the exercises
- **Marty the Money Bag** 💰 will give you specific tips (and sometimes code)
along the way
- **Nancy the Notepad** 📝 will encourage you to take notes on what you're
learning
- **Olivia the Owl** 🦉 will give you useful tidbits/best practice notes
- **Dominic the Document** 📜 will give you links to useful documentation
- **Barry the Bomb** 💣 will be hanging around anywhere you need to blow stuff
up (delete code)
- **Matthew the Muscle** 💪 will indicate that you're working with an exercise
- **Chuck the Checkered Flag** 🏁 will indicate that you're working with a final
- **Peter the Product Manager** 👨💼 helps us know what our users want
- **Alfred the Alert** 🚨 will occasionally show up in the test failures with
potential explanations for why the tests are failing
- **Kellie the Co-worker** 🧝♀️ your co-worker who sometimes does work ahead of
your exercises
## Workshop Feedback
Each exercise has an Elaboration and Feedback link. Please fill that out after
the exercise and instruction.
At the end of the workshop, please go
[here to give overall feedback](https://docs.google.com/forms/d/e/1FAIpQLSdRmj9p8-5zyoqRzxp3UpqSbC3aFkweXvvJIKes0a5s894gzg/viewform).
[npm]: https://www.npmjs.com/
[node]: https://nodejs.org
[git]: https://git-scm.com/
[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/web-forms/deploy.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/epicweb-dev/web-forms/actions?query=workflow%3Adeploy
[license-badge]: https://img.shields.io/badge/license-GPL%203.0%20License-blue.svg?style=flat-square
[license]: https://github.com/epicweb-dev/web-forms/blob/main/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://kentcdodds.com/conduct
[win-path]: https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/
[mac-path]: http://stackoverflow.com/a/24322978/971592
[issue]: https://github.com/epicweb-dev/web-forms/issues/new