Skip to content

A react-admin powered client-side that supports data-capture regularly

License

Notifications You must be signed in to change notification settings

BuildForSDG/Team-270-PulaniFront

Repository files navigation

Pulani (v1.0.0)

Codacy Badge

About

We bring you a data-collection client-side that runs on top of REST API, using ES6, React and Material Design.
Our building blocks are powered by react-admin, an open sourced project, maintained by marmelab.

Why

Let's start at the high-level and narrow down:

  • No Poverty (SDG 1):
    This aims to end all forms of poverty, including extreme poverty (those living under $1.25 per day) and relative poverty (defined at a national level). Eradicating poverty is not a task of charity, it is an act of justice and the key to unlocking an enormous human potential.

  • Target (Problem Statement)(2):
    HELP TACKLE EQUAL RIGHTS TO OWNERSHIP, BASIC SERVICES, TECHNOLOGY AND ECONOMIC RESOURCES.

Enter "Pulani"

Many people start businesses, often low-level, by selling products or their services. Yet, on the contrary, there is very limited data (financial and more) about these groups of people and their activities. Lack of enough data about these groups undermines their rights to mainly basic services and economic resources as well as our fight against poverty.

Pulani, a web app, is designed to collect data and capture key metrics from low-level entrepreneurs. The one goal for Pulani is to be a go-to data-driven platform for any party who is working (or intends to work) with the above mentioned groups.

A case of COVID-19

The coronavirus pandemic has hit us hard, we've lost loved ones and many businesses have closed shop.
Many governments have had to directly support the masses with financial or food aid because of the lock-down strategy.

With a direct hit to most economies, the masses are slipping into utter poverty.
Governments are figuring out what best way to tackle this.
The fact is that, to navigate this situation, the authorities need huge data/figures/metrics (financial and more) in order to make the right decisions and implement the right programs.

Usage

With a goal to encourage entreprenuers, especially the low-level, we are designing basic forms so as to capture as much data.
The frequency of this data entry is reliant on the will of the users to do so.

  • Register (get registered by an admin, or self-register)
  • Log-in (enable personal experience)
  • Set a goal (personal/business)
  • Fill in a basic form (varied for product/service)
  • Have a look at your figures (goal tracker)
  • Sign-out (end your session)

Setup

From within the project directory, you can do this:

  • Clone the repo: git clone https://github.com/BuildForSDG/Team-270-PulaniFront.git

  • Navigate to the root folder of the repo: cd Team-270-PulaniFront

  • Install the required dependencies: npm install (This will install all the files upon which this project depends)

  • Start the App: npm start (This will serve up the app on http://localhost:1234)

src/index.js is the project entry point and source code should go into the src folder. Any edits you make will get the page to reload and you'll also see any errors in the console.

  • Test the App: npm test (Launches the test runner in the interactive watch mode)

  • Lint the App: npm run lint (for eslint), npm run lint-md (for remark, run twice to fix errors)

For every "pre-commit", husky enforces eslint --fix, prettier and stylelint --fix (refer to .lintstagedrc)

All tests should be written in the `tests' folder. See the section about running tests for more information.

Hints

This project uses Parcel as the bundler. It is much simpler than WebPack and the others

Authors

The team behind this project:

Contributing

If this project sounds interesting to you and you'd like to contribute, thank you!
And here are areas we think we'd need the most help in this project at this stage:

  1. Sector-driven data: this app is about data collection and we'd need an input from the private sector / NGOs / government on what data they need from the target groups.
  2. Beta-users: to get early feedback, we'd like you to test the staging app and report any bugs via a form.

Acknowledgements

Many more will follow, and thanks for playing a part in this cause:

LICENSE

MIT

About

A react-admin powered client-side that supports data-capture regularly

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •