jcreek/SvelteKitSaasBoilerplate
1
0
Fork 0
mirror of https://github.com/jcreek/SvelteKitSaasBoilerplate.git synced 2026-07-12 18:43:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(*): Create basic readme

Browse Source
This commit is contained in:
Josh Creek
2024-04-29 20:21:22 +01:00
parent 079ccad6ba
commit 3eb10a9452
1 changed files with 30 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+30 -2
View File
@@ -1,2 +1,30 @@
# SvelteKitSaasBoilerplate
A SvelteKit boilerplate project for a SaaS
# SvelteKit Saas Boilerplate
A SvelteKit boilerplate project for a Software As A Service (SaaS) application, to get you started quickly.
## Developing
After you have cloned the repository you can install the dependencies with `npm install`, and start a development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
An example `.env` file is provided in the repository. You will need to copy `.env.example` to `.env` and fill in the values with your own credentials.
## Building
To create a production version:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
## Hosting and Tech Stack
This application is designed to run on [Netlify](https://www.netlify.com/) and uses [Supabase](https://supabase.io/) for database storage and user authentication ([Supabase Auth](https://supabase.com/auth)).