Skip to content

Commit

Permalink
initialize the project description
Browse files Browse the repository at this point in the history
  • Loading branch information
EasonChiang7178 committed Sep 14, 2019
1 parent 1ab121c commit e131fb3
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 901 deletions.
98 changes: 4 additions & 94 deletions README.md
@@ -1,97 +1,7 @@
<!-- AUTO-GENERATED-CONTENT:START (STARTER) -->
<p align="center">
<a href="https://www.gatsbyjs.org">
<img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
</a>
</p>
<h1 align="center">
Gatsby's default starter
</h1>
# Paper Note

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.
DEMO: https://easonchiang7178.github.io/f2e-paper-note/

_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/)._
---

## 🚀 Quick start

1. **Create a Gatsby site.**

Use the Gatsby CLI to create a new site, specifying the default starter.

```sh
# create a new Gatsby site using the default starter
gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
```

1. **Start developing.**

Navigate into your new site’s directory and start it up.

```sh
cd my-default-starter/
gatsby develop
```

1. **Open the source code and start editing!**

Your site is now running at `http://localhost:8000`!

_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)._

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!

## 🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

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”.

3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.

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.

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.

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).

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.

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.

9. **`LICENSE`**: Gatsby is licensed under the MIT license.

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).**

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.

12. **`README.md`**: A text file containing useful reference information about your project.

## 🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:

- **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.

- **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.

## 💫 Deploy

[![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)

<!-- AUTO-GENERATED-CONTENT:END -->
Designed by [Niki](https://challenge.thef2e.com/user/1966?schedule=4322#works-4322)
17 changes: 9 additions & 8 deletions gatsby-config.js
@@ -1,8 +1,9 @@
module.exports = {
pathPrefix: "/f2e-paper-note",
siteMetadata: {
title: `Gatsby Default Starter`,
description: `Kick off your next, great Gatsby project with this default starter. This barebones starter ships with the main Gatsby configuration files you might need.`,
author: `@gatsbyjs`,
title: `Paper Note`,
description: `身邊沒紙時,只好用零食包裝紙背面來寫的開心 | Designed by Niki`,
author: `@EasonChiang7178`,
},
plugins: [
`gatsby-plugin-react-helmet`,
Expand All @@ -18,13 +19,13 @@ module.exports = {
{
resolve: `gatsby-plugin-manifest`,
options: {
name: `gatsby-starter-default`,
short_name: `starter`,
name: `paper-note`,
short_name: `note`,
start_url: `/`,
background_color: `#663399`,
theme_color: `#663399`,
background_color: `#000000`,
theme_color: `#C3C3BB`,
display: `minimal-ui`,
icon: `src/images/gatsby-icon.png`, // This path is relative to the root of the site.
icon: `src/images/paper-note-icon.png`,
},
},
// this (optional) plugin enables Progressive Web App + Offline functionality
Expand Down
13 changes: 6 additions & 7 deletions package.json
@@ -1,9 +1,9 @@
{
"name": "gatsby-starter-default",
"name": "paper-note",
"private": true,
"description": "A simple starter to get up and developing quickly with Gatsby",
"description": "身邊沒紙時,只好用零食包裝紙背面來寫的開心 | Designed by Niki",
"version": "0.1.0",
"author": "Kyle Mathews <mathews.kyle@gmail.com>",
"author": "EasonChiang7178 <ishiu.chiang@gmail.com>",
"dependencies": {
"gatsby": "^2.15.15",
"gatsby-image": "^2.2.19",
Expand All @@ -30,14 +30,13 @@
"develop": "gatsby develop",
"format": "prettier --write \"**/*.{js,jsx,json,md}\"",
"start": "npm run develop",
"serve": "gatsby serve",
"test": "echo \"Write tests! -> https://gatsby.dev/unit-testing \""
"serve": "gatsby serve"
},
"repository": {
"type": "git",
"url": "https://github.com/gatsbyjs/gatsby-starter-default"
"url": "https://github.com/easonchiang7178/f2e-paper-note"
},
"bugs": {
"url": "https://github.com/gatsbyjs/gatsby/issues"
"url": "https://github.com/easonchiang7178/f2e-paper-note/issues"
}
}
42 changes: 0 additions & 42 deletions src/components/header.js

This file was deleted.

32 changes: 0 additions & 32 deletions src/components/image.js

This file was deleted.

0 comments on commit e131fb3

Please sign in to comment.