Skip to content

A social cataloging website for your personal library

Notifications You must be signed in to change notification settings

MarianTLibrarian/BookFace

Repository files navigation

BookFace

BookFace is a social cataloging website that allows book lovers to connect, share books they love, and manage their collection of books with personalized bookshelves. This is the culmination of six engineers working closely over the course of one week to complete an MVP based on client's request.

Table of Contents

Tech Stack

React Vite Firebase Express Node Axios Twilio Socket Material-UI Chart.js Nivo Figma Zustand

User Persona & Story

Wireframes

Product Features

Home

Login authentication with Firebase OAuth

Live search with smart filter

Users can perform sitewide search on books/bookclubs

MyBooks

Users can view their personalized bookshelves and joined bookclubs

Book detail page

Users can add book to their bookshelves and update reading status

Reading Stats

Users can generate a personalized reading statistics report

MyClubs

Users can explore and join bookclubs

Club detail page

Users can create an event and post messages

Live Chat

Users can chat with other club members

Video Chat

users can initiate a video call for club members to join

Getting Started

Installation

From the root directory, run the following commands in your terminal.

  1. To install all dependencies
npm install
  1. To start dev server: open http://localhost:3000 to view it in your browser
npm run dev
  1. To build for production
npm run build
  1. To locally preview production build
npm run preview
  1. To connect to the server: use http://localhost:3030 to verify the server connection
npm run serve
  1. To connect to socket for live chat
npm run socket

Contributors

 

 

While all members worked as full stack engineers to develop features, we also had these additional roles:

Product Managers Haley Jung & Addison Hernandez
App Architects Hailee Lu & Katy Feng
UI Leads Junpeng Chang & Joseph Sanfelippo

(back to top)