Skip to content
This repository has been archived by the owner on Mar 6, 2020. It is now read-only.

neelkamath/osmosis-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Osmosis Spec

This is the specification for the improved BMTC ticketing system which is to be prototyped at HackBout.

Usage

Explanation

This explains the idea technically in English with the aid of wireframes. It also states how the prototype will function differently from the real world implementation.

The project is named Osmosis because it helps transport people (biochemically, osmosis is molecules being transported).

We follow a naming strategy similar to major companies such as Uber. The suite of products is called Osmosis. The passenger, conductor, and admin's apps are named Osmosis, Osmosis Conductor, and Osmosis Admin respectively. The backend is named Osmosis Server.

  1. Product Vision
  2. Objectives
  3. Business Viability
  4. Passenger's App
  5. Conductor’s App
  6. Admin's Panel
  7. Database Schema
  8. Prototype Deviations

OpenAPI Specification

The OpenAPI specification is meant for the prototype. You can view the HTTP API documentation here. While the backend developer is implementing the server, API consumers (e.g., a web frontend developer) can use the mock server.

Branding

Branding assets are in the branding directory.

License

This project is under the MIT License.

About

👓 Spec for improved Indian bus system

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published