Skip to content
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

Create Hello World Git Repository Example #43

Open
dgp1130 opened this issue Sep 24, 2016 · 1 comment
Open

Create Hello World Git Repository Example #43

dgp1130 opened this issue Sep 24, 2016 · 1 comment

Comments

@dgp1130
Copy link
Member

dgp1130 commented Sep 24, 2016

I've seen in a few places where they have a "Hello World" tutorial, but include a git repository going through the same steps. They'll even set branches at various checkpoints so readers can follow along and make sure each step is working for them. Since Uniform is so unique, it could be useful to us to make an example like this, creating Car Form from scratch, going from $ npm init and $ npm install uniform-validation, all the way to adding the HTML, sourcing the Uniform library, making their first script, submitting it, and then validating on the server.

Example: https://medium.com/developers-writing/building-a-desktop-application-with-electron-204203eeb658#.c39d5mdxk

@dgp1130 dgp1130 added this to the 0.2.0 Documentation Update milestone Dec 13, 2016
@dgp1130 dgp1130 self-assigned this Dec 17, 2016
@dgp1130
Copy link
Member Author

dgp1130 commented Dec 17, 2016

Created the Uniform-Car-Example interactive Git repository. It describes how to create car form from scratch with checkpoints along the way and an explanation of how Uniform works along the way. There are a few links I need to add and couple things I wasn't sure about putting so I marked them all with TODOs.

The easiest way of debugging documentation is to have someone unfamiliar with the language just do it and see where they get confused. We don't really have that at the moment, so we'll have to use @sawyernovak since you at least didn't write it. Take a look and go through it to let me know what you think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants