Scott.Idem/OSIT-AE-App-Svelte
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finalize README with updated deployment instructions

Browse Source
This commit is contained in:
Scott Idem
2026-03-09 22:27:56 -04:00
parent 9b285d7fec
commit 38b3164a0c
1 changed files with 16 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@@ -215,62 +215,21 @@ More packages related to the Tiptap editor???
npm install @tiptap/extension-link @tiptap/extension-bullet-list @tiptap/extension-history @tiptap/extension-typography @tiptap/extension-underline
```
## Build
### Environment file
## Environment file
The application uses standard SvelteKit `.env` files for build-time configuration (specifically for `PUBLIC_` prefixed variables).
### ".env"
- **`.env.staging`**: Used by `npm run deploy:staging`.
- **`.env.prod`**: Used by `npm run deploy:prod`.
- **`.env.local`**: Used during local development (`npm run dev`).
This is the default used if others are not found when when "npm run dev" or "npm run build" is run.
**Note:** Runtime variables (like private API keys or DB credentials) are managed in the deployment directory's `.env` file and passed to the containers via Docker Compose.
### ".env.local"
This is used when "npm run dev" is run. This is not used in the production build.
### ".env.production"
This is used when "npm run build" is run. This is not used in the development build.
### ".env:prod"
This is modified to allow for a staging environment and production environment built.
### ".env:staging"
This is modified to allow for a staging environment and production environment built.
### Example Important Values when running in dev:
Note: Environment values need to be updated when our home IP address changes. Be sure to check the Aether Container Environment and Aether Node App (SvelteKit) Environment files for the correct IP address. The Node Docker environment needs to be updated here and in the .env file that Docker will read. This needs to be improved later...
```bash
DOCKER_AE_API_DEV_SERVER_EXTRA_HOST=dev-api.oneskyit.com:108.48.200.147
DOCKER_AE_API_SERVER_EXTRA_HOST=dev-api.oneskyit.com:108.48.200.147
PUBLIC_AE_API_SERVER=api.oneskyit.com
PUBLIC_AE_API_BAK_SERVER=bak-api.oneskyit.com
```
# create-svelte
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
## Creating a project
If you're seeing this, you've probably already done this step. Congrats!
```bash
# create a new project in the current directory
npm create svelte@latest
# create a new project in my-app
npm create svelte@latest my-app
```
---
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
Start a local development server:
```bash
npm run dev
@@ -279,14 +238,16 @@ npm run dev
npm run dev -- --open
```
## Building
## Deployment (Production/Staging)
To create a production version of your app:
To create a production or staging version and deploy it to the local containers:
```bash
npm run build
# For Staging/Dev
npm run deploy:staging
# For Production
npm run deploy:prod
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
These commands use the multi-stage **Dockerfile** to build the app in a clean environment and automatically restart the corresponding Docker containers.