https://github.com/alexmingoia/pux-starter-app

Starter Pux app w/ hot-reloading and isomorphic routing and rendering
https://github.com/alexmingoia/pux-starter-app

pux starter-kit

Last synced: 13 days ago
JSON representation

Starter Pux app w/ hot-reloading and isomorphic routing and rendering

• Host: GitHub
• URL: https://github.com/alexmingoia/pux-starter-app
• Owner: alexmingoia
• License: bsd-3-clause
• Created: 2016-01-26T07:57:36.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-03-31T06:44:18.000Z (over 5 years ago)
• Last Synced: 2024-09-22T20:53:19.182Z (about 2 months ago)
• Topics: pux, starter-kit
• Language: PureScript
• Homepage: https://www.purescript-pux.org
• Size: 2.03 MB
• Stars: 102
• Watchers: 10
• Forks: 39
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-purescript - pux-starter-app - Starter Pux app w/ hot-reloading and isomorphic routing and rendering (boilerplate)

README

        
# pux-starter-app

The [starter app](http://github.com/alexmingoia/pux-starter-app) is a skeleton

Pux project configured with webpack and supporting hot-reload for rapid

development.

For isomorphic rendering and routing a more complex configuration is available in the

[`isomorphic`](https://github.com/alexmingoia/pux-starter-app/tree/isomorphic) branch.

## Installation

Clone the repository and run `npm install` to get started:

```sh

git clone git://github.com/alexmingoia/pux-starter-app.git my-awesome-pux-app

cd my-awesome-pux-app

npm install

npm start

```

After compiling the app should be available at `http://localhost:8080`.

### Directory structure

- `src`: Application source code.

  - `src/App/Config.js`: Configuration values.

  - `src/App/Config.purs`: Configuration type.

  - `src/App/Events.purs`: Application event type and foldp function.

  - `src/App/Routes.purs`: Routes.

  - `src/App/State.purs`: Application state type and init function.

  - `src/App/View/Homepage.purs`: Home page.

  - `src/App/View/Layout.purs`: App layout.

  - `src/App/View/NotFound.purs`: 404 page.

  - `src/Main.purs`: PureScript entry point.

- `static`: Static files served with application.

- `support`: Support files for building.

  - `support/entry.js`: Webpack entry point. Handles hot reloading.

- `bower.json`: Bower package configuration.

- `package.json`: Node package configuration.

- `webpack.config.js`: Webpack configuration.

### NPM scripts

#### watch

`npm start` or `npm run watch` will start a development server, which

hot-reloads your application when sources changes.

#### serve

`NODE_ENV=production npm run serve` builds your application and starts a

production server.

#### build

`npm run build` builds application client and server bundles.