https://github.com/piercel2022/blog-starter

Blog starter is a A statically generated blog example using Next.js, Markdown, and TypeScript. The blog posts in the example will be stored as local markdown files in the application's directory (not fetched from an external data source), so there will be the need to read the data from the file system.
https://github.com/piercel2022/blog-starter

javascript tailwind typescript

Last synced: 10 days ago
JSON representation

Blog starter is a A statically generated blog example using Next.js, Markdown, and TypeScript. The blog posts in the example will be stored as local markdown files in the application's directory (not fetched from an external data source), so there will be the need to read the data from the file system.

• Host: GitHub
• URL: https://github.com/piercel2022/blog-starter
• Owner: Piercel2022
• License: mit
• Created: 2023-06-23T06:14:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-20T23:53:45.000Z (12 months ago)
• Last Synced: 2024-10-09T10:21:53.538Z (28 days ago)
• Topics: javascript, tailwind, typescript
• Language: TypeScript
• Homepage: https://react-rails.netlify.app/
• Size: 841 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

REQUIRED SECTIONS:

- Table of Contents

- About the Project

  - Built With

  - Live Demo

- Getting Started

- Authors

- Future Features

- Contributing

- Show your support

- Acknowledgements

- License

# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

**[Blog-starter]** is a A statically generated blog example using Next.js, Markdown, and TypeScript.

The blog posts in the example will be stored as local markdown files in the application's directory (not fetched from an external data source), 

so there will be the need to read the data from the file system.It is built using the TypeScript programming language and leverages the power and flexibility of Markdown for content creation.

## 🛠 Built With 

### Tech Stack 

  Language

  


    
Typescript

  


  Server

  


    
Next.js


  

    Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, 

    then convert it to structurally valid XHTML (or HTML).

  

  


    
Markdown

  


MD

  


    
MarkDown

  


### Key Features 

- **[key_feature_1]**

- **[key_feature_2]**

- **[key_feature_3]**

![Screenshot1](https://github.com/Piercel2022/Blog-starter/assets/98626003/a5a70ca4-603c-4bd4-996f-175e8ce1eb95)

![Screenshot2](https://github.com/Piercel2022/Blog-starter/assets/98626003/91d5ef2b-0d23-4b9b-a43b-14d66a4e07f5)

![Screenshot3](https://github.com/Piercel2022/Blog-starter/assets/98626003/4dc89028-e97f-4b07-abed-df1f711c7313)

  TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.

  


    
typescript

  



### Key Features 

- **[Post creation]**

- **[Blog post management]**

- **[Deployment and Hosting]**

(back to top)


## 🚀 Live Demo 

- [blog starter](https://react-rails.netlify.app/)

(back to top)

- [Live Demo](https://react-rails.netlify.app/)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

```sh

 yarn

```

Ruby, rails and postgresql installed

### Setup

Clone this repository to your desired folder:

```sh

  git clone https://github.com/Piercel2022/Blog-starter

```

```sh

  git clone [email protected]:Piercel2022/Blog-starter.git

  cd Blog-starter

```

### Usage

To run the project, execute the following command:

```sh

  yarn run dev

```

## 👥 Authors 

```sh

  yarn run build

```

(back to top)


## 👥 Author 

👤 **Pierre Celestin Moussa**

- GitHub: https://github.com/Piercel2022

- Twitter: https://twitter.com/pier_celestin

- LinkedIn: https://linkedin.com/in/piercelestinmax

## 🔭 Future Features 

- [ ] **[new_feature_1]**

- [ ] **[new_feature_2]**

- [ ] **[new_feature_3]**

(back to top)


- GitHub:[@Piercel2022](https://github.com/Piercel2022)

- Twitter:[@pier_celestin](https://twitter.com/pier_celestin)

- LinkedIn: [@pierrecelestinmax](https://linkedin.com/in/pierrecelestinmax)

(back to top)


## 🔭 Future Features 

- [ ] **[User Authentication ]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


(back to top)

## ⭐️ Show your support 


If you like this project...

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the knowledge I have gain during my studies

(back to top)

## 🙏 Acknowledgments 


I would like to thank...

## 📝 License 

This project is [MIT](./LICENSE) licensed.