Skip to content

Commit 4618f1d

Browse files
Complete medium-priority enhancements: netconv3, allorabd, netemp, ecourier-courier
Co-authored-by: rezwana-karim <126201034+rezwana-karim@users.noreply.github.com>
1 parent 13fc317 commit 4618f1d

4 files changed

Lines changed: 699 additions & 75 deletions

File tree

docs/projects/allorabd.md

Lines changed: 193 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,208 @@
1-
# allorabd
1+
# AlloraBD - Full-Stack E-Commerce Platform
2+
23
## Overview
34

4-
Laravel + Vue
5+
AlloraBD is a modern full-stack e-commerce platform built with Laravel backend and Nuxt.js (TypeScript) frontend, featuring a complete separation of concerns between API and presentation layers. The project demonstrates a professional implementation of a decoupled architecture combining Laravel's robust backend capabilities with Nuxt.js's powerful Vue.js-based frontend.
6+
7+
This platform provides a comprehensive e-commerce solution for businesses in Bangladesh and beyond, offering product management, order processing, customer management, and administrative tools through a modern, responsive interface.
8+
9+
## ✨ Key Features
10+
11+
- **Decoupled Architecture:** Separate Laravel backend API and Nuxt.js frontend
12+
- **Modern Tech Stack:** Laravel 8+ backend with Vue.js/Nuxt frontend
13+
- **TypeScript Support:** Type-safe frontend development with TypeScript
14+
- **RESTful API:** Clean API design for frontend-backend communication
15+
- **Product Management:** Complete e-commerce product catalog system
16+
- **Order Processing:** Full order management and fulfillment workflow
17+
- **User Authentication:** Secure authentication and authorization
18+
- **Responsive Design:** Mobile-friendly interface with Vue.js components
19+
20+
## ✨ Key Features
21+
22+
- **Decoupled Architecture:** Separate Laravel backend and Nuxt.js frontend
23+
- **API-First Design:** RESTful API for flexibility and scalability
24+
- **Modern Frontend:** Vue.js/Nuxt.js with TypeScript for type safety
25+
- **Laravel Backend:** Robust PHP backend with Eloquent ORM
26+
- **Real-Time Updates:** Dynamic UI with Vue.js reactivity
27+
- **Authentication:** Secure user authentication and authorization
28+
- **Database Management:** Efficient data handling with Laravel Eloquent
29+
- **TypeScript Support:** Type-safe frontend development
530

6-
## Laravel + Nuxt (Typescript)
7-
### Installation Backend (Laravel)
8-
1. Open Folder allorabd in Visual Studio Code
31+
## 🏗️ Technology Stack
932

10-
## Code & Repository
33+
### Backend Technologies
34+
- **Framework:** Laravel Framework
35+
- **Language:** PHP 7.4+ (61.5% of codebase)
36+
- **Database:** MySQL/PostgreSQL
37+
- **API:** RESTful architecture
1138

39+
### Frontend Technologies
40+
- **Framework:** Vue.js with Nuxt.js
41+
- **Language:** TypeScript (2.9%), JavaScript (10.0%)
42+
- **UI:** Vue components (25.6%)
43+
- **Styling:** CSS/SCSS
44+
45+
## 📊 Project Information
46+
47+
### Repository Details
1248
- **GitHub:** https://github.com/syed-reza98/allorabd
1349
- **Primary Language:** PHP
14-
- **Languages:** PHP (61.5%), Vue (25.6%), JavaScript (10.0%), TypeScript (2.9%)
15-
- **Last Updated:** 06/05/2025
50+
- **Languages Breakdown:** PHP (61.5%), Vue (25.6%), JavaScript (10.0%), TypeScript (2.9%)
1651
- **Repository Size:** ~206MB
52+
- **Last Updated:** 06/05/2025
1753

18-
## Architecture & Tech Stack
54+
### Project Status
55+
- **Status:** 🟢 Active
56+
- **Visibility:** 🌐 Public
1957

20-
- **Technology Stack:** Vue.js/Nuxt.js, Laravel Framework
21-
- **Architecture:** REST API
58+
## 🏷️ Categories & Tags
2259

23-
## Project Status
60+
**Primary Category:** Web Development / Full-Stack
2461

