https://github.com/fyodorio-closet/yellow-bricks
Elm web app for tracking job applications
https://github.com/fyodorio-closet/yellow-bricks
elm elm-architecture web webapp
Last synced: about 1 year ago
JSON representation
Elm web app for tracking job applications
- Host: GitHub
- URL: https://github.com/fyodorio-closet/yellow-bricks
- Owner: fyodorio-closet
- Created: 2019-05-20T03:59:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-21T04:03:56.000Z (about 7 years ago)
- Last Synced: 2025-02-07T07:41:28.772Z (over 1 year ago)
- Topics: elm, elm-architecture, web, webapp
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Yellow Bricks App
This project is bootstrapped with [Create Elm App](https://github.com/halfzebra/create-elm-app).
You can find the most recent and full version of the getting started guide [here](https://github.com/halfzebra/create-elm-app/blob/master/template/README.md).
## Installing Elm packages
```sh
elm-app install
```
Other `elm-package` commands are also [available].(#package)
## Installing JavaScript packages
To use JavaScript packages from npm, you'll need to add a `package.json`, install the dependencies, and you're ready to go.
```sh
npm init -y # Add package.json
npm install --save-dev pouchdb-browser # Install library from npm
```
```js
// Use in your JS code
import PouchDB from 'pouchdb-browser';
const db = new PouchDB('mydb');
```
## Available scripts
In the project directory you can run:
### `elm-app build`
Builds the app for production to the `build` 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.
You may change the listening port number by using the `PORT` environment variable. For example type `PORT=8000 elm-app start ` into the terminal/bash to run it from: [http://localhost:8000/](http://localhost:8000/).
### `elm-app install`
Alias for [`elm install`](http://guide.elm-lang.org/get_started.html#elm-install)
Use it for installing Elm packages from [package.elm-lang.org](http://package.elm-lang.org/)
### `elm-app test`
Run tests with [node-test-runner](https://github.com/rtfeldman/node-test-runner/tree/master)
You can make test runner watch project files by running:
```sh
elm-app test --watch
```