neo-todo-api/README.md
minhtrannhat 61bac977ff
Feat & Fix(API): Sending emails to users
- Send emails to users when they register or when they reset their
  password.
- Fix `.gitignore` not recoginizing changes in `lib` folder
2022-12-15 09:45:16 -05:00

40 lines
1.0 KiB
Markdown

# Todo API
## Frontend
### Development dependencies
- `prettier`: Formatter
## Backend
### Development workflow
- Run `eval (pdm venv activate in-project)` (if you are using Fish shell) or `eval $(pdm venv activate in-project)` (if you are using bash/zsh) at the `backend` folder root.
### Dependencies
#### Python dependencies
- `quart`: a micro-webframework, async version of Flask.
- `black`: Code formatter.
- `isort`: Import formatter.
- `mypy`: Type checking.
- `flake8`: General Python bugs.
- `vulture`: Find unused code in Python programs.
- `pytest`: For testing (turbocharged with `async`).
- `bcrypt`: Hashing and salting password.
- `zxcvbn`: Test password strength.
- `freezegun`: Check for expired token.
- `quart-rate-limiter`: Rate limiting.
- `pydantic` and `quart-schema`: Request/Response validation.
- `httpx`: send HTTP POST requests from our app.
#### SQL Dev-deps
- `bandit`: Check for SQL injection vulnerabilities.
#### Miscs Dev-deps
- `djhtml`: Generate jinja templates html for emails.