Skip to content

Latest commit

 

History

History
123 lines (87 loc) · 5.38 KB

README.md

File metadata and controls

123 lines (87 loc) · 5.38 KB
Raw
tech-buddy

Tech Buddy 🔗

Tech Buddy is a comprehensive platform where instructors can effortlessly create and list their courses, and students can easily find and purchase the courses they desire. It features secure account setup with email OTP verification, enhanced password encryption using Bcrypt, end-to-end encrypted payments with SHA-256, and seamless payment processing with Razorpay. Users can give ratings and reviews to help others make informed decisions, and the fully responsive design ensures flawless functionality on any screen size.

🌐 View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

🌟 About the Project

📷 Screenshots

image
image

👾 Tech Stack

Front-End
Back-End
Database
Security
Storage
Payments
Deployment

🎯 Features

  • ✅ Account Creation with OTP Verification: Secure account setup with email OTP verification.
  • ✅ Security: Enhanced password encryption using Bcrypt Encryption and Payment is end-to-end encrypted using SHA 256 Encryption Algorithm to ensure user data safety.
  • ✅ Integrated Payments: Seamless payment processing with Razorpay.
  • ✅ Responsive Design: Responsive UI design ensures seamless access across devices, including desktops, tablets, and mobile phones.
  • ✅ Course Ratings and Reviews: Users can give ratings and reviews to the purchased courses, helping others to make informed decisions.
  • ✅ Deployment: Easy deployment with Render for backend and Vercel for front-end, ensuring quick and hassle-free deployment of the application.

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

API_KEY API_SECRET API_SECRET CLOUD_NAME FOLDER_NAME JWT_SECRET MAIL_HOST MAIL_PASS MAIL_USER MONGODB_URL RAZORPAY_KEY RAZORPAY_SECRET REACT_APP_BASE_URL PORT

🧰 Getting Started

⚙️ Installation

Clone the repository

git clone <repository-url>

Install dependencies

npm install

Set up the following

MongoDb Database, Razorpay, MAIL Service and Cloud Storage Service

Run the application

npm run dev

🚩 Deployment

Build Command

$ npm run build

👋 Contributing

Contributions are welcome! Feel free to submit bug reports, feature requests, or pull requests. Please ensure that you follow the code of conduct and contribution guidelines when contributing to this project.

📜 Contribution Guidelines

Please read the Contribution Guidelines

📜 Code of Conduct

Please read the Code of Conduct

⚠️ License

Distributed under the MIT License.

🤝 Contact

Himanshu Maharshi - @LinkedIn_handle - [email protected]

🔗 Project Link 🔗 https://github.com/himanshumaharshi/tech-buddy