CT313H: WEB TECHNOLOGIES AND

SERVICES
Building Contactbook App - Frontend
You will build a contact management app as a SPA app. The tech stack includes Nodejs/Express,
Knex.js, MySQL/MariaDB for backend (API server) and Vue.js for frontend (GUI). In the next two lab
sessions, you will build the app frontend.

The app is built as a SPA with Vue.js and has the following features:

A page showing a list of contacts, support pagination and the ability to filter any piece of
information of a contact (name, email, phone, address, favorite) on each page of contacts.

A page to edit a contact.

A page to add a new contact.

Support for deleting a contact, all contacts.

A 404 error page for unknown paths.

The app uses the HTTP API built in the first two lab sessions. The source code is managed by git
and uploaded to GitHub.

This step-by-step tutorial will help implement all the above requirements. However, students are
free to make their own implementation as long as the requirements are met.

Requirements for the lab report:

The submitted report file is a PDF file containing images showing the results of your works.
Each functionality on a page may need several images to illustrate (e.g., images showing the
implemented functionalities, successful and failed scenarios, results of the operations, ...).
You should NOT screenshoot the source code.

You only need to create ONE report for the whole four lab sessions. At the end of each lab
session, students need to (1) submit the work-in-progress report and (2) push the code to the
GitHub repository given by the instructor.

The report should also filled with student information (student ID, student name, class ID)
and the links to the GitHub repositories.

Plagiarism will result in 0.

Step 0: Before getting started...

For easier debugging, Vue.js devtools extension should be installed in the browser.

The HTTP API server built in the first two lab sessions should work correctly.

Step 1: Clone the repo from GitHub

Clone the GitHub repo to your machine:

 git clone <đường-link-đến-repo-GitHub-đã-nhận> contactbook-frontendInstall dependencies

and run the project in dev mode:

cd contactbook-frontend
npm install
npm run dev

Open a browser, go to http://localhost:5173/ to see the result.

Step 2: Setup VSCode

Install Vue Language Features (Volar) extension for VSCode.

Install ESLint, Prettier extensions for VSCode if needed.

Configure VSCode to automatically format the source code on save or paste: Go to File >
Settings, search for "format" and then check "Editor: Format on Paste" and "Editor: Format on
Save":

In the project directory, add jsconfig.json file. This file helps VSCode understand the project
structure:

{
"compilerOptions": {
"baseUrl": "./",
"paths": {
"@/*": ["src/*"]
}
}
}

Commit changes and push to GitHub:

cd contactbook-frontend
git add -A
git commit -m "Setup VSCode"
git push origin master

Step 3: Create functions to get data from server

In the project directory, configure proxy to the API server in vite.config.js:

export default defineConfig({
...
server: {
proxy: {
'/api': {
target: 'http://localhost:3000/',
changeOrigin: true,
},
 },
},
});

