https://github.com/cliff-rosenberg/14-mvc-tech-blog

A simple Tech Blog using the Model-View-Controller format. A MySQL database is used to store User data, as well as Posts and Comments on those Posts.
https://github.com/cliff-rosenberg/14-mvc-tech-blog

express-js express-session handlebars-js javascript mysql node-js sequelize-orm

Last synced: 3 months ago
JSON representation

A simple Tech Blog using the Model-View-Controller format. A MySQL database is used to store User data, as well as Posts and Comments on those Posts.

• Host: GitHub
• URL: https://github.com/cliff-rosenberg/14-mvc-tech-blog
• Owner: cliff-rosenberg
• Created: 2022-06-27T01:30:51.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-05T15:15:43.000Z (over 2 years ago)
• Last Synced: 2025-01-27T11:22:25.372Z (5 months ago)
• Topics: express-js, express-session, handlebars-js, javascript, mysql, node-js, sequelize-orm
• Language: JavaScript
• Homepage:
• Size: 963 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 14-MVC-Tech-Blog

## Table of Contents-

- [Tech Blog using MVC Format](#mvc-tech-blog)

  - [Table of Contents-](#table-of-contents-)

  - [Licensing](#licensing)

  - [Description](#description)

  - [Installation](#installation)

  - [Screenshots](#screenshots)

  - [Usage](#usage)

  - [Credits](#credits)

  - [Contributing](#contributing)

  - [Testing](#testing)

  - [Additional Info](#additional-info)

## Licensing

[![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE)

Link: [MIT License](https://opensource.org/licenses/MIT)

## Description

A simple "Tech Blog" website using the Model-View-Controller format. A MySQL database is used to store User data, as well as Posts and Comments on those Posts. Database modelling is done through the Sequelize ORM for MySQL. The API ("Controller") functions are accessed using Express.js web application framework. The "View" functions are provided by Handlebars.js templating system.

## Installation

NOTE: As of November 2022, Heroku has no "free" accounts, so the demo application has been taken offline until another suitable host can be found.

Can also be installed locally by copying directory structure as-is, then doing a `npm install` in the base directory to install necessary dependancies. Application database is MySql, and the database container can be created by navigating to the `/db` directory and then using the MySQL command line utility and the `SOURCE` command to create it. Data tables can be seeded into the container after this by navigating to the `/seeds` directory and using the command `node seed.js` to create them.

## Screenshots

Base page

![./assets/images/screenshot1.png](./assets/images/screenshot1.png)

User login page

![./assets/images/screenshot4.png](./assets/images/screenshot4.png)

User now logged in

![./assets/images/screenshot2.png](./assets/images/screenshot2.png)

Add a comment to a post

![./assets/images/screenshot3.png](./assets/images/screenshot3.png)

User 'Dashboard' page

![./assets/images/screenshot5.png](./assets/images/screenshot5.png)

Editing a post

![./assets/images/screenshot6.png](./assets/images/screenshot6.png)

User sign-up page

![./assets/images/screenshot7.png](./assets/images/screenshot7.png)

## Usage

To run when installed locally: The app server is launched by Node, type the command 'node server.js' to start the back-end. Then launch a web browser and go to the URL 'localhost:3001/' to get the inital page.

## Credits

This application uses the following technologies/libraries:  

[Express.js v4.0](https://expressjs.com/)

[Sequelize v6](https://sequelize.org/)

[MySQL v8.0](https://www.mysql.com/)

[dotenv](https://www.npmjs.com/package/dotenv)

## Contributing

  [Contributor Covenant](https://www.contributor-covenant.org/)

## Testing

  No testing is provided.

## Additional Info

- Github: [cliff-rosenberg](https://github.com/cliff-rosenberg)

- Email: cliff459 AT icloud.com