Skip to content

Repository files navigation

GreatReads

The Project

The purpose of this project is to provide users with a way to track and organize their reading habits. This project focuses on the individual user and their personal reading experience. Users are able to create their own accounts, search for books and organize bookshelves of books. The search capability can search for thousands of books and users can add any book to their bookshelves. With each search result they can interact with books and view their information, including the author and a description of the book. A user can mark a book as read or unread, add personal notes about the book, and add or remove books to and from their shelves.

UI Prototype

Figma design Last updated: November 23, 2024

Architecture Documentation

Architecture document

Development Environment

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

    npm install
    npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.

Syncing Supabase Types with Database Schema

Having run npm install and logged in to Supabase on your default browser, run the following commands:

    supabase login
    supabase link # Follow CLI instructions and select GreatReadsWebApp
    supabase gen types typescript --linked --schema=public > src/utils/database.types.ts  

Contributing

Contributing documentation

Backend API documentation

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploying on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

Resources

Contributing

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages