cgnhmt / polibri-public

Polibri e-commerce web application

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Polibri

E-commerce web application using Express 4. Example website is here

Dependencies

  • Npm version 6.4.1
  • Node.js version 10.15.3
  • Knex version 0.17.6
  • Nodemon version 1.19.1
  • posgresql version 7.11.0

Installation

git clone https://github.com/AndacMucahid/polibri-public/
cd polibri
npm install

Running Locally

In order to run the application,

  • first install a local posgresql database then insert credentials to knexfile.js, then:
npm start

Your app should now be running on localhost:5000.

Documentation

Tools used

  • Core libraries

    • bookshelf for object relational mapping. It's a library working with knex which is for database connections
    • express.js for simplify application server structure while keeping node.js style backend intact.
    • passport and passport-local for easy to implement authentication middleware and login functionality via cookies.
    • express-session to handle session management with connect-loki which is local cookie storing tool.
  • Helper libraries

    • swagger-ui-express to serve OpenAPI documentation as UI.
    • morgan Http request logger, a helper tool.
    • bcyrpt for storing hashed passwords
    • nodemon to restart application server whenever a file is changed. Helped too much while developing.
    • yamljs for parsing our OpenApi document. SwaggerUI-express was not supporting .yaml directly.

About

Polibri e-commerce web application


Languages

Language:CSS 55.8%Language:JavaScript 23.0%Language:HTML 21.2%