Skip to content

Commit

Permalink
Merge pull request #26 from elm-land/rhg/vitepress
Browse files Browse the repository at this point in the history
Elm Land v0.16.0 – New website, new CLI output, big changes!
  • Loading branch information
ryan-haskell committed Aug 29, 2022
2 parents f277348 + 98220bb commit be31bd7
Show file tree
Hide file tree
Showing 152 changed files with 10,413 additions and 28,818 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/node.js.yml
@@ -1,7 +1,7 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Node.js CI
name: "Elm Land CLI"

on:
push:
Expand All @@ -19,7 +19,7 @@ jobs:

strategy:
matrix:
node-version: [12.x, 14.x, 16.x]
node-version: [16.x,18.x]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
@@ -0,0 +1 @@
.DS_Store
13 changes: 12 additions & 1 deletion README.md
@@ -1,9 +1,20 @@
# Elm Land
[![Node.js CI](https://github.com/elm-land/elm-land/actions/workflows/node.js.yml/badge.svg)](https://github.com/elm-land/elm-land/actions/workflows/node.js.yml)

[![Elm Land: reliable web apps for everyone.](./elm-land-banner.png)](https://elm.land)
[![Elm Land: reliable web apps for everyone.](./elm-land-banner.jpg)](https://elm.land)

## Projects in this repo

This GitHub repo is made up of two projects:

- __[@elm-land/docs](./docs/)__ - The official website at [elm.land](https://elm.land)
- __[@elm-land/cli](./cli/)__ - The CLI tool available at [npmjs.org/elm-land](https://npmjs.org/elm-land)


### Other projects

This repo also includes two other subprojects for anyone else making tooling for Elm:

- __[@elm-land/elm-error-json](./elm-error-json/)__ - Can render the Elm compiler's JSON error output as HTML or colored terminal

- __[@elm-land/codegen](./codegen/)__ - the lightweight codegen library used internally by the Elm Land CLI
43 changes: 30 additions & 13 deletions cli/README.md
@@ -1,29 +1,46 @@
# @elm-land/cli
> The CLI tool available at [npmjs.org/elm-land](https://npmjs.org/elm-land)
# Elm Land
> Reliable web apps for everyone
## Work in progress!
![](../elm-land-banner.jpg)

We'll be building out a more interesting CLI tool, but for now, here's what we've got
### Alpha release

```bash
Although this framework is still a work-in-progress, please feel free to tinker around until `v1.0.0` is released!

Feedback is welcome anytime in the [Elm slack](https://elmlang.herokuapp.com/). Drop a comment in the `#elm-spa-users` channel and tag `@ryan` if you like!

## Using the CLI

The `elm-land` CLI tool has everything you need to create your next Elm application:

```
$ npx elm-land
🌈 Welcome to Elm Land!
🌈 Welcome to Elm Land! (v0.16.0)
Here are the commands:
✨ elm-land init <folder-name> ...... create a new project
🚀 elm-land server ................ run a local dev server
📦 elm-land build .......... build your app for production
📄 elm-land add page <url> ................ add a new page
📑 elm-land add layout <name> ........... add a new layout
🔧 elm-land customize <name> .. customize a default module
```

Pretty exciting stuff, right?
## The source code

# Guide Driven Design
If you would like to see how it works, all the code is available and [open-source on GitHub](https://github.com/elm-land/elm-land).

> philozsilo: "gdd guide driven design"
The CLI, docs website, and other related Elm Land projects can all be found in that single repo.

All of our tests are intended to make sure what users read in the docs are accurate!
### Running the test suite

I did my best and you like it.
The tests in this project are designed to verify that the [official guide](https://elm.land/guide) and [all of the examples](https://github.com/elm-land/elm-land/tree/main/examples) are accurate for users.

## Running the tests
For that reason, we are using [bats](https://github.com/bats-core/bats-core) to make sure our CLI behaves as expected!

```bash
# Make sure you are in the `cli` folder!
# Make sure you are in the `./cli` folder!
npm install
npm link
npm run setup
Expand Down

0 comments on commit be31bd7

Please sign in to comment.