https://github.com/devferx/mi-patito-store
https://github.com/devferx/mi-patito-store
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devferx/mi-patito-store
- Owner: devferx
- Created: 2025-04-13T03:33:10.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-20T00:19:01.000Z (10 months ago)
- Last Synced: 2025-04-20T01:24:41.080Z (10 months ago)
- Language: TypeScript
- Size: 261 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mi Patito Store
## Project Description
Mi Patito Store is a full-stack e-commerce application designed to manage and sell duck-related products. The project is divided into two main parts:
- **Backend**: Handles server-side logic, database interactions, and APIs.
- **Frontend**: Provides a user-friendly interface for managing inventory and interacting with the application.
## Technologies Used
### Backend
- **Node.js**: JavaScript runtime for building the server-side application.
- **TypeScript**: Strongly typed programming language for better code quality.
- **Prisma**: ORM for database management and migrations.
- **Express.js**: Web framework for building RESTful APIs.
- **Docker**: Containerization for consistent development and deployment environments.
### Frontend
- **React**: JavaScript library for building user interfaces.
- **TypeScript**: Strongly typed programming language for better code quality.
- **Vite**: Fast build tool for modern web projects.
- **Tailwind CSS**: Utility-first CSS framework for styling.
- **Zod**: Schema validation for form inputs.
## Features
- Inventory management for ducks (add, edit, delete, and list).
- Dynamic price calculation based on quantity, package type, and shipping method.
- Responsive user interface built with React, Tailwind CSS, and Vite.
- Form validation using react-hook-form and Zod.
- Full integration between backend and frontend.
## Installation Guide
### Backend
1. **Navigate to the backend directory**:
```bash
cd mi-patito-store/backend
```
2. **Install dependencies**:
```bash
npm install
```
3. **Set up the database**:
- Ensure Docker is installed and running.
- Start the database using Docker Compose:
```bash
docker-compose up -d
```
4. **Run database migrations**:
```bash
npx prisma migrate dev
```
5. **Start the development server**:
```bash
npm run dev
```
### Frontend
1. **Navigate to the frontend directory**:
```bash
cd mi-patito-store/frontend
```
2. **Install dependencies**:
```bash
npm install
```
3. **Start the development server**:
```bash
npm run dev
```
4. **Access the application**:
Open your browser and navigate to `http://localhost:5173`.