Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chronisp/gatsby-starter
Gatsby Starter for creating portfolio & blog.
https://github.com/chronisp/gatsby-starter
cms contentful gatsby gatsby-starter gatsbyjs graphql headless-cms material-ui netlify react redux typescript
Last synced: 3 months ago
JSON representation
Gatsby Starter for creating portfolio & blog.
- Host: GitHub
- URL: https://github.com/chronisp/gatsby-starter
- Owner: chronisp
- License: mit
- Created: 2019-08-28T11:17:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-28T12:19:52.000Z (about 3 years ago)
- Last Synced: 2024-10-01T03:24:06.605Z (3 months ago)
- Topics: cms, contentful, gatsby, gatsby-starter, gatsbyjs, graphql, headless-cms, material-ui, netlify, react, redux, typescript
- Language: TypeScript
- Homepage: https://gatsby-starter-dot.netlify.com/
- Size: 1.22 MB
- Stars: 53
- Watchers: 3
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Gatsby Starter
Gatsby Starter for creating portfolio & blog.
## Key Features
These are the key features of the project:
* [Gatsby](https://www.gatsbyjs.org/) (GraphQL for queries)
* [React](https://reactjs.org/) (everything in React Hooks)
* [TypeScript](https://www.typescriptlang.org/) (in progress...)
* [Redux](https://redux.js.org/) (custom HOF to connect actions & props)
* [Material UI](https://material-ui.com/) (palette, typography & breakpoints configuration)
* [Contentful CMS](https://www.contentful.com/) (blog integration)
* [Netlify Deployment Support](https://www.netlify.com)
* [React Helmet](https://github.com/nfl/react-helmet)
* [Prettier](https://prettier.io/)
* [Gatsby-image](https://www.gatsbyjs.org/packages/gatsby-image/)
* Config files for each environment
## Get Started
Make sure that you have Node.js (>=12.13.0) and yarn v.1 or above installed.
Install Gatsby CLI
```sh
npm install -g gatsby-cli
```
Clone repository
```sh
git clone https://github.com/chronisp/gatsby-starter.git
```
Move to project directory
```sh
cd
```
Install all dependencies
```sh
yarn install
```
### Contentful blog
Setup Contentful settings
```sh
yarn setup
```
Follow the instructions in order to setup ```CONTENTFUL_SPACE_ID``` and ```CONTENTFUL_ACCESS_TOKEN```. Required settings will be defined in both ```.env.development``` and ```.env.production``` files.
For more info on how to setup Contentful follow this [link](https://www.contentful.com/r/knowledgebase/gatsbyjs-and-contentful-in-five-minutes/).
### Development mode
Start development server
```sh
yarn develop
```
Your site is now running at ```http://localhost:8000```.
### Production mode
Create a production build
```sh
yarn build
```
Serve the production build locally
```sh
yarn serve
```
Your site is running at ```http://localhost:9000```.
### Linting
Format all JS files
```sh
yarn format
```
For any building or deployment issues, ensure you have setup your environment according to [Gatsby guide](https://www.gatsbyjs.org/docs/preparing-your-environment/) for [Windows](https://www.gatsbyjs.org/docs/gatsby-on-windows/) or [Linux](https://www.gatsbyjs.org/docs/gatsby-on-linux/).