DeScribeIt - A CRUD Blogging Platform

Welcome to DeScribeIt, a full-stack blogging platform that allows users to create, read, update, and delete blog posts. The platform includes user authentication with JWT, allowing for secure login and signup processes.

Hosted at: DeScribeIt

Table of Contents

• Features
• Technology Stack
• Installation
• Configuration
• Usage
• API Endpoints
• Folder Structure
• Screenshots
• Contributing
• License
• Contact

Features

• User registration and authentication with JWT
• Create, read, update, and delete blog posts
• Responsive design with a user-friendly interface
• Secure API endpoints using Express and JWT
• Backend built with Node.js, Express, and MongoDB
• Frontend built with React and TypeScript
• Real-time updates with a RESTful API

Technology Stack

• Frontend: React, TypeScript, CSS, HTML
• Backend: Node.js, Express, TypeScript
• Database: MongoDB
• Authentication: JSON Web Tokens (JWT)
• Hosting: Netlify

Installation

Prerequisites

• Node.js (v14 or higher)
• MongoDB

Steps

1. Clone the repository:

   git clone https://github.com/balani491/DeScribeIt.git
   cd DeScribeIt

2. Install Dependencies:

   • Navigate to the frontend and install dependencies:

     cd frontend
     npm install

   • Navigate to the backend and install dependencies:

     cd backend
     npm install

3. Environment Variables:

   • Create a .env file in the backend directory and configure your MongoDB URI, JWT secret, and other necessary environment variables. Example .env file:

   PORT1=3000
   DATABASE_URL={YOUR_MONGO_DB_CONNECTION_STRING}
   JWT_SECRET = {YOUR_JWT_SECRET}
   

4. Run the Application:

   • Start the backend server:

     cd backend
     tsc -b
     node src/index.js

   • Start the frontend development server:

     cd frontend
     npm run dev

   Usage

   1. Access the Website: Visit DeScribeIt.

   2. Create a New Description:

      • Click on the "New Description" button.
      • Fill in the required details for your content description.

   3. Save and Preview:

      • Save your description to see a real-time preview.

   4. Export or Share:

      • Export the description or share it using the provided options.