This website is built with SvelteKit, Sass, & Typescript to compile a html/css/js application delivered by a Node.js server. PNPM manages all dependency packages. Docker is used to compile the app into a minified Ubuntu environment. Fly.io hosts the Docker Image to serve the completed website.
- Install Git Bash for deployment scripts & GitHub commits.
- Install Node.
- Install PNPM.
- Install flyctl for deployments.
- Install psql for remote SQL deployment.
- Ensure each of the above command line tools are accessible by PATH.
- Clone this repository to a directory on your computer. That directory will be referred to as
root. - Open a terminal in
root. - Run
pnpm iin the terminal to install all remaining app dependencies. From here, you can use & edit the app locally on your Windows machine. See ### Run Scripts for more information.
- Install
nodejsfrom pacman. - Install
pnpmfrom pacman. - Install
flyctl-binfrom the AUR. - Install
postgresqlfrom pacman. - Clone this repository to a directory on your computer. That directory will be referred to as
root. - Open a terminal in
root. - Run
pnpm iin the terminal to install all remaining app dependencies. From here, you can use & edit the app locally on your Arch Linux machine. See ### Run Scripts for more information.
- Add the
nodePackages.pnpmflyctlpostgresqlpackages to NixOS config or Home Manager config. - Run
sudo nixos-rebuild switchhome-manager switch. - Clone this repository to a directory on your computer. That directory will be referred to as
root. - Open a terminal in
root. - Run
pnpm iin the terminal to install all remaining app dependencies. From here, you can use & edit the app locally on your Arch Linux machine. See ### Run Scripts for more information.
To run a script, type pnpm run <script-name> into a terminal within the root folder.
| script-name | description |
|---|---|
start |
run start:dev |
start:dev |
create a local hot-reloading server at localhost:5173 to serve source code files |
start:preview |
run build:preview, create a local server at localhost:4173 to serve built code files |
build:preview |
build app using .env.development |
build:prod |
build app using .env |
deploy |
update app dependencies, run build:prod, run deploy:database, run deploy:secrets, run deploy:server |
deploy:database |
update postgres users, databases, tables, procedures, etc. |
deploy:secrets |
set flyctl secrets from .env file |
deploy:server |
deploy build folder to flyctl |
check |
evaluate Svelte syntax |
check:watch |
re-evaluate Svelte syntax when files are updated |
article |
cli to modify articles in the postgres database; pass -h for more details |
Some features of this app require secret database credentials. These secrets cannot be shared in public.
- Obtain the secrets.
- Create a file named
.envin the root directory. - Copy the secrets into the
.envfile. - Repeat for file named
.env.development.
- Install Dependencies.
- Create Secrets.
- Open a terminal in the root folder.
- Run
pnpm run deploy. - If postgres access is denied: check .env password; check .env host; check port 5432 is free (use
netstat -ano | findstr :5432)
Unfortunately, this project doesn't support community contributions right now. Feel free to fork, but be sure to read the license.