Skip to content
Snippets Groups Projects
README.md 1.45 KiB
Newer Older
  • Learn to ignore specific revisions
  • # Work Adventure Dialog & Quest System (WADQS?)
    
    Jonas Zohren's avatar
    Jonas Zohren committed
    
    
    ## Structure:
    
    Jonas Zohren's avatar
    Jonas Zohren committed
    
    ```
    
    ├── public
    │   ├── dialogs (dialog data, each file is a dialogset for one npc)
    │   ├── images (images to link to in dialogs)
    ├── src (source code for svelte dialog webapp)
    ```
    
    Jonas Zohren's avatar
    Jonas Zohren committed
    
    ## Get started
    
    Install the dependencies...
    
    ```bash
    cd svelte-app
    npm install
    ```
    
    ...then start [Rollup](https://rollupjs.org):
    
    ```bash
    npm run dev
    ```
    
    Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
    
    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](https://code.visualstudio.com/) we recommend installing the official extension [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). 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:
    
    ```bash
    npm run build
    ```
    
    You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).