Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Commit

Permalink
Merge branch 'master' of github.com:Cretezy/Noderize
Browse files Browse the repository at this point in the history
  • Loading branch information
Cretezy committed Mar 19, 2018
2 parents 26a17de + 0e49b6a commit d310441
Show file tree
Hide file tree
Showing 11 changed files with 24 additions and 24 deletions.
6 changes: 3 additions & 3 deletions docs/docs/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Create

In the [introduction](introduction.md), we saw how to create a Noderize app using the `create-noderize` package.

It is recommended you use the single-use script from the [introduction](introduction.md) as it will always be up-to-date, however you can optionally install the command globally with:
It is recommended you use the single-use script from the [introduction](introduction.md) as it will always be up-to-date. However, you can optionally install the command globally with:

```bash
yarn global add create-noderize
Expand All @@ -17,7 +17,7 @@ npm install -g create-noderize
create-noderize <path>
```

Some arguments can be passed to this script to modify it's behavior.
Some arguments can be passed to this script to modify its behavior.

## Index

Expand All @@ -27,7 +27,7 @@ Some arguments can be passed to this script to modify it's behavior.

### `--typescript`

This will setup a TypeScript project by:
This will set up a TypeScript project by:

* Setting the [`language`](configuration-noderize.md#languages) option to `typescript`
* Renaming `src/index.js` to `src/index.ts`
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Flow

[Flow](https://flow.org/) is a static type checker that adds types to JavaScript.

Flow is built-in to Noderize, you simply have to add the `flow-bin` command to your project to start using it:
Flow is built-in to Noderize. You simply have to add the `flow-bin` command to your project to start using it:

```bash
yarn add -D flow-bin
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features-modern.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Feature: Modern JavaScript
sidebar_label: Modern JavaScript
---

Noderize enables to use of modern Javascript out-of-the-box with Babel:
Noderize enables the use of modern JavaScript out-of-the-box with Babel:

* ES6, ES7, ES8.
* Stage 3: Object rest/spread, async generator functions
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guides-firebase-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To deploy Firebase Cloud Functions, we must:

## Requirements

You must setup the [Firebase CLI](https://github.com/firebase/firebase-tools) before setting up Functions.
You must set up the [Firebase CLI](https://github.com/firebase/firebase-tools) before setting up Functions.

Quick Firebase CLI setup:

Expand All @@ -27,7 +27,7 @@ firebase login

## Project Setup

Create a directory to be used as your project root (for Firebase). Setup Firebase using `firebase init`, and **do not** select the Functions options when creating.
Create a directory to be used as your project root (for Firebase). Set up Firebase using `firebase init`, and **do not** select the Functions options when creating.

Next, [create](create.md) a Noderize project inside your project root called `functions`.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guides-heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ title: Guide: Heroku
sidebar_label: Heroku
---

Deploy to Heroku is very simple:
Deploying to Heroku is very simple:

* Be in a Git repo (optional, `git init`)
* Create an Heroku app using `heroku create [name]`
* Create a Heroku app using `heroku create [name]`
* Move `@noderize/scripts` from `devDependencies` to `dependencies` in your `package.json`.
* Add `heroku-postbuild` script in `package.json`:
```json
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides-publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ By default, npm/Yarn will include these [files](https://docs.npmjs.com/files/pac
* NOTICE
* The file in the "main" field

When using multiple bundles and/or static files, we must indicate to publish the whole `dist` folder (and optionally include `src` for human-readable code). Add to your `package.json`:
When using multiple bundles and/or static files, we must indicate that the whole `dist` folder should be published (and optionally include `src` for human-readable code). Add to your `package.json`:

```json
"files": ["src", "dist"],
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ yarn build
npm run build
```

This will build your app to `dist/index.js` (this output is optionally [configurable](configuration-noderize.md#output))
This will build your app to `dist/index.js` (this output is optionally [configurable](configuration-noderize.md#output)).

You can then run your file using the `start` script (for source map support) or using Node directly:

Expand All @@ -59,4 +59,4 @@ node dist/index.js

Noderize is packed with [features](features-index.md) such as [modern JavaScript support](features-modern.md) and [TypeScript support](features-typescript.md).

[Code formatting](features-formatting.md) ([`format` script](scripts.md#format)) and [testing](features-testing.md) ([`test` script](scripts.md#test)) is built-in and let's get work on your high quality code distraction-free.
[Code formatting](features-formatting.md) ([`format` script](scripts.md#format)) and [testing](features-testing.md) ([`test` script](scripts.md#test)) is built-in and lets you get working on your high-quality code distraction-free.
6 changes: 3 additions & 3 deletions docs/docs/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Noderize Scripts
sidebar_label: Scripts
---

Noderize comes build it with commands ("scripts"). These scripts are automatically added to your `package.json` `scripts` field when using [`create-noderize`](create.md):
Noderize comes with commands ("scripts") built-in. These scripts are automatically added to your `package.json` `scripts` field when using [`create-noderize`](create.md):

```json
"scripts": {
Expand All @@ -28,7 +28,7 @@ npm run <script>

> Note: with npm, you may omit `run` for the `start` and `test` scripts. For example: `npm start`.
For every the `watch` and `start` script, you may pass arguments to both Noderize and your app:
For the `watch` and `start` scripts, you may pass arguments to both Noderize and your app:

```bash
yarn watch [noderize args] -- [app args]
Expand Down Expand Up @@ -64,7 +64,7 @@ Uses [run options](configuration-noderize.md#run-options).

### `watch`

Continuously builds are runs your app.
Continuously builds and runs your app.

Uses [build](configuration-noderize.md#build-options) & [run options](configuration-noderize.md#run-options).

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/tutorials-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Our goal is to:

We will be using 3 libraries:

* [`Commander.js`](https://github.com/tj/commander.js): commands and sub-commands
* [`Commander.js`](https://github.com/tj/commander.js): Commands and sub-commands
* [`chalk`](https://github.com/chalk/chalk): Color our output
* [`Inquirer.js`](https://github.com/SBoudrias/Inquirer.js): Prompts

Expand Down Expand Up @@ -100,7 +100,7 @@ program.command("greet [name]").action(greet);
program.command("fibonacci [n]").action(fibonacci);
```

Next, we'll add a catch-all command (if entering a non-valid command). We will firstly show a message to the user, then show them to general help message, and exit with error code 1.
Next, we'll add a catch-all command (if entering a non-valid command). We will firstly show a message to the user, then show them the general help message, and exit with error code 1.

```js
program.action(() => {
Expand Down Expand Up @@ -243,7 +243,7 @@ Finished!

In this tutorial we saw how to:

* [Setup a Noderize app and install dependencies](#setup)
* [Set up a Noderize app and install dependencies](#setup)
* [Created our program structure](#structure)
* [Added the `greet` sub-command](#greet)
* [Added the `fibonacci` sub-command](#fibonacci)
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/tutorials-express.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ To determine which port our web server will run on, we'll try reading from the `
const port = parseInt(process.env.PORT) || 3000;
```

Next, we will to tell Express to listen to requests. We will also provide a callback to indicate us that our app is running:
Next, we will tell Express to listen to requests. We will also provide a callback to notify us that our app is running:

```js
app.listen(port, () => {
Expand Down Expand Up @@ -106,11 +106,11 @@ When visiting `http://localhost:3000`, we'll see this:

![](/img/docs/tutorials-express-1.png)

Success! From now our, on code will automatically update on changes.
Success! From now on, our code will automatically update on changes.

## Greeting route

Lets next add our greeting endpoint, which will takes a `name` parameter (defaulting to `world`) and returns a greeting:
Let's next add our greeting endpoint, which takes a `name` parameter (defaulting to `world`) and returns a greeting:

```js
app.get("/greet", (req, res) => {
Expand All @@ -128,7 +128,7 @@ Finished!

In this tutorial we saw how to:

* [Setup a Noderize app and install Express](#setup)
* [Import Express and setup our Express server](#express-server)
* [Set up a Noderize app and install Express](#setup)
* [Import Express and set up our Express server](#express-server)
* [Run our Noderize app](#running-our-app)
* [Add our greeting route](#greeting-route)
2 changes: 1 addition & 1 deletion docs/docs/tutorials-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Tutorials
sidebar_label: Index
---

Tutorials of using Noderize.
Tutorials on using Noderize.

## Index

Expand Down

0 comments on commit d310441

Please sign in to comment.