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

https://github.com/heintayzar-hm/community


https://github.com/heintayzar-hm/community

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        



Community

# 📗 Table of Contents

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

# 📖 [Community]

**[Community]** is a community app for farmers and their news.

## 🛠 Built With

### Tech Stack

Client

### Key Features

> Describe between 1-3 key features of the application.

- can login
- can comment
- can see posts

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://community-nine-ecru.vercel.app/)

(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:

- nodejs installed
- code editor
- basic react and tailwind ideas

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/heintayzar-hm/community.git
cd community
```

### Install

Install this project with:

```sh
npm install
```

### Usage

To run the project, execute the following command:

### Run tests

To run tests, run the following command:
(currently no tests)

### Deployment

You can deploy this project using: Vercel

(back to top)

## 👥 Authors

👤 **Author1**

- GitHub: [@githubhandle](https://github.com/githubhandle)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)

👤 **Author2**

- GitHub: [@githubhandle](https://github.com/githubhandle)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)

(back to top)

## 🔭 Future Features

- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project...

(back to top)

## 🙏 Acknowledgments

I would like to thank...

(back to top)

## ❓ FAQ (OPTIONAL)

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Question_1]**

- [Answer_1]

- **[Question_2]**

- [Answer_2]

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)