Skip to content

EricRisher/tech-blog

Repository files navigation

QuantumByte

Table-of-Contents

Description

My motivation for creating QuantumByte stemmed from recognizing a distinct need within the developer community for a specialized platform to share and engage with technology-focused content. I saw an opportunity to apply my web development skills to create a CMS-style blog site that would not only allow developers to publish and discuss technical articles, blog posts, and tutorials but also foster a sense of community. Leveraging technologies like Handlebars.js, Sequelize, and express-session, I aimed to provide a space that emphasizes the nuances of technical writing and discussions, thereby enriching the developer experience and facilitating shared learning and growth.

I built QuantumByte to create a specialized platform for developers to easily share and engage with technical content, filling a gap in the community for a dedicated space that supports both writing and interactive discussions. This project allowed me to harness modern web technologies and contribute to the developer ecosystem by fostering a community where knowledge and experiences can be shared and discussed freely.

QuantumByte addresses the need for a centralized, developer-focused platform where individuals can publish, share, and interact with technical content. It solves the problem of scattered technical discussions and content across various platforms by providing a dedicated space for developers to connect, share their insights, and learn from each other's experiences. This encourages a more cohesive community and enriches the collective knowledge base of the tech industry.

Test out the site Here!

Installation

To install TechBlog on your local machine, follow these steps. Ensure you have Node.js and npm installed to get started.

  1. Clone the repository:
    git clone git@github.com:EricRisher/tech-blog.git

  2. Navigate to the project directory:
    cd main

  3. Install dependencies:
    npm install

  4. Create a .env file:

DB_NAME='techblog_db'
DB_USER='yourusername'
DB_PASSWORD='yourpassword'
SESSION_SECRET='yoursecret'
  1. Start the Server:
    npm run start

Usage

Once TechBlog is installed and running, here's how you can use the site to maximize its features and functionalities:

Signing Up and Logging In

  • Sign Up: When you visit TechBlog for the first time, you'll be presented with an option to sign up. Create a username and password to set up your account. This allows you to write blog posts, comment on others' posts, and engage with the community.
  • Log In: If you're a returning user, simply log in with your username and password to access your dashboard and interact with the site's features.

Navigating the Site

  • Homepage: The homepage displays all the existing blog posts from various developers. You can browse through these posts to read about different tech topics.
  • Dashboard: Once logged in, the dashboard is your personal space where you can see your published posts and have the option to add new ones.

Interacting with Blog Posts

  • Reading Posts: Click on any blog post title from the homepage to read the full post, including the post creator’s username and the date it was created.
  • Commenting: If you're signed in, you can leave comments on blog posts you're interested in. This is a great way to engage with the content and interact with other developers.
  • Creating Posts: From your dashboard, you can create new blog posts by entering a title and content. Once you publish your post, it will appear on the homepage and your dashboard.
  • Editing or Deleting Posts: You can edit or delete your own posts via the dashboard. This allows you to keep your content up-to-date or remove posts that are no longer relevant.

Logging Out and Session Management

  • Log Out: You can log out via the navigation link. Logging out is important for security, especially when using shared devices.
  • Session Timeout: For added security, if you're idle on the site for a prolonged period, you'll be automatically logged out and will need to log in again to resume activities.

Engaging with the Community

  • Commenting and Discussing: Use the comment sections under each post to discuss topics, ask questions, and share insights. TechBlog is designed to foster a supportive and engaging tech community.

General Usage Tips

  • Explore: Regularly visit the homepage to discover new posts and learn about the latest tech trends and insights from fellow developers.

  • Contribute: Share your knowledge by writing posts. Whether it’s a tutorial, a piece on new technology, or your personal opinion on tech trends, your contributions enrich the community.

  • Engage: Participate in discussions through comments. Engaging with others’ posts can lead to meaningful exchanges of ideas and knowledge.

    Questions

    If you have any questions, please contact me at rishereric13@gmail.com or visit website here!