/Route-and-Market-Management-System

This is my technical challenge for the convicti company

Primary LanguageVue

Route and Market Management System

Project Description

This project is a route and market management system with distinct areas for administrators and promoters. The application enables the creation, editing, and visualization of markets, routes, products, and promoters, with specific functionalities for each user type.

System Requirements

Administrator Area

Markets: (/) - home

  • Search for markets.
  • Add a market with a modal form.
  • View on the map with Pins representing registered markets.
  • Details of the market when clicking on the Pin.
  • Add the market to a new route when clicking on "Add to Route."
  • Edit market data when clicking on "Edit."

Routes: (/rotas)

  • Horizontal list of promoters.
  • View routes of a promoter by clicking on their name.
  • Details of the markets in the route when clicking the down arrow.

Promoters have got a different view of the 'route' route

Products: (/produtos)

  • Search for products.
  • Add a product with a modal form.
  • Edit a product by clicking on the pencil icon.

Promoters: (/promotores)

  • Search for promoters.
  • Add a promoter with a modal form.
  • Edit a promoter by clicking on the pencil icon.
  • Default password for promoters created via API: "123456."

Installation Instructions

This guide will provide the necessary steps to set up and run the application in your local development environment.

Prerequisites

Make sure you have the following tools installed on your system:

  • Node.js - We use Node.js to run the JavaScript code of the application.
  • npm - JavaScript package manager (usually installed with Node.js).
  • yarn - JavaScript package manager.
  • docker - OS-level virtualization to deliver software in packages.

Set-up the backend

follow this instructions on BitBucket - How to set-up the server-side enviorment

Installation Steps

  1. Clone the repository:

    git clone https://github.com/Jonorusc/convicti-technical-challenge.git
  2. Install dependencies:

    yarn
    ## OR
    yarn install
  3. Set up environment variables: Rename the .env.example file to .env and configure the necessary environment variables such as API keys, database settings, etc.

  4. Start the application:

    yarn dev

    After loading, the page will automatically open in your default web browser.

See how it looks like

Admin view - YOUTUBE Promoter View- YOUTUBE