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: 5 days ago
JSON representation

Every developer needs a simple blog

• Host: GitHub
• URL: https://github.com/qmachard/developers-blog
• Owner: qmachard
• License: mit
• Created: 2019-07-19T11:39:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T22:58:18.000Z (almost 2 years ago)
• Last Synced: 2024-07-12T04:34:01.806Z (4 months ago)
• Topics: blog, cms, developer, github-page, tools
• Language: JavaScript
• Homepage:
• Size: 9.34 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  

    

  





  Developer's Blog





  Every developer needs a simple blog





  Checkout the demo : blog.quentinmachard.fr





  

    

  

  

    

  

## 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

```