https://github.com/ahmadhabibi14/vftalk
AAAAAAAAAAAAAAAAAAAAAAAAAA
https://github.com/ahmadhabibi14/vftalk
chatapp fiber-go golang handlebars mysql tailwindcss websocket zerolog
Last synced: 5 months ago
JSON representation
AAAAAAAAAAAAAAAAAAAAAAAAAA
- Host: GitHub
- URL: https://github.com/ahmadhabibi14/vftalk
- Owner: ahmadhabibi14
- License: mit
- Created: 2023-09-24T09:15:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-01T16:22:24.000Z (about 1 year ago)
- Last Synced: 2024-12-04T06:08:23.840Z (5 months ago)
- Topics: chatapp, fiber-go, golang, handlebars, mysql, tailwindcss, websocket, zerolog
- Language: Go
- Homepage:
- Size: 27.5 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VFtalk - Chat App
## Tech stack:
- Programming Language: [Go-Lang](https://go.dev), [JavaScript](https://www.javascript.com/)
- Http Router: [Go Fiber](https://gofiber.io)
- Frontend Library: [Astro](https://astro.build/), [Svelte](https://svelte.dev)
- UI Library: [TailwindCSS](https://tailwindcss.com/), [Svelte Icon Pack](https://leshak.github.io/svelte-icons-pack/)
- DBMS: [MariaDB](https://mariadb.org/)
- Container: [Docker](https://www.docker.com/)
- CI/CD: [Github Action](https://docs.github.com/en/actions)
- Web Server: [NGINX](https://www.nginx.com/)
- SMTP: [Docker-mailserver](https://github.com/docker-mailserver/docker-mailserver), [Mailhog](https://github.com/mailhog/MailHog)
### How to start development:
```shell
##### Install dependencies
go mod tidy
cd views/pages
pnpm install
##### Set up docker
docker-compose up -d
docker network create vftalk-network
##### Start App
go run main.go web
# or
air web
##### Start nodejs for build javascript or css stuff
cd views/pages
pnpm watch
```
### MariaDB
```shell
##### Login to MariaDB CLI
docker exec -it vftalk-db mariadb -u root -p
##### Database migration
### Install golang-migrate
go install -tags "postgres,mysql" github.com/golang-migrate/migrate/v4/cmd/migrate@latest
### Create Migration
migrate create -ext sql -dir database/migration migration_state
## or
make migrate state=migration_state
### Run migration
make migrate-up
make migrate-down
## or
go run main.go migrate-up
go run main.go migrate-down
```
### Docker
```shell
# Remove all containers
docker rm -f $(docker ps -aq)
# Remove containers
docker-compose down
```
### Deploy
```shell
cd deploy
##### Execute deploy script, it will automatically do their magic
./deploy.sh
#### or
## Configure github action script for CI/CD
## add github secrets, make sure which variable to store as defined at .github/workflows/deploy.yaml
```
### TODO:
- [x] User edit progile
- [ ] Limit online users to only 20
- [x] Login handler
- [x] API rate limit
- [x] Login page
- [x] Fix layout to not overflow
- [x] Responsive to mobile device
- [ ] Turn to Progressive Web App (PWA)
- [x] Add Database to store user data
- [ ] Add Database to store chats
- [x] User Info
- [ ] Add Tenor API for stickers and GIFs
- [ ] Upload picture in chats, and stickers from Tenor API
- [x] Use mailhog for SMTP in development, add to docker
- [x] Deploy to server (must use linux)
- [x] Add MariaDB to docker-compose
- [ ] Use docker-mailserver for SMTP in production
- [x] User can edit profile picture
- [ ] Image editor when update profile picture, specify for 1:1 ratio
- [ ] Compress image after user uploaded it
- [ ] Direct message
- [ ] Notification (server sent event)
- [ ] Active user list (for direct message)
- [x] Database migration
- [x] Add column for Google ID (OAuth) in MySQL