Code Monkey home page Code Monkey logo

peludoh's Introduction

Peludo Heart

CONTENTS

SUMMARY

Peludo Heart is an app to make reservations and order pet products.

BUSINESS

what is it

Peludo Heart is a veterinarian that offers services and products for pets.

Problem

Peludo Heart needed to implement a way to handle orders for its products and services. currently only a notebook is used for annotating.

what needs?

Peludo Heart needed to show his products and services to existing and new customers through an app.

Organization chart

  • Administrator | Doctor
  • Doctor assistant
  • Accountant (product sales manager)

organization_map

main requirement

  • order products and offer services

secondary requirement

  • adoption pets

DESIGN

use case diagram

use_case_diagram

class diagram

class_diagram

API ENDPOINTS

PRODUCTS ENDPOINTS

HTTP METHOD API ENDPOINT FUNCTION
GET /products/list/ return list of all products
GET /products/list/<slug>/ return detail of product by slug
GET /products/related/<id>/ return related products of one product by id
GET /products/category/ return list of products by category
GET /products/category/<id>/ return specific products by category by id

USERS ENDPOINTS

HTTP METHOD API ENDPOINT FUNCTION
POST /login/ return token and user data
POST /users/ create user by phone instead of username
PUT /users/<user_id>/change_password/ Update password
PUT /users/<user_id>/ Update Phone number

ADOPTION ENDPOINTS

HTTP METHOD API ENDPOINT FUNCTION
GET /adoption/ return list of pets

APPOINTMENT ENDPOINTS

HTTP METHOD API ENDPOINT FUNCTION
GET /appointments/list/ return list of appointments
POST /appointments/ create appointment
UPDATE /appointments/ update appointment

Token is required

NOTIFICATION ENDPOINTS

HTTP METHOD API ENDPOINT FUNCTION
GET /notifications/ get list of notifications
GET /notifications/<notification_id> retrive notification by id
POST /notifications/mark-all-as-read/ mark all notifications as read

Token is required

CART ENDPOINTS

HTTP METHOD API ENDPOINT FUNCTION
GET /cart/ return current shopping cart. if the cart is used return new cart.
POST /cart/ add product to the cart by product_id
PUT /cart/cart-item/<int:pk>/ update quantity of product in the shopping cart by id of product
DELETE /cart/cart-item/<int:pk>/ delete product of the shopping cart by id of product in the cart
GET /cart/<product_id>/ verify if the product is in the shopping cart by product_id

Token is required

ORDERS ENDPOINTS

HTTP METHOD API ENDPOINT FUNCTION
GET /orders/ return list of orders of the user
GET /orders/<order_code>/ return order detail of the user
POST /orders/checkout/ create order
PUT /orders/checkout/ user can cancel order if the status does not change to received

Token is required

MOBILE

Sitemap

sitemap_app

Screens

1 2 3 1
1 2 3 1
1 2 3 1

TECHNOLOGIES

BACKEND

  • DRF

FRONTEND

  • TailwindCss

MOBILE

  • Flutter (Android/iOs)

DATABASE

  • PostgreSQL

HOSTING

  • Digital Ocean

DESIGN TOOL

  • draw.io (use case, class diagram,sequence)
  • Whimsical

METHODOLOGY

  • Kanban kanban

tools

  • Postman (test api endpoints)

peludoh's People

Contributors

zhou1925 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.