Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update introduction on majifix components #5

Merged
merged 3 commits into from
Jul 20, 2018
Merged

update introduction on majifix components #5

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c913d6b
update introduction on majifix components
joshuamabina Jul 19, 2018
c9928c7
fix typos
joshuamabina Jul 20, 2018
6e302e8
accomodate components with no public repos
joshuamabina Jul 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 43 additions & 8 deletions get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,49 @@ support public service providers in solving each and every problem, while giving

## Majifix components

MajiFix has different components

- A ticket management system to support public officials to keep track of problems that were reported.
- A management app that provides statistics about system performance to city managers.
- A mobile app that citizens can use to easily report problems.
- A Facebook Messenger Bot, so that people can submit problems through FB Messenger’s interface. No need to download an app.
- A USSD interface, specially relevant in places where not everyone owns a smartphone.
- A public website, that publicly shows what is going on with the system.
MajiFix has different components. The followin text provides brief description of each component.

### Majifix API

Majifix API is built on Node.JS. It is a RESTful API layer designed in support of reporting and tracking common public service (i.e. water) problems.

It is consists of a suite of node packages covering the business/domain logic (the part of a platform that encodes the real-world business rules that determine how data is created, displayed, stored and changed), built for performance and scale.

You can consider it as the data layer within a platform (including the data model). It is designed to be plugged into a templating layer, a mobile application or to be used with any other data consumer.

Majifix API provides a starting point that's further advanced than a framework. It allows you to get a complete data layer up and running in minutes.

See source code [repository](https://github.com/CodeTanzania/open311-api).

### Majifix management app

Majifix management app is desined to help manaes statistical information about system performance to official city managers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a typo on this line.


See source code [repository](https://github.com/CodeTanzania/open311-mobile-manager).

### Majifix client mobile app

Majifix mobile app is used by citizens to help them instantly report problems to city managers

See source code [repository]().
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still a private repo so the source code will be published once it is refactored and all sensitive information removed from the code


### Majifix facebook messenger bot

Majifix facebook messenger bot is designed to create more social engagement by allowinj citizens to submit problems to the Majifix platform through Facebook Messenger's interface without downloadin the actual app.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This a typo also on this line


See source code [repository](https://github.com/CodeTanzania/facebook-majifix-bot).

### Majifix USSD

Majifix USSD interface, specially relevant in places where not everyone owns a smartphone.

See source code [repository]().

### Majifix website

A public website, that publicly shows what is going on with the system.

See source code [repository](https://github.com/CodeTanzania/majifix.io).

## Our vision

Expand Down