The Whisker Chat App is a Websocket based messaging application built using Golang and SvelteKit. It allows users to connect and exchange messages in real-time, leveraging the power of PocketBase as the backend. The app offers a simple and intuitive interface, supporting group chats for smooth and seamless communication.
- Real-time messaging: Instantly send and receive messages in real-time.
- Group chats: Engage in groups to chat with multiple users.
- User-friendly interface: The app's intuitive design makes it easy for users of all levels to navigate and use.
- Online status: Know when other users are online and available for chat.
- Image sharing: Share images or youtube videos with your friends to make conversations more engaging.
- Message history: Access your chat history and previous conversations (up to 256 messages).
-
Clone the repository:
git clone https://github.com/tastycrayon/whisker
-
Navigate to the project directory:
cd whisker
-
Build the Docker image:
docker build -t whisker .
-
Run the Docker container:
docker run -p 8080:8080 whisker
The Chat App can be customized using the following environment variables:
PUBLIC_POCKETBASE_URL
: Set the public URL for PocketBase. By default, it useshttps://whisker.fly.dev
.PUBLIC_WEBSOCKET_URL
: Set the public WebSocket URL for real-time communication. By default, it useswss://whisker.fly.dev/ws
.
Environment variable can be edited in Dockerfile
and ./client/.env
.
-
Start pocketbase server with debug mode
go run main.go serve --dir ./pb_data --debug
Or. Use Air for hot reload
go install github.com/cosmtrek/air@latest air serve --dir ./pb_data --debug
-
Import collection schema from
pb.collection.json
-
Enter client folder and install packages
cd client npm i
-
Run devlopement server on http://127.0.0.1:5173
npm run dev -- --host 127.0.0.1
- Golang: Programming language used to build the backend server for the Chat App.
- Svelte: Frontend framework used to build the user interface for the web application.
- PocketBase: Backend database for storing and managing chat data in real-time.
Contributions are welcome! If you find any issues or have suggestions for improvement, feel free to submit a pull request.
This project is licensed under the MIT License.
For any inquiries or feedback, please email me at [email protected]