-
Notifications
You must be signed in to change notification settings - Fork 34
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
Docs: Getting Started content for Documentation #96
Changes from 15 commits
99dabfe
7e1d785
a6b6162
7083cc5
a5f1e12
d6ebe8d
38c32c9
e328112
dd2b2e6
f1d0385
f48aae1
2bc4870
7272c08
64444c1
d92a508
301761f
3315bf8
21cf015
f8d03cc
306c08c
ce5cac4
260b607
7ec572f
d4d7361
c52261a
b39fd15
5467b2c
aa68e4c
a56de80
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,13 @@ | ||
# Getting started with the Forms System Library | ||
# Getting started with the US Forms System | ||
|
||
### Creating a new application with the US Forms System Starter App | ||
Depending on your needs, you can either create a brand new application from scratch or install the US Forms System in an existing application. For more information about React apps, see the [React project's Hello World tutorial](https://reactjs.org/docs/hello-world.html). | ||
|
||
### Installing the library in an existing application | ||
### [Creating a new application with the US Forms System Starter App](getting-started/creating-a-new-application-with-the-us-forms-system-starter-app.md) | ||
|
||
The US Forms System Starter App creates the initial files, configuration, build process, and web server you need to start building your form immediately. | ||
|
||
### [Installing the US Forms System in an existing application](getting-started/installing-the-library-in-an-existing-application.md) | ||
|
||
If you're using an existing React application, you can install the US Forms System in that app. | ||
|
||
[Back to *US Forms System Documentation*](/docs/README.md) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Creating a new application with the US Forms System Starter App | ||
|
||
The US Forms System Starter App creates the initial files, configuration, build process, and web server you need to start building your form immediately. | ||
|
||
For more information, including app installation instructions, see the [US Forms System Starter App README](https://github.com/usds/us-forms-system-starter-app#us-forms-system-starter-app). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was talking to @fatimanoorva this afternoon about where to put the instructions for setting up the starter app. I'm leaning toward wanting to keep the instructions in this repo alongside the other docs, rather than keeping two sets of docs in separate repos. Thoughts/feelings? There's also an issue open about needing to enhance those instructions (#79). I'm working on getting the starter app running on my machine, too, and taking notes. |
||
|
||
[Back to *Getting Started with the US Forms System*](README.md) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Installing the US Forms System in an existing application | ||
|
||
If you're using an existing React application, you can install the US Forms System in that app. | ||
|
||
### In this guide | ||
|
||
- [Install the library and dependencies](#install-the-library-and-dependencies) | ||
- [Create required files](#create-required-files) | ||
|
||
### Install the library and dependencies | ||
|
||
1. Install the library: | ||
```bash | ||
npm install --save https://github.com/usds/us-forms-system.git | ||
``` | ||
|
||
2. Install peer dependencies: | ||
```bash | ||
npm install --save-dev @department-of-veterans-affairs/formation | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We no longer need formation, so you can remove this line! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was wondering about that one! |
||
npm install --save-dev uswds@^1.6.3 | ||
npm install --save-dev react@^15.5.4 | ||
npm install --save-dev react-dom@^15.6.2 | ||
``` | ||
|
||
### Create required files | ||
|
||
To enable your form, create the following files. For an example of these files, see the [us-forms-system-starter-app repository](https://github.com/usds/us-forms-system-starter-app). | ||
|
||
- A [form config file](https://github.com/usds/us-forms-system-starter-app/blob/master/js/config/form.js). For more information, see "Creating a form config file." | ||
- An entry [app.js](https://github.com/usds/us-forms-system-starter-app/blob/master/app.js) file. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @annekainicUSDS - Is this an acceptable description? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes I think so |
||
- A [React component](https://github.com/usds/us-forms-system-starter-app/blob/master/js/components/Form.jsx) to render the top-level us-forms-system component. | ||
- A [routes file](https://github.com/usds/us-forms-system-starter-app/blob/master/js/routes.jsx) that loads `createRoutes` from us-forms-system. This automatically creates the routes from the form config file. | ||
- A [reducers file](https://github.com/usds/us-forms-system-starter-app/blob/master/js/reducers.js) that loads `createSchemaFormReducer` from us-forms-system. This creates the app's reducer functions. | ||
|
||
[Back to *Getting Started with the US Forms System*](README.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a link to a React tutorial here. Let me know if that feels like overkill.