https://github.com/codeforafrica/africancommons
africanCOMMONS is a platform to showcase re-useable tools built across Africa and the people & organisations building them. Accessible at https://commons.africa/
https://github.com/codeforafrica/africancommons
africa african african-commons africancommons civic commons github jekyll open-source showcase yarn
Last synced: 7 months ago
JSON representation
africanCOMMONS is a platform to showcase re-useable tools built across Africa and the people & organisations building them. Accessible at https://commons.africa/
- Host: GitHub
- URL: https://github.com/codeforafrica/africancommons
- Owner: CodeForAfrica
- License: mit
- Created: 2017-02-01T09:11:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T06:55:37.000Z (over 2 years ago)
- Last Synced: 2025-03-04T08:02:09.819Z (7 months ago)
- Topics: africa, african, african-commons, africancommons, civic, commons, github, jekyll, open-source, showcase, yarn
- Language: JavaScript
- Homepage: https://commons.africa/
- Size: 29.5 MB
- Stars: 11
- Watchers: 7
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
africanCOMMONS
--------------
_A platform to showcase re-useable tools built across Africa and the people & organizations building them. Accessible at https://commons.africa/_
[](https://travis-ci.org/CodeForAfrica/africanCOMMONS)
Why is everyone reinventing the wheel? Massive amounts of money and time are being wasted on rebuilding solutions for digital democracies and open data. africanCOMMONS showcases carefully selected best-of-breed open source civic technologies that have already been ‘battle tested’ elsewhere, for possible re-use in countries across the continent.
africanCOMMONS is a carefully curated collection of the world’s best open source software for civic technologies, compatible with our environment, along with a tactical CivicPatterns ‘playbook’ to help digital activists save time, money, and effort. The collection is designed to help citizens, organizations, and governments re-use both code and data for their own projects, free-of-charge, in the most cost-effective way possible to ensure that the bulk of their project budgets are reserved for actual civic engagement rather than technology.
## Installation
### Requirements
To run this site you need:
- Jekyll https://jekyllrb.com/
- Yarn
To install the yarn requirements;
```sh
yarn
```
### Development
From inside the root directory;
1. Serve using Jekyll;
```shell
$ jekyll s -s dist
```
2. On a separate terminal window, watch for JS/CSS changes using Webpack;
```shell
$ yarn watch
```
### Data Update/Import
To update the projects:
```shell
$ yarn commons download && yarn commons
```
Data sources:
- Projects and organisations - [`https://docs.google.com/spreadsheets/d/1GykfqSTxxhXbzszjOrBFuWNruqDXBNiDQNHNpT8Mn4k/edit#gid=0`](https://docs.google.com/spreadsheets/d/1GykfqSTxxhXbzszjOrBFuWNruqDXBNiDQNHNpT8Mn4k/edit#gid=0)
- Reviews - [`dist/_reviews`](dist/_reviews)
- Users - [`https://github.com/CodeForAfricaLabs/github-africa`](https://github.com/CodeForAfricaLabs/github-africa)
## Deployment
Currently we deploy using [Github pages](http://pages.github.com/):
```shell
$ yarn commons deploy
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more on this.
## Tests
To run style guide tests, you can run
```shell
$ yarn test
```
---
## License
The MIT License (MIT)
Copyright (c) 2017 Code for Africa.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.