Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koodeau/sveltekit-metawrite
Everything you need to build a SvelteKit project powered with Appwrite backend, starter powered by Increasio.
https://github.com/koodeau/sveltekit-metawrite
appwrite metawrite svelte sveltekit sveltekit-template
Last synced: 3 months ago
JSON representation
Everything you need to build a SvelteKit project powered with Appwrite backend, starter powered by Increasio.
- Host: GitHub
- URL: https://github.com/koodeau/sveltekit-metawrite
- Owner: koodeau
- License: mit
- Created: 2022-02-18T18:07:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T09:49:28.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T19:11:52.129Z (4 months ago)
- Topics: appwrite, metawrite, svelte, sveltekit, sveltekit-template
- Language: JavaScript
- Homepage: https://increas.io/metawrite
- Size: 211 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Support Us
**Get free $100 credits on DigitalOcean:**
**Join our Discord:**
# SvelteKit Metawrite Starter Template
Everything you need to build a SvelteKit project powered with Appwrite backend, starter powered by [Increasio](https://increas.io/).
## Important to mention
We'll update this starter template once we fix issue with installing `metawrite` package using `npm install metawrite`. But with this template it's easy to get latest version of our `metawrite` package because we still use npm.
**Before developing install the `metawrite` package.**
```bash
npm run metawrite
```
### Keep in mind
- If you have to package your own lib source the you can rename existing `package` folder or use another output directory for `svelte-kit package`.
- Also, if you're not using Docker or any CI/CD, custom workflows for deployment, then consider removing `package` folder from `.gitignore` file and run `npm run metawrite` before commiting or deployment.
## Developing
Once you've installed Metawrite with `npm run metawrite` and installed other dependencies with `npm install` (or `pnpm` or `yarn`), 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
```
## Building
To create a production version of your app:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
## Building with Docker
If you need build command:
```bash
docker-compose up --build
```
This is a good option for deployment, because starter template has all required configs to automatically install newest version of `metawrite`, all dependencies and start SSR server using Node.
# Appwrite and SvelteKit Combo
You can add this template to your Appwrite Server configuration by pasting following on top of your Appwrite's `docker-compose.yml` services:
```yml
services:
frontend:
image: koodeau/sveltekit-metawrite
container_name: frontend
restart: unless-stopped
env_file: .env
environment:
VITE_SITE_URL: ${VITE_SITE_URL}
VITE_ENDPOINT_URL: ${VITE_ENDPOINT_URL}
VITE_PROJECT_ID: ${VITE_PROJECT_ID}
VITE_LOCALE: ${VITE_LOCALE}
# Add more env variables here
volumes:
- ./app:/srv/frontend
ports:
- "3000:3000"
```
And add following to your Appwrite's `.env` file:
```
VITE_SITE_URL=localhost
VITE_ENDPOINT_URL=http://localhost/v1
VITE_PROJECT_ID=example
VITE_LOCALE=en
```
> Don't forget to change values to match your server configuration.
> To deploy your app if you're not using Docker, you may need to install another [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.