Code Monkey home page Code Monkey logo

simarmannsingh / silverlux Goto Github PK

View Code? Open in Web Editor NEW
48.0 1.0 13.0 18 MB

All the technologies used are free and open-source. You are free to use this template for a personal or commercial purposes. I'm using this template for my blog as well at https://simarmannsingh.com. Don't forget to star the repo if you like this template.

Home Page: https://silverlux.netlify.app/

License: Other

JavaScript 84.30% Sass 15.70%
template blog-template reactjs gatsby netlify netlify-cms responsive jamstack graphql blog

silverlux's Introduction

Silverlux

Logo

LIVE DEMO

NOTE: Identity update - Gatsby-netlifycms-starter-template is now Silverlux

A fully-responsive Gatsby based web-app template which can be easily hosted on any platform. This web-app uses the Netlify CMS as its content management system.

It follows the JAMstack architecture by using Git as a single source of truth, and Netlify for continuous deployment, and CDN distribution. Surely you can use a different host. Netlify CMS and Netlify are two different products and not to be confused as one dependent on another. You are free to use both in combination and separately as well.

A detailed blog post on how you can use this template for your blog (for free obviously) can be found here

Getting Started

There are two ways you can use this template

  1. First Approach(Recommended) Use the button below and it'll automatically take you to the netlify and ask you to create a repository on your behalf in Github/Gitlab/Bitbucket as per you select. This is the recommended approach as it automatically takes care of all the process steps. You don't need to do anything else.

    Deploy to Netlify

  2. Second Approach Do it manually. It requires you to clone/fork this repository in your Github account, and setup the development environment in your system, install all the dependencies and then setup netlify account to pull the github published code for deployment. This approach is for advanced users as it allows users to edit the code and tweak the code as per preferences and it requires knowledge of code, development environment, deployment etc.

Features

  • A simple blogging web-app built with Netlify CMS
  • Editable Pages: About, Blog-Collection and Contact page with Netlify Form support
  • Custom 404 page
  • Tags support: Separate page for posts under each tag
  • Scroll to Top button on every page
  • Create Blog posts from Netlify CMS
  • Uses Bulma for styling, but size is reduced by purge-css-plugin
  • Blazing fast loading times thanks to pre-rendered HTML and automatic chunk loading of JS files
  • Uses gatsby-image with Netlify-CMS preview support
  • Separate components for everything
  • Perfect score on Lighthouse for SEO, Accessibility and Performance
  • Comment and Like functionality
  • Cookie Consent

New Features in v1.4

  • Full text Search functionality powered by Fuse.js

Customization required for Comment functionality

For ease of access, the comment functionality provided by Disqus, has been added.
However, slight configure is required to make it fully functional.

  1. Register your website on the disqus platform, you'll get a shortname
  2. Update the shortname assigned to the Environment variable DISQUS_SHORTNAME here. Save it
  3. If deploying on services like Heroku (free tier is over, it is paid now, but you're rich ? :p), make sure to add this environment variable to the service as well.

A detailed blog post on how to configure the Disqus plugin can be found here

Prerequisites for the development environment

For local development, you need

Running Locally

To run or test the changes locally, simply follow these steps.

  • Use the right version of node, if you use nvm

    nvm use 14.20

    If you don't use nvm to manage the Node version in use, oh boy,..phew!

  • Install all the dependencies using

    yarn install
  • After installing the dependencies, simply start for development mode

    yarn start
  • You can also create a production build for manual deployment using

    yarn build

Note: You can use Netlify CMS locally, just open another terminal and run the following command

npx netlify-cms-proxy-server

and start run gatsby develop.

Setting up the CMS

Follow the Netlify CMS Quick Start Guide to set up authentication, and hosting. You would need to enable Identity in the Netlify account if you are using Netlify for website deployment.

Debugging

Windows users might encounter node-gyp errors when trying to npm install. To resolve, make sure that you have both Python 2.7 and the Visual C++ build environment installed.

npm config set python python2.7
npm install --global --production windows-build-tools

Full details here

MacOS users might also encounter some errors, for more info check node-gyp. We recommend using the latest stable node version.

Purgecss

This plugin uses gatsby-plugin-purgecss and bulma. The bulma builds which usually generate a ~170Kb of .css file are reduced 90% by purgecss resulting in a .css file which at max is 16-18Kb.

Contribution

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

A Screenshot of the Blog Post. [Old]

Disclaimer: Screenshots are old. I'm too lazy to take fresh screenshots again.

Main Page

screenshot

Blog Post

Update: The blog post now also features comment section and Cookie Consent.

blog post screenshot

Upcoming Features in Next versions (TODO)

  • Dark Theme

License

This repository has MIT license which can be found here.

silverlux's People

Contributors

dependabot[bot] avatar simarmannsingh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

silverlux's Issues

GNST-1: TypeError: Cannot read property 'childImageSharp' of undefined (Netlify CMS)

Describe the bug
The live preview in the Netlify CMS is showing an error after initial clean installation.

To Reproduce

Steps to reproduce the behavior:

  1. Install the starter template with "Deploy to Netlify" button on this project
  2. Login to the Netlify CMS
  3. Create a new blog
  4. See error

Expected behavior

The live preview should have opened on the split screen

Screenshots

Error Screenshot

Disqus Comment System

Feature request

What is the expected behavior?
I want disqus comment on this template! Ut also has reaction button feature.

What is motivation or use case for adding/changing the behavior?
It already added on todo list.

How should this be implemented in your opinion?
Add disqus code on gatsby-config.js and redeploy

Are you willing to work on this yourself?
yes

Dark Theme

Hello.
I'm a beginner just starting to learn Gatsby.

I'm glad to meet a very nice theme.
A dark theme is ideal, so I'm looking forward to an early implementation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.