StoReaders

Welcome to StoReaders, a platform for reading and sharing captivating stories.

Table of Contents

• Description
• Features
• Tech Stack
• Setup Instructions
• Contributing

Description

StoReaders is a web application that provides users with a seamless and interactive experience for reading and discussing stories. It offers a range of fictional stories across various genres, allowing users to explore and enjoy captivating narratives.

Features

• User-friendly interface for easy navigation and reading experience.
• Extensive collection of stories across different genres.
• Ability to rate and review stories.
• Ablility to comment on each chapter.
• Account management functionalities, including login, registration, and password recovery.

Tech Stack

• Frontend: Built with Next.js for server-side rendering and for dynamic user interfaces.
• Backend: Powered by Node.js and Express for server-side logic and API development.
• Database: MongoDB for efficient data storage and retrieval.
• Styling: Utilizes CSS modules for component-specific styling.
• Authentication: Implements JWT (JSON Web Tokens) for user authentication and session management.
• Deployment: Hosted on Vercel for seamless deployment and scalability.

Setup Instructions

To run the StoReaders application locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/Kalp22/StoReaders.git

2. Navigate to the project directory:

   cd StoReaders

3. Install dependencies:

   npm install

4. Start the development server:

   npm run dev

5. Open your browser and visit http://localhost:3000 to view the application.

Contributing

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

1. Fork the repository.
2. Create a new branch (git checkout -b feature/my-feature).
3. Make your changes.
4. Commit your changes (git commit -am 'Add new feature').
5. Push to the branch (git push origin feature/my-feature).
6. Create a new Pull Request.