Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imskr/gatsby-starter-plasma
🚀 A modern and clean starter to get up and developing quickly with Gatsby
https://github.com/imskr/gatsby-starter-plasma
blog gatsby gatsby-site gatsby-starter portfolio-website pwa-boilerplate
Last synced: 13 days ago
JSON representation
🚀 A modern and clean starter to get up and developing quickly with Gatsby
- Host: GitHub
- URL: https://github.com/imskr/gatsby-starter-plasma
- Owner: imskr
- License: mit
- Created: 2020-06-13T06:05:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T05:38:03.000Z (21 days ago)
- Last Synced: 2024-10-24T09:22:58.569Z (20 days ago)
- Topics: blog, gatsby, gatsby-site, gatsby-starter, portfolio-website, pwa-boilerplate
- Language: HTML
- Homepage: https://gatsby-starter-plasma.netlify.app
- Size: 12.3 MB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 80
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gatsby Starter: Plasma
[](https://app.netlify.com/sites/gatsby-starter-plasma/deploys)
[](https://travis-ci.com/github/imskr/gatsby-starter-plasma/builds)
[](https://percy.io/SKR/gatsby-starter-plasma)
[](https://eslint.org/)
[](https://github.com/prettier/prettier)
(Work In Progress)
Kick off your project with this gatsby starter 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.
## 🚀 Quick start
1. **Create a Gatsby site.**
Use the Gatsby CLI to create a new site, specifying the default starter.
```shell
# create a new Gatsby site using the default starter
gatsby new gatsby-plasma-starter https://github.com/imskr/gatsby-starter-plasma
```
1. **Start developing.**
Navigate into your new site’s directory and start it up.
```shell
cd gatsby-plasma-starter/
yarn install
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)._
## 🧐 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.