Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 3.03 KB

README.md

File metadata and controls

54 lines (40 loc) · 3.03 KB
Raw

MeBay

This is a project I have created for Cloud Computing (CENG495) class at METU. The purpose of this project was to use MongoDB Stitch API to create an app without paying for or provisioning any server for database. We had the liberty to not deploy our application anywhere if the app could be built so this one is not deployed anywhere. It is using MongoDB Stitch technology, which I believe is now replaced with MongoDB Atlas or Realms.

Ozan Incesulu e2099711

Install & Build:

You need to have Node.js and NPM to build the project. Run build.sh to install dependencies and compile the JS. You may run compile.sh to skip dependency check after one successful build.

Design Choices

I have created a simple framework that can be used to manage state and render basic HTML templates. The reason is I am not satisfied with all the complexities that are required to install some basic app framework these days (especially all the stuff with React and Webpack). I haven't used Elm for this project since using Stitch as an external dependency to the code would be too cumbersome.

I have loaded all users from the database for the application state, since product viewing route needs all state to show all products of all sellers and the user home view needs it to recalculate ratings given for a product.

I have created only one collection, stored all orders on buyer's side and products on seller's side, considering the deletion policies would be best fit this way.

User's Guide

I consider the UI to be intuitive, thus I didn't create a guide.

External Dependencies:
File Structure:
  • index.html -> File that loads public/index.html
  • public -> Contains the deployable parts of the app
    • index.html -> Contains the main entrypoint and page templates
    • js/bundle.js -> Bundled js file created automatically by browserify
    • css/overlay.css -> Code to generate Loading... overlay
  • src -> Contains TS source code for the app
    • framework.ts -> A basic framework I created to handle basic template rendering and redux-like state management without overhead
    • index.ts -> entrypoint of app
    • logout.ts -> Route logic for logging user out
    • mongoOps.ts -> operations performed on MongoDB, abstracted for general use
    • product.ts -> Route logic for the product listing page
    • userHome.ts -> Route logic for user's home
    • userSelect.ts -> Route logic for user selection page
  • build.sh -> Script for building the app
  • compile.sh -> Script to only compile the app
  • package.json / package-lock.json -> npm package resolution files
  • tsconfig.json -> Typescript compiler configuration