publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-23 01:54:18 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
j40-cejst-2/QUICKSTART.md

26 lines
987 B
Markdown
Raw Normal View History

Update documentation to make it easier for users to find the right content for them (#1016) * First pass of updating documentation for new users Trying to look at this from the perspective of someone new to the project, and create some pathways to make it easier for people to get to the content they are looking for. * Make it clear that docker is doing the setup * Link installation again from the main README * Add some docs about the github actions * Add markdown link check * Move git installation first * Add config for markdown link checker * Fix some links * Correct handling of repo root relative links * Fix broken links in data roadmap * Fix more broken links * Fix more links * Ignore link that's returning a 403 to the checker It actually works if you go in a browser. * Fix another broken link * Ignore more urls that don't work * Update the readme under docs * Add some more dataset links * More strongly call out the quickstart * Try to call out even more the quickstart link * Fix dead links * Add note about initialization time * Remove broken link from spanish install guide These will be updated later with a full translation
2021-12-16 10:16:28 -05:00
# Local Quickstart
Install [`git`](https://git-scm.com/). See [Install Git](INSTALLATION.md#install-git).
Open a terminal, clone this repository, and change directory to the repository root:
```sh
$ git clone https://github.com/usds/justice40-tool
Cloning into 'justice40-tool'...
$ cd justice40-tool
```
Frontend release branch to main (#1829) * Add Geolocation from behind feature flag * Comment updates from PR feedback * Modify geolocate icon and beacon to be black * Upgrade lb dependencies - upgrade uswds to 2.13.3 - upgrade trussworks to 3.1.0 - fix breaking changes on Accordion, Search, SummaryBox, Collections, * Fixes links that were off center * Modify styling for geolocation * Modify geolocation message * Add mobile and desktop geolocating * Modify disabled label tooltip message * Add indicators to Puerto Rico (to release branch) (#1688) * Add indicators to Puerto Rico * Remove linguistic iso in Puerto Rico only * Adds demographics v1 - This uses the built-in accordion component * Add custom Accordion component to match designs * Update AreaDetail snapshots * Adding some better comments * Add USWDS expand to demographics side panel * Remove justice40-tool from prefix-path * Update staging link to new CDN link * Remove messaging on mobile * Prettify test file * Add TractInfo component * Style TractDemo component * Move Methodology version to bottom of sidepanel * Add custom expand / collapse component - adds a11y - adds chevron from USWDS icons * Align Geolocate icon and Search - align geolocate and search according to mock for desktop and mobile * Add tribal toggle (UI only) * Refactor Sources/Layers to allow for tribal switching - Remove census tracts layers into it's own component - Create a tribal layer component - Update LayerSelector component tests - update OS map to react to layer selector - * Add tribal info to side panel and feature selection - create a state variable to keep track of weather or not the layer was toggled - allow mapInfoPanel to reset on layer switch - allow AreaDetail to show census and tribal info - allow LayerSelector to set layer toggled - Add selectedFeature to both MapTribal and MapTract components - create various tribal constants for styling - i18n constants * Update snapshots * Update tribal path on production build * Comment update * add QA feedback - swap expand/collapse icons - add parens and slash to copy * Add initial AK points - corrects filter expression - adds radius and color to constants * Update staging deploy script - update domain name - update path * Update AK layer id - make AK layer clickable * Add OS map functionality - split source/layers between Map*Layers.tsx and getOSBaseMap file - update getOSBaseMap to return eithe tribal or tracts layers/sources * Add geolocation locked signal to local storage * Make source/layer comments correspond - getOSBaseMap and Map*Layers should have the same layer comments - modify constants to have matching styles between Tribal and Tracts * Remove zooming in on Alaska data point * Update Tribal shortname ID * Adjust CSS to place LayerSelector in MapHeader * Comment out markdown check on link * Add flooding and wildfire indicators to side panel * Add indicators - barriers to transport - lack of green space - lack of plumbing - leaky tanks * Add back the selected feature layer * Show Tract info/demo only when tracts are selected * Update SCORE_HIGH_PROP from SM_PFS to SM_C - Will allow high zoom tiles to load with BE staging branch 1822/e638 * Fix 2 demographics typos - repeated demographic - change to race/ethnicity * Add HRS, AML, FUDS and demographics (#1861) * Add HRS_ET - refactor to add IndicatorTypes - modify tests - add intl * Add AML and FUDS - update indicatorFilter - update tests each indicator has 3 states to test * Connect BE signal for demographics - update tests - i18n-ize * Remove obsolete tests snapshots * Update to Score N constants * Remove higher ed socio-economic indicator - remove spacer "Meets both socio" - update snapshots * Update BE signal types for - AML - FUDS * Filter out missing historic underinvest. indicators - For the special case when historic underinvestments are missing do not show that indicator at all - update unit tests * Make AML appear as No for all that are missing * Update snapshot * Correct BE signal on low income (#1877) * Adds adjacency, impute flag and custom colors * Update Quickstart docker link * Remove duplicate Higher Ed indicator, update higher ed types and correct copy on 404 page (#1886) * remove duplicate high school degree indicator - for island areas * Update 404 page copy * Remove link that is failing during markdown checks * Updated FE indicators constants to remove _M - by removing these _M suffix on the FE constants, we remove any dependency on changes to the BE score * Remove up/down arrows from indicators * update style of side panel categories if supported - if the browser has ":has" support, the new category styles will be applied - if not, the older style will remain in place * update snapshots * update styling for indicator values - refactor disadvantaged blue dot to utils.scss * remove missing icon and reduce subtext font size * Remove un-needed import in test file * Update category, indicator copy * Update copy indicator desc and titles * update side panel styling for 1.0 * Update methodology version / styling * 1.0 side panel indicator designs (#1896) * Remove up/down arrows from indicators * update style of side panel categories if supported - if the browser has ":has" support, the new category styles will be applied - if not, the older style will remain in place * update snapshots * update styling for indicator values - refactor disadvantaged blue dot to utils.scss * remove missing icon and reduce subtext font size * Remove un-needed import in test file * Update category, indicator copy * Update copy indicator desc and titles * update side panel styling for 1.0 * Update methodology version / styling * Add USVI and GU to map - remove shortcuts on mobile * Fix all link colors, prevent logo from wrapping, update non-selected side-panel (#1908) * Update links colors - Language links - Download links - Simple links - External links - Side panel demographics links - return to top links - update snapshots * Fix wrapping on logo title - remove beta pill * Update un-selected side panel copy (desktop) - two icons are needed * Remove icons on mobile view * Remove the pub. eng. button on all pages * Add usa-link class to all links - will create consiste visible state on all links * Remove tribal toggle - remove tribal layer from feature flag and make it default * Update copy on Explore the Map page (#1915) * Add Explore the Data box * Update explore page description - Remove paragraph under map * Update territories copy - Remove How you can help * Update Whitehouse footer icon * Correct heading order to pass a11y * Remove beta pill in Beta Banner - update snapshots * Update explore page description - remove color key * revert image back to eagle seal * Update release date variable name * Add Impute, Adj and tribal signals to side panel * Remove test category - move send feedback button outside of categorization div - left justify send feedback button - update snapshots * Update links in the territories paragraph on explore page * Update tribal lands copy on explore page * Align geolocate icon on desktop and mobile * Add inverted style to YES - update snapshots * About page 1.0 (#1933) * Initial About page * Update navigation links - adds hover and current effects - fits width of each nav link to content * Add location prop to J40Header * Fix a11y error on internal links - remove AboutCard LinkTypeWrapper if url is not specified - remove gherkin tests on new nav links - update snapshots * Fix mobile nav for new nav links * Add usa-current class to dropdown nav * side panel narwal (#1943) * Adds the PrioritizationCopy and TractPriotization - adds both components - removes logic around selecting AK data points - update snapshots * Add tests for TractPrioritization * Adds tests for PrioritizationCopy * Add income icon and tilde - this is dependent on imputed income and adjacency * Add tool tip to low income icon * Update snapshots * Removing AreaDetail test to allow tooltip library - This library react-tooltip creates random DOM ID which will not allow for snapshot testing as he IDs change on each build. Due to time constraints, we simply removed the AreaDetails test. The AreaDetails component is made up of sub component and each sub component has tests so this is low risk. - This is a temporary solution. Some longer terms solutions may be 1. Remove this library and get the USWDS tool tip to work 2. Re-factor the areaDetail.tests.tsx snapshot tests to do more DOM assertions rather than snapshots 3. Some combination of the two. * Fix Tribal percentage error * Update copy based on bug party (#1973) * Update copy from team debug party - closes #1945 - Lack of green space description - Lack of indoor plumbing * Update copy - closes #1950 * Update copy - closes #1951 * Update survey button - Text and link - closes 1967 * Update copy - correct tool tip copy - closes #1959 * No issue number: Update front-end Readme (#1935) * Addresses `nvm` install * Updated side panel, with two paragraphs, "Completely surrounded" and "Adjusted low income" and more! (#1990) * Update logic for TractPrioritization and bug fix - fix wildfire bug closes #1953 - rename TractPri API to better align with BE signal names - redo test and all test cases * Add PrioCopy1 and PrioCopy2 - fix rounding - limited tests for each component. Many more test cases are needed - add copy to i18n * Adjust LowInc tool tip only on IMP_FLG=T - remove threshold change for low income * Add copy for comp. surr and Adj low inc - create a new component DonutCopy - add tests - modify styling to work in both 1 para case and 2 para case * Add Donut copy * Fix typo on 2nd paragraph * Update browser list * Adds TA_COUNT_AK, TA_COUNT_C and TA_PERC_FE - Prio1 and Prio2 both take TA_COUNT_C which should be null - updates basic tests * Remvoe cypress tests * Update CONUS number to troubleshoot * Copy adjustments - move test copy to console.log - move donutCopy to only show when ADJ_ET is true * Update copy from Word Doc (#2001) * add tsc compile * fix TS warning around headingLevel * Temporary fix around availableFor type error - correlated to fix needed in ticket 2000 * Add copy update from CEJST pages - STATUS doc - Add a period in Get the Data box - Update unselected side panel text - Update text under explore the map - Content and styling for territories note - persistent FAB - “Help improve the tool” - Water needs to be “Water and Wastewater” - Styling on demographics ( show ) => (show) - Update age in demographics to be Elderly over 65 - Wildfire description is not correct - Lead paint description needs to be updated - remove bullet from How you can help - Footer - remove RFI - Footer - remove Eng cal - add sign up link * Update side panel non-selected copy * Add back PEC button to each main page * Remove console logs from J40Header * Fix DOM warning on About page - can't have <li> in <p> * Fix nested DOM warning on Explore page - Modify ExploreDataBox styling * Update side panel non-selected with icons - update height on mobile - update snapshots * Remove markdown ignore comments - hoping this will build and match main so that the FE doesn't trigger the BE * Add comments back to match main * Update methodology page copy to Content 1.0 (#2009) * Update methodology copy - update categories - update snapshots * Add button to datasets page - add tests * Update copy for meth page according to Content1.0 * FAQS page (#2016) * Fix a11y issue on Ling Iso card * Add layout of new FAQs page * Reorder SubNav links on About page * Add NEW tag to new Burdens * Add first 6 questions to FAQs * Add the rest of the FAQs onto the page * Adjust sub-nav order in About header - update snapshots - ensure that FAQ in SubNav is active * Previous versions page narwal (#2018) * Add Previous Version page - Create a new DownloadButton component - Add PreviousVersion link to main nav - Extract out download button from PublicVideo component - Update SidePageNav to render PrevVersion - Add Beta start date - Create previous-version page - Add public eng to all pages - update snapshots * Update cypress test to test prev version page - Add <ul> around card as it fails a11y without it. * Add updated tribal base map - this removes the LAR suffix in MapBox studio * Initial Download page (#2021) * Intial version of 1.0 download page * fix a11y errors * Update snapshots * FRT copy update, isDAC to use SN_C and new base map of custom colors + updated tribal names (#2029) * Update FRT copy in isDAC copy in side panel * Update base map - custom colors + updated tribal names - closes #2005 * Update isDAC logic to use SN_C - update component props - update test cases - closes #2024 * Update snapshots * Remove unused vars from the constants (#2020) (#2023) * Update release copy (#2036) * Update Pub Eng page (#2043) - Refactor download button to have gray buttons also - Add a beta version of the PublicVideoBox in SCSS - Update copy on Pub Eng page * Change geojson to shapefile (#2044) * geojson -> shapefile (#1931) * Update test too (#1931) * Beta and narwal links (#2051) * Update download links to 1.0 * Update previous versions with two beta links * Add beta data doc to prod .env * Update PEC page - add new icons (expired) - create placeholder for 1.0 copy - remove narwal links * Add sign-up link on About page * Update FRT copy * Update contact page * Point map to new 1.0 versions path on S3 - remove FILE_DL prefix on from .env variables as the path is for both file download and map tiles now - Update MapTractLayers to use 1.0 score path - Update downloads file to use updated score path names * Only show two rows (ADJ and ADJ threshold) if - ADJ_ET is true AND - total number of disadv cats is 0 * Make 'PARTIALLY' highlighted like `YES` * Highlight indicator value if - ADJ_ET is true - Imputed poverty income is > threshold (50) * Update RAW true value for HRS_ET * Make the logo and title of header nav back to map * Content 1.0 updates, test tracts updated, some UI tweaks tasks (#2063) * Content 1.0 updates * Import variables rather than entire constant files * Add "--" to all tract info * Show "--" for when Adjusted low income is missing * Add non disadvn case - ADJ_ET is true and threshold isn't met * Replace socio-economic with socioeconomic * Add mouse pointer icon to side panel - this looks like the bird lol * Update sign up link - closes #1640 - update snapshots * Update tract feedback button to include tractid - this is dependent on SM enabling multiple responses - closes #1969 * Update HOLC long description note - closes #2066 * Add content to question 2 of FAQs - closes #2067 - update snapshots * Update copy - closes #2059 - updates release date to 11.21 - updates snapshots * Remove language links - closes #2055 - updates snapshots * Update Two tribal strings - fix if we have TA_COUNT_AK and TA_PERC - Add "Partially surrounded" copy - Add comment on how to find the logic truth table for paragraph1 and 2 * Revert date * Update low income tooltip - take into account pop = null - update comments * Update side panel copy * Update copy on Methodology page * Updated About page copy * Update FAQs copy * Update New tags to bold - closes * Add banner - closes #2019 * Updated top of downloads page - update change log copy * Copy updates - closes #2082 * Add and remove burdens for PR: - closes #2083 * Correct burdens for Puerto Rico * Add 3 download files to FE - beta training slides to .env - instructions to .env - comp. chart to .env - add comp chart to FAQ - update snapshots * Update priotization copy - closes #2086 - closes #2085 - reorders ifs, placed all ifs with dependency no CC > =1 w/i in the first if block * Update copy - update icon in side panel (unselected) - update copy in methodology cards * Update link in FAQs * Update linked text on note Tribal Nations * Remove download file links from FAQs * Update top of Download page * Final copy update -closes #2082 * Update space in About page copy * Update copy based on Katherine's findings - update snapshots - remaining changes from Content 1.0 * Undo BE settings file * Fix FUDS bug - closes #2090 * Fix Low Income tooltip copy * Final copy updates -closes #2092 * Final final copy changes * Update 1.0 communities list on download page Co-authored-by: Jorge Escobar <83969469+esfoobar-usds@users.noreply.github.com> Co-authored-by: Lucas Merrill Brown <lucas.m.brown@omb.eop.gov> Co-authored-by: Matt Bowen <83967628+mattbowen-usds@users.noreply.github.com>
2022-11-21 15:20:34 -08:00
Install [`docker`](https://docs.docker.com/get-docker/). See [Install Docker](INSTALLATION.md#install-docker).
Update documentation to make it easier for users to find the right content for them (#1016) * First pass of updating documentation for new users Trying to look at this from the perspective of someone new to the project, and create some pathways to make it easier for people to get to the content they are looking for. * Make it clear that docker is doing the setup * Link installation again from the main README * Add some docs about the github actions * Add markdown link check * Move git installation first * Add config for markdown link checker * Fix some links * Correct handling of repo root relative links * Fix broken links in data roadmap * Fix more broken links * Fix more links * Ignore link that's returning a 403 to the checker It actually works if you go in a browser. * Fix another broken link * Ignore more urls that don't work * Update the readme under docs * Add some more dataset links * More strongly call out the quickstart * Try to call out even more the quickstart link * Fix dead links * Add note about initialization time * Remove broken link from spanish install guide These will be updated later with a full translation
2021-12-16 10:16:28 -05:00
[SPIKE] Improve backend documentation (#2177) * Update code owners to include new folks and remove the departed ones * Update maintainers to reflect the current personnel * Update contributing with the latest, and make small changes to readme to make it easier to read * Update maintainers with Lucas Brown * Update installation guide to refine instructions and make them easier to follow * Try emojis to make notes stand out more * Experiment with note * Moved installation of data pipeline into a new file (contents TBD), and redid most part of the data pipeline README for clarity and readability * Add mermaid diagram * Fix table * Update readme for clarity and correctness * Update TOC * Fix comparator doc * Add section on internal score comparison * Move tox information from installation to testing * Update installation for data pipeline * Add emojis to make picking out platform-specific instructions easier * Fix Git caps * Update for readability * Add direct link to VS Code instructions * Fix broken link and improve readability * Update installation for clarity and proper case * Update python text * Clean up information about poetry and poetry lockfiles * Remove duplicate paragraph * Fix case * update date table * re-adjust table to put links at the end * Fix a few minor typos --------- Co-authored-by: Sam Powers <121890478+sampowers-usds@users.noreply.github.com>
2023-02-28 15:11:57 -06:00
> _Important_: To be able to run the entire application, you may need to increase the memory allocated for docker to at least 8096 MB. See [this post](https://stackoverflow.com/a/44533437) for more details.
Update documentation to make it easier for users to find the right content for them (#1016) * First pass of updating documentation for new users Trying to look at this from the perspective of someone new to the project, and create some pathways to make it easier for people to get to the content they are looking for. * Make it clear that docker is doing the setup * Link installation again from the main README * Add some docs about the github actions * Add markdown link check * Move git installation first * Add config for markdown link checker * Fix some links * Correct handling of repo root relative links * Fix broken links in data roadmap * Fix more broken links * Fix more links * Ignore link that's returning a 403 to the checker It actually works if you go in a browser. * Fix another broken link * Ignore more urls that don't work * Update the readme under docs * Add some more dataset links * More strongly call out the quickstart * Try to call out even more the quickstart link * Fix dead links * Add note about initialization time * Remove broken link from spanish install guide These will be updated later with a full translation
2021-12-16 10:16:28 -05:00
Use `docker-compose` to run the application:
```sh
$ docker-compose up
```
[SPIKE] Improve backend documentation (#2177) * Update code owners to include new folks and remove the departed ones * Update maintainers to reflect the current personnel * Update contributing with the latest, and make small changes to readme to make it easier to read * Update maintainers with Lucas Brown * Update installation guide to refine instructions and make them easier to follow * Try emojis to make notes stand out more * Experiment with note * Moved installation of data pipeline into a new file (contents TBD), and redid most part of the data pipeline README for clarity and readability * Add mermaid diagram * Fix table * Update readme for clarity and correctness * Update TOC * Fix comparator doc * Add section on internal score comparison * Move tox information from installation to testing * Update installation for data pipeline * Add emojis to make picking out platform-specific instructions easier * Fix Git caps * Update for readability * Add direct link to VS Code instructions * Fix broken link and improve readability * Update installation for clarity and proper case * Update python text * Clean up information about poetry and poetry lockfiles * Remove duplicate paragraph * Fix case * update date table * re-adjust table to put links at the end * Fix a few minor typos --------- Co-authored-by: Sam Powers <121890478+sampowers-usds@users.noreply.github.com>
2023-02-28 15:11:57 -06:00
> Note: This may take a while – possibly even an hour or two – since it has to build the containers and then download and process all the data.
More obviously call out deploy time in quickstart (#1113) Just to set expectation that this will take a while, so new users don't think they did something wrong.
2022-01-10 16:34:43 -05:00
After it initializes, you should be able to open the application in your browser at [http://localhost:8000](http://localhost:8000).
Reference in a new issue Copy permalink