DuaneDave/CMS_API

📖 CMS_API

CMS_API is a solution to the take home assignment given and a solution to the problem was done using popular design pattern in the industry such as MVC and the well known Repository design pattern.

🛠 Built With

Tech Stack

Server

• Node Js
• Express
• Socket.io
• JWT
• Google OAuth
• etc..

Database

• Mongo DB
• Mongoose ODM

Key Features

• Authentication strategy using JWT and Google OAuth
• Real-time activities feed on the admin route
• CRUD operation on the post route
• CRUD operations on the category route
• CRUD operations on the user
• Database relationship
• Proper error handling of all requests

(back to top)

API-Documentation

• Link To Documentation

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Node.js installed
• VsCode or any other code editor installed
• Postman or any other API testing tool installed

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/DuaneDave/CMS_API.git

  create a .env file in the root directory and add the following variables

  PORT = 8080
  NODE_ENV = DEVELOPMENT
  DB_URI = your mongo db URI


  JWT_EXPIRES_TIME = 3d
  JWT_SECRET = bdjbbiugiuwehohfibifhhwioufgwftu
  COOKIE_EXPIRES_TIME = 3
  RESET_PASSWORD_EXPIRES_TIME = 10

  MAIL_USERNAME = your gmail address
  MAIL_PASSWORD = your gmail password
  OAUTH_CLIENTID = your google oauth client id
  OAUTH_CLIENT_SECRET = your google oauth client secret
  OAUTH_REFRESH_TOKEN = your google oauth refresh token
  OAUTH_FROM_EMAIL = noreply@afrobean.com
  OAUTH_FROM_NAME = CMS_API

Install

Install this project with:

  cd CMS_API

  npm install

Usage

To run the project, execute the following command:

  npm run dev to run the project in development mode
  npm run prod to run the project in production mode

Run checks on the activiy feed

You can utilize postman for hooking up with the socket at the backend. To do this, you need to send a post request to the following route

  http://localhost:8080/api/v1/admin

Once the connection is successful, you can hook up on the following events

  postDeleted
  postCreated
  postUpdated
  categoryCreated
  categoryUpdated
  categoryDeleted
  userCreated
  userUpdated

❓ FAQ (OPTIONAL)

• Why did you use repository design pattern?

  Repository Pattern introduces an additional layer of abstraction, the benefits it provides in terms of maintainability, testability, and adaptability often outweigh the overhead. It's especially beneficial in larger applications where clear separation of concerns becomes crucial for long-term maintainability. Reasons includes:

  • Separation of Concerns: - Following design patterns like the Repository Pattern aligns with best practices for structuring maintainable and scalable software. It makes your codebase more readable and easier for other developers to understand.
  • Testability: - The Repository Pattern makes it easier to mock dependencies for testing. This is especially useful in unit testing, where you want to isolate the system under test from its dependencies.
  • Adaptability: - The Repository Pattern makes it easier to swap out data sources. For example, you can easily replace a repository that fetches data from a remote server with one that uses a local database instead. This is especially useful when you want to write tests that don't touch the network or a database.
  • Maintainability: - The Repository Pattern makes it easier to maintain your codebase. For example, if you want to change the way you fetch data from a remote server, you only need to change the implementation of the repository. The rest of your codebase can remain the same.