Table of Contents
Feather is a fully-functioning blog web application that supports Markdown and also implements a complete user model with custom profile pages, dynamic post routes, and username+password based auth-flow.
Every user can write a blog post and additionally provide a title, subtitle, and a cover image to go with the content. They can also delete their posts from their profile page. The blog supports Markdown and hence all the text formatting such as headings, subheadings, lists, links, bold/italics also work.
To get a local copy up and running follow these simple example steps.
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/outoflaksh/feather-blog.git
- Install NPM packages
npm install
- Enter a MongoDB connection string in a
.envfileMONGO_URI=<your connection string (Atlas or localhost)> - Start the development server by executing:
npm run devStart
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License.
Lakshya Malik - IG: @outoflaksh
Project Link: https://github.com/outoflaksh/feather-blog