Developer's Blog

Every developer needs a simple blog

Checkout the demo : blog.quentinmachard.fr

Table of contents

• 🚀 Quick Start
• 🎨 Personalize
• 💫 Deploy

🚀 Quick Start

1. Fork repository and clone project

   $ git clone https://github.com/<your-username>/blog.git blog
   $ cd blog

2. Install dependencies

   $ yarn install --no-dev

3. Start your app

   $ 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.

2. Setup secrets on your github repository :

   GH_ORGANISATION=<your-username>
   GH_REPOSITORY=<your-repository>
   GH_TOKEN=<your-token> # previously generated token
   SITE_THEME=<theme> # dark or white
   PATH_PREFIX=/developers-blog
   CUSTOM_DOMAIN=<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 :

$ yarn deploy