Skip to content
master
Switch branches/tags
Code
This branch is up to date with master.
Contribute

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Gatsby Theme Authentication Enabled Auth0

This is a theme which incorporates Auth0, Material-UI for styling components and a sidebar navigation

See the live demo

Quick Start

git clone https://github.com/ethriel3695/quickstart.git

Create Project

  1. Create a project folder, example: directory C:/source/demo
  2. Through the comand line type cd [projectName]
  3. Create a package.json by typing into the command line:
    npm init
  4. Fill in the package.json in your code editor with the "scripts" below
// package.json
{
  "private": false,
  "name": "demo",
  "version": "0.1.0",
  "license": "MIT",
  "scripts": {
    "build": "gatsby build",
    "develop": "rimraf ./.cache && rimraf ./public && gatsby develop",
    "format": "prettier --write src/**/*.{js,jsx}",
    "start": "npm run develop",
    "serve": "gatsby serve",
    "test": "echo \"Write tests! -> https://gatsby.dev/unit-testing\""
  }
}
  1. Through the command line type
npm i gatsby gatsby-theme-auth-app react react-dom
  1. Create a content folder in the root directory of your project
  2. Create an assets folder in the content directory of your project
  3. Create a post folder in the content directory of your project

Assets

If you want to add a hero image:

  1. Create a hero folder and add an image to the folder

If you want a logo:

  1. Create a logo folder and add your logo named logo.[fileExtension]

Post Creation

NOTE: Iterate the post folders for example 01, 02, 03 Folder structure 01/images/[image], [postName].mdx

NOTE: As of Version 1.1.2, Images are now optional. You no longer have to include a banner attribute in your MDX file

MDX file requirements

Header Format


Key Expected value Description Required
slug /[routeName] The Slug is the route appended to the url for this post Yes
label Label for Nav The name of the NavBar label Yes
title Title The title of the post Yes
description Description Description of Post Yes
date Date Date of post. Navbar and posts are ordered by Date DESC. Date Format: 2019-09-29 No
categories [Tag, Tag] These categories will be used as tags for filtering. A future update will rename categories to tags No
showBanner false/true Determines whether the banner is shown on the post page Yes
banner imagePath ./images/imageName.extension Example: ./images/placeholder.jpg No
published false/true Post will only show up if published is true Yes

Installation

To use this theme in your Gatsby sites, follow these instructions:

  1. Install the theme
npm i gatsby-theme-auth-app

Theme options

Key Default value Description
basePath / Root url for all blog posts
contentPath /content/post Location of blog posts
excelPath /content/excel Use excel data to generate page content
assetPath /content/assets Location of assets
mdx true Configure gatsby-plugin-mdx (if your website already is using the plugin pass false to turn this off)

Additional configuration

In addition to the theme options, there are a handful of items you must modify via the siteMetadata object in your site's gatsby-config.js

The Social tags, if left as an empty string will not appear in the footer

The External Links are for related links to other websites. Example: https://www.google.com

// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: 'gatsby-theme-auth-app',
      options: {}
    }
  ],
  siteMetadata: {
    title: `Demo`,
    author: `Reuben Ellis`,
    description: `An Authentication Site Built with Gatsby, GraphQL, Material-UI and Auth0.`,
    greeting: `This is an optional greeting for a home page with a Hero image`,
    copyright: `Copyright © 2019 [Business] - No part of this website may be reproduced without specific written permission... Just Kidding Copy Away!!!`,
    loginDesc: 'Login / Signup',
    isAuthApp: false,
    social: {
      facebook: 'https://www.facebook.com/altcampus',
      twitter: 'https://www.twitter.com/altcampus',
      github: 'https://www.github.com/[githubUserName]',
      email: 'test@example.com'
    },
    externalLinks: [{ label: '', link: '' }]
  }
};

Only if isAuthApp is set to true in the gatsby-config file

  1. Create An .env.development file to hold your environment variables
  2. In addition replace the values in the site's .env.development file with the correct values from your Auth0 account. If you do not have an Auth0 account create one for free Auth0
// .env.development
GATSBY_AUTH0_DOMAIN = domain.auth0.com; // Replace domain with your auth0 domain
GATSBY_AUTH0_CLIENT_ID = secret_client_id; // This ID can be found after creating an Application within Auth0 within the Application tab
GATSBY_AUTH0_CALLBACK_URL = `http://localhost:8000/callback`; //Remove the literal string character when replacing the callback url
GATSBY_AUTH0_REDIRECT_URL = `http://localhost:8000`; //Remove the literal string character when replacing the callback url
  1. /content: A content folder holding assets that the theme expects to exist. This will vary from theme to theme -- this starter expects a logo directory with either a png, jpg or svg image, a post directory for content and mdx files and a data directory for JSON files. NOTE If the logo directory is empty the theme will use the title attribute in the gatsby-config.js file.

  2. /src: You will probably want to customize your site to personalize it. The files under /src/gatsby-theme-auth-app shadow, or override, the files of the same name in the gatsby-theme-auth-app package. To learn more about this, check out the guide to getting started with using the blog theme starter.

Example: src/gatsby-theme-auth-app/components/layout.css and then edit the following hex values for color scheme changes:

.appHeader {
  background: linear-gradient(
    to bottom,
    #325da7 0%,
    #325da7 19%,
    #325da7 30%,
    #325da7 100%
  );
  box-shadow: inset 0 1px 6px 0 #325da7;
  flex-grow: 1;
  margin: auto 0;
}

.fontAwesomeFooterIcon {
  color: #325da7;
  cursor: pointer;
  text-decoration: none;
  text-shadow: 2px 2px #282828;
}

.socialLink {
  cursor: pointer;
  font-size: 25px;
  margin: 1rem 1rem;
  text-decoration: none;
}

.externalLink {
  color: #325da7;
  font-size: 18px;
  margin: 1rem 1rem;
  text-decoration: none;
  text-shadow: 2px 2px #dddddd;
}
  1. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  2. .prettierrc: This file tells Prettier which configuration it should use to lint files.

  3. 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. When using themes, it's where you'll include the theme plugin, and any customization options the theme provides.

  4. LICENSE: Gatsby is licensed under the MIT license.

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

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

  7. README.md: A text file containing useful reference information about your project.

About

An example submission for the Gatsby Theme Jam.

Resources

Releases

No releases published

Packages

No packages published