Self Hosted App Starter screenshot

Self Hosted App Starter

Author Avatar Theme by Xiaoluoboding
Updated: 14 Aug 2024
73 Stars

A starter for the self-hosted app, help you to build your next full-stack project. https://sha-starter.onrender.com

Categories

Overview

SHA is a full-stack starter built on top of the GSVT Stack, which includes Go, SQLite, Vue 3, and Tailwind CSS. It is a self-hosted solution that can be easily deployed using Docker. The theme allows users to store data using the SQLite database and offers flexibility in choosing a front-end technology stack, with Vue 3 being the default option. Deployment options include Railway and Render.

Features

  • GSVT Stack: SHA is built on top of the GSVT Stack, which includes Go, SQLite, Vue 3, and Tailwind CSS.
  • Self-hosted with Dockerfile: The theme can be self-hosted using the provided Dockerfile for easy deployment.
  • SQLite Database: Users can store their data using the SQLite database.
  • Flexible Front-end Tech Stack: SHA allows users to choose their preferred front-end technology stack, with Vue 3 as the default option.
  • Railway / Render Deployment: The app can be easily deployed on the Railway or Render deploy services.
  • Backend Live Reload: The backend of the application supports live reload for easier development.
  • Frontend Live Reload: Changes to the frontend or backend code trigger live reload for seamless development experience.

Installation

To install SHA, please follow these steps:

  1. Prerequisites:

    • Go (1.16 or later)
    • Air (1.27.10 or later) - required for backend live reload
    • pnpm
  2. Setup:

    • Install Air using the following command: pnpm add -g air
    • Pull the source code of SHA.
  3. Start backend:

    • Use Air to start the backend with live reload: air
  4. Change open file limit:

    • If you encounter an “error: too many open files” error, you may need to change the open file limit on your system.
  5. Start frontend:

    • Start the frontend with live reload.

Once the above steps are completed, SHA should be running at http://localhost:3399. Changes to the frontend or backend code will trigger live reload.

Summary

SHA is a full-stack starter theme built on the GSVT Stack, offering flexibility in front-end technology and easy deployment options. With features like live reload and a self-hosted Docker option, it provides a convenient development environment. The theme is designed to store data using the SQLite database and is licensed under the MIT license.