/portfolio

Online software for creating service directories

Primary LanguagePythonMIT LicenseMIT

portfolio

Online web software for deploying a directory of service professionals.

  1. Functionality
  2. Design
  3. Roadmap
  4. Setting up
  5. Roadmap

Functionality

High level view of different roles and their possible actions:

Developer: Admin of the directory (Eg: EmptyCup)

As a developer, to deploy Portfolio for a particular service you need to:

  1. Define a portfolio (Eg: Interior designer)
  2. Define a service (Eg: House design project)

Once deployed, users can sign up and use the below functionality.

User: Service professional (Eg: Interior Designer)

  • Add portfolio (Profile, Stats, Gallery, Testimonials, Ratings)
  • Configure service (ETA, Pricing, Deliverables)
  • List portfolio in directory
  • Showcase portfolio
  • View tenders floated by Customers (see below).
  • Submit proposal for tenders.

User: Customer (Eg: Home owner)

  • Browse directory
  • Float a tender
  • Connect with provider

Design

The system has 4 independently deployed components:

  1. Static web frontend - Offers UI functionality by fetching data from the backend REST API
  2. Backend REST API - Maintains a DB and runs a JSON REST API
  3. CLI Tool - Single command line tool for admins to manage the deployment
  4. Static web documentation - Documentation for the entire system.

Roadmap

All the planned functionality will be broken down into smaller minor releases starting v0.1.

Setting up

  • npm needs to be installed before getting started.
  • pip needs to be installed before getting started.
  1. Fork & clone the repository
  2. Install virtualenv
  3. Install python dependencies
  4. Install node dependencies