Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.27 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.27 KB

Proseify - Comic App

Proseify is a web application that allows users to read comic books online. It provides a user-friendly interface for browsing, viewing, and enjoying comic book content.

Introduction

Proseify is built using React.js and utilizes React Router for navigation. It fetches comic book data from an API to display comic details and pages. Users can browse through different comics, view comic details, and read individual pages.

Features

  • Browse and read comic books online
  • View comic details including cover image, title, and summary
  • Navigate through comic pages using intuitive controls
  • Like favorite comics to access them easily (feature under development)
  • Responsive

Installation

To run Proseify locally, follow these steps:

  1. Clone the repository: git clone https://github.com/0x0is1/prose
  2. Navigate to the project directory: cd prose
  3. Install dependencies: npm install:backend
  4. Install dependencies: npm install
  5. Start the development server: npm start
  6. Open your browser and visit http://localhost:3006 to view the application

Usage

  • Upon opening the application, you will see a list of comic books.
  • Click on a comic to view its details and start reading.
  • Use the navigation controls to move between comic pages.
  • Enjoy reading your favorite comics online!

Folder Structure

  • src/: Contains the source code for the project.
    • components/: Reusable UI components used throughout the application.
    • pages/: Components representing different pages/routes of the application.
    • utils/: Utility functions and API fetching logic.
    • App.js: Main component containing the routing logic.
    • index.js: Entry point of the application.

Technologies Used

  • React.js
  • React Router
  • JavaScript (ES6+)
  • HTML5
  • CSS3

Previews

preview 1

preview 2

preview 3

Contributing

Contributions to Proseify are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature-name
  3. Commit your changes: git commit -am 'Add new feature'
  4. Push to the branch: git push origin feature-name
  5. Submit a pull request

License

This project is licensed under the MIT License.