Skip to content

Latest commit

 

History

History
110 lines (71 loc) · 3.33 KB

README.md

File metadata and controls

110 lines (71 loc) · 3.33 KB
Raw

Next.js/Nest.js Blog Application

📋 Table of Contents

  1. 🤖 Overview
  2. 🚀 Deploy
  3. ⚙️ Tech Stack
  4. 🔋 Features
  5. 🤸 Quick Start

🤖 Overview

This project is a simple blog application built with Next.js and TypeScript, featuring a responsive design with Tailwind CSS. It includes a comprehensive RESTful API backend developed using Nest.js and MongoDB. The application allows users to create, read, update, and delete blog posts, with content managed via a WYSIWYG editor and displayed as HTML.

🚀 Deploy

Front-end deploy:

https://elian-next-nest-blog.vercel.app

Back-end server deploy:

https://elian-next-nest-blog-api.onrender.com

⚙️ Tech Stack

Front-end:

  • Next.js
  • TypeScript
  • Tailwind CSS

Back-end:

  • Nest.js
  • TypeScript
  • MongoDB

Deploy:

  • Vercel (Front-end)
  • Render (Back-end)
  • MongoDB Atlas (Database)

🔋 Features

👉 Responsive Home Page with Blog Post Grid: A responsive home page displaying all blog posts in a grid layout, optimized for both mobile and desktop views.

👉 Individual Post Pages: Each post has its own dedicated page, showcasing the title, main (banner) image, and full article content rendered as HTML.

👉 WYSIWYG Editor: A built-in WYSIWYG editor (i.e., react-quill) for creating and editing blog posts, allowing users to format their content with ease.

👉 RESTful API: A complete RESTful API to manage blog posts, including endpoints to create, retrieve, update, and delete posts, with comprehensive error handling and data validation.

👉 Swagger Documentation: API documentation implemented with Swagger for easy reference and testing.

👉 Admin Page: A simple management page for administrating blog posts, including pagination support for efficient content browsing.

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

Install instructions:

Front-End:

1. git clone https://github.com/elian-cheng/blog-app-next-nest.git
2. cd blog-app-next-nest
3. git checkout front
4. npm i
5. npm run start

Back-End:

1. git clone https://github.com/elian-cheng/blog-app-next-nest.git
2. cd blog-app-next-nest
3. git checkout back
4. create and add all necessary variables to .env file
5. npm i
6. npm run start

Set Up Environment Variables

Create a new file named .env in the root of your server project and add the following content:

DATABASE_URL=

Running the Project

npm run dev

Open http://localhost:3000 in your browser to view the project front-end. Open http://localhost:5000 in your browser to view the project back-end. Open http://localhost:5000/docs or https://elian-next-nest-blog-api.onrender.com/docs in your browser to view the project API Swagger documentation.