Skip to content

πŸ“š Literature-focused social platform, inspired by Goodreads. Features include ratings, reviews, reading goals, and user collections.

License

Notifications You must be signed in to change notification settings

mgrabka/neatreads

Repository files navigation

Neatreads

This project is built with Next.js 13, utilizing app router with route handlers & dynamic routes & SSR, and Google API.

πŸš€ Features

  • 🌟 Reviews and Ratings

  • πŸ“š Reading status

  • πŸ† Reading goals

  • πŸ—‚ Collections

  • 🀡 User Profiles

  • πŸ‘₯ Follows

  • πŸ”Ž Search (querying users and books at once)

Local setup

Prerequisites

  • Ensure you have Docker installed and running in the background.

Setup Instructions

  1. Checkout to the "local" branch:

    git checkout local
  2. Install project dependencies:

    pnpm i
  3. Start Supabase:

    supabase start
  4. Run the project in preview mode:

    pnpm run preview
  5. Access the application locally at http://localhost:3000. (default)*

Local Email Testing

When testing locally, emails won't be sent to your address. You have to access inbucket at:

http://localhost:54324 (default)*

Disclaimer *

Please note that ports may vary, check output of supabase start to know for sure.

License

Licensed under the MIT license.

About

πŸ“š Literature-focused social platform, inspired by Goodreads. Features include ratings, reviews, reading goals, and user collections.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages