Welcome to Komak, Nabo's open source project for developing a platform to help fight against the effects of the COVID-19 pandemic.
Komak is an app born out of necessity in the wake of the COVID-19 events. The goal of Komak is to provide a digital platform for healthy volunteers to help out those most in need.
Komak uses geolocation services to match volunteers with people that are at risk in their area. Komak then enables communication between the two parties so that volunteers can help with groceries, pharmacy runs, etc.
Komak is open-source, and we need all of the help we can get in this hopefully short-lived endeavor.
Komak is built with 3 groups of stakeholders in mind:
-
People in need of isolation.
-
Healthy adults that want to help out.
-
Groups and organizations working towards the same goal. Komak can help them act more efficiently using our platform.
- Geolocation-based matching
- Matching volunteers with those in need
- Accept or reject help requests
- Call or text the people you match with
- Submit requests via web form
- (Planned) Select the area you want to help within
- (Planned) Create an "in need" account for someone else (your grandparents, for example)
- (Planned) Identity verification
- (Planned) Communicating special needs with requests
- (Planned) Selecting availability time windows
- One the best way to help the project is to talk about it, in any way you can (blog, articles, twitter, etc...)
- Found a bug ? Have an awesome idea ? You can create an issue on the issue tracker
- Non-english speaker ? You can help us translating this app on Crowding
- We are a non-profit organization but you can help us pay the bills. Contact us at contact@komak.io.
First, thank you! If you want to help the development of this project, you can pick an issue that has been created by one of the main contributor. We recommend starting with an issue with the "Help wanted" or "Good first issue" label. Please, in the issue, let us know that you're working on it. Everybody hates double work ;) If you have an amazing idea, cool! But please create an issue first, so that we can discuss and validate it before you start working on it.
We have 2 main repositories : App & Backend.
- The backend is written in Node.js + Typescript + Nest.js and is using MongoDB (database) & RabbitMQ (message broker). You can find more information by accessing the repository. A swagger API doc is available.
- The app is also written in Typescript, and uses the React Native framework.
Clone the project and then run:
npm installThe project is trying to install cocoapod dependencies. If you don't have MacOS, don't worry ! It will just fail installing them, but the command will still succeed.
Running Android is the most straightforward. Follow the React Native Instructions - Click on this click, then choose React Native CLI Quickstart, your plaform and the target OS (Android). Be careful of reading all instructions carefully.
Once you're done, you should be able to run the project on Android.
npm run androidFirst, follow the React Native Instructions - Click on this click, then choose React Native CLI Quickstart, your plaform and the target OS (iOS).
TODO
Per default, you don't need to run the backend, you'll be connected to our staging environment. If you want to work on both in parallel, you can just start the backend by cloning it, installing dependencies and running npm run start:dev. See more instructions on the repository page. Then you can change the bacend url to your local IP, here.
We want to develop technology to aid the global response to COVID-19.
Komak's vision is to help reduce the spread of COVID-19 by enabling healthy adults to help those most in need maintain physical isolation.
We envision Komak as a safe to use platform for every one of our users and hope for everyone to support us in this goal.
We want to develop a platform that is:
- Easy to use: Our platform should be intuitive and easy to access
- Open source: We believe everyone should be able to contribute to our efforts in whatever way they can. We plan to leverage the open source community in delivering the best platform that we can, and as quickly as we can. Time is of the essence!
- Globally accessible: The platform is being developed with a global scope. Geolocation-enabled services mean that any community, no matter where it is located, can tap into our platform.
- Free and non-profit: Komak is born as a volunteer response to the current crisis. We will not charge for access to the platform, and we will not make a profit out of it. Any funding we might receive through donations or sponsorships will be used to cover the costs of running the platform, increasing awareness and supporting the safety of our users.
- Helping flatten the curve: Experts are saying that COVID-19 will have to be managed for longer than we have previously thought. We hope that our efforts will help reduce the spread of the disease and by doing so contribute to reducing bottlenecks in our healthcare in the wake of the global pandemic.
Komak is a group effort, and we would like to thank all of the people and companies that are helping us build it.
The core members of Komak are:
We are very lucky to have attracted a number of contributors to help us out in building this. You can find the up to date list of contributors on our website.
We are thankful to our sponsors for covering some of the costs of our initiative. If you'd like to sponsor our efforts, please get in touch at contact@komak.io
- Ocean.io, hosting
Please do not hesitate to get in contact with us if you wish to contribute, sponsor our efforts or just say hi! You can reach us by email at contact@komak.io