Merge pull request #200 from ZoltanVeres/netlifyci-lighthouse-support

Adds netlify-lambda support

CONTRIBUTING.md

@@ -0,0 +1,154 @@
+# CONTRIBUTING
+
+Contributions are always welcome, no matter how large or small. Before contributing,
+please read the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Setup
+
+> Install yarn on your system: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
+
+### Install dependencies
+
+> Only required on the first run, subsequent runs can use `yarn` to both
+bootstrap and run the development server using `yarn develop`.
+Since this starter using the [netlify-lambda](https://github.com/netlify/netlify-lambda), there could be further issues you, please check the [Readme](https://github.com/netlify/netlify-lambda) for further information and set up questions. 
+
+```sh
+$ git clone https://github.com/netlify-templates/gatsby-starter-netlify-cms
+$ yarn 
+```
+
+## Available scripts
+
+### `start`
+
+Starts the development server. This task runs both the `start:app` and `start:lambda` scripts.
+
+#### Usage
+
+```sh
+$ yarn start
+```
+
+### `build`
+
+Build the static files into the `public` folder, turns lambda functions into a deployable form. This task runs both the `build:app` and `build:lambda` scripts.
+
+#### Usage
+
+```sh
+$ yarn build
+```
+
+### `clean`
+
+Removes all the files from `public`, `.cache` directories using the `rimraf` command.
+
+#### Usage
+
+```sh
+yarn clean
+```
+
+### `develop`
+
+Runs the `clean` script and starts the gatsby develop server using the command `gatsby develop`. Since this is not starting the lambda server it can be used when you only changing the site and not the lambda functions.
+
+#### Usage
+
+```sh
+yarn develop
+```
+
+### `serve`
+
+This command is shorthand for `gatsby serve` 
+
+#### Usage
+
+```sh
+yarn serve
+```
+
+### `test`
+
+Not implmented yet
+
+#### Usage
+
+```sh
+yarn test
+```
+
+### `format`
+
+Formats code and docs according to our style guidelines using `prettier`
+
+#### Usage
+
+```sh
+yarn format
+```
+
+### `start:app`
+
+Runs the `develop` command, this mapping is needed so we can start both gatsby and lambda with one command (`yarn start`).
+
+#### Usage
+
+```sh
+yarn start:app
+```
+
+### `start:lambda`
+
+Runs the `netlify-lambda` command, starts the lambda server in develop mode.
+
+#### Usage
+
+```sh
+yarn start:lambda
+```
+
+### `build:app`
+
+Builds the gatsby app
+
+#### Usage
+
+```sh
+yarn build:app
+```
+
+### `build:lambda`
+
+Runs the `netlify-lambda build` command, compiles the functions.
+
+#### Usage
+
+```sh
+yarn build:lambda
+```
+
+
+## Pull Requests
+
+We actively welcome your pull requests!
+
+If you need help with Git or our workflow, please ask on [Gitter.im](https://gitter.im/netlify/NetlifyCMS). We want your contributions even if you're just learning Git. Our maintainers are happy to help!
+
+Netlify CMS uses the [Forking Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) + [Feature Branches](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). Additionally, PR's should be [rebased](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) on master when opened, and again before merging.
+
+1. Fork the repo.
+2. Create a branch from `master`. If you're addressing a specific issue, prefix your branch name with the issue number.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Run `yarn test` and ensure the test suite passes. (Not applicable yet)
+5. Use `yarn format` to format and lint your code.
+6. PR's must be rebased before merge (feel free to ask for help).
+7. PR should be reviewed by two maintainers prior to merging.
+
+## License
+
+By contributing to the Gatsby - Netlify CMS starter, you agree that your contributions will be licensed
+under its [MIT license](LICENSE).

README.md

@@ -20,6 +20,7 @@ It follows the [JAMstack architecture](https://jamstack.org) by using Git as a s
 - Uses `gatbsy-image` with Netlify-CMS preview support
 - Separate components for everything
 - Netlify deploy configuration
+- Netlify function support, see `src/lambda` folder
 - Perfect score on Lighthouse for SEO, Accessibility and Performance (wip:PWA)
 - ..and more
 
@@ -41,7 +42,7 @@ After clicking that button, you’ll authenticate with GitHub and choose a repos
 $ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git
 $ cd [REPO_NAME]
 $ yarn
-$ npm run develop
+$ npm run start
 ```
 To test the CMS locally, you'll need run a production build of the site:
 ```
@@ -72,3 +73,8 @@ npm install --global --production windows-build-tools
 
 ## Purgecss
 This plugin uses [gatsby-plugin-purgecss](https://www.gatsbyjs.org/packages/gatsby-plugin-purgecss/) and [bulma](https://bulma.io/). The bulma builds are usually ~170K but reduced 90% by purgecss.
+
+# CONTRIBUTING
+
+Contributions are always welcome, no matter how large or small. Before contributing,
+please read the [code of conduct](CODE_OF_CONDUCT.md).

gatsby-config.js

@@ -1,3 +1,5 @@
+var proxy = require("http-proxy-middleware")
+
 module.exports = {
   siteMetadata: {
     title: 'Gatsby + Netlify CMS Starter',
@@ -74,4 +76,17 @@ module.exports = {
     }, // must be after other CSS plugins
     'gatsby-plugin-netlify', // make sure to keep it last in the array
   ],
+  // for avoiding CORS while developing Netlify Functions locally
+  // read more: https://www.gatsbyjs.org/docs/api-proxy/#advanced-proxying
+  developMiddleware: app => {
+    app.use(
+      "/.netlify/functions/",
+      proxy({
+        target: "http://localhost:9000",
+        pathRewrite: {
+          "/.netlify/functions/": "",
+        },
+      })
+    )
+  },
 }

netlify.toml

@@ -1,6 +1,7 @@
 [build]
   publish = "public"
   command = "npm run build"
+  functions = "lambda"
 [build.environment]
   YARN_VERSION = "1.9.4"
   YARN_FLAGS = "--no-ignore-optional"