From b76b5cb48601354c2e3f2a03163d7894f2c83b48 Mon Sep 17 00:00:00 2001 From: Kamil Matuszewski Date: Sun, 12 Jan 2025 20:04:38 +0100 Subject: [PATCH] feat: updated readme with info for frontend (#29) --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 93a8c5c..42bdbbb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Pharmacy App -This project is a pharmacy application that includes user account management, product browsing, a shopping cart, and email notifications. It is designed to run on Docker and PostgreSQL with a Python backend built using Flask. +This project is a pharmacy application that includes user account management, product browsing, a shopping cart, and email notifications. It is designed to run on Docker and PostgreSQL with a Python backend built using Flask and React Native frontend built using Expo. ## Development @@ -69,11 +69,33 @@ To run tests in the Docker container: docker compose exec backend uv run pytest ``` +## Frontend + +To start developing the app all you need to do is: + +### Navigate to `/frontend` + +```bash +cd frontend +``` + +### Install all dependencies + +```bash +npm install +``` + +### Starting the app + +```bash +npx expo start -c +``` + --- ## Production deployment -Configure Environment Variables in `backend/.env` file with all necessary configuration. +Configure Environment Variables in `backend/.env` file with all necessary configuration and specify your host's IP address in `frontend` section of `docker-compose.yml`. Build and start services: