Code Monkey home page Code Monkey logo

kunalkeshan / mkd-blog Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 8.0 2.75 MB

mkd-blog short for Markdown Blog is a blogging platform where anyone can share the articles they write to the world. The editing platform of the mkd-blog uses articles written in Markdown and is converted into HTML.

License: MIT License

EJS 17.33% JavaScript 62.30% CSS 20.37%
nodejs expressjs blogging blog javascript ejs sql mysql full-stack-application html css markdown

mkd-blog's Introduction

mkd-blog

What is mkd-blog? Aim/Outcome/Intro


mkd-blog short for Markdown Blog is a blogging platform where anyone can share their articles they write to the world. The editing platform of the mkd-blog is markdown based, users can write their articles in markdown and it is later rendered as html in the output.

Users with the knowledge of Markdown can use the platform to create articles and share it in a decorated manner.

mkd-blog Features


Core Feature

💡 Users can write their articles in Markdown and can easily share it to the world with a simple link.

Minimum Viable Product (MVP)

  1. Signup and Sign-in for Users.
  2. Edit user profile page.
  3. Create New Articles.
  4. Update Existing Articles. (belonging to that user)
  5. Delete Existing Articles. (belonging to that user)
  6. Read a article in a single page.

Additional

  1. Save articles for later or Read Later Option.
  2. Use Rebrandly API to create short URL’s or articles and use that to share the articles.
  3. Archive written articles.
  4. Allow Tags/Categories for articles.
  5. Like a comment.
  6. Implementing Editor.js Or TinyMCE to create easy to use Text Editor.
  7. Light and Dark Mode Toggle Feature.
  8. Share to Social Media buttons. Copy it to Clipboard.
  9. Highlight text and options to share it on twitter, and other social media along with copy to clipboard option.
  10. Embed Article Option.
  11. Like a article.
  12. Follow a author.
  13. Add Comments to an article.
  14. Display existing articles in the homepage.

mkd-blog Worked With

Role Name Contact
Team Lead Kunal Keshan [email protected]
Vice Team Lead Himanshu [email protected]
Developer Sitanshu Pokalwar [email protected]
Developer Sahil Kumar [email protected]
Developer Krishna Chaitanya Thota [email protected]
Developer Udit Gogia [email protected]
Developer Sai Surya Varun Appala [email protected]

Links To Project


Github

https://github.com/kunalkeshan/mkd-blog

Site (Work in Progress)

Quick Links

📨Detailed Development Documentation: mkd-blog Dev Docs

mkd-blog's People

Stargazers

 avatar  avatar

Watchers

 avatar

mkd-blog's Issues

Should Home really be Authenticated?

  • All blog articles allow their users to access their home page see articles and even read them.
  • The only difference is that, certain actions like, follow, like and comment cannot be done until the user has signed up or is already logged in.

Change API Endpoints

Change the API Endpoints to adapt

ToDo:
/<variant>/api/<request/ => /api/<variant>/<request

Eg:

  • /author/api/isUsernameUnique => /api/author/isUsernameUnique

CTA:
Change in...

  • Routes
  • Controllers
  • Comments
  • Documentaion
  • Postman

Welcome and Verify Email - Security Issue

Security Performance Suggestion

  • Keep verify account links as time-sensitive links using JWT.
  • Add another feature to request another verify account email which is time-sensitive as well.
  • Approx. 1 week should do it!

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.