Code Monkey home page Code Monkey logo

rsinghcodes / readlist Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 1.9 MB

ReadList is a full-stack blog web app built using ReactJS, ChakraUI, GraphQL, Apollo Server and MongoDB✌️. This app also has the feature that other users can like and comment on the post of other users as well.

Home Page: https://readlistapp.netlify.app

License: GNU General Public License v3.0

HTML 1.66% JavaScript 97.73% Dockerfile 0.61%
mongodb graphql expressjs nodejs chakra-ui chakra-ui-icons reactjs apollo-server apollo-client mongoose

readlist's Introduction

ReadList

ReadList is a blog web application where people can share writings, content and their ideas online. This app allows readers to read, like, comment and share on other platforms or social handles.

ReadList App preview

Project Objectives

The main objective of developing this application is that people can easily share any knowledge, thoughts, news or other important information on this. This application is helpful in publishing content, articles, any information or knowledge online or digitally. People can easily share their thoughts, tutorials, tips and tricks etc. without any restrictions.

The purpose of this web application is to make it easy to publish any type of content digitally. Providing the best user experience for sharing information and knowledge. Less formalities is required for authentication of author or reader. Registration or login is simple and easy. Sharing links has been provided for sharing on any other platform and social handle.

🎮 Features & Functionality

User

  • User can register.
  • User can login.
  • Manage Account - Delete Account or Update Full Name or password.
  • Create and view posts.
  • Search posts.
  • Markdown supported.
  • Delete or update published posts.
  • Comment on published posts.
  • Like on published posts.
  • Copy to clipboard of share link.

Admin

  • Admin can delete user or user's posts.
  • Search posts.
  • Delete comments.
  • Create or Delete new Admin.
  • Grant or Revoke user account from login. Admin

🚧 Technology Stack

  • Server Enviornment - Node.js
  • Framework - Express.js
  • DevOps - Docker
  • Bundler - Webpack
  • For APIs - GraphQL in conjunction with Apollo Server
  • Frontend - React.js, Chakra UI
  • Database - MongoDB in conjunction with Mongoose
  • Cloud database service - MongoDB Atlas
  • Deployment - Render (Backend) & Netlify (Frontend)

Authentication is implemented using a JSON Web Token (JWT) saved in local storage. Upon a successful login attempt made to the GraphQL endpoint, the response is a JWT containing the user data. This token is then added to every API request that requires authorization.

Backend Application link:

🗄 Backend - https://github.com/rsinghcodes/readlist-backend

⬇️ Installation & Set Up

Step 1️⃣: Clone this repository to your local machine

git clone https://github.com/rsinghcodes/ReadList.git

Step 2️⃣: Install all the dependencies.

npm install

Step 3️⃣: Now start the application

npm start

Your app is ready to be run! ✨✨
Open http://localhost:3000 to view it in the browser.

📡 Project Deployment

Project has been deployed here! Show some love by starring ⭐ this repo.

Features that I'm planning to add in future

  • Authentication through OTP.
  • Send emails and notifications to users about any activities like someone liked or commented on user's posts.
  • Editor with autocomplete feature.
  • Search or filter posts by tags or categories.

readlist's People

Contributors

dependabot[bot] avatar rsinghcodes avatar

Stargazers

 avatar

Watchers

 avatar

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.