Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 2.25 KB

README.md

File metadata and controls

91 lines (66 loc) · 2.25 KB

📢 Chirp Play

Welcome to Chirp Play, a platform where users can share videos and thoughts (chirps), interact with content, and connect with others.

⭐ Introduction

Chirp Play is a Next.js based web application designed to facilitate sharing, interaction, and engagement around videos and user-generated content called "chirps". Users can register, login, upload videos, like, comment, and much more.

🚀 Features

  • User Authentication:

    • Register and login securely.
    • Manage user profiles.

  • Content Sharing:

    • Upload videos and chirps (text thoughts).
    • Like and comment on videos and chirps.
    • View liked videos and watch history.

  • Search and Discovery:

    • Search for videos and chirps.
    • Explore trending content.

  • Interaction:

    • Like videos and chirps.
    • Comment on videos and chirps.
    • Like comments on videos.

⬇️ Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Node.js and npm installed on your machine.
  • MongoDB installed locally or access to a MongoDB instance.

Installation

Clone the repository:

git clone https://github.com/itisRamzan/chirp-play.git

Install dependencies:

cd chirp-play
npm install

Running the Application

Create a .env file in the root directory and add the following environment variables:

DB_HOST=
DB_NAME=
SESSION_SECRET=
JWT_SECRET=
NEXT_PUBLIC_CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=
RESEND_API_KEY=

Run the development server:

yarn run dev

📝 Usage

  • Navigate to http://localhost:3000 in your browser.
  • Register an account or log in if you already have one.
  • Start exploring and interacting with videos and chirps.

🤝 Contributing

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the repository
  2. Create a new 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

👉 Contact

For any inquiries or feedback, please reach out to: