Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/pranavrajs/personal-blog

Last synced: 3 days ago
JSON representation
Host: GitHub
URL: https://github.com/pranavrajs/personal-blog
Owner: pranavrajs
License: mit
Created: 2019-11-09T18:07:10.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2023-01-11T20:53:09.000Z (almost 2 years ago)
Last Synced: 2024-12-10T21:08:12.720Z (13 days ago)
Language: JavaScript
Size: 21.9 MB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        


     

    Lumen





  A minimal, lightweight and mobile-first starter for creating blogs uses Gatsby.





        



## Table of contents

+ [Features](http://github.com/alxshelepenok/gatsby-starter-lumen#features)

+ [Web Performance Tests](http://github.com/alxshelepenok/gatsby-starter-lumen#web-performance-tests)

+ [Quick Start](http://github.com/alxshelepenok/gatsby-starter-lumen#quick-start)

+ [Deploy with Netlify](http://github.com/alxshelepenok/gatsby-starter-lumen#deploy-with-netlify)

+ [Folder Structure](http://github.com/alxshelepenok/gatsby-starter-lumen#folder-structure)

+ [Related](http://github.com/alxshelepenok/gatsby-starter-lumen#related)

+ [Contributors](http://github.com/alxshelepenok/gatsby-starter-lumen#contributors)

+ [Backers](http://github.com/alxshelepenok/gatsby-starter-lumen#backers)

+ [Sponsors](http://github.com/alxshelepenok/gatsby-starter-lumen#sponsors)

+ [Credits](http://github.com/alxshelepenok/gatsby-starter-lumen#credits)

+ [License](http://github.com/alxshelepenok/gatsby-starter-lumen#license)

## Features

+ [Lost Grid](http://lostgrid.org).

+ [Modern font stack](https://bitsofco.de/the-new-system-font-stack).

+ Beautiful typography inspired by [matejlatin/Gutenberg](https://github.com/matejlatin/Gutenberg).

+ Syntax highlighting in code blocks using [PrismJS](http://prismjs.com).

+ [Mobile-First](https://medium.com/@mrmrs_/mobile-first-css-48bc4cc3f60f) approach in development.

+ Archive organized by tags and categories.

+ Pagination support.

+ [Netlify CMS](https://www.netlifycms.org) support.

+ Google Analytics.

+ Disqus Comments.

+ [Flow](https://flow.org/) static type checking.

## Web Performance Tests

+ Lighthouse Report - [WebPageTest](https://www.webpagetest.org/result/190510_FE_3f2b13d0beed320f477467d433f56f43/)

+ Visual Comparison - [WebPageTest](https://www.webpagetest.org/video/compare.php?tests=190510_KZ_1228c343ccf04148619a5d0b89a41f71,190510_RE_b3bfad442f32c690a9f420fe46025b8d,190510_RS_3b5f0bff2d95161351dc6934cadbf1cf,190510_SC_5c458c451941f81b12911ccf4171a817,190510_63_52d5edd8743773815fbacb2e9c66d228,190510_AS_741b29f5af5a6e54980d82826d7bb5bb)

## Quick Start

#### Create a Gatsby site

Use the Gatsby CLI to create a new site, specifying the Lumen starter.

```sh

# Create a new Gatsby site using the Lumen starter

gatsby new blog https://github.com/alxshelepenok/gatsby-starter-lumen

```

#### Start Developing

Navigate into your new site’s directory and start it up.

```sh

cd blog

gatsby develop

```

#### Open the source code and start editing!

Your site is now running at `http://localhost:8000`!

Note: You'll also see a second link: `http://localhost:8000/___graphql`. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql).

Open the `blog` directory in your code editor of choice and edit `src/templates/index-template.js`. Save your changes and the browser will update in real time!

## Deploy with Netlify

[Netlify](https://netlify.com) CMS can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. Use the button below to build and deploy your own copy of the repository:



After clicking that button, you’ll authenticate with GitHub and choose a repository name. Netlify will then automatically create a repository in your GitHub account with a copy of the files from the template. Next, it will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete. Next, you’ll need to set up Netlify’s Identity service to authorize users to log in to the CMS.

## Deploy to Github Pages

To deploy to github pages, simply do the following:

- Ensure that your `package.json` file correctly reflects where this repo lives

- Change the `pathPrefix` in your `config.js`

- Run the standard deploy command

```sh

npm run deploy

```

#### Access Locally

```

$ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git

$ cd [REPO_NAME]

$ yarn

$ npm run develop

```

To test the CMS locally, you'll need run a production build of the site:

```

$ npm run build

$ gatsby serve

```

## Folder Structure

```

└── content

    ├── pages

    └── posts

└── static

    ├── admin

    └── media

└── src

    ├── assets

    │   └── scss

    │       ├── base

    │       └── mixins

    ├── cms

    │   └── preview-templates

    ├── components

    │   ├── Feed

    │   ├── Icon

    │   ├── Layout

    │   ├── Page

    │   ├── Pagination

    │   ├── Post

    │   │   ├── Author

    │   │   ├── Comments

    │   │   ├── Content

    │   │   ├── Meta

    │   │   └── Tags

    │   └── Sidebar

    │       ├── Author

    │       ├── Contacts

    │       ├── Copyright

    │       └── Menu

    ├── constants

    ├── templates

    └── utils

```

## Related

[Statinamic port](https://github.com/thangngoc89/statinamic-theme-lumen) by [Khoa Nguyen](https://github.com/thangngoc89)

## Contributors

Thanks goes to these wonderful people!

[](https://github.com/vzhou842) |[](https://github.com/abisz) |[](https://github.com/mariolopjr) |[](https://github.com/alehel) |[](https://github.com/ihororlovskyi) |[](https://github.com/timbroder) |

:---: |:---: |:---: |:---: |:---: |:---: |

[vzhou842](https://github.com/vzhou842) |[abisz](https://github.com/abisz) |[mariolopjr](https://github.com/mariolopjr) |[alehel](https://github.com/alehel) |[ihororlovskyi](https://github.com/ihororlovskyi) |[timbroder](https://github.com/timbroder) |

[](https://github.com/vinnymac) |[](https://github.com/yodahuang) |[](https://github.com/axelclark) |[](https://github.com/BigTony666) |[](https://github.com/stigrune) |[](https://github.com/ybbarng) |

:---: |:---: |:---: |:---: |:---: |:---: |

[vinnymac](https://github.com/vinnymac) |[yodahuang](https://github.com/yodahuang) |[axelclark](https://github.com/axelclark) |[BigTony666](https://github.com/BigTony666) |[stigrune](https://github.com/stigrune) |[ybbarng](https://github.com/ybbarng) |

[](https://github.com/marktani) |[](https://github.com/concreted) |[](https://github.com/chmac) |[](https://github.com/charandas) |[](https://github.com/marcelabomfim) |[](https://github.com/zollillo) |

:---: |:---: |:---: |:---: |:---: |:---: |

[marktani](https://github.com/marktani) |[concreted](https://github.com/concreted) |[chmac](https://github.com/chmac) |[charandas](https://github.com/charandas) |[marcelabomfim](https://github.com/marcelabomfim) |[zollillo](https://github.com/zollillo) |

[](https://github.com/codejet) |[](https://github.com/reed-jones) |[](https://github.com/SayakaOno) |[](https://github.com/swapnilmishra) |[](https://github.com/vvasiloud) |[](https://github.com/vstoms) |

:---: |:---: |:---: |:---: |:---: |:---: |

[codejet](https://github.com/codejet) |[reed-jones](https://github.com/reed-jones) |[SayakaOno](https://github.com/SayakaOno) |[swapnilmishra](https://github.com/swapnilmishra) |[vvasiloud](https://github.com/vvasiloud) |[vstoms](https://github.com/vstoms) |

[](https://github.com/wichopy) |[](https://github.com/yairmark) |

:---: |:---: |

[wichopy](https://github.com/wichopy) |[yairmark](https://github.com/yairmark) |

## Backers [![Backers on Open Collective](https://opencollective.com/lumen/backers/badge.svg)](#backers)

Thank you to all our backers!



## Sponsors [![Sponsors on Open Collective](https://opencollective.com/lumen/sponsors/badge.svg)](#sponsors)

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.





















## Credits

Nature graphic by [Anna Bearne](https://www.behance.net/annabearne) from [Noun Project](https://thenounproject.com/) is licensed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/us/legalcode).

## License

The MIT License (MIT)

Copyright (c) 2016-2019 Alexander Shelepenok

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.