Giter Site home page Giter Site logo

astrocket's Introduction


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 [email protected] 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

astrocket's People

Contributors

corentings avatar renovate[bot] avatar dependabot[bot] avatar imgbotapp avatar

Stargazers

Dylan avatar Nikola Hristov avatar David Barbier avatar Rishi Raj Jain avatar

Watchers

 avatar

Forkers

fossabot

astrocket's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

  • WARN: File contents are invalid JSON but parse using JSON5. Support for this will be removed in a future release so please change to a support .json5 file name or ensure correct JSON syntax.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

  • Update all non-major dependencies (@astrojs/sitemap, @astrojs/solid-js, @tailwindcss/typography, @vite-pwa/astro, astro, astro-compress, astro-critters, astro-font, cypress, daisyui, ghcr.io/corentings/astrocket/backend, ghcr.io/corentings/astrocket/frontend, github.com/pocketbase/pocketbase, sharp, solid-emoji-picker, solid-markdown, vite)
  • Update dependency @iconify-icon/solid to v2

Detected dependencies

docker-compose
docker-compose.yml
  • ghcr.io/corentings/astrocket/backend v0.3.0
  • ghcr.io/corentings/astrocket/frontend v0.3.0
dockerfile
backend/Dockerfile
  • golang 1.22-alpine
  • alpine 3.19
frontend/Dockerfile
  • node 20-alpine
  • node 20-alpine
  • node 20-alpine
frontend/DockerfileProd
  • node 20-alpine
  • node 20-alpine
  • node 20-alpine
github-actions
.github/workflows/docker-publish-front.yml
  • actions/checkout v4
  • sigstore/cosign-installer v3.5.0@59acb6260d9c0ba8f4a2f9d9b48431a222b68e20
  • docker/setup-buildx-action v3.3.0@d70bba72b1f3fd22344832f00baa16ece964efeb
  • docker/login-action v3.1.0@e92390c5fb421da1463c202d546fed0ec5c39f20
  • docker/metadata-action v5.5.1@8e5442c4ef9f78752691e2d8f8d19755c6f78e81
  • docker/build-push-action v5.3.0@2cdde995de11925a030ce8070c3d77a52ffcf1c0
.github/workflows/docker-publish.yml
  • actions/checkout v4
  • sigstore/cosign-installer v3.5.0@59acb6260d9c0ba8f4a2f9d9b48431a222b68e20
  • docker/setup-buildx-action v3.3.0@d70bba72b1f3fd22344832f00baa16ece964efeb
  • docker/login-action v3.1.0@e92390c5fb421da1463c202d546fed0ec5c39f20
  • docker/metadata-action v5.5.1@8e5442c4ef9f78752691e2d8f8d19755c6f78e81
  • docker/build-push-action v5.3.0@2cdde995de11925a030ce8070c3d77a52ffcf1c0
.github/workflows/test.yml
  • actions/checkout v4
  • actions/setup-go v5
gomod
backend/go.mod
  • go 1.22.0
  • github.com/stretchr/testify v1.9.0
  • github.com/pocketbase/pocketbase v0.22.10
npm
frontend/package.json
  • @astrojs/node ^8.1.0
  • @astrojs/sitemap 3.0.5
  • @astrojs/solid-js ^4.0.1
  • @astrojs/tailwind 5.1.0
  • @emoji-mart/data ^1.1.2
  • @iconify-icon/solid ^1.0.5
  • @nanostores/solid ^0.4.2
  • @solidjs/router ^0.13.0
  • @tailwindcss/aspect-ratio ^0.4.2
  • @tailwindcss/forms ^0.5.3
  • @tailwindcss/line-clamp ^0.4.4
  • @tailwindcss/typography ^0.5.9
  • @vite-pwa/astro ^0.2.0
  • astro 4.2.8
  • astro-compress ^2.2.8
  • astro-compressor ^0.4.1
  • astro-critters ^2.0.11
  • astro-font ^0.0.80
  • astro-iconify ^1.2.0
  • daisyui ^4.6.1
  • nanostores ^0.10.0
  • pocketbase ^0.21.0
  • remark-gemoji ^8.0.0
  • remark-gfm ^4.0.0
  • rollup ^4.9.6
  • sharp ^0.33.2
  • solid-emoji-picker ^0.2.1
  • solid-js ^1.8.12
  • solid-markdown ^2.0.0
  • solid-textarea-autosize ^0.0.5
  • tailwindcss ^3.4.1
  • twemoji ^14.0.2
  • vite 5.2.10
  • autoprefixer ^10.4.7
  • cypress ^13.6.4
  • organize-imports-cli ^0.10.0
  • postcss ^8.4.33
  • prettier ^3.2.2
  • prettier-plugin-astro ^0.13.0
  • typescript ^5.3.2
  • vite-imagetools ^7.0.0
  • sharp ^0.33.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.