IPcPart Project

This is a full stack webapp project with Typescript, Vue 3, Express, MySql !

Table of Contents

1. Features
2. Built With
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Contributing
6. License
7. Contact
8. Screenshots

Features

• Frontend - Vue.js

  • User registration
  • User login/logout
  • Add to cart
  • Checkout
  • Browse products
  • Manage users
  • Manage staffs

• Backend

  • CURD product, order, user, staff
  • MySql interaction
  • Auth with jwt

Built With

Server side

• node
• express
• typescript
• express validator
• mysql2
• jwt
• cors
• bcryptjs
• uuidv4

Cilent side

• vue 3
• typescript
• vue-router
• vue-validate
• fortawesome
• axios
• pinia
• yup
• sass
• vite

(back to top)

Getting Started

Prerequisites

Ensure Node.js and NPM are installed_

You will need to npm install in each directory in order to install the node module needed for each part of the project Directories Include: Root, Server & Client

Ensure Mysql server are installed and set up as backend/config/mysql.config.ts (fixable)

// backend/config/mysql.config.ts
export default {
  host: 'localhost',
  port: 3360,
  user: 'root',
  password: '',
  database: 'ipcpart',
  waitForConnections: true,
  connectionLimit: 10,
  queueLimit: 0,
};

Installation

1. Clone or Download the repository (Depending on whether you are using SSH or HTTPS)

$ git clone https://github.com/vinh466/ipcpart.git
$ cd ipcpart

2. Install dependencies

$ npm install

3. Start the application

$ npm run dev

Then access Frontend - Client with http://localhost:3001, Frontend - Admin with http://localhost:3001/admin and Backend with http://localhost:3005 via your Postman.

(back to top)

Usage

Service	Endpoint
Backend	http://localhost:3005/api
User Frontend	http://localhost:3001/
Admin Frontend	http://localhost:3001/admin

There are three users in the database initially. You can use them to login Frontend/Backend.

Service	Username	Password
Admin	admin	123123
Staff	nv1	123123
User	vinhvinh	123123

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Vinh Nguyen - @fb - vinh466@gmail.com

Project Link: https://github.com/vinh466/mevn-contactbook

(back to top)

Screenshots

(back to top)