An open API service indexing awesome lists of open source software.

https://github.com/saadimalik92/blog-site

Clean, dark-mode friendly blog platform with profile management, post favoriting, admin dashboard, and real-time interactions.
https://github.com/saadimalik92/blog-site

blog-engine blogging blogging-site csharp css eleventy example hexo hugo-blog-theme jamstack jekyll-template liquid lunr pages

Last synced: 6 months ago
JSON representation

Clean, dark-mode friendly blog platform with profile management, post favoriting, admin dashboard, and real-time interactions.

Awesome Lists containing this project

README

          

# Blog Site 📝🌙

![Blog Site](https://img.shields.io/badge/Blog%20Site-Ready%20to%20Use-brightgreen)
[![Releases](https://img.shields.io/badge/Releases-Latest%20Release-blue)](https://github.com/SaadiMalik92/blog-site/releases)

Welcome to **Blog Site**, a clean and dark-mode friendly blog platform designed for easy management of posts and user profiles. This repository is built with modern web technologies, providing a seamless experience for both users and administrators.

## Table of Contents

- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Features

- **Dark Mode**: Enjoy a sleek interface that is easy on the eyes, especially during nighttime reading.
- **Profile Management**: Users can create and manage their profiles effortlessly.
- **Post Favoriting**: Save your favorite posts for quick access later.
- **Admin Dashboard**: A powerful dashboard for administrators to manage content and users.
- **Real-Time Interactions**: Engage with content through real-time comments and notifications.

## Technologies Used

This project utilizes a range of technologies to deliver a robust experience:

- **Express.js**: A fast, unopinionated, minimalist web framework for Node.js.
- **JavaScript**: The core language for both front-end and back-end development.
- **JWT Authentication**: Secure user authentication using JSON Web Tokens.
- **MongoDB**: A NoSQL database for storing user and post data.
- **Node.js**: A JavaScript runtime for building scalable network applications.

## Getting Started

To get started with the Blog Site, follow these steps:

1. **Clone the Repository**:
```bash
git clone https://github.com/SaadiMalik92/blog-site.git
cd blog-site
```

2. **Install Dependencies**:
```bash
npm install
```

3. **Set Up Environment Variables**:
Create a `.env` file in the root directory and add the necessary environment variables. Here is a sample structure:
```
PORT=3000
MONGODB_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
```

4. **Run the Application**:
Start the server with:
```bash
npm start
```

5. **Visit the Application**:
Open your browser and navigate to `http://localhost:3000`.

You can also check the [Releases](https://github.com/SaadiMalik92/blog-site/releases) section for downloadable files and instructions on how to execute them.

## Usage

Once the application is running, you can:

- **Create an Account**: Sign up to create your user profile.
- **Write a Blog Post**: Use the editor to write and publish your posts.
- **Favorite Posts**: Click on the heart icon to save posts you love.
- **Admin Features**: If you are an admin, access the dashboard to manage users and posts.

## Contributing

We welcome contributions to improve the Blog Site. If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push to your branch.
5. Open a pull request.

Your contributions help make this project better for everyone.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

## Contact

For any questions or feedback, feel free to reach out:

- **Email**: saadi@example.com
- **GitHub**: [SaadiMalik92](https://github.com/SaadiMalik92)

Thank you for checking out Blog Site! We hope you find it useful. If you have any issues or suggestions, please check the [Releases](https://github.com/SaadiMalik92/blog-site/releases) section for updates and discussions.