Skip to content

README.md

Latest commit

 

History

History
131 lines (94 loc) · 4.86 KB

README.md

File metadata and controls

131 lines (94 loc) · 4.86 KB

Shopery

🚀 Getting Started

To start the project, use:

pnpm dev fe-admin
pnpm dev fe-web
pnpm serve be-api

To generate a new library, use:

npx nx g lib @shopery/ui --directory=libs/ui/ui-shared

To run Prettier for the entire project, use:

pnpm prettier-all

To run ESLint:

pnpm lint fe-web
pnpm lint fe-admin
pnpm lint be-api

🐳 Docker

To run Redis and MongoDB using Docker, follow the steps below.

🔧 Configuration

  • Make sure you have a .env file in the project root with the following variables:

▶️ Start Services

  • Use the following command to spin up the containers:
docker-compose up -d

This will start: Redis (redis:7) — for caching and session management. MongoDB (mongo:7) — with default credentials root / example.

🧹 Stop & Clean Up

  • To stop the services and remove volumes:
docker-compose down -v

🛠 Technologies

Web (Frontend)

Admin Panel

Backend

📄 Project Structure

shopery/
├── apps/
│   ├── fe-web/     # Next.js Web Frontend
│   ├── fe-admin/   # React Admin Panel
│   └── be-api/     # Fastify Backend API
│
├── libs/
│   ├── ui-shared/  # Shared UI components
│   └── shared/     #Shared function and business logic
│
├── package.json
├── nx.json
├── docker-compose.yaml
└── README.md

🎯 Contributors & Maintainers

  • Feel free to contribute to the project! Fork, create a branch, and submit a PR.

💡 Questions or Issues? If you encounter any issues, feel free to open an issue on the repository.