Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/justintime50/glass

Minimalist blog featuring syntax highlighting, images, comments, themes, RSS, and SEO out of the box.
https://github.com/justintime50/glass

blog blogging comments gatsby images medium minimalist posts rss seo syntax-highlighting themes

Last synced: about 2 months ago
JSON representation

Minimalist blog featuring syntax highlighting, images, comments, themes, RSS, and SEO out of the box.

Host: GitHub
URL: https://github.com/justintime50/glass
Owner: Justintime50
License: mit
Created: 2019-06-21T23:04:57.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-10-24T04:00:38.000Z (2 months ago)
Last Synced: 2024-10-24T21:23:57.080Z (about 2 months ago)
Topics: blog, blogging, comments, gatsby, images, medium, minimalist, posts, rss, seo, syntax-highlighting, themes
Language: PHP
Homepage:
Size: 5.72 MB
Stars: 12
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Glass

Minimalist blog featuring syntax highlighting, images, comments, themes, RSS, and SEO out of the box.

[![Build Status](https://github.com/Justintime50/glass/workflows/build/badge.svg)](https://github.com/Justintime50/glass/actions)
[![Coverage Status](https://coveralls.io/repos/github/Justintime50/glass/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/glass?branch=main)
[![Version](https://img.shields.io/github/v/tag/justintime50/glass)](https://github.com/justintime50/glass/releases)
[![Licence](https://img.shields.io/github/license/justintime50/glass)](LICENSE)

Showcase

Glass draws its simplistic design inspiration from [Medium](https://medium.com) and [Gatsby](https://www.gatsbyjs.org) - striving for minimalism and elegance like a pane of Glass. Glass allows you to quickly deploy a self-hosted blog in just a few simple steps.

## Features

- Custom image support per post
- Comments (can be enabled/disabled)
- Syntax highlighting for code snippets
- Themes to style your blog instance
- RSS feed so users can easily stay up-to-date with the latest posts via `/feed`
- SEO out of the box with custom tags per post
- Admin panel to manage posts, comments, categories, and users
- ReCaptcha on user signup by populating the `NOCAPTCHA_SECRET` and `NOCAPTCHA_SITEKEY` env variables in production

## Install

```bash
# Copy the env files, and edit as needed
cp src/.env-example src/.env && cp .env-example .env

# Run the setup script which will bootstrap all the requirements, spin up the service, and migrate the database
just setup
```

### Install in Subdirectory (Optional)

There is a guide on how to do this [here](https://serversforhackers.com/c/nginx-php-in-subdirectory).

## Usage

Visit `glass.localhost` in a browser to get started.

### Default Login

The default login is `[email protected]` and `password`. **Make sure to update the email/password after first login!**

## Deploy

```bash
# Deploy the project locally
just run

# Deploy the project in production
just prod
```

## Development

```bash
# Get a comprehensive list of development tools
just --list
```