neo-todo-api/README.md

# 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.
Initial commit 2022-11-18 16:08:50 -05:00			`# Todo API`

			`## Frontend`

			`### Development dependencies`

			- `prettier`: Formatter

			`## Backend`

Feat(API): Request/Response schema validation 2022-12-10 18:46:51 -05:00			`### 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`
Initial commit 2022-11-18 16:08:50 -05:00
Feat(API): Added rate-limiting and json error handling 2022-11-19 15:13:38 -05:00			`#### Python dependencies`
Initial commit 2022-11-18 16:08:50 -05:00
Feat(API): Added rate-limiting and json error handling 2022-11-19 15:13:38 -05:00			- `quart`: a micro-webframework, async version of Flask.
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:40:38 -05:00			- `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`).
Feat(API): Added rate-limiting and json error handling 2022-11-19 15:13:38 -05:00			- `bcrypt`: Hashing and salting password.
			- `zxcvbn`: Test password strength.
			- `freezegun`: Check for expired token.
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:40:38 -05:00			- `quart-rate-limiter`: Rate limiting.
			- `pydantic` and `quart-schema`: Request/Response validation.
			- `httpx`: send HTTP POST requests from our app.
Initial commit 2022-11-18 16:08:50 -05:00
			`#### SQL Dev-deps`

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:40:38 -05:00			- `bandit`: Check for SQL injection vulnerabilities.
Initial commit 2022-11-18 16:08:50 -05:00
			`#### Miscs Dev-deps`

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:40:38 -05:00			- `djhtml`: Generate jinja templates html for emails.