SocialMediaApp Readme

Overview

Welcome to SocialMediaApp, a modern social media application built with Vite, React TypeScript, Tailwind CSS, Shadcn, Tanstack Query, and Appwrite Cloud for the backend. This application aims to provide users with a seamless and enjoyable social media experience.

Prerequisites
Getting Started
Project Structure
Technologies Used
Features
Contributing
License

Prerequisites

Before you begin, ensure you have the following dependencies installed:

Node.js
npm or yarn

Getting Started

Clone the repository:

git clone https://github.com/ajeibi/social-media-app.git

Navigate to the project directory:
```
cd social-media-app
```
Install dependencies:
```
npm install
# or
yarn
```

Create a .env file in the root directory and add your Appwrite Cloud API key:

REACT_APP_APPWRITE_ENDPOINT=https://your-appwrite-endpoint/api
REACT_APP_APPWRITE_PROJECT_ID=your-appwrite-project-id
REACT_APP_APPWRITE_API_KEY=your-appwrite-api-key

Start the development server:
```
npm run dev
# or
yarn dev
```
Open your browser and visit http://localhost:3000 to view the app.

Project Structure

src/: Contains the source code for the application.
- components/: Reusable React components.
- pages/: Individual pages of the application.
- styles/: Stylesheets and Tailwind CSS configurations.
- utils/: Utility functions and helper modules.
public/: Static assets and HTML template.
appwrite/: Appwrite Cloud configurations and services.

Technologies Used

Vite: A fast frontend development build tool.
React: A JavaScript library for building user interfaces.
TypeScript: A superset of JavaScript that adds static typing.
Tailwind CSS: A utility-first CSS framework.
Shadcn: A lightweight state management library.
Tanstack Query: A powerful data-fetching and caching library.
Appwrite: An open-source backend server for web and mobile developers.

Features

User authentication and authorization.
Posting and sharing updates.
Real-time notifications.
Friend requests and connections.
Explore and discover new content.

Contributing

If you would like to contribute to the project, please follow the Contribution Guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Ajeibi/Snapgram