Kickoff a OO python REST application while having a coffee
Primary Actor: Developer
Stakeholders and Interests:
- Me: Desires to provide a well crafted REST API foundation for quick kick-off of either a study, challenge, real application or anything.
- Developer: May use this project as the foundation of her/his app.
- Contributor: May help Me to craft this project and give some advice and ideas for a successful move forward with this project.
Preconditions: Developer has a study, challenge or a real REST application to be done.
Success Guarantee (or Postconditions): I received feedback about this project from Devs and Contributors. Hopefully, some Dev found this project useful for her/himself.
Happy Path
- Developer finds Kickooffee project.
- Developer gets Kickooffee project.
- Kickooffee provides a foundation with the minimum necessary to create a REST API application.
- Developer customizes Kickooffee according to her/his needs.
- Developer keeps going with her/his project.
- Developer gives the Kickooffee credits.
Extensions (or Alternative Flows):
4a. Kickoofee provides more than Developer needs:
- Developer removes what her/him don't want.
4b. Kickoofee provides less than Developer needs:
- Developer open an issue on Kickoofee repo.
- I will analyze what could be done.
- I will give a feedback about it.
- I will solve the issue.
- Developer gets again Kickooffee project updated.
Special Requirements:
- Well crafted here means: OOA/D, Clean Code, Clean Architecture, Tests Coverage ~100%, Linter, CI/CD
- Database ORM and raw SQL framework
- REST APIs frameworks
- Foundation includes User CRUD, SignUP, LogIn, Auth
Open issues:
- What are the current framework available for the project?
sudo apt update
sudo apt install postgresql postgresql-contrib -y
psql -V
sudo passwd postgres
postgres
postgres
su postgres
psql -c "ALTER USER postgres WITH PASSWORD 'postgres'" -d postgres
exitexport PYTHONPATH=~/kickooffee/repo/kickooffee/src