Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jnaoroji/mvc_tech_blog_jn

CMS style Tech blog created using the MVC Paradigm- Express, Sequelize, MySQL, bcrypt
https://github.com/jnaoroji/mvc_tech_blog_jn

bcyrpt blog connect-session-sequelize dotenv express-handlebars express-session handlebarsjs javascript mysql2 nodejs sequelize-orm

Last synced: about 1 month ago
JSON representation

CMS style Tech blog created using the MVC Paradigm- Express, Sequelize, MySQL, bcrypt

Host: GitHub
URL: https://github.com/jnaoroji/mvc_tech_blog_jn
Owner: jnaoroji
License: mit
Created: 2023-06-23T02:18:15.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-07-09T13:40:22.000Z (over 1 year ago)
Last Synced: 2024-10-01T07:04:59.917Z (about 1 month ago)
Topics: bcyrpt, blog, connect-session-sequelize, dotenv, express-handlebars, express-session, handlebarsjs, javascript, mysql2, nodejs, sequelize-orm
Language: CSS
Homepage: https://jnaoroji.github.io/MVC_Tech_Blog_JN/
Size: 13 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 14 Model-View-Controller (MVC): Jenny's Tech Blog

## Description

My Task is to build a CMS-style blog site, where developers can publish thier blog posts and comment on other developers' posts. This app will include an MVC paradigm in its architectural structure, using Handlebars.js as the templating language, Sequelize as the ORM, and the express-session npm package for authentication.

This app will follow the user story and acceptance criteria below:

## User Story

```md
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
```

## Acceptance Criteria

```md
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 posts and comments but I am prompted to log in again before I can add, update, or delete posts
```

## Usage

To use this application visit the Heroku deployment link and Create an account!
- https://jenny-tech-blog-5f80e3182e28.herokuapp.com/

## Credits

- [MySQL2](https://www.npmjs.com/package/mysql)
- https://sequelize.org/docs/v6/core-concepts/assocs/#why-associations-are-defined-in-pairs
- [Sequelize](https://www.npmjs.com/package/sequelize)
- [dotenv](https://www.npmjs.com/package/dotenv)
- [Deploy with Heroku and MySQL](https://coding-boot-camp.github.io/full-stack/heroku/deploy-with-heroku-and-mysql)
- [Heroku Deployment Guide](https://coding-boot-camp.github.io/full-stack/heroku/heroku-deployment-guide)
- [express-handlebars](https://www.npmjs.com/package/express-handlebars)
- [express-session](https://www.npmjs.com/package/express-session)
- [connect-session-sequelize](https://www.npmjs.com/package/connect-session-sequelize)
- [bcrypt package](https://www.npmjs.com/package/bcrypt)
- Mock up example:
![Animation cycles through signing into the app, clicking on buttons, and updating blog posts.](./assets/14-mvc-homework-demo-01.gif)

## Screenshots
These screenshots show my app's functionality:
- The homepage:
![Homepage screenshot](./assets/screenshotHome.png)

- The Dashboard:
![Dashboard screenshot](./assets/ScreenshotDashboard.png)

- The Comments section:
![Comments screenshot](./assets/ScreenshotComments.png)

- The Update Section:
![Updates screenshot](./assets/ScreenshotUpdate.png)

## License

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Please refer to the LICENSE in the repo or click on the badge for documentation.