- Project Description
- Technologies
- Use
- Installation
- License
- Contribution Guidelines
- Test Instructions
- Questions
- Mockups
The Tech Blog is a CMS-style blog site, where developers can publish their own posts and comment on other developers’ posts. While developers spend plenty of time creating new applications and debugging existing codebases, most developers also spend some of their time reading and writing about technical concepts, recent advancements, and new technologies. Developers can use the Tech Blog to publish their own writing, while monitoring and commenting on other developers' posts.
The Tech Blog functions simiar to well-known CMS (content management systems), such as Wordpress. The Tech Blog app follows the MVC paradigm in its architectural structure, uses Handlebars.js as its templating language, Sequelize as its ORM, the express-session npm package for authentication, and bcrypt for securing user credentials.
Any developer can view and try out the Tech Blog on Heroku
The Tech Blog code is available on GitHub.
- Bash
- bcrypt
- Connect session sequelize
- dotenv
- ESLint
- Express
- Express-session
- Handlebars
- Insomnia
- JavaScript
- JSON
- Mysql2
- node
- Prettier
- Sequelize
- Visual Studio
Try out the app on Heroku.
Gifs illustrating the following steps can be found under Mockups
- Click Login (top left) to create a Tech Blog user account
- Enter a username, email and password, then click Sign Up
- Note that your password must be a minimum of 8 characters in length
- You will now see Your Dashboard. This is where you can add posts. All posts you create will be listed here.
- To create a new blog post, click Create a new post then enter a title and post content. Then click publish.
- Go to Home. You will see your post at the bottom of the list of posts. View the full text of any post by clicking on that post.
- You may edit the posts you create by returnting to Your Dashboard and clicking on the post you wish to edit. You may also delete your post here
- To make a comment, go to Home and click on any post. Enter your comment, then click Add your comment.
- To log out, click on Logout (top left)
- You need a GitHub account to access the code
- Install the Tech Blog by forking the repository and then cloning the fork locally
- More information
License covering this application: MIT
- Contributions are welcome.
- Support resolving issues is very much appreciated: Tech Blog Issues
- You may contribute to the Tech Blog project following the Contribution Guidelines below.
- The code is located in the Tech Blog Code Repository
- To contribute, open a new issue describing your proposed enhancement or fix.
- Before contributing, browse through the open issues to see if your issue already exists or if there is an issue you might be able to solve.
- If you're a newbie dev, start contributing by looking for issues labelled "good first issue"
- It is good practice to set up your project repository as an "upstream" remote and synchronize with the project repository
- Don't update the main branch. Rather create your own branch using a descriptive brief name
- You can create pull requests, but only admins can review and merge.
- Be nice to your reviewer by adding adding a plain English explanation of your pull request and how your updates addresses the issue/s or enhancements it concerns
- Also see the GitHub Community Guidelines
Test using the following User Story and Acceptance Criteria to validate the functionality of the Tech Blog.
AS A developer who writes about tech
I WANT a CMS-style blog site
SO THAT I can publish articles, blog posts, and my thoughts and opinions
GIVEN a CMS-style blog site
- WHEN I visit the site for the first time
THEN I am presented with the homepage, which includes existing blog posts if any have been posted; navigation links for the homepage and the dashboard; and the option to log in - WHEN I click on the homepage option
THEN I am taken to the homepage - WHEN I click on any other links in the navigation
THEN I am prompted to either sign up or sign in - WHEN I choose to sign up
THEN I am prompted to create a username and password - WHEN I click on the sign-up button
THEN my user credentials are saved and I am logged into the site - WHEN I revisit the site at a later time and choose to sign in
THEN I am prompted to enter my username and password - WHEN I am signed in to the site
THEN I see navigation links for the homepage, the dashboard, and the option to log out - WHEN I click on the homepage option in the navigation
THEN I am taken to the homepage and presented with existing blog posts that include the post title and the date created - WHEN I click on an existing blog post
THEN I am presented with the post title, contents, post creator’s username, and date created for that post and have the option to leave a comment - WHEN I enter a comment and click on the submit button while signed in
THEN the comment is saved and the post is updated to display the comment, the comment creator’s username, and the date created - WHEN I click on the dashboard option in the navigation
THEN I am taken to the dashboard and presented with any blog posts I have already created and the option to add a new blog post - WHEN I click on the button to add a new blog post
THEN I am prompted to enter both a title and contents for my blog post - WHEN I click on the button to create a new blog post
THEN the title and contents of my post are saved and I am taken back to an updated dashboard with my new blog post - WHEN I click on one of my existing posts in the dashboard
THEN I am able to delete or update my post and taken back to an updated dashboard - WHEN I click on the logout option in the navigation
THEN I am signed out of the site - WHEN I am idle on the site for more than a set time
THEN I am able to view comments but I am prompted to log in again before I can add, update, or delete comments
If you have questions about the Tech Blog, feel free to email the author, Helen Anderson.
See more of Helen's work on GitHub
- Creating a user and logging in
- Create a blog post
- Edit a post
- Add and delete a comment
