Add structure

Author: bapturp

.gitignore

@@ -0,0 +1,8 @@
+# Dependency directory
+node_modules/
+
+# Debug log from npm
+npm-debug.log
+
+# Environment Variables should NEVER be published
+.env

app.js

@@ -0,0 +1,36 @@
+// ℹ️ Gets access to environment variables/settings
+// https://www.npmjs.com/package/dotenv
+require("dotenv").config();
+
+// ℹ️ Connects to the database
+require("./db");
+
+// Handles http requests (express is node js framework)
+// https://www.npmjs.com/package/express
+const express = require("express");
+
+// Handles the handlebars
+// https://www.npmjs.com/package/hbs
+const hbs = require("hbs");
+
+const app = express();
+
+// ℹ️ This function is getting exported from the config folder. It runs most pieces of middleware
+require("./config")(app);
+
+const capitalize = require("./utils/capitalize");
+const projectName = "app";
+
+app.locals.appTitle = `${capitalize(projectName)} created with IronLauncher`;
+
+// 👇 Start handling routes here
+const indexRoutes = require("./routes/index.routes");
+app.use("/", indexRoutes);
+
+const authRoutes = require("./routes/auth.routes");
+app.use("/auth", authRoutes);
+
+// ❗ To handle errors. Routes that don't exist or errors that you handle in specific routes
+require("./error-handling")(app);
+
+module.exports = app;

config/index.js

@@ -0,0 +1,65 @@
+// We reuse this import in order to have access to the `body` property in requests
+const express = require("express");
+
+// ℹ️ Responsible for the messages you see in the terminal as requests are coming in
+// https://www.npmjs.com/package/morgan
+const logger = require("morgan");
+
+// ℹ️ Needed when we deal with cookies (we will when dealing with authentication)
+// https://www.npmjs.com/package/cookie-parser
+const cookieParser = require("cookie-parser");
+
+// ℹ️ Serves a custom favicon on each request
+// https://www.npmjs.com/package/serve-favicon
+const favicon = require("serve-favicon");
+
+// ℹ️ global package used to `normalize` paths amongst different operating systems
+// https://www.npmjs.com/package/path
+const path = require("path");
+
+// ℹ️ Session middleware for authentication
+// https://www.npmjs.com/package/express-session
+const session = require("express-session");
+
+// ℹ️ MongoStore in order to save the user session in the database
+// https://www.npmjs.com/package/connect-mongo
+const MongoStore = require("connect-mongo");
+
+// Connects the mongo uri to maintain the same naming structure
+const MONGO_URI =
+  process.env.MONGODB_URI || "mongodb://127.0.0.1:27017/app";
+
+// Middleware configuration
+module.exports = (app) => {
+  // In development environment the app logs
+  app.use(logger("dev"));
+
+  // To have access to `body` property in the request
+  app.use(express.json());
+  app.use(express.urlencoded({ extended: false }));
+  app.use(cookieParser());
+
+  // Normalizes the path to the views folder
+  app.set("views", path.join(__dirname, "..", "views"));
+  // Sets the view engine to handlebars
+  app.set("view engine", "hbs");
+  // AHandles access to the public folder
+  app.use(express.static(path.join(__dirname, "..", "public")));
+
+  // Handles access to the favicon
+  app.use(
+    favicon(path.join(__dirname, "..", "public", "images", "favicon.ico"))
+  );
+
+  // ℹ️ Middleware that adds a "req.session" information and later to check that you are who you say you are 😅
+  app.use(
+    session({
+      secret: process.env.SESSION_SECRET || "super hyper secret key",
+      resave: false,
+      saveUninitialized: false,
+      store: MongoStore.create({
+        mongoUrl: MONGO_URI,
+      }),
+    })
+  );
+};

db/index.js

@@ -0,0 +1,19 @@
+// ℹ️ package responsible to make the connection with mongodb
+// https://www.npmjs.com/package/mongoose
+const mongoose = require("mongoose");
+
+// ℹ️ Sets the MongoDB URI for our app to have access to it.
+// If no env has been set, we dynamically set it to whatever the folder name was upon the creation of the app
+
+const MONGO_URI =
+  process.env.MONGODB_URI || "mongodb://127.0.0.1:27017/app";
+
+mongoose
+  .connect(MONGO_URI)
+  .then((x) => {
+    const databaseName = x.connections[0].name;
+    console.log(`Connected to Mongo! Database name: "${databaseName}"`);
+  })
+  .catch((err) => {
+    console.error("Error connecting to mongo: ", err);
+  });

error-handling/index.js

@@ -0,0 +1,17 @@
+module.exports = (app) => {
+  app.use((req, res, next) => {
+    // this middleware runs whenever requested page is not available
+    res.status(404).render("not-found");
+  });
+
+  app.use((err, req, res, next) => {
+    // whenever you call next(err), this middleware will handle the error
+    // always logs the error
+    console.error("ERROR: ", req.method, req.path, err);
+
+    // only render if the error ocurred before sending the response
+    if (!res.headersSent) {
+      res.status(500).render("error");
+    }
+  });
+};

middleware/isLoggedIn.js

@@ -0,0 +1,8 @@
+module.exports = (req, res, next) => {
+  // checks if the user is logged in when trying to access a specific page
+  if (!req.session.currentUser) {
+    return res.redirect("/auth/login");
+  }
+
+  next();
+};

middleware/isLoggedOut.js

@@ -0,0 +1,8 @@
+module.exports = (req, res, next) => {
+  // if an already logged in user tries to access the login page it
+  // redirects the user to the home page
+  if (req.session.currentUser) {
+    return res.redirect("/");
+  }
+  next();
+};

models/User.model.js

@@ -0,0 +1,32 @@
+const { Schema, model } = require("mongoose");
+
+// TODO: Please make sure you edit the User model to whatever makes sense in this case
+const userSchema = new Schema(
+  {
+    username: {
+      type: String,
+      required: false,
+      unique: true,
+      trim: true,
+    },
+    email: {
+      type: String,
+      required: true,
+      unique: true,
+      trim: true,
+      lowercase: true,
+    },
+    password: {
+      type: String,
+      required: true,
+    },
+  },
+  {
+    // this second object adds extra properties: `createdAt` and `updatedAt`
+    timestamps: true,
+  }
+);
+
+const User = model("User", userSchema);
+
+module.exports = User;