Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/qmachard/developers-blog

Every developer needs a simple blog
https://github.com/qmachard/developers-blog

blog cms developer github-page tools

Last synced: about 2 months ago
JSON representation

Every developer needs a simple blog

Awesome Lists containing this project

README

        



Gatsby



Developer's Blog


Every developer needs a simple blog


Checkout the demo : blog.quentinmachard.fr



Build Status on Github Actions


License

## Table of contents

- 🚀 [Quick Start](#-quick-start)
- 🎨 [Personalize](#-personalize)
- 💫 [Deploy](#-deploy)

## 🚀 Quick Start

1. Fork repository and clone project

```bash
$ git clone https://github.com//blog.git blog
$ cd blog
```

1. Install dependencies

```bash
$ yarn install --no-dev
```

1. Start your app

```bash
$ yarn start
```

## 🎨 Personalize

TODO

## 💫 Deploy

For the moment only GitHub Pages is provided by the project.

### Prepare deployment

1. Generate your secret token :

Go to https://github.com/settings/tokens/new and enable `repos` scope.

1. Setup secrets on your github repository :

```
GH_ORGANISATION=
GH_REPOSITORY=
GH_TOKEN= # previously generated token
SITE_THEME= # dark or white
PATH_PREFIX=/developers-blog
CUSTOM_DOMAIN=
```

### Automatic Deployment

This blog is automatically deployed to Github Pages for two cases :

- When issues are closed to publish new articles
- When push on master to upgrade blog

This actions are managed by GitHub Actions

### Manual Deployment

It's possible to manually deploy the blog with this command :

```bash
$ yarn deploy
```