feat(readme): added readme
This commit is contained in:
1 file changed
+92
@@ -0,0 +1,92 @@
|
||||
# Vendora - E-Commerce Platform
|
||||
|
||||
Vendora is a modern e-commerce platform built with React Native (Expo) for the frontend and Django REST Framework for the backend.
|
||||
|
||||
## Project Overview
|
||||
|
||||
This full-stack e-commerce application offers:
|
||||
|
||||
- Product browsing by categories
|
||||
- User authentication and account management
|
||||
- Shopping cart functionality
|
||||
- Order processing
|
||||
- Product ratings and reviews
|
||||
- Responsive design for mobile and web
|
||||
|
||||
## Tech Stack
|
||||
|
||||
### Frontend
|
||||
- React Native (Expo)
|
||||
- TypeScript
|
||||
- TailwindCSS/NativeWind for styling
|
||||
- React Navigation for routing
|
||||
- Axios for API calls
|
||||
|
||||
### Backend
|
||||
- Django
|
||||
- Django REST Framework
|
||||
- SQLite (development)
|
||||
- JWT Authentication
|
||||
|
||||
## Project Structure
|
||||
|
||||
The project is organized into two main directories:
|
||||
|
||||
- `/frontend` - React Native Expo application
|
||||
- `/backend` - Django REST API
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Backend Setup
|
||||
|
||||
1. Navigate to the backend directory:
|
||||
```
|
||||
cd backend
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. Run migrations:
|
||||
```
|
||||
python manage.py migrate
|
||||
```
|
||||
|
||||
4. Start the server:
|
||||
```
|
||||
python manage.py runserver
|
||||
```
|
||||
|
||||
### Frontend Setup
|
||||
|
||||
1. Navigate to the frontend directory:
|
||||
```
|
||||
cd frontend
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
3. Start the development server:
|
||||
```
|
||||
npm start
|
||||
```
|
||||
|
||||
4. Follow the Expo instructions to run on your device or emulator
|
||||
|
||||
## Features
|
||||
|
||||
- Product catalog with categories
|
||||
- User registration and authentication
|
||||
- Shopping cart management
|
||||
- Order processing and history
|
||||
- Product search and filtering
|
||||
- Product ratings and reviews
|
||||
|
||||
## API Endpoints
|
||||
|
||||
Detailed API documentation can be found in the respective README files within the frontend and backend directories.
|
||||
Reference in new issue
Block a user