Skip to content

A platform where interested ones can post and read great shayaris and poems

License

Notifications You must be signed in to change notification settings

ag21o9/VerseWhisper

Repository files navigation

Verse Whisper

Verse Whisper is a platform where users can log in and publish their own shayaris. Users can also browse through shayaris uploaded by others and share their poetic creations.

Table of Contents

Features

  • User login system for personalized experience.
  • Users can publish their own shayaris.
  • Browse and read shayaris uploaded by other users.
  • Easy-to-use interface for uploading and managing shayaris.

Installation

To get started with the Verse Whisper platform locally, follow the steps below:

  1. Clone the repository:
    git clone https://github.com/YOUR-USERNAME/verse-whisper.git
  2. Navigate to the directory and Install dependencies:
    npm install
  3. Start the application:
    npm run dev
    

Usage

Once the application is running:

Go to http://localhost:3000 in your browser. Create an account or log in to your existing account. Start publishing or browsing shayaris! Use the upload feature to share your own shayaris with the community.

Contributing

We welcome contributions! Please follow the steps in the CONTRIBUTION.md file to learn how to get involved.

To contribute:

  • Fork the repository.
  • Create a feature branch.
  • Commit your changes.
  • Open a pull request.

Environment variables

CONNECTION_STRING=your-database-connection-string

Key Adjustments:

  • CONNECTION_STRING section added under Environment Variables.
  • The .env file setup is explained clearly for the database connection.

Make sure to replace your-database-connection-string, YOUR-USERNAME, and your Contact Information where necessary!

Contact

For any inquiries or questions, please reach out to the project maintainer:

Name: Abhijeet Gupta Email: ag21210909@gmail.com GitHub: ag21o9

About

A platform where interested ones can post and read great shayaris and poems

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published