Skip to content

๐Ÿš€ A social platform for readers built with React, Vite, and Tailwind CSS. Discover books, organize shelves, and share your journey.

License

Notifications You must be signed in to change notification settings

Olliver-0/colophon-client

Repository files navigation

Colophon Client ๐Ÿš€

A full-stack social platform for readers to discover new books, organize their virtual bookshelves, and share their literary journey.

Project Status: In Development ๐Ÿšง


Table of Contents


About The Project

Colophon is a social network dedicated to book lovers. The platform allows users to create virtual bookshelves to organize their readings (read, currently reading, and want to read), write reviews, give ratings, and share their progress with friends.

This repository contains the code for the front-end client, built with React, Vite, and Tailwind CSS.


Tech Stack

  • React.js
  • Vite
  • TypeScript
  • Tailwind CSS
  • Axios
  • React Router

Getting Started

Follow these steps to get a local copy up and running.

  1. Clone the repository:
    git clone [https://github.com/Olliver-0/colophon-client.git](https://github.com/Olliver-0/colophon-api.git)
  2. Navigate to the project directory:
    cd colophon-client
  3. Install NPM packages:
    npm install
  4. Set up Environment Variables:
    • Create a .env file in the root of the project.
    • Add the API URL: VITE_API_URL=http://localhost:3000
  5. Start the development server: bash npm run dev The application will be running on http://localhost:5173 (or the next available port).

Features

MVP (Version 1.0)

  • User Authentication pages (Sign Up and Login)
  • Book search interface
  • Virtual bookshelves display
  • Book details page with ratings and reviews

Future Roadmap

  • Social activity feed
  • User profile dashboard with reading stats
  • Responsive design for all devices

Live Demo

(Link not available yet)


Contact

Natรฃ Gabriel de Oliveira - nata.gabriel.de.oliveira@gmail.com

Project Link: https://github.com/Olliver-0/colophon-client

About

๐Ÿš€ A social platform for readers built with React, Vite, and Tailwind CSS. Discover books, organize shelves, and share your journey.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published