README.md

BlogProject.io

Markdown Blog coded in Typescript on Next.js
Explore the docs »

Deployed Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Here's a project that can be valuable for developers who want to have a blog simply and most cheaply. Deploying on Vercel, it's free for hobby accounts. This blog project doesn't use a database, and the posts are Markdown files.

(back to top)

Built With

• Next.js
• TypeScript

(back to top)

Getting Started

To run this project locally is straightforward. It is about clone or forking the repository and installing it. Any beginner can do it with no problem following the instructions.

Prerequisites

To make this project run on your computer, you must have Node.js and Typescript installed.

• to install Node.js go to https://nodejs.org/en/download/
• Typescript

  npm install -g typescript

Installation

1. Clone the repo

   git clone https://github.com/fl4viooliveira/blogproject.git

2. Install NPM packages

   npm install

3. Run the application

   npm run dev

(back to top)

Usage

This project is beneficial as a blog for anyone in special for developers. Creating posts using Markdown is a good practice for most developers.

(back to top)

Roadmap

• Clone the project
• Test and improve the code.
• Please give us feedback, opening new issues.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Another way to contribute to this project is by creating a post.

1. Fork the Project
2. Create your Post Branch (git checkout -b myPost)
3. Create a new .md file on the posts folder using slug format ( It-is-my-post.md)
4. Use the following lines on top of your post file:

---
date: "2022-05-30" # yyyy-mm-dd
title: "It is your post title"
url: "" # If this post was previously posted on another website, please add the URL, to adding it on canonical tag.
author: "fl4viooliveira" # add your GitHub user name
intro: "Write here your post introduction, ..."
category:
  - cat1
  - cat2
tags:
  - tag1
  - tag2
---
YOUR POST CONTENT

5. Commit your Changes (git commit -m "It is my post")
6. Push to the Branch (git push origin myPost)
7. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Twitter - @fl4viooliveira

Project Link: https://github.com/fl4viooliveira/blogproject

(back to top)