Skip to content

Commit

Permalink
chore: Added features to readme and updated terminal preview (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
zoey-kaiser authored Jun 21, 2024
1 parent 0ed008f commit f9acec0
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
Binary file modified .github/create-sidebase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@
Get started with the <a target="_blank" href="https://sidebase.io/sidebase">sidebase</a> fully typed Nuxt 3 starter by running <code>npm create sidebase@latest</code>
</p>

![sidebase](./.github/create-sidebase.png)
<p align="center">
<img src="./.github/create-sidebase.png" alt="sidebase preview" width="700" />
</p>

## create-sidebase

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
Expand All @@ -19,9 +23,7 @@
[![Follow us on Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/sidebase_io)
[![Join our Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/NDDgQkcv3s)

## create-sidebase

The productive way to build fullstack Nuxt 3 applications.
> The productive way to build fullstack Nuxt 3 applications.
sidebase is a web app development kit to build production ready fullstack apps quickly. We build sidebase to provide a modular, modern, fully-typed and best-practice approach to make your ideas a reality. Around a core of TypeScript and Nuxt 3 sidebase adds components like databases, CI, authentication, testing and more.

Expand All @@ -34,3 +36,16 @@ sidebase is a web app development kit to build production ready fullstack apps q

[license-src]: https://img.shields.io/npm/l/create-sidebase.svg
[license-href]: https://npmjs.com/package/create-sidebase

## Features

- Automatic installation and setup of popular Nuxt3 modules
- [TailwindCSS](https://tailwindcss.com/): A utility-first CSS framework packed with classes that can be composed to build any design, directly in your markup.
- [Naive UI](https://www.naiveui.com/): A Vue 3 Component Library. Complete, Customizable, Uses TypeScript, Fast.
- [Prisma ORM](https://www.prisma.io/): Next-generation Node.js and TypeScript ORM.
- [tRPC 10](https://trpc.io/): Build end-to-end typesafe APIs in Nuxt applications.
- [sidebase-auth](https://sidebase.io/nuxt-auth): Authentication via OAuth, Credentials and magic email flows. Wraps the popular NextAuth.js with 12k stars.
- [i18n](https://i18n.nuxtjs.org/): I18n (Internationalization) module for your Nuxt project powered by Vue I18n.
- Premade CI pipeline templates, built for Nuxt
- [Github Actions](https://docs.github.com/en/actions)
- [DroneCI](https://www.drone.io/)

0 comments on commit f9acec0

Please sign in to comment.