Skip to content

Commit 920f7a6

Browse files
author
Evert Arias
committed
Update README
1 parent fd69cbd commit 920f7a6

File tree

1 file changed

+10
-89
lines changed

1 file changed

+10
-89
lines changed

README.md

+10-89
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,20 @@
1-
<!-- AUTO-GENERATED-CONTENT:START (STARTER) -->
2-
<p align="center">
3-
<a href="https://www.gatsbyjs.org">
4-
<img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
5-
</a>
6-
</p>
7-
<h1 align="center">
8-
Gatsby's default starter
9-
</h1>
1+
# Gatsby Netlify Form Example
102

11-
Kick off your project with this default boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.
3+
Simple Gatsby static site to demonstrate how to submit a form to Netlify Forms
124

13-
_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
145

15-
## 🚀 Quick start
166

17-
1. **Create a Gatsby site.**
7+
## Development
188

19-
Use the Gatsby CLI to create a new site, specifying the default starter.
9+
```bash
10+
git clone https://github.com/evert-arias/gatsby-netlify-form-example.git
11+
cd gatsby-netlify-form-example
12+
npm install
13+
npm start
14+
```
2015

21-
```shell
22-
# create a new Gatsby site using the default starter
23-
gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
24-
```
2516

26-
1. **Start developing.**
27-
28-
Navigate into your new site’s directory and start it up.
29-
30-
```shell
31-
cd my-default-starter/
32-
gatsby develop
33-
```
34-
35-
1. **Open the source code and start editing!**
36-
37-
Your site is now running at `http://localhost:8000`!
38-
39-
_Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
40-
41-
Open the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
42-
43-
## 🧐 What's inside?
44-
45-
A quick look at the top-level files and directories you'll see in a Gatsby project.
46-
47-
.
48-
├── node_modules
49-
├── src
50-
├── .gitignore
51-
├── .prettierrc
52-
├── gatsby-browser.js
53-
├── gatsby-config.js
54-
├── gatsby-node.js
55-
├── gatsby-ssr.js
56-
├── LICENSE
57-
├── package-lock.json
58-
├── package.json
59-
└── README.md
60-
61-
1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
62-
63-
2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.
64-
65-
3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
66-
67-
4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
68-
69-
5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
70-
71-
6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
72-
73-
7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
74-
75-
8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
76-
77-
9. **`LICENSE`**: Gatsby is licensed under the MIT license.
78-
79-
10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**
80-
81-
11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.
82-
83-
12. **`README.md`**: A text file containing useful reference information about your project.
84-
85-
## 🎓 Learning Gatsby
86-
87-
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
88-
89-
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
90-
91-
- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
9217

9318
## 💫 Deploy
9419

95-
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default)
96-
97-
[![Deploy with ZEIT Now](https://zeit.co/button)](https://zeit.co/import/project?template=https://github.com/gatsbyjs/gatsby-starter-default)
98-
99-
<!-- AUTO-GENERATED-CONTENT:END -->
20+
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/evert-arias/gatsby-netlify-form-example)

0 commit comments

Comments
 (0)