Skip to content

anemoneflower/HCI_ReadIT

Repository files navigation

KAIST CS374: ReadIT!

Seoyun Son (anemoneflower, [email protected])
Chaeeun Hwang (navy3690, [email protected])
Siwon Kim (coolofficials, [email protected])

WebPage URL

https://hci-readit.web.app/

Target User

This is service for Readers who want to recall contents of the book after paused their reading.

Libraries and frameworks

Vue.js

2.6.11

Firebase

7.14.6

Views & Components in ./src

App.vue: manage global components like NavBar and mini-SearchBar
assets: png files for logo and icons
components: Components that used for pages in View folder

  • Book.vue: Book compoent used in Booklist.vue
  • Card.vue: Book note list row components used in BookNoteBoard.vue and MyBookNote.vue
  • NavBar.vue: Component used in app.vue
  • NoteBox.vue: Conponent used in ReadNote.vue
  • SearchBar.vue: Component for search bar function. Used in Home.vue and App.vue
  • other files are unused in current deploy version

views: Components that used for pages

  • BookNoteBoard.vue: Book note list
  • MyBookNote.vue: My book note list
  • Booklist.vue: Book list page
  • Home.vue: Home page
  • MyBooklist.vue: Book list page for mypage
  • ReadNote.vue: Read note page for mypage
  • SignIn.vue: Sign in page
  • WriteNote.vue: Write note page
  • other files are unused in current deploy version

router/index.js: set routing

Project setup

npm install

npm i -g @vue/cli

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint