100-Words

🔥 Live version: https://erlange.github.io/100-words/

A high-performance word generator, suitable for your band name, album, book or your future award-winning movie titles.

• Get started
• Installation
• Building and running in production mode
• Single-page app mode
• Using TypeScript
• Deploying to the web

It is a Svelte boilerplate app with routing and TypeScript support, Babel to facilitate running on ancient browsers such as IE11 and UI from Materialize-CSS and FontAwesome.

Get started

Note that you will need to have Node.js installed.

Installation

Download the zip file or clone this repository:

mkdir [your-local-directory]
cd [your-local-directory]
git clone https://github.com/erlange/100-words.git
cd 100-words
npm install

...then start Rollup:

npm run dev

Navigate to localhost:5432. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

Change this line in App.svelte to change the base-href to other than /100-words

Change the port by editing this line in package.json file.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Single-page app mode

By default, sirv will only respond to requests that match files in public. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.

If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for any path. You can make it so by editing the "start" command in package.json:

"start": "sirv public --single"

Using TypeScript

This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:

node scripts/setupTypeScript.js

Or remove the script via:

rm scripts/setupTypeScript.js

Deploying to the web

With Vercel

Install vercel if you haven't already:

npm install -g vercel

Then, from within your project folder:

cd public
vercel deploy --name my-project

With surge

Install surge if you haven't already:

npm install -g surge

Then, from within your project folder:

npm run build
surge public my-project.surge.sh

Looking for a shareable component template? Go here --> sveltejs/component-template

© 2021 - erlange