https://github.com/fl4viooliveira/blogproject
Markdown Blog coded in Typescript on Next.js
https://github.com/fl4viooliveira/blogproject
blog community firstcontributions javascript markdown nextjs opensource seo-optimization typescript webdev
Last synced: about 2 months ago
JSON representation
Markdown Blog coded in Typescript on Next.js
- Host: GitHub
- URL: https://github.com/fl4viooliveira/blogproject
- Owner: fl4viooliveira
- License: mit
- Created: 2022-05-29T17:20:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-10T22:41:55.000Z (over 3 years ago)
- Last Synced: 2025-02-10T01:35:23.946Z (over 1 year ago)
- Topics: blog, community, firstcontributions, javascript, markdown, nextjs, opensource, seo-optimization, typescript, webdev
- Language: TypeScript
- Homepage:
- Size: 372 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/fl4viooliveira/blogproject/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
[](https://github.com/fl4viooliveira/blogproject/graphs/contributors)
[](https://github.com/fl4viooliveira/blogproject/network/members)
[](https://github.com/fl4viooliveira/blogproject/stargazers)
[](https://github.com/fl4viooliveira/blogproject/issues)
[](https://github.com/fl4viooliveira/blogproject/blob/main/LICENSE.md)
[](https://linkedin.com/in/fl4viooliveira)
BlogProject.io
Markdown Blog coded in Typescript on Next.js
Explore the docs »
Deployed Website
·
Report Bug
·
Request Feature
Table of Contents
## 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.
### Built With
- [Next.js](https://nextjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
## 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/](https://nodejs.org/en/download/)
- Typescript
```sh
npm install -g typescript
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/fl4viooliveira/blogproject.git
```
2. Install NPM packages
```sh
npm install
```
3. Run the application
```js
npm run dev
```
## 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.
## Roadmap
- [ ] Clone the project
- [ ] Test and improve the code.
- [ ] Please give us feedback, opening new issues.
See the [open issues](https://github.com/fl4viooliveira/blogproject/issues) for a full list of proposed features (and known issues).
## 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:
```yaml
---
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
## License
Distributed under the MIT License. See `LICENSE.md` for more information.
## Contact
Twitter - [@fl4viooliveira](https://twitter.com/fl4viooliveira)
Project Link: [https://github.com/fl4viooliveira/blogproject](https://github.com/fl4viooliveira/blogproject)
[](https://github.com/fl4viooliveira/blogproject/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
[](https://github.com/fl4viooliveira/blogproject/graphs/contributors)
[](https://github.com/fl4viooliveira/blogproject/network/members)
[](https://github.com/fl4viooliveira/blogproject/stargazers)
[](https://github.com/fl4viooliveira/blogproject/issues)
[](https://github.com/fl4viooliveira/blogproject/blob/main/LICENSE.md)
[](https://linkedin.com/in/fl4viooliveira)