mirror of
https://github.com/GSA/notifications-admin.git
synced 2025-12-13 08:34:33 -05:00
Updated readme
This commit is contained in:
28
README.md
28
README.md
@@ -40,7 +40,7 @@ You will need the following items:
|
|||||||
[Follow the instructions here to set up the Notify.gov API.](https://github.com/GSA/notifications-api#before-you-start)
|
[Follow the instructions here to set up the Notify.gov API.](https://github.com/GSA/notifications-api#before-you-start)
|
||||||
|
|
||||||
The Notify.gov API is required in order for the Notify.gov Admin UI to run, and
|
The Notify.gov API is required in order for the Notify.gov Admin UI to run, and
|
||||||
it will also take care of many of the steps that are listed here. The sections
|
it will also take care of many of the steps that are listed here. The sections
|
||||||
that are a repeat from the API setup are flagged with an **[API Step]** label
|
that are a repeat from the API setup are flagged with an **[API Step]** label
|
||||||
in front of them.
|
in front of them.
|
||||||
|
|
||||||
@@ -83,11 +83,13 @@ Your system `$PATH` environment variable is likely set in one of these
|
|||||||
locations:
|
locations:
|
||||||
|
|
||||||
For BASH shells:
|
For BASH shells:
|
||||||
|
|
||||||
- `~/.bashrc`
|
- `~/.bashrc`
|
||||||
- `~/.bash_profile`
|
- `~/.bash_profile`
|
||||||
- `~/.profile`
|
- `~/.profile`
|
||||||
|
|
||||||
For ZSH shells:
|
For ZSH shells:
|
||||||
|
|
||||||
- `~/.zshrc`
|
- `~/.zshrc`
|
||||||
- `~/.zprofile`
|
- `~/.zprofile`
|
||||||
|
|
||||||
@@ -97,7 +99,7 @@ environments.
|
|||||||
Which file you need to modify depends on whether or not you are running an
|
Which file you need to modify depends on whether or not you are running an
|
||||||
interactive shell or a login shell
|
interactive shell or a login shell
|
||||||
(see [this Stack Overflow post](https://stackoverflow.com/questions/18186929/what-are-the-differences-between-a-login-shell-and-interactive-shell)
|
(see [this Stack Overflow post](https://stackoverflow.com/questions/18186929/what-are-the-differences-between-a-login-shell-and-interactive-shell)
|
||||||
for an explanation of the differences). If you're still not sure, please ask
|
for an explanation of the differences). If you're still not sure, please ask
|
||||||
the team for help!
|
the team for help!
|
||||||
|
|
||||||
Once you determine which file you'll need to modify, add these lines before any
|
Once you determine which file you'll need to modify, add these lines before any
|
||||||
@@ -158,7 +160,7 @@ _NOTE: This project currently uses the latest `1.4.x release of Terraform._
|
|||||||
#### [API Step] Python Installation
|
#### [API Step] Python Installation
|
||||||
|
|
||||||
Now we're going to install a tool to help us manage Python versions and
|
Now we're going to install a tool to help us manage Python versions and
|
||||||
virtual environments on our system. First, we'll install
|
virtual environments on our system. First, we'll install
|
||||||
[pyenv](https://github.com/pyenv/pyenv) and one of its plugins,
|
[pyenv](https://github.com/pyenv/pyenv) and one of its plugins,
|
||||||
[pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), with Homebrew:
|
[pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), with Homebrew:
|
||||||
|
|
||||||
@@ -285,7 +287,7 @@ we'll use `3.12` in our example here since we recently upgraded to this version:
|
|||||||
pyenv install 3.12
|
pyenv install 3.12
|
||||||
```
|
```
|
||||||
|
|
||||||
Next, delete the virtual environment you previously had set up. If you followed
|
Next, delete the virtual environment you previously had set up. If you followed
|
||||||
the instructions above with the first-time set up, you can do this with `pyenv`:
|
the instructions above with the first-time set up, you can do this with `pyenv`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -306,6 +308,20 @@ you'll be set with an upgraded version of Python.
|
|||||||
|
|
||||||
_If you're not sure about the details of your current virtual environment, you can run `poetry env info` to get more information. If you've been using `pyenv` for everything, you can also see all available virtual environments with `pyenv virtualenvs`._
|
_If you're not sure about the details of your current virtual environment, you can run `poetry env info` to get more information. If you've been using `pyenv` for everything, you can also see all available virtual environments with `pyenv virtualenvs`._
|
||||||
|
|
||||||
|
#### Updating the .env file for Login.gov
|
||||||
|
|
||||||
|
To configure the application for Login.gov, you will need to update the following environment variables in the .env file:
|
||||||
|
|
||||||
|
```
|
||||||
|
COMMIT_HASH=”--------”
|
||||||
|
```
|
||||||
|
|
||||||
|
Reach out to someone on the team to get the most recent Login.gov key.
|
||||||
|
|
||||||
|
```
|
||||||
|
LOGIN_PEM="INSERT_LOGIN_GOV_KEY_HERE"
|
||||||
|
```
|
||||||
|
|
||||||
#### Updating the .env file for E2E tests
|
#### Updating the .env file for E2E tests
|
||||||
|
|
||||||
With the newly created `.env` file in place, you'll need to make one more
|
With the newly created `.env` file in place, you'll need to make one more
|
||||||
@@ -353,7 +369,7 @@ API is running as well!
|
|||||||
## Creating a 'First User' in the database
|
## Creating a 'First User' in the database
|
||||||
|
|
||||||
After you have completed all setup steps, you will be unable to log in, because there
|
After you have completed all setup steps, you will be unable to log in, because there
|
||||||
will not be a user in the database to link to the login.gov account you are using. So
|
will not be a user in the database to link to the login.gov account you are using. So
|
||||||
you will need to create that user in your database using the 'create-test-user' command.
|
you will need to create that user in your database using the 'create-test-user' command.
|
||||||
|
|
||||||
Open two terminals pointing to the api project and then run these commands in the
|
Open two terminals pointing to the api project and then run these commands in the
|
||||||
@@ -372,8 +388,6 @@ is the same one you are using in login.gov and make sure your phone number is in
|
|||||||
If for any reason in the course of development it is necessary for your to delete your db
|
If for any reason in the course of development it is necessary for your to delete your db
|
||||||
via the `dropdb` command, you will need to repeat these steps when you recreate your db.
|
via the `dropdb` command, you will need to repeat these steps when you recreate your db.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Git Hooks
|
## Git Hooks
|
||||||
|
|
||||||
We're using [`pre-commit`](https://pre-commit.com/) to manage hooks in order to
|
We're using [`pre-commit`](https://pre-commit.com/) to manage hooks in order to
|
||||||
|
|||||||
Reference in New Issue
Block a user