Implement CRUD functionality for Categories and Articles section, express-validator with custom message on form entry errors implemented.

Author: AnmolTomer

05_Sports_Blog/.vscode/settings.json

@@ -1,24 +1,29 @@
 # Sports Blog
 
->## Sports Blog Demo - Web View
+> ## Sports Blog Demo - Web View
 
 ![](demo.gif)
 
-
->## Mobile View
+> ## Mobile View
 
 ![](mobile.gif)
 
-
 ## 05_01 Project Intro
 
 - We will create a Sports Blog with full CRUD functionality. We will use mongoose this time around. It is another method of connecting to MongoDB, and is more advanced than standard MongoDB driver which we used in last project of TODO App. It's more efficient, advanced and sort of more intuitive to connect to NoSQL DB.
+
 - Functionality also includes visitors being able to post comments on every blog post.
+
 - We have category sort available as well on blog. Where users can sort as per their choice.
+
 - Admin features such as being able to add and remove categories along with notification messages whenever there is some edit done.
+
 - Same functionality available to manage articles also available.
+
 - Use of data and time formatter to present Data, Time in a more clean manner.
+
 - Form validation as well.
+
 - Run MongoDB in docker using `sudo docker run -d -p 27017:27017 -v ~/data:/data/db mongo`, visit [this](https://www.thachmai.info/2015/04/30/running-mongodb-container/) for detailed info.
 
 - Or you can do this to remove related to mongoDB if you have any, I'd recommend Docker:
@@ -36,29 +41,30 @@ sudo apt install mongodb
 sudo service mongodb start
 mongo
 sudo service mongodb stop
- ```
+```
 
 ## Tools/Technologies Used
 
 - Mongoose ODM (Object Document Mapper) - Models & Schemas
 - Multiple Collections (articles and categories)
 - Express Messages & Validator, Sessions
 - Working with advanced Pug Layouts
-- Express Router
+- Express Router, with routes on separate files. We set up everything from scratch.
 
 ## 05_02 Mongoose ODM (Object Document Mapper)
 
 - **Mongoose**: A more powerful way to work with Node and MongoDB. ODM is similar to an Object Relational Mapper which we get in relational databases.
 - It is an elegant object modelling package for Node and allows us to easily create CRUD apps.
 - Mongoose also includes things like type casting, validation, query building, hooks, etc.
 - Mongoose uses models to represent documents that can be saved and fetched from the database.
-- Mongoose models must have a schema, which is used to define attributes for documents. 
+- Mongoose models must have a schema, which is used to define attributes for documents.
 - Methods can also be defined on mongoose schemas.
 - **Allowed Schema Types**: String, Number, Data, Buffer, Boolean, Mixed, ObjectID, Array.
 
 ## 05_03 App Middleware Setup
 
 - We will proceed in same manner as we did for **PC Repair** website such as using external routing files, Pug template engine, but this time we won't use express generator, rather we will set everything up from scratch and create our own app.js file as this gives us less limitations and more flexibility while setting up our project.
+
 - We have a lot more dependencies for this app. So instead of doing npm install --save, we will directly put all of our requirements in package.json file so that we can just run npm install and it will set it up everything in one go.
 
 - See the docs for express-messages and validator on these links: [Validator](https://express-validator.github.io/docs/), [messages](https://github.com/visionmedia/express-messages)
@@ -77,9 +83,11 @@ sudo service mongodb stop
 
 ## 05_05 Fetching Categories and Working with Mongoose
 
-- Create db and add categories using the following
+- Create db and add categories using the following, db.createCollection docs [here](https://docs.mongodb.com/manual/reference/method/db.createCollection/)
 
-```
+![](https://i.imgur.com/rV5Ek63.png)
+
+```sql
 use sportsblog
 db.createCollection('categories')
 db.createCollection('articles')
@@ -89,6 +97,7 @@ db.categories.insert({title:'Football','description':'These are Football article
 db.categories.insert({title:'Cricket','description':'These are Cricket articles.'})
 db.categories.find()
 ```
+
 - Now we have 4 categories in our DB, next want to fetch these categories using Mongoose. In Mongoose we deal with models, create a directory called models and inside it create a file called `category.js`. We try keeping everything encapsulated inside module.
 - To connect to mongoose, we go to app.js and define the required methods. After doing mongoose.connection go to `routes/categories.js` and bring up Category model. Now on visiting localhost:5000/categories you would see all the categories and description in the console. Next we want to take those categories and pass them into our template of categories page.
 - Next we work on implementing functionality for `/manage/categories/add` route using a form we would be able to add new categories.
@@ -149,7 +158,7 @@ db.categories.find()
 
 ## 05_10 Messages
 
-- To show a message we can see that in the route /manage/categories when we add something and do a res.redirect, before that we can send a flash message.  We can do so by entering the following `req.flash('Success', 'Added To Category')` after that we go to app.js and setup connect-flash and we use a variable globally called messages which we may use in our templates to show messages. So we should add the message in `/manage/categories/` route as that's where we will be redirected once we submit the request successfully. Make some changes to style.css and messages will work on your page.
+- To show a message we can see that in the route /manage/categories when we add something and do a res.redirect, before that we can send a flash message. We can do so by entering the following `req.flash('Success', 'Added To Category')` after that we go to app.js and setup connect-flash and we use a variable globally called messages which we may use in our templates to show messages. So we should add the message in `/manage/categories/` route as that's where we will be redirected once we submit the request successfully. Make some changes to style.css and messages will work on your page.
 - On adding articles also we want the same effect, so we go to articles.js and before the redirect request we do the same as we did for categories.
 - With messages showing up on Add and Edit for category and articles we are done with admin side or things related to controlling the content on the site.
 

05_Sports_Blog/README.md

@@ -1,17 +1,9 @@
 const express = require('express')
 const path = require('path')
-const bodyParser = require('body-parser')
 const session = require('express-session')
 const mongoose = require('mongoose')
-// const expressValidator = require('express-validator')
-
-const {
-    check,
-    validationResult
-} = require('express-validator')
 
 // Mongoose connect
-
 mongoose.connect('mongodb://localhost:27017/sportsblog', {
     useNewUrlParser: true,
     useUnifiedTopology: true
@@ -20,59 +12,50 @@ const db = mongoose.connection
 
 
 // Port
-const port = 5000
+const port = 3000;
 
-// init app
-const app = express()
-
-// Moment for Date and Time
+var app = express();
 app.locals.moment = require('moment')
 
-// Routes
-
-const index = require('./routes/index')
-const articles = require('./routes/articles')
-const categories = require('./routes/categories')
-const manage = require('./routes/manage')
+app.use(session({ cookie: { maxAge: 60000 }, 
+    secret: 'woot',
+    resave: false, 
+    saveUninitialized: false}));
+// Views dir setup
 
-// View setup
-app.set('views', path.join(__dirname, 'views'))
-app.set('view engine', 'pug')
+app.set('views',path.join(__dirname,'views'));
+app.set('view engine','pug');
 
-// BodyParser middleware
-app.use(bodyParser.json())
-app.use(bodyParser.urlencoded({
-    extended: false
-}))
+// More on how body-parser or express parsing capability works https://www.geeksforgeeks.org/body-parser-middleware-in-node-js/
 
-// Express session
+app.use(express.json());
+app.use(express.urlencoded({extended: false}));
 
-app.use(session({
-    secret: 'secret',
-    resave: false,
-    saveUninitialized: true
-}))
+// Set static dir
 
+app.use(express.static(path.join(__dirname,'public')))
 
-// Set static folder
-app.use(express.static(path.join(__dirname, 'public')))
+// Middleware for express messages
 
-// See docs for express messages and validator github.com/expressjs/express-messages ver: Express3+
-app.use(require('connect-flash')())
+app.use(require('connect-flash')());
 app.use((req, res, next) => {
-    res.locals.messages = require('express-messages')(req, res)
-    next()
-})
+  res.locals.messages = require('express-messages')(req, res);
+  next();
+});
 
-app.use(express.json());
-app.use('/', index)
-app.use('/articles', articles)
-app.use('/categories', categories)
-app.use('/manage', manage)
+const index = require('./routes/index')
+const categories = require('./routes/categories')
+const manage = require('./routes/manage')
+const articles = require('./routes/articles')
 
+// -x-x-x-x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x--x-x-
 
+app.use('/', index);
+app.use('/articles', articles);
+app.use('/categories', categories);
+app.use('/manage', manage);
 
 
-app.listen(port, '0.0.0.0', () => {
-    console.log('Server started on port: ' + port)
-})
+app.listen(port, () => {
+    console.info(`Server started on port ${port} ✅ 🚀`);
+  });

05_Sports_Blog/sportsblog/app.js

@@ -3,43 +3,22 @@ const mongoose = require('mongoose')
 // Article Schema - Title, Subtitle, Category, Body, Author, Created_At
 
 const articleSchema = mongoose.Schema({
-    title: {
-        type: String
-    },
-    subtitle: {
-        type: String
-    },
-    category: {
-        type: String
-    },
-    body: {
-        type: String
-    },
-    author: {
-        type: String
-    },
-    created_at: {
-        type: Date,
-        default: Date.now,
-    },
-    comments: [{
-        comment_subject: {
-            type: String
-        },
-        comment_body: {
-            type: String
-        },
-        comment_author: {
-            type: String
-        },
-        comment_email: {
-            type: String
-        },
-        comment_date: {
-            type: String
+    title: {type: String},
+    subtitle: { type: String },
+    category: {type: String},
+    body: {type: String},
+    author: {type: String},
+    created_at: {type: Date,default: Date.now},
+
+    comments: [
+        {
+            comment_subject: {type: String},
+            comment_body: {type: String},
+            comment_author: {type: String},
+            comment_email: {type: String},
+            comment_date: {type: String}
         }
-
-    }]
+    ]
 })
 
 
@@ -57,17 +36,14 @@ module.exports.getArticles = function (callback, limit) {
 }
 
 // Add Article
-
 module.exports.addArticle = function (article, callback) {
     Article.create(article, callback)
 }
 
 // Get Article By Category
 
 module.exports.getCategoryArticles = function (categoryId, callback) {
-    let query = {
-        category: categoryId
-    }
+    let query = {category: categoryId}
     Article.find(query, callback).sort([
         ['title', 'ascending']
     ])
@@ -86,13 +62,11 @@ module.exports.updateArticle = function (query, update, options, callback) {
 }
 
 // Remove article
-
 module.exports.removeArticle = function (query, callback) {
     Article.deleteOne(query, callback)
 }
 
 // Create Method for Comment
-
 module.exports.addComment = function (query, comment, callback) {
     Article.updateOne(query, {
         $push: {

05_Sports_Blog/sportsblog/models/article.js

@@ -1,35 +1,30 @@
-const mongoose = require('mongoose')
+// Contains all models related to category
 
-// Category Schema
+// Bring in mongoose
+const mongoose = require('mongoose')
 
 const categorySchema = mongoose.Schema({
-    title: {
-        type: String
-    },
-    description: {
-        type: String
-    }
+    title: {type: String},
+    description: {type:String}
 })
 
-// Category will allow access outside the file.
-const Category = module.exports = mongoose.model('Category', categorySchema);
+// Allows access from outside when we export
+const Category = module.exports = mongoose.model('Category',categorySchema)
+
+// Functions that we can reference related to database can be kept here as well.
 
-// We try to keep everything encapsulated inside the module.
+// Get Categories
 
-module.exports.getCategories = function (callback, limit) {
-    Category.find(callback).limit(limit).sort([
-        ['title', 'ascending']
-    ])
+module.exports.getCategories = function(callback,limit){
+    Category.find(callback).limit(limit).sort([['title','ascending']]);
 }
 
 // Add category
-
 module.exports.addCategory = function (category, callback) {
     Category.create(category, callback)
 }
 
 // Get Single Category by its ID
-
 module.exports.getCategoryById = function (id, callback) { // We can directly do callById outside as well, but we are sticking to encapsulating stuff
     Category.findById(id, callback) // Mongoose method
 }