Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/andrianarivo/discuss

Last synced: about 17 hours ago
JSON representation

Host: GitHub
URL: https://github.com/andrianarivo/discuss
Owner: andrianarivo
License: mit
Created: 2023-12-09T16:24:16.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-01-02T13:03:44.000Z (about 1 year ago)
Last Synced: 2024-04-18T09:35:12.290Z (10 months ago)
Language: TypeScript
Size: 252 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



  


  
Discuss




# 📗 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)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Discuss 

**Discuss** is a web application that allows users to create and join discussion groups. Users can create posts and comment on posts in their groups. Users can also create private groups that require an invitation to join.

## 🛠 Built With 

### Tech Stack 

  Client

  


    React.js

  


  Server

  


    Next.js

  


Database

  


    SQLite

  


### Key Features 

- **Create Topic, Posts & Replies**

- **Read Posts and their replies**

- **Login/Signup via Github OAuth**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://discuss-topaz.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:

- **[Node.js](https://nodejs.org/en/)**

- **[npm](https://www.npmjs.com/)** or **[yarn](https://yarnpkg.com/)**

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/andrianarivo/discuss.git

```

### Install

Install this project with:

```sh

  cd my-project

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run dev

```

### Deployment

You can deploy this project using [Vercel](https://vercel.com/).

```sh

  vercel deploy

```

(back to top)


## 👥 Authors 

👤 **David**

- GitHub: [@andrianarivo](https://github.com/andrianarivo)

- Twitter: [@dandrianarivo](https://twitter.com/dandrianarivo)

- LinkedIn: [LinkedIn](https://linkedin.com/in/andrianarivo)

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/andrianarivo/discuss/issues).

(back to top)


## ⭐️ Show your support 

If you like this project consider giving it a ⭐️. 

(back to top)


## 🙏 Acknowledgments 

I would like to thank the following for their invaluable help and support:

- [Novity](https://novity.io)

- Stephen Grider for his amazing course on NextJS.

(back to top)


## 📝 License 

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

(back to top)