Skip to content

The aim of this project is to develop a web-based portal named “Hunger Helpers” which makes a communication between donor and food seeker. Built with HTML, CSS , JavaScript, Firebase, NodeJs.

Notifications You must be signed in to change notification settings

shikhargupta-in/foodshare

Repository files navigation

express-app

Important Components

  • app.js

    • our app's main entry point

    • when creating a new page, add a corresponding router to app.js

      ...
      // require page routers
      const indexRouter = require("./routes/index");
      ...
      const <example>Router = require("./routes/<example>";)
      ...
      ...
      // use page routers
      app.use("/", indexRouter);
      ...
      app.use("/<example>", <example>Router)

\config

  • firebase-config-admin.js

    • enables use of the Firebase Admin SDK

    • require this file for admin-specific functionality for authentication, firestore, etc.

  • firebase-config-client.js

    • enables use of the Firebase JavaScript SDK

    • require this file for client-side functionality, such as logging a user in

\routes

  • contains routing files (JavaScript), one per page

\views

  • \partials

    • contains reusable elements, such as headers, footers, etc.
  • contains view files (Pug), one per page

Other Components

  • .eslintrc.js

  • package-lock.json

    • describes app dependencies

    • automatically updated when installing / updating packages

  • package.json

    • describes app details, dependencies

    • automatically updated when installing / updating packages

\bin

  • www
    • creates an HTTP server for app.js

\node_modules

  • contains libraries downloaded via npm

\public\stylesheets

  • style.css

    • describes the presentation of our content

    • mostly overridden since we are using Bootstrap

\secrets

  • foodshare-d3eee-firebase-adminsdk-muxzq-c6401baa87.json

    • private key file for firebase-config-admin.js

About

The aim of this project is to develop a web-based portal named “Hunger Helpers” which makes a communication between donor and food seeker. Built with HTML, CSS , JavaScript, Firebase, NodeJs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published