README.md

Conduit - A Blogging App

📌 Introduction

"Conduit" is a social blogging site (i.e. like Medium.com )

General functionality:

• Authenticate users via Refresh and Access Token in same site http-only cookie (login/signup pages + logout button on settings page)
• Silent rerfresh and signin after access token expires
• CRU* users (sign up & settings page - no deleting required)
• CRUD Articles
• CR*D Comments on articles (no updating required)
• GET and display paginated lists of articles
• Favorite articles
• Follow other users

✔️ Routing Guidelines

• Home page (URL: /global/?page=1 )
  • List of tags
  • List of articles pulled from either Feed, Global, or by Tag
  • Pagination for list of articles
• Sign in/Sign up pages (URL: /signin, /signup )
  • Uses JWT (store the token in localStorage)
  • Authentication can be easily switched to session/cookie based
• Settings page (URL: /settings )
• Editor page to create/edit articles
• Article page (URL: /article/article-slug-here )
  • Delete article button (only shown to article's author)
  • Render markdown from server client side
  • Comments section at bottom of page
  • Delete comment button (only shown to comment's author)
• Profile page (URL: /profile/:username, /profile/:username/favorites )
  • Show basic user info
  • List of articles populated from author's created articles or author's favorited articles

💻 Technology Stack/Tools

• React
• Redux-toolkit
• MongoDB
• Redis
• Node
• Express

🚀 Local Development

Step-1

Clone this repo

https://github.com/Udit-takkar/Conduit-Blogging-App.git

Step-2

Install all dependencies

npm install
cd client
npm install

Step-3

npm run dev ## In the root folder
npm start.  ## In client folder

Contributing

Conduit is an open source project. Feel free to contribute and suggest any improvements. All bugs and issues should be reported to the issues tab.

License

This project is open source and available under the MIT License.