Skip to content

Latest commit

 

History

History
139 lines (90 loc) · 4.54 KB

README.md

File metadata and controls

139 lines (90 loc) · 4.54 KB
Raw

Join the Discord for any further discussion

Blog Website

Introduction

Welcome to the Blog Website, a platform that empowers users to create, share, and engage with blogs. This repository contains the source code for the website, which securely stores blogs in a database while providing a seamless experience for writers and readers.

Features

  • User-Friendly Interface: The intuitive user interface allows users to effortlessly compose and edit blogs.

  • Database Storage: All blogs are securely stored in a database, making it easy to manage and retrieve them whenever needed.

  • Responsive Design: The website is designed to be responsive, ensuring an optimal experience on both desktop and mobile devices.

Getting Started

Prerequisites

Before you begin, make sure you have the following prerequisites installed on your local machine:

Installation

  1. Clone the Repository

    Clone this repository to your local machine:

    git clone https://github.com/Kritika30032002/Blog_Website.git

  2. Navigate to the Project Directory

  3. Install Dependencies npm install

Configuration

To configure the project, follow these steps:

  • Create a .env File Create a .env file in the root directory of the project to store your environment variables. Replace your_session_secret with a secure, random string for session management.
PORT=3000
MONGODB_URI=mongodb://localhost:27017/blog-website
SESSION_SECRET=your_session_secret

Running the Application

  1. Start the application Start the application by running: npm start or node app.js
  2. Access the website Open your web browser and navigate to http://localhost:3000 to access the blog website.

🚀 How to Contribute to This Project 🚀

We’re excited to have you contribute to this project! Follow these simple steps to get started:

  1. 🍴 Fork the Repository

    • Go to the repository page.
    • Click the Fork button (top right). This creates a copy of the project in your GitHub account.

  2. 💻 Clone Your Fork

    • Once the repository is forked, clone it to your local machine. Open your terminal and run:
     git clone
  https://github.com/Kritika30032002/Blog_Website.git
    • Replace your-username with your GitHub username.

  3. 🌿 Create a New Branch

    • Before making any changes, create a new branch for your work:
     git checkout
 -b your-branch-name
    • Choose a branch name that describes what you're working on, such as fix-navbar or add-contact-form.

  4. 🛠️ Make Your Changes

    • Open the project files in your code editor (like VS Code) and make your changes.
    • You can contact the project manager for any queiries you have.

  5. ✅ Test Your Changes

    • Make sure your changes work correctly by testing the website locally. Open the index.html file in your browser to see your updates.

  6. 💬 Commit Your Changes

    • Once your changes are ready, commit them with a descriptive message: 
      git add .
git commit -m "Added feature X or Fixed issue Y"

  7. 📤 Push Your Changes

    • Push your changes to your forked repository on GitHub:
     git push origin your-branch-name

  8. 🔄 Create a Pull Request (PR)

    • Go back to the original repository here.
    • Click the Compare & pull request button.
    • Write a short description of your changes and submit the pull request (PR).

  9. 🔎Review Changes

    • The project manager will review your PR. If your changes are approved, your request would be merged.

By following these steps, you can easily contribute to this project! If you have any questions, feel free to ask in the repository’s discussion or issue section.

📢Contributors📢

Our Amazing Contributors

Contributing

We enthusiastically welcome contributions from the community. If you discover a bug or have an enhancement in mind, please don't hesitate to open an issue or create a pull request. Your input is invaluable to us.

Join the discord server for more discussion: