gabdlr/a-dog-a-pet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: fix typos in readme

Browse Source
This commit is contained in:
Gabriel De Los Rios
2024-12-10 21:20:37 -03:00
parent b33c115dcf
commit 4a6419c476
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -3,10 +3,10 @@
#### Description:
This project is meant to be the starting point of a pet adoptions web site. It allows users to register, register pets and ask for pets adoption. It also has a contact form which is not fully functional. It has been done using python with the Flask framework and a sqlite database.
The purpouse of the project is build a web site where people looking to adopt a pet can contact with people that are offering pets for adoption, as a registered user you could do both, but this could actually be splitted into separate roles though. To adopt or publish a pet you'll need to fill the registration form which has validation both in the frontend and the backend making sure data is correct. After registration you have access to you profile where you can update some of you details as your email address or phone number, but not you name or lastname. In the pets page you can see all the listed pets for adoption whether you are registered or not, you can filter by attributes as pet type (cat or dog), sex and age range. Every pet has a picture and its details, like name, age, etc, and link for ask to adopt it. If registered when clicking on the adopt link will set the pet as in 'pending' status adoption which is visually noticeable by the picture turning to grayscale, meaning other people can't ask to adopt it untill your request is rejected. If a non user tries to adopt a pet the link will lead to the login section. Only logged in users can see the add pet option in the menu, the add pet section also consist of a form with its validations, after succesfully submitting the pet data the user will be notified that the pets has been added and it will be publicly displayed in the pets section for everyone to see. A user can't adopt a pet that has published, it will simply ignore the request and redirect to the pet list without changes.
The purpouse of the project is to build a web site where people looking to adopt a pet can contact with people that are offering pets for adoption, as a registered user you could do both, but this could actually be splitted into separate roles though. To adopt or publish a pet you'll need to fill the registration form which has validation both in the frontend and the backend making sure data is correct. After registration you have access to your profile where you can update some of your details as your email address or phone number, but not your name or lastname. In the pets page you can see all the listed pets for adoption whether you are registered or not, you can filter by attributes as pet type (cat or dog), sex and age range. Every pet has a picture and its details, like name, age, etc, and a link to ask to adopt it. If registered when clicking on the adopt link, it will set the pet as in 'pending' status adoption which is visually noticeable by the picture turning to grayscale, meaning other people can't ask to adopt it untill your request is rejected. If a non user tries to adopt a pet the link will lead to the login section. Only logged in users can see the add pet option in the menu, the add pet section also consists of a form with its validations, after succesfully submitting the pet data the user will be notified that the pets has been added and it will be publicly displayed in the pets section for everyone to see. A user can't adopt a pet that has published himself, it will simply ignore the request and redirect to the pet list without changes.
Beside the adoptions there is information about the site itself and a contact form, it is not fully developed but it would be easy to extend and implement the functionality.
This projects uses a lot of resources from the flask environment as flask sqlalchemy orm, flask session, jinja, etc. Ia also integrates with cloudinary for the image hosting so having a cloudinary account is required for it to be fully functional as is. The deployed version also uses gunicorn as webserver but it can be run with the flask run command.
This projects uses a lot of resources from the flask environment as flask sqlalchemy orm, flask session, jinja, etc. It also integrates with cloudinary for the image hosting so having a cloudinary account is required for it to be fully functional as is. The deployed version also uses gunicorn as webserver but it can be run with the flask run command.
### General structure:
This app is divided in modules or "blueprints", it consists of a total of 4 modules: Users, Pets, Us and Main.