An open API service indexing awesome lists of open source software.

https://github.com/iamsjunaid/tweetx-web

TweetX is a user-friendly social media platform that simplifies the way you connect and share in the digital realm. With a seamless user experience, TweetX empowers users with essential features for authentic engagement.
https://github.com/iamsjunaid/tweetx-web

css firebase html javascript react tailwindcss

Last synced: 10 months ago
JSON representation

TweetX is a user-friendly social media platform that simplifies the way you connect and share in the digital realm. With a seamless user experience, TweetX empowers users with essential features for authentic engagement.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [🎥 Walkthrough Video](#walkthrough-video)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 About the Project

TweetX App Description:

TweetX is a user-friendly social media platform that simplifies the way you connect and share in the digital realm. With a seamless user experience, TweetX empowers users with essential features for authentic engagement.

## 🛠 Built With

### Tech Stack

HTML

CSS

Javascript

ReactJS

Tailwind

Firebase

(back to top)

### Key Features

*Sign Up/Login*: Get started with TweetX by creating a secure account or logging in effortlessly, ensuring a personalized and safe experience.

*Post 2-Sentence Texts*: Express yourself concisely with 2-sentence text posts, capturing your thoughts and ideas with simplicity and impact.

*View Personal Posts*: Access a personalized feed showcasing your own posts, making it easy to revisit and reflect on your contributions.

*Explore Other Users*: Discover a diverse community by exploring a list of other users, each with their unique perspectives and content.

*Follow Users*: Build meaningful connections by following other users. Stay connected with the latest updates from those you find interesting.

*Dynamic Feed*: Experience a dynamic feed that consolidates posts from users you follow. If you follow 3 users, and each has posted 10 messages, your feed will display 30 messages chronologically, providing a comprehensive view of your network's activity.

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://tweetx-kez3.onrender.com/)

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need to clone or fork and run it in a browser

### Setup

Clone this repository to your desired folder:

Example commands:

```sh
cd my-folder
git clone https://github.com/iamsjunaid/tweetx-web.git
```
For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo

### Install

- To install the package
```sh
npm install
```

### Usage

- To run the project

```sh
npm start
```

- To check the linter issues

```sh
npx eslint "**/*.{js,jsx}"
```

```sh
npx stylelint "**/*.{css,scss}"
```

(back to top)

## 👥 Authors

👤 Author : **Junaid Ahmed Syed**

- Github : [@GitHub](https://github.com/iamsjunaid)
- LinkedIn : [@LinkedIn](https://www.linkedin.com/in/junaidahmedsyed/)

(back to top)

## 🔭 Future Features

*Picture Upload* Users will be upload a profile picture to their account.

*Like Posts* Users will be able to like posts from other users.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/iamsjunaid/tweetx-web/issues ).

(back to top)

## ⭐️ Show your support

If you like this project you can give a Star at project's [GitHub page](https://github.com/iamsjunaid/tweetx-web).

(back to top)

## 🙏 Acknowledgments

Design inspiration taken from : [](https://drive.google.com/drive/folders/1dWZjkH7sqtagKuxRMznyS4UURAmL4sZG?usp=sharing)

(back to top)

## 📝 License

This project is [MIT](https://github.com/iamsjunaid/tweetx-web/blob/main/LICENSE) licensed.

(back to top)