Skip to content

Latest commit

 

History

History
109 lines (76 loc) · 2.9 KB

README.md

File metadata and controls

109 lines (76 loc) · 2.9 KB
Raw

Nymph Svelte Template

An app template using Nymph.js, SMUI, and SvelteKit.

Template App Screenshot

Structure

This repository contains two separate parts.

  • app: The main web/server app. This app uses, Nymph.js, SMUI, and SvelteKit. It runs a server with a Nymph endpoint and a Nymph PubSub server. It serves the front end browser app.
  • commands: The server utility commands. These commands are meant to be run on a live server and help you manage the data for the app.

All parts use Nymph.js to handle data.

Local Development

In development mode, Nymph is configured to use a SQLite3 database, development.db in the root folder.

Run these commands:

npm i
cd app
npm i
npm run dev

to run a local dev server. It will then be available at http://127.0.0.1:5173/.

To get started, create a root user:

Username: root
Password: [whatever]
Name: Root
Email: root@localhost

This user will be created with admin privileges and without any onboarding entities (first time setup). It will have access to the http://127.0.0.1:5173/user/ user admin app.

Now you can log out and create a regular user for testing. This user will not have admin privileges and will be onboarded with some example projects and tasks.

When you create a regular user, the verification email will pop up in your browser. This is what happens in development mode instead of the email actually being sent.

Remote Development Server

# Install pm2
sudo npm i -g pm2

# Start the Managed Server
sudo pm2 start pm2.config.cjs --env development

# Restart the Servers (after a rebuild)
sudo pm2 restart all

Production Server

# Install pm2
sudo npm i -g pm2

# Start the Managed Server
sudo pm2 start pm2.config.cjs --env production

# Save the process list and set to start up on system start.
sudo pm2 save
sudo pm2 startup systemd

# Restart the Servers (after a rebuild)
sudo pm2 restart all

Prereqs

# You might need this on Ubuntu/Debian
sudo apt install nodejs npm
# Or this on Manjaro/Arch
sudo pamac install nodejs-lts-erbium

# Then get them all on the same version of node.
sudo npm i -g n
# You can use a higher version, but 16 is the minimum.
sudo n 16
sudo npm i -g npm@latest

Copyright

Copyright 2023 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.