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 bidirectional, i.e. raw articles can be written in text and converted into HTML & Markdown, simultaneously, articles written in Markdown is also converted into HTML and Text.
Users with or without the knowledge of Markdown can use the platform to create articles and share it in a decorated manner.
| HTML | CSS | JS |
|---|---|---|
| To build the structure and layout of the website. | To style the website to provide a reasonable user experience. | To add the core functionality of the project into the website. |
| Nodejs and Expressjs | MySQL | EJS |
|---|---|---|
| To create the server side application that will run the logic of the mkd-blog. | Database management system to manage data associated with the mkd-blog. | To create dynamic pages easily and to manage small components of mkd-blog. |
| Axios |
|---|
| Axios is used to make the required requests to the server as it offers easy to use methods for direct communication and data exchange. |
| Git | GitHub |
|---|---|
| To track different versions of code in the local system. | To collaborate with team and have a track of code of all members across a single platform |
| Server at Heroku | MySQL at (to be decided) |
|---|---|
| Heroku is used to keep the server side up and running 24/7 and serve the application to the end user. | (To be decided) |
| TailwindCSS | Rebrandly API | EditorJS |
|---|---|---|
| Using tailwinds utility classes to create mockup in a quick and reliable manner. | To create short URLs for all articles. | EditorJS used UI to edit text as per user requirements and allow to save and edit for later. Make it easier as we don’t have to implement our own text editor. Other than one for Markdown. |
| SASS (Syntactically awesome style sheets) |
|---|
| SASS to organize styles and keep track of project related variables in a more organized manner |
💡 Users can write their articles in plain text or Markdown and can easily share it to the world with a simple link.
- Signup and Sign-in for Users.
- Edit user profile page.
- Create New Articles.
- Update Existing Articles. (belonging to that user)
- Delete Existing Articles. (belonging to that user)
- Read a article in a single page.
- Like a article.
- Follow a author.
- Add Comments to an article.
- Display existing articles in the homepage.
- Save articles for later or Read Later Option.
- Use Rebrandly API to create short URL’s or articles and use that to share the articles.
- Archive written articles.
- Allow Tags/Categories for articles.
- Like a comment.
- Implementing Editor.js to create easy to use Text Editor.
- Light and Dark Mode Toggle Feature.
-
v1.0 as on
-
Layout Desktop
-
Layout Mobile
| 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 | ||
| Developer | ||
| Developer |
https://github.com/kunalkeshan/mkd-blog
📨 Bitly Mini Link to this Documentation: https://bit.ly/mkdBlogDevDocs
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent