About Grafhy-SSM

GRAFHY is a virtual communication platform that enables users to exchange messages, posts, and images made with Python and Vue.js

v

Published by

vitorcarvalho67

Visit View Profile

README.md

View on GitHub

English | Рortuguês

Imagem logo

GRAFHY (social media)

GitHub stars GitHub languages top

GRAFHY is a virtual communication platform that enables users to exchange messages, posts, and images. Furthermore, it offers features such as creating conversation groups, user login and registration, real-time encrypted messaging, message and post notifications, user profiles with photos, and encrypted passwords. Its MySQL database ensures efficient management of user interactions, making it a comprehensive and secure platform for online communication.

Technology

Python
FastAPI
MySQL
Minio
JavaScript
Nginx
Vue
Docker-compose
Tauri

How To Use

git clone https://github.com/VitorCarvalho67/Grafhy-SSM.git

Navigate to the project directory on sever side

cd Grafhy-SSM/server

Create a virtual environment (venv) for the project

python -m venv venv

Activate the virtual environment. On Windows:

.\venv\Scripts\activate

On macOS and Linux:

source venv/bin/activate

Install the project's dependencies from requirements.txt.

pip install -r requirements.txt

Running the server side

uvicorn main:app --reload

Running the client side

Navigate to the project directory on client side, install the dependencies and run the project

cd client
npm run dev

Screenshots

Running with docker

[!IMPORTANT] remember to uncomment .env.example and remove .example from the file name.

sudo docker-compose build
sudo docker-compose up
# or 
sudo docker-compose up -d

Contributing

Contributions to this project are welcome. Please follow these steps to contribute:

Fork the repository.
Create a new branch for your feature or bug fix.
Commit your changes.
Push to the branch.
Submit a pull request.

Grafhy-SSM