simple-auth/README.md
2022-10-03 17:43:59 +02:00

49 lines
838 B
Markdown

# simple-auth
A little web server providing JWT token for auth auser.
**NOTE**: for now, the server is listening on port **9000**. Change it, in the src if needed.
## Build
```bash
cargo build --release
# run the server
./target/release/simple-auth
```
## Test
### unit tests
```bash
cargo test
```
### integration tests
* run the server locally or remotly (the URL must be changed if needed in `curling.bash` and `test_requests.py`)
* run curl tests
```bash
cd tests/bash/
./curling.bash && echo "passed"
```
* run python requests tests
```bash
# create a python venv
cd tests/python
python3 -m venv venv
source venv/bin/activate
# intall the requirements
pip install -r requirements
# launch the tests
python -m unitest
```
## Documentation
```bash
# add the '--open' arg to open the doc on a browser
cargo doc --no-deps
```