You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 13, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+39-35Lines changed: 39 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,29 +13,18 @@ To learn more about the project, check out this [blog post](https://www.whitehou
13
13
14
14
Code.gov is an open source project, so we invite your contributions, be it in the form of code, design, or ideas.
15
15
16
-
## Requirements
17
-
18
-
The development of code.gov is guided by the requirements set forth in https://sourcecode.cio.gov/.
19
-
20
-
## Configuration
21
-
For documentation on how to configure code-gov-front-end, go [here](CONFIGURATION.md).
22
-
23
16
## Contributing
24
17
25
18
Here’s how you can help contribute to code.gov:
26
19
27
20
* Source Code Policy
28
-
* To provide feedback on the [Federal Source Code Policy](https://sourcecode.cio.gov/), you should follow [this issue tracker](https://github.com/WhiteHouse/source-code-policy/issues)
21
+
* To provide feedback on the [Federal Source Code Policy](https://sourcecode.cio.gov/), follow [this issue tracker](https://github.com/WhiteHouse/source-code-policy/issues)
29
22
30
23
* Code.gov
31
24
* To provide feedback on code-gov-front-end, please checkout our [Contributing Guildelines](CONTRIBUTING.md).
32
25
* To contribute to the Code.gov style guide, head over to the [code-gov-style](https://github.com/GSA/code-gov-style) repo.
33
26
* Checkout [code-gov](https://github.com/GSA/code-gov) for a list of additional project repositories. If you aren't sure where your question or idea fits, this is a good place to share it.
34
27
35
-
## Questions?
36
-
37
-
If you have questions, please feel free to [send us an email](mailto:code@gsa.gov).
38
-
39
28
## Getting Started
40
29
41
30
After you have cloned this repo, you can use `npm install` to install all of the
@@ -45,7 +34,40 @@ You can then run the server using `npm run start`.
45
34
46
35
By default, the development server will listen on <http://localhost:8080/>. You can change the default port by setting the `PORT` environment variable before starting the server (for example, `PORT=3000 npm start`).
47
36
48
-
## Testing
37
+
### Specifying an API Key
38
+
The app uses the API key provided in the site.json by default.
39
+
If you want to override that, specify an `CODE_GOV_API_KEY` environmental variable. Here's an example:
40
+
```
41
+
CODE_GOV_API_KEY=l87sfdi7ybc2bic7bai8cb2i176c3b872tb3 npm run start
42
+
```
43
+
44
+
You can sign up for an API key at [developers.code.gov](https://developers.code.gov/key.html).
45
+
46
+
### File Structure
47
+
The directories in `src` are organized around the pillars of React, along
48
+
with several additional custom file types. When creating new files, be sure to
49
+
add your file and any necessary templates, styles, and tests to a directory
50
+
dedicated to your new file in the appropriate place.
51
+
52
+
### Style Guide
53
+
54
+
The bulk of the CSS for this application is at [Style Guide repository](https://github.com/GSA/code-gov-style) so that we can more easily keep things consistent and deploy changes more quickly.
55
+
56
+
You'll need to clone/download the [Style Guide repository](https://github.com/GSA/code-gov-style) to get started.
57
+
58
+
If you need to make CSS changes, make them within this directory and commit them to that repository.
59
+
60
+
For more instructions on how to make changes, view the readme inside of the [Style Guide repository](https://github.com/GSA/code-gov-style).
61
+
62
+
### Changes to the Policy Guide
63
+
64
+
The code for the [Policy Guide](https://code.gov/policy-guide/) section of the site is located in the [code-gov-fscp-react-component](https://github.com/GSA/code-gov-fscp-react-component) repo. Any changes or issues related to the Policy Guide should be made in that repository.
65
+
66
+
### Changes to the About Page
67
+
68
+
The code for the [About](https://code.gov/about/overview/introduction) section of the site is located in the [code-gov-about-page](https://github.com/GSA/code-gov-about-page) repo. Any changes or issues related to the About section should be made in that repository.
69
+
70
+
### Testing
49
71
50
72
Unit testing is done using the [jest](https://github.com/facebook/jest) framework with [enzyme](https://github.com/airbnb/enzyme).
The app uses the API key provided in the site.json by default.
71
-
If you want to override that, specify an `CODE_GOV_API_KEY` environmental variable. Here's an example:
72
-
```
73
-
CODE_GOV_API_KEY=l87sfdi7ybc2bic7bai8cb2i176c3b872tb3 npm run start
74
-
```
75
-
76
-
77
91
## Generating License Data
78
92
To update the `dependency_licenses.json` file, run `npm run licenses`.
79
93
80
-
## File Structure
81
-
The directories in `src` are organized around the pillars of React, along
82
-
with several additional custom file types. When creating new files, be sure to
83
-
add your file and any necessary templates, styles, and tests to a directory
84
-
dedicated to your new file in the appropriate place.
85
-
86
-
87
-
## Style Guide
88
-
We've moved the bulk of the CSS for this application into a [Style Guide repository](https://github.com/GSA/code-gov-style) so that we can more easily keep things consistent and deploy changes more quickly.
89
-
90
-
You'll need to clone/download the [Style Guide repository](https://github.com/GSA/code-gov-style) to get started.
91
-
92
-
If you need to make CSS changes, make them within this directory and commit them to that repository.
94
+
## Configuration
95
+
For documentation on how to configure code-gov-front-end, go [here](CONFIGURATION.md).
93
96
94
-
For more instructions on how to make changes, view the readme inside of the [Style Guide repository](https://github.com/GSA/code-gov-style).
97
+
## Questions?
95
98
99
+
If you have questions, please feel free to [send us an email](mailto:code@gsa.gov).
0 commit comments