Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Latest commit

 

History

History
49 lines (40 loc) · 1.54 KB

README.md

File metadata and controls

49 lines (40 loc) · 1.54 KB

Please note:

This project is no longer being maintained and has been replaced by the new sidebase docs.

sidebase

sidebase.io

With sidebase every new project feel like a fun side-project while scaling to production.

This is the website of sidebase, a modern, best-practice, batteries-included fullstack-app starter based on Nuxt3 and TypeScript.

Quick start

  1. Clone the repository
    git clone https://github.com/sidestream-tech/sidebase-website
  2. Go into the app/ directory
    cd app/
  3. Install the dependencies
    npm i
  4. Start developing (with database, backend, API, ... running) at localhost:3000
    npm run dev

Commands and Further Documentation

You can also:

  • npm run story for isolated component development using histoire
  • npm run test for testing
    • npm run test -- -u to update the component snapshots
    • npm run test -- -t "test describe text" to run a specific test
    • npm run test:ui to start the vitest UI
  • npm run lint for linting using eslint
  • npm run build for bundling using vite

Deployment

sidebase.io is hosted with GitHub Pages. GitHub automatically deploys the contents of the /docs folder. In order to force a redeployment run

npm run generate

in the /app folder. Once this is completed be sure to push the changes made to the docs folder.