Giter Club home page Giter Club logo

akwaba's Introduction

Akwaba

A digital data collection system to help organizations optimize the collection, storage, and management of the collected data. Organizations such as non-for-profit organizations need to collect data regularly for their activities. However, most of these organizations still use traditional methods. Their operators must carry around large amount of papers forms. My experience working with a not-for-profit showed me that these methods are time-consuming, costly, and error-prone. The system is an offline-first web application also known as Progressive Web Application (PWA) which will allow mobile workers to collect data even when they do not have access to the Internet. New information that is entered while the operators are offline can be sync up and down anytime they get access to the internet. This project was built as part of my final year project in Business Computing and Information Systems. The goal was to demonstrate how data replications techniques could be used in web applications to improve performance and availibity.

Live demo

The project is a PWA, so it works best when served using https. Check out the hosted version at:

Requirements

Installation

Open your operating system command-line interface, go to the project folder and run:

$ npm install # install the project dependencies

Rename the env_example file to .env:

You can use your file explorer or if your are on a unix like system you can use:

$ mv env_example .env

Note: You should update the .env file to match your environment. Default values are provided.

Then build the project:

$ npm run build

Usage

You can serve the application by running:

$ npm run start:prod

To use the database server locally, update the value of VUE_APP_SYNC_URL in the .env file to http://localhost:5984, rebuild the application and run the following command:

$ npm run server
  • Note:: An internet connection is required for authentication.
  • Note: You can run the Akwaba API server locally by following the instructions at its repository.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

License

Creative Commons Licence
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License

akwaba's People

Contributors

detygon avatar clebercarmo avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.