Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/vitorcarvalho67/grafhy-ssm

GRAFHY is a virtual communication platform that enables users to exchange messages, posts, and images made with Python and Vue.js
https://github.com/vitorcarvalho67/grafhy-ssm

ci-cd docker-compose fastapi full-stack-application github-actions minio mysql-database nginx python3 s3-storage social-media-website-fastapi tauri vite vuejs website

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/vitorcarvalho67/grafhy-ssm
Owner: VitorCarvalho67
License: gpl-3.0
Created: 2023-07-12T01:40:08.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-20T19:41:26.000Z (11 months ago)
Last Synced: 2024-05-11T05:45:45.436Z (9 months ago)
Topics: ci-cd, docker-compose, fastapi, full-stack-application, github-actions, minio, mysql-database, nginx, python3, s3-storage, social-media-website-fastapi, tauri, vite, vuejs, website
Language: Vue
Homepage:
Size: 42.5 MB
Stars: 6
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

English |
Рortuguês

Imagem logo

# GRAFHY (social media)

[![GitHub license](https://img.shields.io/github/license/vitorcarvalho67/Grafhy-SSM)](vitorcarvalho67/Grafhy-SSM/blob/master/LICENSE)
![GitHub stars](https://img.shields.io/github/stars/vitorcarvalho67/Grafhy-SSM)
![Build Status](https://github.com/VitorCarvalho67/Grafhy-SSM/actions/workflows/ci.yml/badge.svg)
![GitHub languages top](https://img.shields.io/github/languages/top/vitorcarvalho67/Grafhy-SSM)
[![GitHub contributors](https://img.shields.io/github/contributors/VitorCarvalho67/Grafhy-SSM)](https://github.com/VitorCarvalho67/Grafhy-SSM/graphs/contributors)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2e2a5e150f9b4af3b6c95070f6526e01)](https://app.codacy.com/gh/VitorCarvalho67/Grafhy-SSM/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

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
```bash
git clone https://github.com/VitorCarvalho67/Grafhy-SSM.git
```

Navigate to the project directory on sever side
```bash
cd Grafhy-SSM/server
```

Create a virtual environment (venv) for the project
```bash
python -m venv venv
```

Activate the virtual environment.
On Windows:
```bash
.\venv\Scripts\activate
```

On macOS and Linux:
```bash
source venv/bin/activate
```

Install the project's dependencies from requirements.txt.
```bash
pip install -r requirements.txt
```

## Running the server side
```bash
uvicorn main:app --reload
```

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

```bash
cd client
npm run dev
```

## Screenshots

## Running with docker

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

```bash
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:

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