despeauxz/narrativre

A CRUD application

Narrative Project

A CRUD application for marketers to create orders for buyers

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License

About The Project

(back to top)

Built With

This project was built with following packages and framework

• Vue.js
• Buefy

(back to top)

Getting Started

In the Narrative Marketplace, a buy order describes the parameters for purchasing data. A buy order can have the following fields:

• Name: Name for the buy order.
• Max Bid Price: The maximum amount that a buyer is willing to pay for data.
• Data Package Type: The type of data being purchased. The possible values are "Device Location", "Device Behavior", and "ID Mapping".

The goal of this task is to implement a web app for working with buy orders. It should support the following use cases:

• Creating a new buy order
• Displaying an existing buy order
• Updating an existing buy order
• Deleting a buy order

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/despeauxz/narrativre

2. Switch to the master branch
3. Install NPM packages

   npm install

4. Run npm run serve, then you be able to preview the project on http://localhost:8080

(back to top)

Usage

Local Storage is used to persist products since there's no time to spin up a NODE server in a mono-repo structure(BE and FE)

• By the sidebar, there's a button to create products
• Products are displayed in 2 views(Grid and List)
• You can view more details by clicking the cards and then you have action items if you are switched as a Merchant(Update and Delete) for Buyers, they only have the Buy button enabled
• You can click the delete button and remove product and likewise update button to toggle the product form

(back to top)

Roadmap

• Creating a new buy order
• ADisplaying an existing buy order (List and Grid)
• Updating an existing buy order
• Deleting a buy order
• Tried to create a buyer and marketer design structure but had little time since I'm still working for my current employer

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)