📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

💼 E-commerce Backend

Hello it's me Qusai Issa and Muhammad Alabadsa from Palestine
and this is an E-commerce project.

🛠 Built With

Tech Stack

This Project was built with TypeScript, MYSQL, Node.js and Sequelize

Clients

• MYSQL
• TypeScript
• Node.js
• Sequelize

Key Features

• E-commerce project that is connected to MYSQL dataBase
• Follow TypeScript best practice
• Follow GitHub flow
• Create, Read, Update and Delete functions (CRUD)

(back to top)

🚀 Live Demo

not deployed yet

• Live Demo Link

📊 Database Schema

• Database Schema

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Visual Studio Code.
• Node JS.
• Git bash.
• GitHub Account.
• Mysql

Setup

Clone this repository to your desired folder: Use git clone command or download ZIP folder run the following commands

Install

Install this project with: npm Example command:

  cd my-project
  npm init -y
  npm install -g typescript
  npm install -g ts-node
  npm install --save-dev typescript @types/node @types/express
  npm install mysql
  npm i --save-dev @types/mysql

Usage

To run the project, execute the following command: npm start or live server Example command:

   npm run dev

Run tests

To run tests, run the following command: npm test Example command:

  npm test

👤 Authors Qusai Issa

• GitHub: @qusai122
• LinkedIn: Qusai Issa

Muhammad Alabadsa

• GitHub: @mAbadsa
• LinkedIn: Muhammad Alabadsa

(back to top)

🔭 Future Features

• Build an E-commerce that uses a MYSQL database
• Validate and expect all errors that will occur
• Using TypeScript and express
• Using RESTful APIs

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

if you like this project, kindly give it a star.

(back to top)

🙏 Acknowledgments

We would like to thank all our colleagues and trainers in TAP for helping us.

• Mohammad Barhoush : Linkedin
• Mohamed Sharif : Linkedin
• Tap : Linkedin

(back to top)

📝 License

This project is MIT licensed.