Skip to content

Commit 4ae4373

Browse files
committed
update README
1 parent 3be1b37 commit 4ae4373

File tree

3 files changed

+37
-1
lines changed

3 files changed

+37
-1
lines changed

.dockerignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,5 @@
2121
**/secrets.dev.yaml
2222
**/values.dev.yaml
2323
README.md
24+
node_modules
25+
package

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" />
1717
</a>
1818

19-
# SvelteKit-Appwrite Starter Template
19+
# SvelteKit Metawrite Starter Template
2020

2121
Everything you need to build a SvelteKit project powered with Appwrite backend, starter powered by [Increasio](https://increas.io/).
2222

@@ -66,4 +66,38 @@ docker-compose up --build
6666

6767
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.
6868

69+
# Appwrite and SvelteKit Combo
70+
71+
You can add this template to your Appwrite Server configuration by pasting following on top of your Appwrite's `docker-compose.yml` services:
72+
73+
```yml
74+
services:
75+
frontend:
76+
image: koodeau/sveltekit-metawrite
77+
container_name: frontend
78+
restart: unless-stopped
79+
env_file: .env
80+
environment:
81+
VITE_SITE_URL: ${VITE_SITE_URL}
82+
VITE_ENDPOINT_URL: ${VITE_ENDPOINT_URL}
83+
VITE_PROJECT_ID: ${VITE_PROJECT_ID}
84+
VITE_LOCALE: ${VITE_LOCALE}
85+
# Add more env variables here
86+
volumes:
87+
- ./app:/srv/frontend
88+
ports:
89+
- "3000:3000"
90+
```
91+
92+
And add following to your Appwrite's `.env` file:
93+
94+
```
95+
VITE_SITE_URL=localhost
96+
VITE_ENDPOINT_URL=http://localhost/v1
97+
VITE_PROJECT_ID=example
98+
VITE_LOCALE=en
99+
```
100+
101+
> Don't forget to change values to match your server configuration.
102+
69103
> 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.

static/logo.png

14.1 KB
Loading

0 commit comments

Comments
 (0)