mirror of
https://github.com/offen/website.git
synced 2024-12-23 13:30:20 +01:00
add README for accounts app
This commit is contained in:
parent
264c3273cb
commit
4252ec39b2
@ -1,4 +1,7 @@
|
||||
test:
|
||||
@pytest --disable-pytest-warnings
|
||||
|
||||
.PHONY: test
|
||||
fmt:
|
||||
@black .
|
||||
|
||||
.PHONY: test fmt
|
||||
|
37
accounts/README.md
Normal file
37
accounts/README.md
Normal file
@ -0,0 +1,37 @@
|
||||
# accounts
|
||||
|
||||
The `accounts` app is responsible for managing operator accounts and issuing authentication tokens that will identify requests made to the `server` and the `kms` service.
|
||||
|
||||
The application is built using the [Flask][flask-docs] framework.
|
||||
|
||||
[flask-docs]: http://flask.pocoo.org/
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
### Commands
|
||||
|
||||
#### Install dependencies
|
||||
|
||||
```
|
||||
pip install --user -r requirements.txt -r requirements-dev.txt
|
||||
```
|
||||
|
||||
#### Run the development server
|
||||
|
||||
```
|
||||
FLASK_APP=accounts FLASK_ENV=development flask run
|
||||
```
|
||||
|
||||
#### Run the tests
|
||||
|
||||
```
|
||||
make test
|
||||
```
|
||||
|
||||
#### Auto format code using `black`
|
||||
|
||||
```
|
||||
make fmt
|
||||
```
|
@ -2,6 +2,7 @@ import unittest
|
||||
|
||||
from accounts import app
|
||||
|
||||
|
||||
class TestStatus(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.app = app.test_client()
|
||||
|
Loading…
Reference in New Issue
Block a user