diff --git a/README.md b/README.md index d6c65856..1d8b1cca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dropship Platform -A modern dropshipping platform built with React, Node.js, and MongoDB. +A modern dropshipping platform built with React, Node.js, and MongoDB, deployable to Cloudflare. ## Features @@ -35,10 +35,11 @@ A modern dropshipping platform built with React, Node.js, and MongoDB. - JWT Authentication - Winston Logger -### DevOps -- Docker +### DevOps & Deployment +- Docker & Docker Compose - Nginx - GitHub Actions +- Cloudflare (Pages, Workers, KV, R2) ## Getting Started @@ -61,11 +62,11 @@ cp dropship-frontend/.env.example dropship-frontend/.env 4. Start the development environment: ```bash -docker-compose up --build +./start-services.sh dev ``` The application will be available at: -- Frontend: http://localhost +- Frontend: http://localhost:80 - Backend API: http://localhost:3000 ## Development @@ -75,12 +76,38 @@ The application will be available at: - Run tests: `npm test` - Build for production: `npm run build` +## Deployment Options + +### 1. Cloudflare Deployment (Recommended) + +The platform is optimized for deployment on Cloudflare's edge network. This provides: +- Global CDN distribution +- DDoS protection +- SSL/TLS encryption +- Edge computing with Workers +- Persistent storage with KV and R2 +- Real-time capabilities with WebSockets + +To deploy to Cloudflare: +1. Follow the [Cloudflare Deployment Guide](CLOUDFLARE_DEPLOYMENT.md) +2. Configure GitHub secrets for CI/CD +3. Push to main branch to trigger deployment + +### 2. Docker Deployment + +For self-hosted deployments: +1. Follow the [Deployment Guide](DEPLOYMENT.md) +2. Use provided Docker Compose configuration +3. Configure environment variables +4. Run deployment script + ## Documentation - [API Documentation](API_DOCS.md) - [Developer Guide](DEVELOPER_GUIDE.md) - [Admin Guide](ADMIN_GUIDE.md) - [Deployment Guide](DEPLOYMENT.md) +- [Cloudflare Deployment Guide](CLOUDFLARE_DEPLOYMENT.md) ## Contributing @@ -89,3 +116,18 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Security + +For security issues, please refer to our [Security Policy](SECURITY.md) and report any vulnerabilities responsibly. + +## Support + +For support and questions: +- Create an issue +- Check our [FAQ](FAQ.md) +- Join our [Discord community](https://discord.gg/dropship-platform) + +## Roadmap + +See our [project roadmap](https://github.com/yourusername/dropship-platform/projects) for planned features and improvements.