From b1a93c0a91bbfd48d553db4b82e73959d6743e26 Mon Sep 17 00:00:00 2001 From: bayanolla Date: Wed, 29 Oct 2025 16:25:19 +0300 Subject: [PATCH] Update README to clarify non-Docker setup instructions --- README.md | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5dc6c02..0aa8cc1 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ A modern, responsive website for showcasing drone builds and services, built wit ### Prerequisites - Node.js (version 16 or higher) -- Bun or npm package manager +- npm package manager ### Installation @@ -34,21 +34,25 @@ A modern, responsive website for showcasing drone builds and services, built wit 2. Install dependencies: ```bash - bun install - # or npm install ``` ### Development -Start the development server: -```bash -bun run dev -# or -npm run dev -``` +To run the application without Docker: + +1. Start the frontend development server: + ```bash + npm run dev + ``` + +2. In a separate terminal, start the backend server: + ```bash + npm start + ``` The site will be available at http://localhost:8080 +The backend API will be available at http://localhost:3001 ### Building for Production @@ -73,11 +77,11 @@ To enable the contact form functionality: 1. Configure Gmail SMTP credentials in `.env` file 2. Run the Node.js server: ```bash - bun run start - # or npm start ``` +The backend will be available at http://localhost:3001 and will automatically proxy API requests from the frontend development server. + ### Gmail SMTP Configuration To configure Gmail for sending emails: @@ -107,9 +111,11 @@ src/ Create a `.env` file in the root directory with necessary environment variables. -## Deployment with Docker +## Deployment with Docker (Optional) -This project includes Docker configuration files for easy deployment: +This project includes Docker configuration files for containerized deployment. This is optional and the application can run perfectly without Docker. + +If you choose to use Docker: 1. Build and run the application using Docker Compose: ```bash