voidvampire / vnstreet

Blog application built using Express.js, SQLite, Tailwind and Bun

VNStreet - A Blogging Platform

VNStreet is a full-stack blog application built using Express.js, SQLite, Tailwind CSS, and Bun. This project was developed as part of the Full Stack Developer Internship at Bharat Intern. VNStreet allows users to create, edit, and share their blog posts, making it a versatile platform for bloggers and content creators.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• License

Features

• User authentication for secure access to the platform.
• Create, edit, and delete blog posts.
• Rich text editor for composing and formatting blog content.
• Responsive design using Tailwind CSS for a seamless user experience.
• SQLite database for efficient data storage and retrieval.
• Lightweight server using Express.js.
• Development environment setup with Bun for easy development and testing.

Prerequisites

Before you begin, ensure you have installed bun and git.

Installation

To get VNStreet up and running on your local machine, follow these steps:

1. Clone the repository:

   git clone https://github.com/VoidVampire/VNStreet.git
   cd VNStreet

2. Install project dependencies:

   bun install

Usage

To start VNStreet locally, run the following command:

bun run dev

The application will be accessible at http://localhost:8080 in your web browser. Here are the steps to get started:

1. Create an Account:

   • Initially, there will be no posts. To get started, go to http://localhost:8080/admin.
   • Create an account by providing your details and registering.

2. Log In:

   • After creating an account, log in to your VNStreet account using your credentials.

3. Manage Your Blog:

   • Once logged in, you can:
     • Add new blog posts.
     • Edit existing posts.
     • Delete posts you no longer need.
     • Logout when you're done.

This gives you full control over your blogging experience on VNStreet. Enjoy writing and sharing your blog posts!

License

This project is licensed under the MIT License - see the LICENSE file for details.

---