https://github.com/pixel-point/gatsby-ab-example
https://github.com/pixel-point/gatsby-ab-example
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pixel-point/gatsby-ab-example
- Owner: pixel-point
- Created: 2021-10-01T13:03:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-01T13:04:39.000Z (over 3 years ago)
- Last Synced: 2025-04-28T13:03:40.272Z (2 months ago)
- Language: JavaScript
- Size: 588 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pixel Point Gatsby Starter
## Table of Contents
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Run website](#run-the-website)
- [Build website](#build-the-website)
- [Run built website](#run-built-website)
- [Clean Gatsby cache](#clean-gatsby-cache)
- [Project Structure](#project-structure)
- [Code Style](#code-style)
- [ESLint](#eslint)
- [Prettier](#prettier)
- [VS Code](#vs-code)
- [Style Variables](#style-variables)
## Getting Started
1. Clone this repository
```bash
git clone [email protected]:pixel-point/gatsby-starter.git
```
2. Install dependencies
```bash
npm install
```
3. Copy .env.example and rename it into .env
## Usage
### Run the website
```bash
npm run start
```
### Build the website
```bash
npm run build
```
### Run the built website
```bash
npm run serve
```
### Clean Gatsby cache
```bash
npm run clean
```
## Project Structure
```text
├── src
│ ├── components
│ │ ├── pages — React components that are being used specifically on a certain page
│ │ └── shared — React components that are being used across the whole website
│ ├── hooks
│ ├── images — Images that are being quired using graphql. Read more about it here — gatsbyjs.org/docs/working-with-images. Also note, that folder structure should be equal to the structure of components folder
│ ├── layouts
│ ├── pages
│ ├── styles
│ ├── templates
│ ├── utils
│ └── html.js — HTML template for all generated pages. Read more about it here — gatsbyjs.org/docs/custom-html
├── static
│ └── fonts - Self-hosted fonts
├── gatsby-browser.js — This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser. Read more about it here — gatsbyjs.org/docs/browser-apis
├── 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. Read more about it here — gatsbyjs.org/docs/gatsby-config
├── gatsby-node.js — This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. Read more about it here — gatsbyjs.org/docs/node-apis
└── gatsby-ssr.js — This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering. Read more about it here — gatsbyjs.org/docs/ssr-apis
```
## Component Folder Structure
### Each component includes
1. Main JavaScript File
2. SASS File
3. Index File
### Each component optionally may include
1. Folder with images
2. Folder with icons
Also, each component may include another component that follows all above listed rules.
### Example structure
```bash
component
├── nested-component
│ ├── images
│ │ └── image.png
│ ├── icons
│ │ └── icon.svg
│ ├── nested-component.js
│ ├── nested-component.module.scss
│ └── index.js
├── images
│ └── image.png
├── icons
│ └── icon.svg
├── component.js
├── component.module.scss
└── index.js
```
## Code Style
### ESLint
[ESLint](https://eslint.org/) helps find and fix code style issues and force developers to follow same rules. Current configuration is based on [Airbnb style guide](https://github.com/airbnb/javascript).
Additional commands:
```bash
npm run lint
```
Run it to check the current status of eslint issues across project.
```bash
npm run lint:fix
```
Run it to fix all possible issues.
### Prettier
[Prettier](https://prettier.io/) helps to format code based on defined rules. [Difference between Prettier and ESLint](https://prettier.io/docs/en/comparison.html).
Additional commands:
```bash
npm run format
```
Run it to format all files across the project.
### VS Code
Following extensions required to simplify the process of keeping the same code style across the project:
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
After installation enable "ESLint on save" by adding to your VS Code settings.json the following line:
```json
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
```
You can navigate to settings.json by using Command Pallete (CMD+Shift+P) and then type "Open settings.json".
To enable Prettier go to Preferences -> Settings -> type "Format". Then check that you have esbenp.prettier-vscode as default formatter, and also enable "Format On Save".
Reload VS Code and auto-format will work for you.
## Style Variables
All style variables that being used across the whole application are stored in [src/styles/variables.scss](/src/styles/variables.scss).