/Blogfeed

Personal and Public Blog website

Primary LanguageCSSMIT LicenseMIT

Issues MIT License LinkedIn


Logo

Blogfeed

Create Personal and Private Blogs
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Blogfeed Screen Shot

Blog creation Web application created for self-learning and showcase purpose.

Features :

  • Google OAuth 2.0 authentication and responsive for multiple screens 😄

  • Scalable image upload functionality (Cloudinary)

  • Redis Cache Implementation

  • Blog Like Functionality

(back to top)

Built With

Following Frameworks are used to make this project

  • Node
  • EXPRESSJS
  • MONGOOSE
  • Mongodb
  • Redis
  • REACT
  • REDUX
  • JEST

(back to top)

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

Install Node v14+

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/webdevtut/Blogfeed.git

  2. Install NPM packages

    npm install

  3. In Client folder run the command

    npm install --legacy-peer-deps

  4. Connect Redis URL and MongoDB URL

  5. Get Google OAuth Keys → here

  6. Get Cloudinary Keys → here

  7. In base folder run the command

    npm run dev

(back to top)

Usage

Create an account on deployed website to see the example🤗.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Deployment on Render
  • Google OAuth Integration And Responsive styling upgrade
  • Implement Jest (Testing Framework) Global setup along with modular tests.
  • Implement State management using Redux
  • Add Redis Caching Layer Integration
  • Add Features for User Accessibility
    • Camera access on device for taking and uploading straight from device
    • Share Blog on other social media platform feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @tushar-web-dev - tusharlookingforjob@gmail.com

Project Link: https://blogfeed.onrender.com/

(back to top)

Acknowledgments

Useful links

(back to top)