https://github.com/tireon003/kode_notes_api
It's a project of test task by Kode. Notes API implementation.
https://github.com/tireon003/kode_notes_api
alembic assignment fastapi jwt-auth pyaspeller python3 rest-api sqlalchemy-orm
Last synced: 10 months ago
JSON representation
It's a project of test task by Kode. Notes API implementation.
- Host: GitHub
- URL: https://github.com/tireon003/kode_notes_api
- Owner: Tireon003
- Created: 2024-08-23T20:15:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-31T23:34:15.000Z (over 1 year ago)
- Last Synced: 2025-01-09T05:14:37.120Z (12 months ago)
- Topics: alembic, assignment, fastapi, jwt-auth, pyaspeller, python3, rest-api, sqlalchemy-orm
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Test task by Kode
### Description
It is a simple app with API and Postgres implementation.
API based on FastAPI. Functionality:
- Sign up
- Log in
- Add new note
- Show notes list
API interacts with DB on Postgres by SQLAlchemy ORM.
Implemented Alembic migrations.
API has an authorization and authentication system based on JWT.
Passwords are secured by encryption and hashed storing in DB.
Each note spelling before add to DB. Thus, notes haven't mistakes in its title and content parts.
### Stack
- FastAPI
- SQLAlchemy ORM
- Alembic
- Docker & docker-compose
### How to build and run?
#### Build:
```commandline
docker-compose build
```
#### Run (background):
```commandline
docker-compose up -d
```
#### Stop:
```commandline
docker-compose stop
```
## Tests
You can test API in Postman using Postman collections. JSON-collection in project directory.