yshgroup / vue-test-address-book

Build the contact management system with Vue3 + Pinia + Quasar

Contact Management System

Welcome to the Contact Management System, a user-friendly interface allowing you to manage your contacts efficiently. Below you will find the necessary information on how to get started with this project.

Functional Requirements

This system is designed to meet the following user stories:

1. Create New Contact: As a user, you can create a new contact by entering the first name, last name, email, and phone number to track people you know.
2. Search for Contact: As a user, you have the ability to search for a contact by first and/or last name to find their information quickly.
3. Update Contacts: As a user, you can update contacts whenever there's a change in their last name, email, or phone number to keep your contact information up to date.
4. Delete Contact: As a user, you can delete a contact from your list to maintain an organized and relevant contact list.

Prerequisites

To run this project, you need to have Node.js and NPM installed. This ensures that all dependencies and the runtime are correctly set up.

• Node Version: 21.5.0
• Vue Version: 3.2.29
• Quasar Version: 2.8.0

Running the Project

To get the project up and running on your local machine, follow these steps:

1. Clone the repository or extract the provided zip file into your desired directory.

2. Navigate to the project directory using a terminal or command prompt:

   cd path/to/address-book

3. Install necessary dependencies:

   npm install

4. To start the project, use the following NPM command:

   npm run dev

   Alternatively, if you're using Quasar CLI:

   quasar dev

   This will launch the project in development mode.

Testing the Project

If tests are available and you wish to run them, execute the following command:

npm run test:jest

This command will run the test suite associated with the project (if implemented).

Note: The commands for starting or testing the project may differ based on the specific setup and scripts defined within the package.json file.

---

For further details or any issues encountered, refer to the project documentation or contact the project maintainer. Enjoy managing your contacts seamlessly with our Contact Management System!

Reference

• Vue3
• Pinia: version 2.1.7
• Quasar: version 2.8.0
• vue-router: Version 4.0.12
• IndexedDB