diff --git a/README.md b/README.md index c5c19d7..280a712 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,73 @@ -# Pharmacy App +# Your Pharmacy -A pharmacy application with features for user management, product browsing, shopping cart functionality, and email notifications. Built with a Flask backend and React Native frontend, running in Docker with PostgreSQL database. +A full-stack e-commerce solution that brings the pharmacy shopping experience online. Built with Flask, React Native, and PostgreSQL, this modern application provides a seamless shopping experience for health and wellness products. -## Development setup +
+ Landing page +

Landing page with quick access to shopping

+
-Follow these steps to set up the project locally: +## Features -### Access the Docker Environment +Users can create an account with email verification and track their orders through a personal profile. -In VSCode, use the "Reopen in Container" option to seamlessly open the project inside the container. +
+ Sign up page +

Registration form with validation

+
-### Backend setup +
+ User profile dashboard +

Profile dashboard with order history

+
-```bash -cd backend -uv run flask run -h 0.0.0.0 -``` +Browse products in grid or list view, with detailed information about each item. -### Frontend setup +
+ Product catalog +

Product catalog in list view

+
-```bash -cd frontend -npx expo start -c -``` +
+ Product details +

Detailed product view with purchase options

+
-Access the application at http://localhost (Port 8081). +Manage your shopping cart with real-time updates and easy checkout process. ---- +
+ Shopping cart +

Shopping cart with quantity adjustments

+
-### Database Management +
+ Order details +

Order details summary

+
-#### Reset Database +Receive email notifications for account verification and order confirmations. -To completely reset the database and its data: +
+ Email verification +

Account verification email

+
-```bash -uv run flask db downgrade base -uv run flask db upgrade -``` +
+ Order confirmation email +

Order confirmation details

+
-#### CLI Commands +## Technical foundation -Available custom CLI commands: +The application is built on a modern tech stack that ensures reliability and performance. The backend uses Flask with PostgreSQL for data storage, while the frontend is crafted with React Native and styled using TailwindCSS. -```bash -uv run flask seed products -``` +This combination provides a responsive and native-like experience across all devices while maintaining robust development and production environments. -### Tests +## Dockerized architecture -Run all tests: - -```bash -uv run pytest -``` - -To run tests in the Docker container: - -```bash -docker compose exec backend uv run pytest -``` +The entire application is containerized using Docker, with separate containers for the backend, frontend, database, and Nginx as a reverse proxy. ---- +This containerized architecture ensures consistent development and deployment environments, making it easy to scale and maintain. ## Production deployment diff --git a/images/email-order-confirmation.png b/images/email-order-confirmation.png new file mode 100644 index 0000000..5f961dc Binary files /dev/null and b/images/email-order-confirmation.png differ diff --git a/images/email-verification.png b/images/email-verification.png new file mode 100644 index 0000000..d10a1f0 Binary files /dev/null and b/images/email-verification.png differ diff --git a/images/view-cart.png b/images/view-cart.png new file mode 100644 index 0000000..39ab84d Binary files /dev/null and b/images/view-cart.png differ diff --git a/images/view-email-verification.png b/images/view-email-verification.png new file mode 100644 index 0000000..1f70fee Binary files /dev/null and b/images/view-email-verification.png differ diff --git a/images/view-home-list.png b/images/view-home-list.png new file mode 100644 index 0000000..cb8fb09 Binary files /dev/null and b/images/view-home-list.png differ diff --git a/images/view-index.png b/images/view-index.png new file mode 100644 index 0000000..d3f5984 Binary files /dev/null and b/images/view-index.png differ diff --git a/images/view-order-details.png b/images/view-order-details.png new file mode 100644 index 0000000..c8b43de Binary files /dev/null and b/images/view-order-details.png differ diff --git a/images/view-product-details.png b/images/view-product-details.png new file mode 100644 index 0000000..c0d0ba3 Binary files /dev/null and b/images/view-product-details.png differ diff --git a/images/view-profile.png b/images/view-profile.png new file mode 100644 index 0000000..d3ef353 Binary files /dev/null and b/images/view-profile.png differ diff --git a/images/view-sign-in.png b/images/view-sign-in.png new file mode 100644 index 0000000..1faa2cc Binary files /dev/null and b/images/view-sign-in.png differ diff --git a/images/view-sign-up.png b/images/view-sign-up.png new file mode 100644 index 0000000..0638985 Binary files /dev/null and b/images/view-sign-up.png differ