Skip to content

HeyBuddy-NSK/nkblog

Repository files navigation

NKBlog

NKBlog is a social blogging application designed to facilitate the creation, sharing, and interaction with blog posts within a community.

Features

  • User Authentication: Secure sign-up and login functionality.
  • Blog Post Creation: Users can create, edit, and delete their blog posts.
  • Comment System: Engage with other users through comments.
  • Responsive Design: Optimized for both desktop and mobile devices.
  • User Profiles: View and manage personal profiles and posts.

Installation

To set up NKBlog on your local machine, follow these steps:

  1. Clone the repository:

    git clone https://github.com/HeyBuddy-NSK/nkblog.git
    cd nkblog
  2. Install dependencies:

    cd requirements
    pip install -r dev.txt
  3. Set environment variables: Create a .env file in the root directory and add necessary environment variables as described in set_environment_variables.bat.

  4. Run the application:

    python nkblog.py

Technologies Used

  • Python: Backend logic.
  • Flask: Web framework.
  • HTML/CSS: Frontend design.
  • SQLite: Database.

Contributing

We welcome contributions! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Create a pull request.

License

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

Contact

For questions or feedback, please reach out to the project maintainer.


Thank you for using NKBlog! We hope you enjoy creating and sharing your stories with our community.