Init project and architecture

[h0shizaki]

Description

We need to initialize the project. Then select the tools and design the architecture

[h0shizaki]

From the SE262's requirement , we must use MongoDB and Mongoose library. And we must apply EJS to generate html. Then we must use Leaflet for creating an interactive map.

[h0shizaki]

Monolithic architecture with MVC Pattern

example of directory structure

• src/
  • configs/
  • controllers/
  • models/
  • views/
  • routes/
  • utilities/
• public/
• app.js
• package.json

Technology

• NodeJS
• MongoDB
• Express
• EJS
• Mongoose
• Leaflet

Implementation plans

Website

Using Express to serving the EJS template and also apply the Bootstrap to enhance the UI.

Authentication

Encrypt the password before save to the MongoDB with bycpt library and implement the session-based authentication.

Map

Apply the Leaflet that it!

Food order and cart

Fetch the items from the mongodb and then, render them with ejs. Implement the cart by store the cart item in the session.

Restaurant

Authorize the staff separate from the costumer by adding { "role" : USER_ROLE } into the schema then, Implement CRUD operation on food, order and user. And if possible apply ChartJS for create a summarize of the restaurant.

[h0shizaki]

Versioning plan

v0.1.x

feature:

• Serving the static website
• Users can view the mock items information

v0.2.x

feature:

• Add the authentication feature

v0.3.x

feature:

• Enable the costumer to view and add the food items into their cart

v0.4.x

feature:

• Enable the staff to CRUD order, food and user
• Enable the costumer to place an order

v0.5.x

At this version, we can release this project. feature:

• Enable the user to track their order's information
• Implement the interactive map

Enhancing Plan

v.1.0.x

Staff dashboard can display the statistical data

[h0shizaki]

@IcePutipong มาอ่านแผนคร่าวๆ ได้ตรงนี้นะ

[h0shizaki]

Init project

Setup tasks

• Logging
• Routing
• Load Environment variable

[h0shizaki]

• Init project a662bf0b16e1066b0a91170897675df5afc38f40
• Logging b3cdb0953871c7688eb16b885244bcbf162d8274
• Routing 789632c4296acb90fae1a92a30d283e7372fd103 63b1883d6411f75a9c31eba977ba3c09b2cf6bde
• Load Environment variable 09ef5d72a6026575346b19ad252d26eba61ab1eb

[h0shizaki]

Create unit test then, run this unit test and it magically passes!!

describe('EZ Unit test', () => {

    test('Test', () => {
        expect(2 + 1).toBe(3);
    });
});

4cb7f87bae8e6bb292879e93e6673303c98f8adb

[h0shizaki]

Done