Skip to content

FeMo - Designed for your family memories. COMP30022 (IT project) project, summer 2019

Notifications You must be signed in to change notification settings

desert-eagles/FeMo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FeMo

Visit the web app here!

Getting started

Before installing, download and install Node.js. Node.js 0.10 or higher is required.

To get the Node server running locally:

  • Clone this repo
    • $ git clone https://github.com/desert-eagles/FeMo.git
  • Install the dependencies in the local node_modules folder using the npm install command
    • $ npm install
  • Download the .env file containing sensitive configuration settings
  • Start the local server
    • $ npm start

Code Overview

Dependencies

  • bcrypt - A library to help in hashing passwords
  • body-parser - Parse incoming request bodies in a middleware before the handlers
  • cloudinary - Cloud service that offers a solution to a web application's entire image management pipeline
  • connect-mongo - MongoDB session store for Connect and Express
  • cookie-parser - Parse HTTP request cookies
  • debug - Small debugging utility
  • dotenv - Load environment variables from .env file
  • express - The server for handling and routing HTTP requests
  • express-session - Session middleware for Express
  • http-errors - Create HTTP error objects
  • mongoose - For modeling and mapping MongoDB data to javascript
  • morgan - HTTP request logger middleware for Express
  • multer - Middleware for handling multipart/form-data
  • multer-storage-cloudinary - A cloudinary multer storage engine
  • nodemailer - Send emails from Node.js
  • pug - Clean, whitespace-sensitive template language for writing HTML
  • serve-favicon - Favicon serving middleware with caching

Application Structure

  • app.js - The entry point to our application. This file defines our express server and connects it to MongoDB using mongoose. It also requires the routes and models we'll be using in the application.
  • routes/ - Contains the route definitions for our API.
  • controllers/ - Defines our app route handlers and contains their logic.
  • models/ - Contains the schema definitions for our Mongoose models.
  • public/ - Stores static images custom JavaScript files and CSS.
  • views/ - Contains templates to be rendered by the server.
  • package.json - Takes care of the dependencies and the scripts to run with the npm command.

About

FeMo - Designed for your family memories. COMP30022 (IT project) project, summer 2019

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published