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

Group requirements and add section headers

Browse Source
This commit is contained in:
Devon Mackay 2018-07-11 11:23:55 -04:00
parent ccd959e4a9
commit 7b839a922b
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -11,14 +11,20 @@ microservices when appropriate.
## Installation ## Installation
### Requirements
See the [scriptz](https://github.com/dod-ccpo/scriptz) repository for the shared See the [scriptz](https://github.com/dod-ccpo/scriptz) repository for the shared
requirements and guidelines for all ATAT applications. requirements and guidelines for all ATAT applications.
Additionally, ATST requires a redis instance for session management. Have redis
installed and running. By default, ATST will try to connect to a redis instance
running on localhost on its default port, 6379.
### Cloning
This project contains git submodules. Here is an example clone command that will This project contains git submodules. Here is an example clone command that will
automatically initialize and update those modules: automatically initialize and update those modules:
git clone --recurse-submodules git@github.com:dod-ccpo/atst.git git clone --recurse-submodules git@github.com:dod-ccpo/atst.git
### Setup
This application uses Pipenv to manage Python dependencies and a virtual This application uses Pipenv to manage Python dependencies and a virtual
environment. Instead of the classic `requirements.txt` file, pipenv uses a environment. Instead of the classic `requirements.txt` file, pipenv uses a
Pipfile and Pipfile.lock, making it more similar to other modern package managers Pipfile and Pipfile.lock, making it more similar to other modern package managers
@ -37,7 +43,6 @@ To enter the virtualenv manually (a la `source .venv/bin/activate`):
If you want to automatically load the virtual environment whenever you enter the project directory, take a look at [direnv](https://direnv.net/). An `.envrc` file is included in this repository. direnv will activate and deactivate virtualenvs for you when you enter and leave the directory. If you want to automatically load the virtual environment whenever you enter the project directory, take a look at [direnv](https://direnv.net/). An `.envrc` file is included in this repository. direnv will activate and deactivate virtualenvs for you when you enter and leave the directory.
Additionally, ATST requires a redis instance for session management. Have redis installed and running. By default, ATST will try to connect to a redis instance running on localhost on its default port, 6379.
## Running (development) ## Running (development)