root-readme.hbs 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. # {{ name }}
  2. A full-stack e-commerce application built with [Vendure](https://www.vendure.io/) and [Next.js](https://nextjs.org/).
  3. ## Project Structure
  4. This is a monorepo using npm workspaces:
  5. ```
  6. {{ name }}/
  7. ├── apps/
  8. │ ├── server/ # Vendure backend (GraphQL API, Admin Dashboard)
  9. │ └── storefront/ # Next.js frontend
  10. └── package.json # Root workspace configuration
  11. ```
  12. ## Getting Started
  13. ### Development
  14. Start both the server and storefront in development mode:
  15. ```bash
  16. npm run dev
  17. ```
  18. Or run them individually:
  19. ```bash
  20. # Start only the server
  21. npm run dev:server
  22. # Start only the storefront
  23. npm run dev:storefront
  24. ```
  25. ### Access Points
  26. - **Vendure Dashboard**: http://localhost:{{ serverPort }}/dashboard
  27. - **Shop GraphQL API**: http://localhost:{{ serverPort }}/shop-api
  28. - **Admin GraphQL API**: http://localhost:{{ serverPort }}/admin-api
  29. - **Storefront**: http://localhost:{{ storefrontPort }}
  30. ### Admin Credentials
  31. Use these credentials to log in to the Vendure Dashboard:
  32. - **Username**: {{ superadminIdentifier }}
  33. - **Password**: {{ superadminPassword }}
  34. ## Production Build
  35. Build all packages:
  36. ```bash
  37. npm run build
  38. ```
  39. Start the production server:
  40. ```bash
  41. npm run start
  42. ```
  43. ## Learn More
  44. - [Vendure Documentation](https://docs.vendure.io)
  45. - [Next.js Documentation](https://nextjs.org/docs)
  46. - [Vendure Discord Community](https://vendure.io/community)