Git Product home page Git Product logo

react-blog-github's Introduction

React Blog

React + Github Issues ๐Ÿ‘‰ Your Personal Blog ๐Ÿ”ฅ

React Blog is a personal blog system build on React that helps you create your own personal blog using Github Issues


๐Ÿ”ฅ Features

โœ… Own your content
โœ… Write using Markdown On Github Issues
โœ… Syntax/Code Highlighting
โœ… Fully customizable
โœ… Tags - Topics
โœ… Links
โœ… Reactions
โœ… Images
โœ… Minutes Read
โœ… Beautiful UI Like Medium
โœ… Easy deployment: Using Github Pages
โœ… Instant Effects on Blog when changing github issues
โœ… Beautiful blockquote

๐Ÿ”— Live Demo

Here's a live demo

Github Issues / Blogs


๐Ÿš€ Get Up and Running in 10 Minutes

You can get a react-blog site up and running on your local dev environment in 10 minutes with these five steps:

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

You'll need Git and Node.js (which comes with npm) installed on your computer

1. From your command line, clone and run react-blog-github:

# Clone this repository
$ git clone https://github.com/username/react-blog-github.git

# Go into the repository
$ cd react-blog-github

# Install dependencies
$ npm install

2. Generate a Github Personal Access Token.

Generate a Github personal access token using these Instructions Make sure you don't select any scope just generate a simple token without any scope

After that copy your generated token and then encode your token into base 64 using this Website

Copy your base64 converted token

3. Change /src/config.js.

Go to your cloned repository and make the following changes in /src/config.js

export const config = {

  // Your Github Converted Token
  githubConvertedToken: "Github Converted Token",

  //   Your Github User Name
  githubUserName: "saadpasta",

  //   Your Github Repo Name Where You Have your issues as Blog

  githubRepo: "react-blog-github",

  // Your Personal Blog Title 

  title : "Saad Pasta" , 

  // Your Personal Blog Subtitle 

  subtitle : "Front End Developer Blog"
  
};

4. Write A Blog.

After doing following changes now you just need to write a blog on repository issues that you have mentioned in your config.js

  • Open your repository github issues
  • Create a new issue
  • Now write your blog in github issue in markdown. You can also use slack edit to write your markdown
  • Add a label blog on your github issue to make it different from other standard issues. Keep in mind blog label is mandatory otherwise it won't show on your website.

5. Start Your React App.

That's it now you just need to start your react application From your command line run .

# Run
$ npm start

๐Ÿ› ๏ธ Technologies used

This project is only possible thanks to the awesomeness of the following projects:

๐ŸŒฑ Inspiration

This project is inspired from many other similar projects.

๐Ÿค Contributing

Any idea on how we can make this more awesome ? Open a new issue! We need all the help we can get to make this project awesome!

๐Ÿ’ฅ Todo

  • Add Comment From Github
  • Add Loader
  • Authentication using Github
  • Seo using React helmet
  • Footer
  • Header
  • Social Media Sharing

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


SyedMuhammadHammadGhani

๐Ÿ“–

Saad Pasta

๐Ÿ’ป ๐Ÿ“– ๐ŸŽจ ๐Ÿšง

Jason Van Malder

๐Ÿ’ป ๐Ÿš‡

This project follows the all-contributors specification. Contributions of any kind welcome!

react-blog-github's People

Contributors

saadpasta avatar allcontributors[bot] avatar muhammad-hammad avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.