Gatsby Starter Mate logo

Greenkeeper badge Travis badge eslint code style: prettier Maintainability

Gatsby Starter: Mate

A portfolio starter for Gatsby integrated with Contentful CMS.

The target audience are developers πŸ’» and tech writers ✍️.

Demo Website

Why? πŸ€”

In case you are looking for a quick setup portfolio or upgrade your current, you have to definitely try Mate!

This starter is totally content based on Contentful, which is a headless CMS where you can write the content for your page. In summary, Contentful is the Model when Gatsby with React is the View.

At the same time, as this portfolio is written with Gatsby is extremely easy to add more than one source of data! For example, the demo comes with an integration of Medium posts based on a user name ✌️

Features πŸ› 

How to start ▢️

If you never used Gatsby before, I highly recommend you to Set up your development environment!

To copy and install this starter run this command:

$ gatsby new mate-portofolio

At this point you have the repository download with all the dependencies installed, but if you try to start by running yarn develop you are going to received this message in the console:

  TypeError: Expected parameter accessToken

This is because you didn’t specify from which Contentful space the portfolio will take the information. So the next step is create an empty space in Contentful!

After the space is created, run the following command:

yarn setup

This CLI will request 3 values:

These 3 values are inside the Settings section –> API keys.

After you provide them the CLI will automatically starts copying all the Content models and Contents from mate-demo-contentful to your space ✨

If everything went smooth you should see something like this in your terminal:

Writing config file...
Config file /Users/my-user/Git/test/mate-portofolio/.env written
β”‚ The following entities are going to be imported: β”‚
β”‚ Content Types                   β”‚ 3              β”‚
β”‚ Editor Interfaces               β”‚ 3              β”‚
β”‚ Entries                         β”‚ 8              β”‚
β”‚ Assets                          β”‚ 6              β”‚
β”‚ Locales                         β”‚ 1              β”‚
β”‚ Webhooks                        β”‚ 0              β”‚
 βœ” Validating content-file
 βœ” Initialize client (1s)
 βœ” Checking if destination space already has any content and retrieving it (2s)
 βœ” Apply transformations to source data (1s)
 βœ” Push content to destination space
   βœ” Connecting to space (1s)
   βœ” Importing Locales (1s)
   βœ” Importing Content Types (4s)
   βœ” Publishing Content Types (3s)
   βœ” Importing Editor Interfaces (3s)
   βœ” Importing Assets (7s)
   βœ” Publishing Assets (3s)
   βœ” Archiving Assets (1s)
   βœ” Importing Content Entries (1s)
   βœ” Publishing Content Entries (5s)
   βœ” Archiving Entries (1s)
   βœ” Creating Web Hooks (0s)
Finished importing all data

After this step we can finally run the project and see the result in http://localhost:8000/ πŸ˜ƒ

yarn start

Screenshot and Design πŸ–Ό

As the starter is a SPA it only has two routes:

Section Screenshot
Home Home
About me About me
Projects Projects
Writing Writing
/404 404

Building your site πŸ“¦

As we are dealing with environment variables, the .env file is excluded from .gitignore file. Therefore, in order to deploy the website you have to send SPACE_ID and ACCESS_TOKEN with the build command.

SPACE_ID=xxxxx ACCESS_TOKEN=yyyyy yarn build

The result will be stored inside the public folder, so you can upload to your webhost. I highly suggest using this starter with Netlify when you can define which command will build the project and also send the environment variables inside the website configuration.

Adding your information πŸ“

All the text of this starter live inside Contentful, more spefically inside the Content of About. In order to change it, just go to Content section and change the entity of About with the information you want.

Contentful About change

Regarding the projects and social links the process is the same! Contentful is really easy to learn so don’t be afraid of breaking everything, remember that you can restore to the start point by running yarn setup πŸ˜„

Tracking with Google Analytics - Optional πŸ“ˆ

This starter has the analytics plugin inside the gatsby-config, so the only need to do in order to enable it is to provide the Tracking Id for your site (starts with UA-). Just set a new variable inside your .env file called ANALYTICS_ID and analytics wil be turn on automatically πŸ˜„

Update your Starter πŸ’‘

In case you cloned this repository before and you want all the latest changes of it, you can execute the following command to update the code in your repository with the one in this repository:

# Add repository remote entry
$ git remote add mate

# Get changes from master branch of gatsby-starter-mate
$ git pull mate master --allow-unrelated-histories

# Reset changes in unnecesary folder/files
$ git reset media/ bin/ manifest-config.js

# Remove files affected by the reset
$ git checkout .

# In this step you migth need to fix a lot of conflicts, you can do fix manually or use just accept all the changes from mate
$ git checkout --theirs .

# WATCH OUT that some configuration can be overwritten in this last step, like package.json, colors, etc. I highly recommend to do an overall look up at the end of fixing the conflicts.

# Install in case there is any new dependency added to the starter
$ yarn

# Build the project to see if everything is working as expected
$ yarn build

Configuration πŸ‘·β€β™‚οΈ

Mate starter is a SPA (Single Page Application), so basically you have only two pages:

The structure for the main page is the following:

  <Landing />
  <About />
  <Projects />
  <Writing />

Layout is the core of the application, it manages the theme for the application, the navigation between sections, also it defines the header.

All the components inside Layout are Section components. A section can have a link inside the Header or not, in order to add you need to wrapped the exported Section with withNavigation HOC and it will be automatically registered (Context magic ✨).

Contributing πŸ’ͺ

I came with the idea of creating the starter after the positive feedback I received when I deployed my website. Therefore this starter is not perfect! I tried my best to remove all the personal information, also improve the code to make it easier to understand.

I’m totally open for pull requests with bug fixes, changes in Documentation, or new features to the starter πŸ™Œ

Plase check the Contribution guidelines before opening yours πŸ™

License πŸ“