https://github.com/quentinwidlocher/materia

chat-application flask-api flask-socketio vuejs webapp websocket-chat

Last synced: about 2 months ago
JSON representation

Chat client & server

Host: GitHub
URL: https://github.com/quentinwidlocher/materia
Owner: QuentinWidlocher
Created: 2019-05-29T13:39:25.000Z (about 7 years ago)
Default Branch: develop
Last Pushed: 2023-01-07T05:54:59.000Z (over 3 years ago)
Last Synced: 2025-02-01T22:47:07.853Z (over 1 year ago)
Topics: chat-application, flask-api, flask-socketio, vuejs, webapp, websocket-chat
Language: TypeScript
Homepage: https://materia-87a70.web.app
Size: 2.69 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 40
Metadata Files:
- Readme: README.md

README

![Materia](/frontend/src/assets/logo.png)

# Materia

## What is Materia

Materia is a websocket chat client made with flask, socket.io and Vue JS.
Its goal is not to be better than the others, it's only a training.

## What is Materia made of ?

### Frontend

- Vue.js
- Bootstrap 4

### Backend

- Flask (1.0.3)
- Socket.io

## How to install

### 1) Setup the virtual environement

```
# Linux
python3 -m venv venv

# Windows
py -3 -m venv venv
```

### 2) Activate the virtual environement

```
# Linux
. venv/bin/activate

# Windows
venv\Scripts\activate
```

### 3) Install python requirements

```
pip install -r requirements.txt
```

### 4) Install npm requirements

```
./> npm install
./> cd frontend
./frontend> npm install
```

### 5) Build the frontend

```
./frontend> npm run-script build
```

### 6) Launch the flask server

```
./frontend> cd ..
./> python app.py
```

### 7) Open the served page

Go to `http://127.0.0.1:5000/`