Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dino-kupinic/communify

✨ A cutting-edge chat web app offering a seamless and intuitive real-time communication experience ✨
https://github.com/dino-kupinic/communify

docker express pinia socket-io typescript vue vue-router

Last synced: about 1 month ago
JSON representation

✨ A cutting-edge chat web app offering a seamless and intuitive real-time communication experience ✨

Awesome Lists containing this project

README

        

Image

# Communify

> Intuitive and simple groupchats.

## 🥳 Installation and Configuration

### Installation
1. clone the repository:
```bash
git clone https://github.com/Dino-Kupinic/Communify.git
```
2. `npm install` in frontend:
```bash
cd frontend && npm install
```
`⚠️ Important: you need to have docker CLI installed!`

3. run `compose.yaml`
```bash
cd .. && docker compose up
```
Continue with the configuration below.

### Configuration

5. create a `.env` file in `/frontend`. Example .env is provided.

`⚠️ Important: for hosting in the network, you should also change the BACKEND_URL file in frontend/src/db/pocketbase.ts:`
```ts
const POCKETBASE_URL = "http://:8090"

export const pb = new PocketBase(POCKETBASE_URL)

```
// WIP

`⚠️ Important: This tutorial only covers setting up with the vite dev server. If you want to use apache or ngnix, you will have to figure that out yourself.`

## 👌 Authors

- [@Dino Kupinic](https://www.github.com/Dino-Kupinic) (version 1 & 2)
- [@Johannes Kerbl](https://www.github.com/JKerbl) (version 1)
- [@Jannick Angerer](https://www.github.com/Neuery17Alt) (version 1)

## 🛠️ Tech Stack

**Frontend:** Vue.js

**Backend:** Pocketbase

**Database:** SQLite

## 🍿 License

[MIT](https://choosealicense.com/licenses/mit/)