pk/atst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #400 from dod-ccpo/readme-updates

Browse Source 
update readme for onboarding new devs
This commit is contained in:
patricksmithdds 2018-10-19 13:51:53 -04:00 committed by GitHub
commit ec8589fdbd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -29,6 +29,10 @@ locally:
`pipenv`'s documentation for instructions on installing `pipenv]( `pipenv`'s documentation for instructions on installing `pipenv](
https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv). https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv).
* `yarn`
ATST requires `yarn` for installing and managing Javascript
dependencies: https://yarnpkg.com/en/
* `postgres` >= 9.6 * `postgres` >= 9.6
ATST requires a PostgreSQL instance (>= 9.6) for persistence. Have PostgresSQL installed ATST requires a PostgreSQL instance (>= 9.6) for persistence. Have PostgresSQL installed
and running on the default port of 5432. You can verify that PostgresSQL is running and running on the default port of 5432. You can verify that PostgresSQL is running
@ -65,7 +69,7 @@ To perform the installation, run the setup script:
script/setup script/setup
The setup script creates the virtual environment, and then calls script/bootstrap The setup script creates the virtual environment, and then calls script/bootstrap
to install all of the Python and Node dependencies. to install all of the Python and Node dependencies and run database migrations.
To enter the virtualenv manually (a la `source .venv/bin/activate`): To enter the virtualenv manually (a la `source .venv/bin/activate`):
@ -76,6 +80,21 @@ project directory, take a look at [direnv](https://direnv.net/). An `.envrc`
file is included in this repository. direnv will activate and deactivate file is included in this repository. direnv will activate and deactivate
virtualenvs for you when you enter and leave the directory. virtualenvs for you when you enter and leave the directory.
### Troubleshooting Setup
If you have a new postgres installation you might encounter
errors about the `postgres` role not existing. If so, run:
```
createuser -s postgres
```
If `script/setup` complains that the database does not exist,
run:
```
createdb atat
```
## Running (development) ## Running (development)