mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-08-12 04:29:44 +02:00
* Bringing over changes from original PR * Added the rapidfuzz lib to pip * Added the lib to requirements * Refactored the fuzzy matcher out to a generic util, updated the create federal porfolio. * linter fixes * lint fixes * Adjusting loop to skip index (correct testing) * Created test for the fuzzy string match fixed any issues that were found. Set back the version of set up tools to what it should be. * Linter and Black changes. * cleaning up updates * Added root user to the owasp sec scan to fix the perm issue. * More updates to fix owasp. * linting fix * Removed the person name fuzzy matcher. * lint fix * Refactored the domains and requests for loop for dry run * lint fix * Cleaning up lint and test after removing the persongenerator * cleaning a test * forgot a file * fixed lint issue --------- Co-authored-by: Abraham Alam <abraham.alam@ecstech.com>
This commit is contained in:
parent
ce910c2c68
commit
b4b2ac6e63
16 changed files with 2037 additions and 937 deletions
|
@ -10,9 +10,9 @@ If you're new to Django, see [Getting Started with Django](https://www.djangopro
|
|||
|
||||
```shell
|
||||
cd src
|
||||
docker-compose build
|
||||
docker compose build
|
||||
```
|
||||
* Run the server: `docker-compose up`
|
||||
* Run the server: `docker compose up`
|
||||
|
||||
Press Ctrl-c when you'd like to exit or pass `-d` to run in detached mode.
|
||||
|
||||
|
@ -50,7 +50,7 @@ Resources:
|
|||
|
||||
## Setting Vars
|
||||
|
||||
Non-secret environment variables for local development are set in [src/docker-compose.yml](../../src/docker-compose.yml).
|
||||
Non-secret environment variables for local development are set in [src/docker compose.yml](../../src/docker compose.yml).
|
||||
|
||||
Secrets (for example, if you'd like to have a working Login.gov authentication) go in `.env` in [src/](../../src/) with contents like this:
|
||||
|
||||
|
@ -159,15 +159,15 @@ The CODEOWNERS file sets the tagged individuals as default reviewers on any Pull
|
|||
|
||||
## Viewing Logs
|
||||
|
||||
If you run via `docker-compose up`, you'll see the logs in your terminal.
|
||||
If you run via `docker compose up`, you'll see the logs in your terminal.
|
||||
|
||||
If you run via `docker-compose up -d`, you can get logs with `docker-compose logs -f`.
|
||||
If you run via `docker compose up -d`, you can get logs with `docker compose logs -f`.
|
||||
|
||||
You can change the logging verbosity, if needed. Do a web search for "django log level".
|
||||
|
||||
## Mock data
|
||||
|
||||
[load.py](../../src/registrar/management/commands/load.py) called from docker-compose (locally) and reset-db.yml (upper) loads the fixtures from [fixtures_user.py](../../src/registrar/fixtures/fixtures_users.py) and the rest of the data-loading fixtures in that fixtures folder, giving you some test data to play with while developing.
|
||||
[load.py](../../src/registrar/management/commands/load.py) called from docker compose (locally) and reset-db.yml (upper) loads the fixtures from [fixtures_user.py](../../src/registrar/fixtures/fixtures_users.py) and the rest of the data-loading fixtures in that fixtures folder, giving you some test data to play with while developing.
|
||||
|
||||
See the [database-access README](./database-access.md) for information on how to pull data to update these fixtures.
|
||||
|
||||
|
@ -179,26 +179,26 @@ To get a container running:
|
|||
|
||||
```shell
|
||||
cd src
|
||||
docker-compose build
|
||||
docker-compose up -d
|
||||
docker compose build
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Django's test suite:
|
||||
|
||||
```shell
|
||||
docker-compose exec app ./manage.py test
|
||||
docker compose exec app ./manage.py test
|
||||
```
|
||||
|
||||
OR
|
||||
|
||||
```shell
|
||||
docker-compose exec app python -Wa ./manage.py test # view deprecation warnings
|
||||
docker compose exec app python -Wa ./manage.py test # view deprecation warnings
|
||||
```
|
||||
|
||||
Linters:
|
||||
|
||||
```shell
|
||||
docker-compose exec app ./manage.py lint
|
||||
docker compose exec app ./manage.py lint
|
||||
```
|
||||
|
||||
### Get availability for domain requests to work locally
|
||||
|
@ -266,7 +266,7 @@ accessibility rules. The scan runs as part of our CI setup (see
|
|||
type
|
||||
|
||||
```shell
|
||||
docker-compose run pa11y npm run pa11y-ci
|
||||
docker compose run pa11y npm run pa11y-ci
|
||||
```
|
||||
|
||||
The URLs that `pa11y-ci` will scan are configured in `src/.pa11yci`. When new
|
||||
|
@ -280,7 +280,7 @@ security rules. The scan runs as part of our CI setup (see
|
|||
type
|
||||
|
||||
```shell
|
||||
docker-compose run owasp
|
||||
docker compose run owasp
|
||||
```
|
||||
|
||||
## Images, stylesheets, and JavaScript
|
||||
|
@ -297,7 +297,7 @@ We utilize the [uswds-compile tool](https://designsystem.digital.gov/documentati
|
|||
|
||||
### Making and viewing style changes
|
||||
|
||||
When you run `docker-compose up` the `node` service in the container will begin to watch for changes in the `registrar/assets` folder, and will recompile once any changes are made.
|
||||
When you run `docker compose up` the `node` service in the container will begin to watch for changes in the `registrar/assets` folder, and will recompile once any changes are made.
|
||||
|
||||
Within the `registrar/assets` folder, the `_theme` folder contains three files initially generated by `uswds-compile`:
|
||||
1. `_uswds-theme-custom-styles` contains all the custom styles created for this application
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue