Skip to content

anshulltyagii/Sparkify

Repository files navigation

Sparkify

Sparkify is a social platform project. It provides a platform for users to share photos, connect with friends, and explore a visual feed of content.

Table of Contents

Here are some of the features of Sparkify 👇

⚛️ Tech Stack: React.js, MongoDB, Node.js, Express, Tailwind, Typescript

🔐 Authentication with JSONWEBTOKENS (JWT)

🔥 React Query for Data Fetching, Caching etc.

👥 Suggested Users to Follow

✍️ Creating Posts

🗑️ Deleting Posts

❤️ Liking Posts

🔒 Delete Posts (if you are the owner)

📝 Edit Profile Info

🖼️ Edit Profile Image

📷 Image Uploads

🔔 Send Notifications

⏳ And much more!

Installation

To get started with Sparkify, follow these steps:

  1. Clone the repository

  2. Navigate to the Project directory

  3. Install dependencies

  4. Configure the environment: Edit the .env.local file in the root directory and add the necessary environment variables (database connection, etc.).

  5. Start the application

Features

1. User Authentication

Sparkify implements secure user authentication to ensure a personalized experience for each user.

2. Profile Management

Users can create and manage their profiles, including updating profile pictures, bios, and other information.

3. Photo Sharing

Sparkify allows users to upload and share photos with their followers.

4. Feed Exploration

Users can explore a visual feed of content, including posts from their followers and popular content on the platform.

5. Likes and Saving Posts

Users can engage with content by liking photos, and saving posts.

Usage

  1. Register for a new account or log in with existing credentials.
  2. Explore the platform by viewing the feed and engaging with content.
  3. Share your own photos and updates with followers.
  4. Connect with friends and build your social network.

Contributing

We welcome contributions to Sparkify! If you'd like to contribute, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and submit a pull request.

For major changes, please open an issue first to discuss the proposed changes.