Skip to content

vivekneupane11/book-website-nextjs

Repository files navigation

Book Reading App

Next.js License

A web application that enhances the reading experience by allowing users to interact with book content through various features.

Demo

You can check out the live demo of the Book Reading App here.

BOOK READER APP

Video Tutorial

You can watch a tutorial on how to create this app here.

Features

  • 📚 Displaying Books
  • ✍️ Highlighting text
  • 🔤 Making text bold
  • 📝 Add sticky notes to the book contents
  • ✨ Medium-like features
  • 🎨 Creating highlights in ReactJS
  • 💡 ReactJS highlighter
  • 📌 Mark text in ReactJS

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js (v14.x.x or later) and npm/yarn installed on your system.

Installation

  1. Clone the repository:

    git clone https://github.com/vivekneupane11/book-website-nextjs.git
  2. Navigate to the project directory:

    cd book-website-nextjs
  3. Install the dependencies:

    npm install
    # or
    yarn install

Running the Project

To start the development server, run:

npm run dev
# or
yarn dev

Open your browser and go to http://localhost:3000 to see the app in action.

Scripts

Here are some useful scripts you can run:

  • dev: Starts the development server.
  • build: Builds the app for production.
  • start: Starts the production server.

Project Structure

book-website-nextjs/
├── pages/            # Next.js pages
├── components/       # React components
├── public/           # Static files
├── styles/           # CSS styles
└── ...

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Open a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contact

If you have any questions or suggestions, feel free to reach out through my social media:

Twitter
YouTube
LinkedIn

Video Tutorial

You can watch a tutorial on how to create this app here.