CorentinGS / Astrocket

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Astrocket
Astrocket

A simple chat app using Astro + Pocketbase.

Built with Devbox

Key FeaturesHow To DevelopHow To DeployDemoDisclaimerLicense

screenshot

Key Features

  • Modern UI - Astrocket provides a modern interface that is easy to use and intuitive.
  • Self-hosted - Astrocket is designed with self-hosting in mind and allows users to deploy their instance quickly and easily using prebuilt docker images.
  • Secure - Astrocket provides secured account creation using oauth2. Thus, people don’t need to worry about their privacy as they can control their data/messages and don’t rely on third-party providers.

How To Develop

Follow the instructions on the backend and frontend READMEs.

How To Deploy

Using Docker Compose

You can deploy the app using docker-compose. You can find an example of a docker compose file here.

If you want to use the prebuilt images, you can edit the docker-compose.yml file to use the images from the GitHub packages.

docker compose up -d

Default data

The default data is stored in the backend/pb_data for pocketbase binaries and data for docker compose volumes. data is a copy of backend/pb_data and is used by docker compose. If you don't want to use the default data, you can remove both folders and they will be recreated on the next start. Keep in mind that if you remove the data, you will lose all the messages and users.

If for some reason docker doesn't load the default data, you can load copy the data from backend/pb_data to data and restart the containers.

The default admin user is admin@corentings.dev and the password is admin123456789. I recommend you to change the admin password as soon as possible.

Demo

You can access the demo here.

You can login using the following credentials: username: demo password: demo123456789

Tests

A list of tests can be found here.

Features

A list of features can be found here.

Disclaimer

This project is for educational purposes only. It is not intended to be used in production. The project is destined to be presented as a final project for a course at IU International University of Applied Sciences.

License

MIT


corentings.dev  ·  GitHub @CorentinGS

About

License:MIT License


Languages

Language:Astro 71.0%Language:TypeScript 18.9%Language:JavaScript 6.1%Language:Go 2.1%Language:Dockerfile 1.1%Language:CSS 0.5%Language:Shell 0.2%