Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gregziegan/rpg-framework
A web app that allows you to build event based RPGs
https://github.com/gregziegan/rpg-framework
Last synced: 11 days ago
JSON representation
A web app that allows you to build event based RPGs
- Host: GitHub
- URL: https://github.com/gregziegan/rpg-framework
- Owner: gregziegan
- Created: 2016-09-21T00:49:08.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-06T06:02:21.000Z (over 8 years ago)
- Last Synced: 2024-12-24T06:51:45.325Z (19 days ago)
- Language: Elm
- Size: 212 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-elm-gamedev - rpg-framework
README
This project was bootstrapped with [Create Elm App](https://github.com/halfzebra/create-elm-app).
Below you will find some information on how to perform common tasks.
You can find the most recent version of this guide [here](https://github.com/halfzebra/create-elm-app/blob/master/template/README.md).
## Table of Contents
- [Sending feedback](#sending-feedback)
- [Folder structure](#folder-structure)
- [Installing Elm packages](#installing-elm-packages)
- [Testing](#testing)
- [Available scripts](#available-scripts)
- [elm-app build](#elm-app-build)
- [elm-app start](#elm-app-start)
- [elm-app eject](#elm-app-eject)
- [elm-app ](#elm-app-elm-platform-comand)
- [package](#package)
- [repl](#repl)
- [make](#make)
- [reactor](#reactor)
- [IDE setup for Hot Module Replacement](#ide-setup-for-hot-module-replacement)
## Sending feedback
You are very velcome with any [feedback](https://github.com/halfzebra/create-elm-app/issues)
## Installing Elm packages
```sh
elm-app package install
```
## Folder structure
```
my-app/
README.md
elm-package.json
src/
favicon.ico
index.html
index.js
main.css
Main.elm
```
For the project to build, these files must exist with exact filenames:
- `src/index.html` is the page template;
- `src/favicon.ico` is the icon you see in the browser tab;
- `src/index.js` is the JavaScript entry point.
You can delete or rename the other files.
You may create subdirectories inside src.
## Testing
We recommend using [node-test-runner](https://github.com/rtfeldman/node-test-runner) for testing.
It is a command line tool, which helps you to start writing unit tests for your Elm code.
## Available scripts
In the project directory you can run:
### `elm-app build`
Builds the app for production to the `dist` folder.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
### `elm-app start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `elm-app eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Elm Platform, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
### `elm-app `
Create Elm App does not rely on global installation of Elm Platform, but you still can use it's local Elm Platform to access default command line tools:
#### `package`
Alias for [elm-package](http://guide.elm-lang.org/get_started.html#elm-package)
Use it for installing Elm packages from [package.elm-lang.org](http://package.elm-lang.org/)
#### `repl`
Alias for [elm-repl](http://guide.elm-lang.org/get_started.html#elm-repl)
#### `make`
Alias for [elm-make](http://guide.elm-lang.org/get_started.html#elm-make)
#### `reactor`
Alias for [elm-reactor](http://guide.elm-lang.org/get_started.html#elm-reactor)
## IDE setup for Hot Module Replacement
Remember to disable [safe write](https://webpack.github.io/docs/webpack-dev-server.html#working-with-editors-ides-supporting-safe-write) if you are using VIM or IntelliJ IDE, such as WebStrom.