The above configuration means that when there is a HTTP request with an URI starting with
/api coming from the app (http://localhost:5173/), the target host of the request will be replaced
with the address of the API server (http://localhost:3000/). For example, a request to
http://localhost:5173/api/contacts will become a request to http://localhost:3000/api/contact s.
Create src/services/contacts.service.js as follows:

function makeContactsService() {
const baseUrl = '/api/contacts';
const headers = {
'Content-Type': 'application/json',
};

async function getContacts(page, limit = 5) {

let url = `${baseUrl}?page=${page}&limit=${limit}`;
return await fetch(url).then((res) => res.json());
}

async function createContact(contact) {

return await fetch(baseUrl, {
method: 'POST',
headers,
body: JSON.stringify(contact),
}).then((res) => res.json());
}

async function deleteAllContacts() {

return await fetch(baseUrl, {
method: 'DELETE',
}).then((res) => res.json());
}

async function getContact(id) {

return await fetch(`${baseUrl}/${id}`).then((res) => res.json()); }

async function updateContact(id, contact) {

return await fetch(`${baseUrl}/${id}`, {
method: 'PUT',
headers,
body: JSON.stringify(contact),
}).then((res) => res.json());
}

async function deleteContact(id) {

return await fetch(`${baseUrl}/${id}`, {
method: 'DELETE',
}).then((res) => res.json());
}

return {
getContacts,
deleteAllContacts,
getContact,
createContact,
updateContact,
 deleteContact,
};
}

export default makeContactsService();

The contacts.service.js module defines functions interacting with the API server (built in lab
sessions 1 and 2) by issuing the corresponding HTTP requests.

Step 4: Implement a page showing a list of contacts

The UI presented in this tutorial is as follows:

Install Bootstrap 4 and Font Awesome:

npm i bootstrap@4 jquery popper.js @fortawesome/fontawesome-free Edit src/main.js to

import Bootstrap and Font Awesome:

import { createApp } from 'vue';

import 'bootstrap/dist/css/bootstrap.min.css';
import '@fortawesome/fontawesome-free/css/all.min.css';
import App from './App.vue';
...

Install vue-router : npm i vue-router@4 , and create src/router/index.js as follows:

import { createWebHistory, createRouter } from 'vue-router';
import ContactBook from '@/views/ContactBook.vue';

const routes = [
{
path: '/',
name: 'contactbook',
component: ContactBook,
},
];

const router = createRouter({

history: createWebHistory(import.meta.env.BASE_URL),
routes,
});

export default router;

The import.meta.env object contains environment variables for the app managed by Vite.
env.BASE_URL returns the base URL of the app on the web server. This value comes from the "base"
option in the vite.config.js file ("/" by default - the app is deployed right in the document root on the
web server).

Open src/main.js and add the router to the app:

...
import router from './router';

createApp(App)
.use(router)
.mount('#app');

Define a placeholder page in src/views/ContactBook.vue as follows:

<template>
<h2>ContactBook page</h2>
</template>

The root component in src/App.vue is updated as follows:

<script setup>
import AppHeader from '@/components/AppHeader.vue';
</script>

<template>
<AppHeader />

<div class="container mt-3">

<router-view />
</div>
</template>

<style>
.page {
max-width: 400px;
margin: auto;
}
</style>

AppHeader component (src/components/AppHeader.vue) defines the app navigation bar:

<template>
<nav class="navbar navbar-expand navbar-dark bg-dark">
<a
href="/"
class="navbar-brand"
>Ứng dụng Quản lý danh bạ</a>
<div class="mr-auto navbar-nav">
<li class="nav-item">
<router-link
:to="{ name: 'contactbook' }"
class="nav-link"
>
Danh bạ
<i class="fas fa-address-book"></i>
</router-link>
 </li>
</div>
</nav>
</template>

Go to http://localhost:5173/ to check the page showing the string "ContactBook page".

As shown in the figure, the ContactBook page use 4 components: InputSearch, ContactList,
ContactCard and Pagination. Let's create these components:

1. InputSearch component (src/components/InputSearch.vue):

<script setup>
defineProps({
modelValue: { type: String, default: '' },
});

const $emit = defineEmits(['submit', 'update:modelValue']);

</script>

<template>
<div class="input-group">
<input
type="text"
class="form-control px-3"
placeholder="Nhập thông tin cần tìm"
:value="modelValue"
@input="(e) => $emit('update:modelValue', e.target.value)"
@keyup.enter="$emit('submit')"
/>
<div class="input-group-append">
<button
class="btn btn-outline-secondary"
type="button"
@click="$emit('submit')"
>
<i class="fas fa-search"></i>
</button>
</div>
</div>
</template>

The component has a property named modelValue. This property is bound to the input value.
An event named update:modelValue is emitted when the input value changes. These conditions
enable the use of v-model on InputSearch to create a two-way binding, i.e., <InputSearch v model="..."
/>.

2. ContactList component (src/components/ContactList.vue):

<script setup>
defineProps({
contacts: { type: Array, default: () => [] },
selectedIndex: { type: Number, default: -1 },
});

const $emit = defineEmits(['update:selectedIndex']);

</script>
 <template>
<ul class="list-group">
<li
class="list-group-item px-3"
v-for="(contact, index) in contacts"
:class="{ active: index === selectedIndex }"
:key="contact.id"
@click="$emit('update:selectedIndex', index)"
>
{{ contact.name }}
</li>
</ul>
</template>

The component has a property named activeIndex. An event named update:activeIndex is

emitted when a list element is selected. These conditions enable the use of v-model on ContactList to
create a two-way binding, i.e., <ContactList v-model:activeIndex="..." />.

3. ContactCard component (src/components/ContactCard.vue):

<script setup>
defineProps({
contact: { type: Object, required: true },
});
</script>

<template>
<div>
<div class="p-1">
<strong>Tên:</strong>
{{ contact.name }}
</div>
<div class="p-1">
<strong>E-mail:</strong>
{{ contact.email }}
</div>
<div class="p-1">
<strong>Địa chỉ:</strong>
{{ contact.address }}
</div>
<div class="p-1">
<strong>Điện thoại:</strong>
{{ contact.phone }}
</div>
<div class="p-1">
<strong>Liên hệ yêu thích:&nbsp;</strong> <i
v-if="contact.favorite"
class="fas fa-check"
></i>
<i
v-else
class="fas fa-times"
></i>
</div>
</div>
</template>

4. Pagination componenent (src/components/Pagination.vue):

<script setup>
import { computed } from 'vue';

const props = defineProps({

totalPages: {
type: Number,
required: true,
},
length: {
type: Number,
default: 3,
},
currentPage: {
type: Number,
default: 1,
},
});

const $emit = defineEmits(['update:currentPage']);

const pages = computed(() => {

const pages = [];

const half = Math.floor(props.length / 2); let start =

props.currentPage - half;
let end = props.currentPage + half;

if (start <= 0) {
start = 1;
end = props.length;
}

if (end > props.totalPages) {

end = props.totalPages;

start = end - props.length + 1;

if (start <= 0) start = 1;
}

for (let i = start; i <= end; i++) {

pages.push(i);
}

return pages;
});
</script>

<template>
<nav>
<ul class="pagination">
<li
class="page-item"
:class="{ disabled: currentPage == 1 }"
>
<a
role="button"
class="page-link"
@click.prevent="$emit('update:currentPage', currentPage - 1)" >
<span>&laquo;</span>
</a>
 </li>
<li
v-for="page in pages"
:key="page"
class="page-item"
:class="{ active: currentPage == page }"
>
<a
role="button"
class="page-link"
@click.prevent="$emit('update:currentPage', page)"
>{{ page }}</a
>
</li>
<li
class="page-item"
:class="{ disabled: currentPage == totalPages }"
>
<a
role="button"
class="page-link"
@click.prevent="$emit('update:currentPage', currentPage + 1)" >
<span>&raquo;</span>
</a>
</li>
</ul>
</nav>
</template>

Edit src/views/ContactBook.vue to define a page showing a list of contacts:

<script setup>
import { ref, computed, onMounted, watch } from 'vue';
import { useRouter } from 'vue-router';
import ContactCard from '@/components/ContactCard.vue';
import InputSearch from '@/components/InputSearch.vue';
import ContactList from '@/components/ContactList.vue';
import Pagination from '@/components/Pagination.vue';
import contactsService from '@/services/contacts.service';

// The full code will be presented below

</script>

<template>
<div class="page row mb-5">
<div class="mt-3 col-md-6">
<h4>
Danh bạ
<i class="fas fa-address-book"></i>
</h4>
<div class="my-3">
<InputSearch v-model="searchText" />
</div>
<ContactList
v-if="filteredContacts.length > 0"
:contacts="filteredContacts"
v-model:selectedIndex="selectedIndex"
/>
<p v-else>
 Không có liên hệ nào.
</p>

<div class="mt-3 d-flex justify-content-center align-items-center"> <Pagination

:totalPages="totalPages"
v-model:currentPage="currentPage"
/>
</div>

<div class="mt-3 row justify-content-around align-items-center"> <button

class="btn btn-sm btn-primary"
@click="retrieveContacts(currentPage)"
>
<i class="fas fa-redo"></i> Làm mới
</button>

<button
class="btn btn-sm btn-success"
@click="goToAddContact"
>
<i class="fas fa-plus"></i> Thêm mới
</button>

<button
class="btn btn-sm btn-danger"
@click="onDeleteContacts"
>
<i class="fas fa-trash"></i> Xóa tất cả
</button>
</div>
</div>
<div class="mt-3 col-md-6">
<div v-if="selectedContact">
<h4>
Chi tiết Liên hệ
<i class="fas fa-address-card"></i>
</h4>
<ContactCard :contact="selectedContact" />
</div>
</div>
</div>
</template>

<style scoped>
.page {
text-align: left;
max-width: 750px;
}
</style>

The ContactBook page has the following variables:

totalPages: stores the total pages (in this case, paginating records happens on the server).

currentPage: stores the current page.

contacts: stores a list of contacts on a page. This list is loaded with the data from the server
when ContactBook is mounted.

selectedIndex: index of the selected contact in the list. selectedIndex identifies the contact
 object passed to ContactCard for displaying detailed information.

searchText: stores text entered from the search box.

The ContactBook page relies on contactsService for accessing data on the server:

// src/views/ContactBook.vue
<script setup>
...

const $router = useRouter();

const totalPages = ref(1);
const currentPage = ref(1);

const contacts = ref([]);

const selectedIndex = ref(-1);
const searchText = ref('');

// Map each contact to a string for searching

const searchableContacts = computed(() =>
contacts.value.map((contact) => {
const { name, email, address, phone } = contact;
return [name, email, address, phone].join('');
})
);

// Contacts filtered by searchText

const filteredContacts = computed(() => {
if (!searchText.value) return contacts.value;
return contacts.value.filter((contact, index) =>
searchableContacts.value[index].includes(searchText.value) );
});

const selectedContact = computed(() => {

if (selectedIndex.value < 0) return null;
return filteredContacts.value[selectedIndex.value]; });

// Get contacts for a specific pages and order them by name async function
retrieveContacts(page) {
try {
const chunk = await contactsService.getContacts(page); totalPages.value =
chunk.metadata.lastPage ?? 1;
contacts.value = chunk.contacts.sort((current, next) =>
current.name.localeCompare(next.name)
);
selectedIndex.value = -1;
} catch (error) {
console.log(error);
}
}

// Handle delete all contacts event

async function onDeleteContacts() {
if (confirm('Bạn muốn xóa tất cả Liên hệ?')) {
try {
await contactsService.deleteAllContacts();
totalPages.value = 1;
currentPage.value = 1;
contacts.value = [];
selectedIndex.value = -1;
 } catch (error) {
console.log(error);
}
}
}

function goToAddContact() {
$router.push({ name: 'contact.add' });
}

// When this component is mounted, load the first page of contacts onMounted(() =>
retrieveContacts(1));

// Whenever searchText changes, reset selectedIndex

watch(searchText, () => (selectedIndex.value = -1));

// When currentPage changes, fetch contacts for currentPage

watchEffect(() => retrieveContacts(currentPage.value));
</script>

Start the API server at port 3000 and then start the Vue app: npm run dev (if it's not started yet).
Open a browser, go to http://localhost:5173/ and verify that: (1) a list of contacts is shown, (2) the
detailed information of a contact is shown when selecting a contact in the list, and (3) the search
functionality works correctly. If the database contains no data, add some example data (use a HTTP
client to send requests to the API server).

After making sure the code works, commit changes to git and upload to GitHub:

git add -u
git add .env src/components/ src/router/ src/services/ src/views/ git commit -m "Create a contact
listing page"
git push origin master

Step 5: Create a 404 error page

Add a route definition matching all the paths (src/router/index.js):

...
const routes = [
...
{
path: '/:pathMatch(.*)*',
name: 'notfound',
component: () => import('@/views/NotFound.vue'),
},
];
...

Create the NotFound page in src/views/NotFound.vue:

<template>
<div class="page">
<p>
Oops, không thể tìm thấy trang. Trở về
<router-link to="/">
trang chủ.
</router-link>
</p>
 </div>
</template>

Open a browser, access to an unknown path and check that the error page is shown.

Commit changes and upload to GitHub:

git add src/router/index.js src/views/NotFound.vue

git commit -m "Implement the 404 page"
git push origin master

Step 6: Create form for adding and updating a contact

The edit page and the add page need a form namely ContactForm. ContactForm receives a
contact object as its property. If the contact object exists on the server (i.e., the id field has a valid
value) then ContacForm will be in edit mode. On the other hand, it will be in add mode. Only in edit
mode, the delete button on the form is shown.

When working with form in Vue, you can use vee-validate and yup to easily validate the form
data. vee-validate provides customized form and input components supporting data validation by
rules. yup helps create these validation rules.

Please not that the use of vee-validate and yup is not required, you can use normal form
and input tags and standard JavaScript code for form validation.

Install vee-validate and yup : npm i vee-validate yup .

Create/edit ContactForm.vue in src/components/ as follows:

<script setup>
import { ref } from 'vue';
import * as yup from 'yup';
import { Form, Field, ErrorMessage } from 'vee-validate';

const props = defineProps({

initialContact: { type: Object, required: true },
});

const $emit = defineEmits(['submit:contact', 'delete:contact']);

const contactFormSchema = yup.object().shape({

name: yup
.string()
.required('Tên phải có giá trị.')
.min(2, 'Tên phải ít nhất 2 ký tự.')
.max(50, 'Tên có nhiều nhất 50 ký tự.'),
email: yup
.string()
.email('E-mail không đúng.')
.max(50, 'E-mail tối đa 50 ký tự.'),
address: yup.string().max(100, 'Địa chỉ tối đa 100 ký tự.'), phone: yup
.string()
.matches(
/(03|05|07|08|09|01[2|6|8|9])+([0-9]{8})\b/g,
'Số điện thoại không hợp lệ.'
),
});
const editedContact = ref({ ...props.initialContact });

function submitContact() {
$emit('submit:contact', editedContact.value);
}

function deleteContact() {
$emit('delete:contact', editedContact.value.id);
}
</script>

<template>
<Form
@submit="submitContact"
:validation-schema="contactFormSchema"
>
<div class="form-group">
<label for="name">Tên</label>
<Field
name="name"
type="text"
class="form-control"
v-model="editedContact.name"
/>
<ErrorMessage name="name" class="error-feedback" /> </div>
<div class="form-group">
<label for="email">E-mail</label>
<Field
name="email"
type="email"
class="form-control"
v-model="editedContact.email"
/>
<ErrorMessage name="email" class="error-feedback" /> </div>
<div class="form-group">
<label for="address">Địa chỉ</label>
<Field
name="address"
type="text"
class="form-control"
v-model="editedContact.address"
/>
<ErrorMessage name="address" class="error-feedback" />
</div>
<div class="form-group">
<label for="phone">Điện thoại</label>
<Field
name="phone"
type="tel"
class="form-control"
v-model="editedContact.phone"
/>
<ErrorMessage name="phone" class="error-feedback" />
</div>

<div class="form-group form-check">

<Field
name="favorite"
type="checkbox"
class="form-check-input"
 v-model="editedContact.favorite"
:value="1"
:unchecked-value="0"
/>
<label for="favorite" class="form-check-label">
<strong>Liên hệ yêu thích</strong>
</label>
</div>

<div class="form-group">
<button class="btn btn-primary">Lưu</button>
<button
v-if="editedContact.id"
type="button"
class="ml-2 btn btn-danger"
@click="deleteContact"
>
Xóa
</button>
</div>
</Form>
</template>

<style scoped>
@import '@/assets/form.css';
</style>

In above code, we defined a schema containing validation rules for input data in the form (
:validation-schema="contactFormSchema" ). Also note that ContactForm can emit two events: submit:contact

and delete:contact.

Step 7: Create an edit page

The UI of the page is as follows:

Create src/views/ContactEdit.vue as follows:

<script setup>
import { ref } from 'vue';
import { useRouter, useRoute } from 'vue-router';
import ContactForm from '@/components/ContactForm.vue';
import contactsService from '@/services/contacts.service';

const props = defineProps({

contactId: { type: String, required: true },
});
 const $router = useRouter();
const $route = useRoute();

const contact = ref(null);

const message = ref('');

async function getContact(id) {

try {
contact.value = await contactsService.getContact(id);
} catch (error) {
console.log(error);
// Redirect to NotFound page and keep URL intact
$router.push({
name: 'notfound',
params: { pathMatch: $route.path.split('/').slice(1) },
query: $route.query,
hash: $route.hash,
});
}
}

async function onUpdateContact(editedContact) {

try {
await contactsService.updateContact(editedContact.id, editedContact); message.value = 'Liên hệ được cập
nhật thành công.';
} catch (error) {
console.log(error);
}
}
async function onDeleteContact(id) {
if (confirm('Bạn muốn xóa Liên hệ này?')) {
try {
await contactsService.deleteContact(id);
$router.push({ name: 'contactbook' });
} catch (error) {
console.log(error);
}
}
}

getContact(props.contactId);
</script>

<template>
<div v-if="contact" class="page">
<h4>Hiệu chỉnh Liên hệ</h4>
<ContactForm
:initial-contact="contact"
@submit:contact="onUpdateContact"
@delete:contact="onDeleteContact"
/>
<p>{{ message }}</p>
</div>
</template>

The path for accessing to the edit page is /contacts/:id with id as the id of the contact. Before
the page is shown, the id property is used to fetch contact data from the server.

Add a route definition for ContactEdit in src/router/index.js:

 ...
const routes = [
...
{
path: '/contacts/:id',
name: 'contact.edit',
component: () => import('@/views/ContactEdit.vue'),
props: (route) => ({ contactId: route.params.id })
},
];
...

Add a link to the edit page in ContactBook (src/views/ContactBook.vue), just below ContactCard:
...
<ContactCard :contact="selectedContact" />
<router-link
:to="{
name: 'contact.edit',
params: { id: selectedContact.id },
}"
>
<span class="mt-2 badge badge-warning">
<i class="fas fa-edit"></i> Hiệu chỉnh</span>
</router-link>
...

Make sure the code works. Commit changes and upload to GitHub:

git add -u
git add src/assets/ src/components/ContactForm.vue src/views/ContactEdit.vue git commit -m "Create an edit page"
git push origin master

Step 8: Create an add page

This page is similar to the edit page, so do it on your own:

Make sure the add page works correctly and then commits changes to GitHub.

The directory structure of the project is as follows:

Step 9: Manage server state with @tanstack/vue-query

Instead of directly call server APIs inside components, update the project to use
@tanstack/vue-query to fetch and modify server state (e.g., contact resources).