This is the documentation of the software part of the graduation project. The team consists of 4 developers specializing in specific fields (tracks).
- Mohamed Yousef and Mohamed Samir in the frontend development
- Mohamed Hamid in the backend development
- Mohamed Ashraf in the mobile app development
One of the key points that we need in the team is the well-organized and easy-to-access information. We need to be tidy, so we should use a special type of app for messaging and chatting like Slack and Discord. Emails are professional but are more useful for important information and between different teams, it is not suitable for daily communication between the team members. We used Discord which enables us to create multiple categories for each sub-team, and for each of the categories we can create channels for each part of the software, backend, frontend, and mobile app development.
To organize our documents including this one, we used Notion which provides a good way to create page embed resources like links and files in the document. Notion also has a very powerful feature, databases.
One of the documents here is the requirements document where we write the features and the requirements of the system and the additional features which we may work on. We could’ve used Notion to manage tasks and sprints (or cycles) as well it is a bit harder for us to create the databases of tasks and link them together. When powerful and feature-rich apps like Jira and Linear exist it is not a wise decision to build the process here in notion.
We chose Linear, the relatively new app which is gaining more user base and popularity in the software industry. It doesn’t only provide a way to add tasks (also called issues) and assign them to users. It provides a way to set a roadmap for the team and split the project into multiple smaller projects. Linear also has another feature that is crucial for our team, cycles. Our cycle is 1 week where we plan, develop, and test the tasks, and during the cycle, we review our progress and plan for the next cycle. This way, we keep our work organized and efficient.
List of apps and services used:
- Notion: documents and resources management.
- Google Drive: documents and resources management.
- Linear: tasks, weekly plans, and roadmaps.
- GitHub: services to manage git repositories and CI/CD processes.
- Discord: chatting and communication.
- Figma: prototyping and designing UI/UX.
- VSCode: development and writing code.
- Ideas to talk about
- Why UI/UX is important
- Choosing the design system and components library
- Why do you build components in Figma?
- The thinking process while designing a page
- Didn’t Documented Yet
- Testing ⇒ Cypress & Jest & React Query Axios
- SEO
- Accessibility
- Performance
The backend architecture of the pharmacy website is designed to provide a robust and scalable platform for managing pharmaceutical data and serving endpoints to support the frontend application and mobile application. Built on Django Rest Framework (DRF), the architecture follows best practices to ensure security, performance, and maintainability.
Django provides the foundation for the backend application, offering a high-level Python web framework for rapid development and clean, pragmatic design. It handles routing, request handling, authentication, and database interactions.
DRF extends Django's capabilities to support building Web APIs. It provides serializers, views, and generic API views to streamline the creation of RESTful endpoints. DRF also offers authentication, permissions, and throttling mechanisms out of the box.
The backend relies on a relational database management system (RDBMS) to store and retrieve pharmaceutical data. Common choices include PostgreSQL, MySQL, or SQLite
we use SQLite for development and PostgreSQL for production.
Django's ORM (Object-Relational Mapping) is used to define models representing pharmaceutical entities such as drugs, prescriptions, users, and orders. These models map to database tables, allowing for easy manipulation and querying of data.
DRF views handle incoming HTTP requests and generate appropriate responses. Views are responsible for processing data, validating inputs, and interacting with the database through Django models. Views may be class-based or function-based, depending on the complexity of the logic.
Serializers in DRF convert complex data types such as Django models into native Python data types suitable for rendering into JSON or other content types. They facilitate data validation, parsing incoming request data, and formatting outgoing response data.
Middleware components in Django intercept HTTP requests and responses, allowing for cross-cutting concerns such as logging, security, or custom preprocessing logic. Middleware can be used to enforce CORS policies, handle exceptions, or modify request/response headers.
Unit tests, integration tests, and end-to-end tests ensure the reliability and correctness of the backend application. Django provides robust testing frameworks, and tools like pytest can be used for comprehensive test coverage.
The backend application can be deployed on cloud platforms like AWS, Azure, or Google Cloud Platform for scalability and high availability. Containerization with Docker and orchestration with Kubernetes simplify deployment and management of the application across different environments.we used pythonanywhere because it free The backend application can be deployed on cloud platforms like AWS, Azure, or Google Cloud Platform for scalability and high availability. Containerization with Docker and orchestration with Kubernetes simplify tdeployment and management of the application across different environments.
DRF provides built-in support for various authentication mechanisms, including token-based authentication, session authentication, OAuth, etc. Authentication ensures that only authorized users can access protected endpoints. Authorization mechanisms control what actions users can perform based on their roles and permissions.
Purpose: Django Allauth is a flexible authentication solution for Django applications, offering support for social account authentication like Goggle and Facebook, email verification, and account management.
Purpose: Dj-Rest-Auth extends Django Allauth's functionality to provide RESTful endpoints for user authentication and registration.
Purpose: Simple JWT is a lightweight library for creating and validating JSON Web Tokens (JWT) to implement token-based authentication in DRF and provide access and refresh tokens and can set period for them
........
User profiles play a crucial role in providing a personalized experience for users within our application. They allow users to manage their information, preferences, and settings. Profile includes personal details, contact information, preferences, and any other relevant data that enhances the user experience.
The profile model stores additional user information. This model typically extends Django's built-in User model or links to it using a one-to-one relationship.
Example:
from django.contrib.auth.models import User
class Profile(models.Model):
user = models.OneToOneField(User, on_delete=models.CASCADE)
image= models.ImageField(upload_to='avatars/', blank=True)
# more fields
Forms or serializers are used to validate and process profile data when users update their profiles through forms or API endpoints.
Views or endpoints handle profile-related requests, such as displaying profile information, updating profiles, or deleting profiles.
Profiles automatically created upon user registration
Users should have the ability to update their profile information
Users should be able to view their own profiles
Users should be able to upload, update, or remove profile pictures
Users should have control over the visibility of their profile information. They may choose to make their profiles public, private, or visible to specific users or groups.
Users is able to delete their profiles.
Access to profile information is restricted based on user permissions.
The home page serves as the entry point to our application, providing users with essential information, navigation options, and access to key features. Product management encompasses the creation, display, and manipulation of products within our application, including adding new products, updating existing ones, and presenting them to users.
The home page typically consists of the following components:
Header: Contains branding elements, navigation links, and user authentication options. - Hero Section: Showcases featured products, promotions, or announcements to capture user attention. - Product Categories: Displays a list of product categories or featured collections to help users discover products. - Latest Products: Highlights recently added or popular products to encourage exploration. - Footer: Includes additional navigation links, contact information, and social media links.
Product management involves the following components:
Product Model: Defines the structure of product data, including attributes such as name, description, price, and image. - Product CRUD (Create, Read, Update, Delete) Operations: Enables administrators to add, edit, and remove products from the system. - Product Listing: Presents products to users in a visually appealing and informative manner, allowing them to browse and search for products. - Product Detail Page: Provides detailed information about individual products, including images, descriptions, specifications, and pricing. - Product Categories and Tags: Organizes products into categories and tags to facilitate navigation and filtering.
Featured Products: Highlight selected products on the home page to attract user attention. - Promotions and Announcements: Display promotional offers, discounts, or announcements to engage users. - Navigation Links: Provide clear and intuitive navigation links to guide users to different sections of the application. - Search Functionality: Allow users to search for products directly from the home page for quick access.
Product Creation: Enable administrators to add new products to the system, including specifying product details and uploading images. - Product Editing: Allow administrators to modify existing product information, such as updating descriptions or adjusting pricing. - Product Deletion: Provide the ability to remove products from the system when they are no longer available. - Product Listing and Pagination: Display products in paginated lists to improve performance and user experience. - Product Filtering and Sorting: Implement filters and sorting options to help users find products based on criteria such as category, price, or popularity.
Access Control: Ensure that only authorized users, such as administrators, can access product management functionalities. - Data Validation: Validate product data to prevent errors and ensure consistency in the database. - Image Upload Security: Implement measures to secure image uploads, such as file type validation and size limits, to prevent malicious uploads.
The product cart feature ensures a seamless shopping experience for users. It allows users to add items to their cart, even if they leave the website and return later. They can conveniently view and manage their selected items and proceed to purchase them securely using their credit card details.
-
Persistent Cart: Users can add products to their cart, and the items will persist even if they navigate away from the website and return later
-
Real-Time Updates: Users receive real-time updates on their cart status, including additions, removals, and total price adjustments.
-
Multiple Payment Options: In addition to credit card payments, users can choose from various payment methods for added flexibility.
-
Guest Checkout: Users have the option to proceed with guest checkout, streamlining the purchasing process for first-time visitors.
-
Secure Transactions: Robust security measures ensure the safety of users' credit card information during transactions.
-
Order History: Users can access their order history, allowing them to track previous purchases and reorder items easily.
-
Wishlist Integration: Seamless integration with the wishlist feature allows users to move desired items from the cart to their wishlist for future reference.
-
Customization Options: Users can personalize their cart by adjusting quantities, applying discounts, and adding notes to specific items.