https://github.com/gitcoder052023/trenvo
This repository contains the source code for Trenvo, an e-commerce web application designed for a seamless online shopping experience. The project is currently under heavy development, and many features are yet to be implemented.
https://github.com/gitcoder052023/trenvo
Last synced: 6 months ago
JSON representation
This repository contains the source code for Trenvo, an e-commerce web application designed for a seamless online shopping experience. The project is currently under heavy development, and many features are yet to be implemented.
- Host: GitHub
- URL: https://github.com/gitcoder052023/trenvo
- Owner: GitCoder052023
- Created: 2024-09-10T07:22:00.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T10:46:51.000Z (6 months ago)
- Last Synced: 2024-12-12T11:35:42.928Z (6 months ago)
- Language: HTML
- Homepage:
- Size: 24.9 MB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🛍️ Trenvo
## 📖 About
**Trenvo** is an elegant and luxurious e-commerce web application providing a seamless online shopping experience. The project is currently **under heavy development**, and many features are yet to be implemented.
> **Note:** This README is primarily for developers contributing to this project.
## 🌟 Current Features
- **Front-End:**
- 🎨 **Landing Page:** A modern home page showcasing featured products and collections.
- 📄 **Static Pages:** Includes "About Us" sections.
- 🔐 **Login & Signup Pages:** Basic forms for user authentication.
- 🛒 **Shopping & Product Pages:** Fully dynamic shopping pages for browsing products.
- 🛍️ **Cart, Checkout, and Payment Pages:** Fully dynamic interfaces for cart review and payment methods.
- 🧑💼 **Profile & Wishlist Pages:** Profile page is dynamic, while the wishlist page remains static.
- 🚚 **Order & Track Order Pages:** Fully dynamic order tracking pages with interactive features.
- 📞 **Contact Us Page:** Fully dynamic and integrated with the backend.
- 🔄 **Password Reset Flow:** A secure, fully dynamic multi-step process integrated with the backend, including email and OTP verification.
- **Back-End:**
- 🌐 **Node.js & Express:** Serving static files and handling routing efficiently.
- 🗃️ **MongoDB:** Storing user data and product information.
- 🔑 **JWT Authentication:** JSON Web Tokens for secure, stateless user authentication and session management.
- 📧 **Nodemailer:** Handles email sending for notifications, password resets, and order confirmations.
## 💻 Tech Stack
- 
- 
- 
- 
- 
- 
- 
- 
- 
## 📋 Pre-requisites
Before you begin, ensure you have the following installed:
- **Node.js** (v16.x or above) - [Download Node.js](https://nodejs.org/)
- **MongoDB** (v5.x or above) - [Download MongoDB](https://www.mongodb.com/)
- **Git** - [Download Git](https://git-scm.com/)
## 🛠️ Project Setup (For Developers)
### Step 1: Clone the Repository
```bash
git clone https://github.com/GitCoder052023/Trenvo.git
```
### Step 2: Navigate to the Project Directory
```bash
cd Trenvo
```
### Step 3: Install Dependencies
```bash
npm i
```
### Step 4: Set Up Environment Variables
Create a `.env` file in the root directory and add the following:
```env
PORT=3000
MONGO_URI=MongoDB-URI
JWT_SECRET=YOUR_JWT_SECRET
SENDER_EMAIL=YOUR_EMAIL_ADDRESS
SENDER_APP_PASSWORD=YOUR_APP_PASSWORD
CLOUDINARY_CLOUD_NAME=REPLACE_WITH_YOUR_OWN_CLOUDINARY_CLOUD_NAME
CLOUDINARY_API_KEY=REPLACE_WITH_YOUR_OWN_CLOUDINARY_API_KEY
CLOUDNINARY_API_SECRET=REPLACE_WITH_YOUR_OWN_CLOUDNINARY_API_SECRET
```
### Step 5: Run the Application
```bash
npm run dev
```
### Step 6: Access the Application
Open your browser and go to `http://localhost:3000`.
## 🌟 Testimonials
We would like to extend our gratitude to the contributors who have significantly supported the development of **Trenvo**:
- **IbrahimAhmad77977**: Played a pivotal role in making pages fully responsive, demonstrating exceptional skill and dedication. His work is highly commendable, and I rate him **5/5**.
- **huzaifazahid1**: Skillfully re-created the frontend for several pages, perfectly translating designs into functional interfaces. His talent and attention to detail are outstanding, earning a **5/5** rating.
- **royadeveloper01**: Made significant contributions to the backend architecture of Trenvo, showcasing proficiency and commitment.
- **AbdullahAhmadAAK**: Contributed extensively to ensuring the responsiveness of pages, exhibiting excellent technical skills. I rate his work **5/5**.
Your efforts and dedication are deeply appreciated! 🚀
## 🤝 Contributing
We welcome contributions from developers around the world! Follow these steps to get started:
1. **Fork the Repository:**
- Click the "Fork" button on the top right of this repository to create your own copy.
2. **Clone the Repository:**
```bash
git clone https://github.com/your-username/Trenvo.git
```
3. **Create a Branch:**
- Use a descriptive name for your branch that indicates the feature or bugfix you are working on:
```bash
git checkout -b feature/your-feature-name
```
4. **Make Changes:**
- Write clean, well-documented code.
- Ensure that your code adheres to the project's coding guidelines.
5. **Test Your Changes:**
- Before submitting your work, ensure that your changes are tested and do not break existing functionality.
6. **Push to Your Fork:**
```bash
git push origin feature/your-feature-name
```
7. **Create a Pull Request:**
- Go to the original repository on GitHub and create a Pull Request (PR).
- Provide a detailed description of your changes and the motivation behind them.
8. **Collaborate:**
- Address feedback and collaborate with reviewers to refine your PR.
By contributing to this project, you agree to abide by its [Code of Conduct](https://github.com/GitCoder052023/Trenvo/blob/main/CODE_OF_CONDUCT.md).