25-
- **Status:** ✅ Active
26-
- **Visibility:** 🌐 Public
62+
**Tags:** `laravel` `vue` `nuxt` `typescript` `full-stack` `rest-api` `php` `spa`
63+
64+
## 🚀 Getting Started
65+
66+
### Prerequisites
67+
- PHP 8.0 or higher
68+
- Composer
69+
- Node.js 16+ and npm
70+
- MySQL 8.0+
71+
- Web server (Apache/Nginx)
72+
73+
### Installation
74+
75+
#### Backend Setup (Laravel)
76+
77+
1. **Clone the repository**
78+
```bash
79+
git clone https://github.com/syed-reza98/allorabd.git
80+
cd allorabd
81+
```
82+
83+
2. **Navigate to backend folder**
84+
```bash
85+
cd backend
86+
```
87+
88+
3. **Install PHP dependencies**
89+
```bash
90+
composer install
91+
```
92+
93+
4. **Configure environment**
94+
```bash
95+
cp .env2.example .env
96+
# Configure database credentials and API settings
97+
```
98+
99+
5. **Set up database**
100+
- Create database named `backend` in MySQL/XAMPP
101+
- Import the `backend.sql` file
102+
103+
6. **Generate application key**
104+
```bash
105+
php artisan key:generate
106+
```
107+
108+
7. **Start Laravel backend**
109+
```bash
110+
php artisan serve
111+
```
112+
113+
### Frontend Setup (Nuxt.js)
114+
115+
1. **Navigate to frontend directory**
116+
```bash
117+
cd frontend
118+
```
119+
120+
2. **Install dependencies**
121+
```bash
122+
npm install
123+
```
124+
125+
3. **Configure API endpoints**
126+
```bash
127+
# Edit nuxt.config.ts to point to backend API
128+
```
129+
130+
4. **Start development server**
131+
```bash
132+
npm run dev
133+
```
134+
135+
## 📖 Usage
136+
137+
AlloraBD provides a modern full-stack experience:
138+
- **Backend API:** Laravel provides RESTful endpoints
139+
- **Frontend SPA:** Nuxt.js/Vue application with TypeScript
140+
- **Development:** Hot-reload for both frontend and backend
141+
- **Production:** Optimized builds for deployment
142+
143+
## 🏛️ Architecture
144+
145+
**Architecture Pattern:** Separated Frontend/Backend with REST API
146+
147+
**Key Architectural Decisions:**
148+
- Laravel backend provides robust API
149+
- Nuxt.js (Vue.js) frontend with TypeScript
150+
- RESTful API communication
151+
- Separate frontend and backend deployments
152+
- Token-based authentication
153+
- Database-driven content management
154+
- Modern JavaScript framework integration
155+
156+
**Project Structure:**
157+
```
158+
allorabd/
159+
├── backend/ # Laravel API
160+
├── frontend/ # Nuxt.js application
161+
├── database/ # SQL files and migrations
162+
└── docs/ # Documentation
163+
```
164+
165+
## 🤝 Contributing
166+
167+
Contributions are welcome! Please follow these steps:
168+
169+
1. Fork the repository
170+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
171+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
172+
4. Push to the branch (`git push origin feature/amazing-feature`)
173+
5. Open a Pull Request
174+
175+
For detailed contribution guidelines, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
176+
177+
## 📝 Additional Information
178+
179+
### Development Notes
180+
- Large repository size due to included assets and dependencies
181+
- Follows Laravel and Vue.js best practices
182+
- TypeScript support for type-safe frontend development
183+
- Includes sample data and database schema
184+
- Comprehensive API documentation in repository
185+
186+
### Project Structure
187+
```
188+
allorabd/
189+
├── backend/ # Laravel API
190+
├── frontend/ # Nuxt.js application
191+
├── database/ # SQL files and migrations
192+
└── docs/ # Additional documentation
193+
```
194+
195+
### Technologies Highlight
196+
- **Backend:** Laravel 8+ with PHP 7.4+
197+
- **Frontend:** Nuxt.js 2.x with TypeScript
198+
- **State Management:** Vuex
199+
- **API:** RESTful architecture
200+
- **Database:** MySQL/PostgreSQL
27201

28-
## Development Notes
202+
### Credits & Attribution
203+
- **Lead Developer:** Syed Salman Reza
204+
- Built with Laravel and Nuxt.js for modern web applications
29205

30-
Backend (Laravel)
31-
1. Open Folder allorabd in Visual Studio Code
32-
2. Here we have backend for Laravel API and frontend for Nuxt
33-
3. Open Terminal cd to backend
34-
4. Rename the .env2.example file to .env
35-
5. Run command 'composer install'
36-
6. Open Xampp and create DB Name backend and Import sql file called backend.sql
37-
7. Run command 'php artisan serve'
206+
---
38207

39-
- For detailed setup instructions, refer to the [repository README](https://github.com/syed-reza98/allorabd#readme)
40-
- Contributing guidelines and project documentation available in the repository
208+
**For detailed setup instructions and documentation, refer to the [repository README](https://github.com/syed-reza98/allorabd#readme).**

0 commit comments

Comments
 (0)