Text summarizer is an personal project to practice learns from the course Test-Driven Development with FastAPI and Docker. The project is a CRUD API to summarize blog posts powered by libraries like FastAPI, tortoise-orm, and Newspaper3k.
The project is deployed on Heroku here.
| Endpoint | HTTP Method | CRUD Method | Result |
|---|---|---|---|
| /summaries | GET | READ | get all summaries |
| /summaries/:id | GET | READ | get a single summary |
| /summaries | POST | CREATE | get a single summary |
| /summaries/:id | PUT | UPDATE | update a summary |
| /summaries/:id | DELETE | DELETE | delete a summary |
To have a development environment this project requires Docker and docker-compose. Please review the files Makefile and docker-compose.yml for more details:
make build # Build docker image
make run # Runs docker image
make create-db # Create required table schemas
make test # Runs tests- Fork the repo (https://github.com/rodrigodelmonte/text-summarizer/fork)
- Create your feature branch (
git checkout -b feature/fooBar) - Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request