Beta Blog Project

A project built to fulfill the following Blogging App tasks:

• Users should have a first_name, last_name, email, password, (you can add other attributes you want to store about the user)
• A user should be able to sign up and sign in into the blog app Use JWT as authentication strategy and expire the token after 1 hour
• A blog can be in two states; draft and published
• Logged in and not logged in users should be able to get a list of published blogs created
• Logged in and not logged in users should be able to to get a published blog
• Logged in users should be able to create a blog.
• When a blog is created, it is in draft state
• The owner of the blog should be able to update the state of the blog to published
• The owner of a blog should be able to edit the blog in draft or published state
• The owner of the blog should be able to delete the blog in draft or published state
• The owner of the blog should be able to get a list of their blogs.
• The list of articles endpoint should be paginated
• It should be filterable by state
• Blogs created should have title, description, tags, author, timestamp, state, read_count, reading_time and body.
• The list of blogs endpoint that can be accessed by both logged in and not logged in users should be paginated, default it to 20 blogs per page.
• It should also be searchable by author, title and tags.
• It should also be orderable by read_count, reading_time and timestamp
• When a single blog is requested, the api should return the user information(the author) with the blog. The read_count of the blog too should be updated by 1
• Come up with any algorithm for calculating the reading_time of the blog.

Built With

• Node
• Express
• MongoDB
• Mongoose

Quick Start

Clone the repo:

git clone https://github.com/Aphatheology/beta_blog_backend.git
cd beta_blog_backend

Install the dependencies:

npm install

Set the environment variables:

cp .envExample .env

# open .env and modify the environment variables 

To run the project:

npm run dev
# will run the server with nodemon

npm run start
# will run the server with node

Important Links

• Documentation: Postman Documentation
• Deployed: On Cyclic
• Article explaining the process: From Development to Deployment: Building and Deploying a Blog API with Node.js, Express, MongoDB, and Mongoose

Thanks