Skip to content

Commit c1ccca3

Browse files
committed
add documentation
fixes #10 fixes #11 addresses #24 but should say more
1 parent 6395944 commit c1ccca3

File tree

4 files changed

+30
-3
lines changed

4 files changed

+30
-3
lines changed

CONDUCT.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
EDGI's Code of Conduct can be found [here](https://envirodatagov.org/edgis-code-of-conduct/).

CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Contributing Guidelines
2+
3+
We love improvements to our tools! EDGI has general [guidelines for contributing](https://github.com/edgi-govdata-archiving/overview/blob/main/CONTRIBUTING.md) and a [code of conduct](https://github.com/edgi-govdata-archiving/overview/blob/main/CONDUCT.md) for all of our organizational repos.
4+
5+
## Here are some notes specific to this project:
6+
7+
TBD

INSTALLATION.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Installation
2+
This document describes how to get EJScreen running locally on your own computer.
3+
4+
There are probably many ways to do this. Here's one that works:
5+
6+
- EJScreen is built using the ASP.NET 4.8 framework. That requires a Windows machine.
7+
- Pull this repo using your preferred method (e.g. Github Desktop, `git`). If you're not working on an established branch, it's advisable to create one (see EDGI's contributing guidelines [here](https://github.com/edgi-govdata-archiving/overview/blob/main/CONTRIBUTING.md)). A branch is a way to develop and test code without overwriting the "official" main version of the code. Eventually, edits on your branch can be merged or "pulled" into the main branch using a "pull request."
8+
- In terms of editing the code, Visual Studio Code integrates well with Github and ASP.NET 4.8.
9+
- Download and open VS Code. ASP.NET 4.8 sites require an IIS server. Maybe the easiest way to work with it is to install the "[IIS Express[(https://github.com/warrenbuckley/IIS-Express-Code)" extension to VS Code, enabling you to start/stop/restart the server from within the editor. In the "Extensions" menu of VS Code (Ctrl-Shift-X), search for "IIS Express."
10+
- IIS Express will create a configuration json for your version of EJScreen (`iisexpress.json`, available from the `.vscode` folder).
11+
- To test EJScreen locally, you should edit the `port` value to something like 8000.
12+
- Then, select "Start Website"!

README.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# EJScreen
22

3-
This is an unofficial copy of EJScreen, hosted by the [Public Environmental Data Partners](https://screening-tools.com/). Some links and text may incorrectly suggest that this site is affiliated with the US Government. We've published an initial reconstruction - you can identify the EJScreen data and index percentiles for a given block group right now. Check back soon as we put more time and resources toward the functionality of EJScreen you might be used to. Thanks for your patience and support.
3+
[![Code of Conduct](https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat)](https://github.com/edgi-govdata-archiving/overview/blob/main/CONDUCT.md)
44

55
EJScreen is the environmental justice screening and mapping tool that utilizes standard and nationally consistent data to highlight places that may have higher environmental burdens and vulnerable populations.
66

7-
First-time users may find the 5-minute [EJScreen in 5: A Quick Overview of EJScreen](https://web.archive.org/web/20241008150339/https://www.youtube.com/watch?v=HZp3AWDJt5A) video helpful as an introduction to the tool.
7+
This is an unofficial copy of EJScreen, hosted by the [Public Environmental Data Partners](https://screening-tools.com/). Some links and text may incorrectly suggest that this site is affiliated with the US Government. We've published an initial reconstruction - you can identify the EJScreen data and index percentiles for a given block group right now. Check back soon as we put more time and resources toward the functionality of EJScreen you might be used to. Thanks for your patience and support.
88

9-
Other helpful resources include:
9+
## Other helpful resources on EJScreen:
1010

11+
- First-time users may find the 5-minute [EJScreen in 5: A Quick Overview of EJScreen](https://web.archive.org/web/20241008150339/https://www.youtube.com/watch?v=HZp3AWDJt5A) video helpful as an introduction to the tool.
1112
- [EJScreen User Guide](https://web.archive.org/web/20250121194015/https://ejscreen.epa.gov/mapper/help/ejscreen_help.pdf) for navigating the various features of the tool,
1213
- [EJScreen Glossary](https://web.archive.org/web/20250123161322/https://www.epa.gov/ejscreen/ejscreen-map-descriptions) for better understanding the map layers and indicators being displayed in the tool, and
1314
- [Frequent Questions about EJScreen](https://web.archive.org/web/20250123162243/https://www.epa.gov/ejscreen/frequent-questions-about-ejscreen)
15+
16+
## Repo Resources
17+
- [Installing EJScreen locally](INSTALLATION.md)
18+
- [Code of Conduct](CONDUCT.md)
19+
- [Contributing](CONTRIBUTING.md)
20+
- [Issues to work on or log](https://github.com/edgi-govdata-archiving/EJScreen/issues)

0 commit comments

Comments
 (0)