Skip to content

Commit

Permalink
Merge branch 'main' into #1645-wordcontribution-dao-test
Browse files Browse the repository at this point in the history
  • Loading branch information
jo-elimu authored Jul 2, 2024
2 parents 09b0da9 + 4862d8d commit 272ce3d
Show file tree
Hide file tree
Showing 13 changed files with 117 additions and 25 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# These are supported funding model platforms

custom: ['https://github.com/elimu-ai/web3-wiki#funding']
custom: ['https://www.drips.network/app/drip-lists/41305178594442616889778610143373288091511468151140966646158126636698']
3 changes: 2 additions & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ jobs:
- run: mvn compile
- run: mvn package -P Jspc
- run: mvn test
- uses: codecov/codecov-action@v3
- uses: codecov/codecov-action@v4
with:
fail_ci_if_error: true
token: ${{ secrets.CODECOV_TOKEN }}
verbose: true
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
See https://github.com/elimu-ai/wiki/blob/main/CONTRIBUTING.md#workflow-example-webapp
# Contributing

## Contributing to elimu.ai 👩🏽‍💻

See https://github.com/elimu-ai/wiki/blob/main/CONTRIBUTING.md

## Funding Splits 💦

> [!NOTE]
> The maintainer splits at https://www.drips.network/app/projects/github/elimu-ai/webapp should reflect the data in [`FUNDING_SPLITS.csv`](FUNDING_SPLITS.csv). If your GitHub username is in `FUNDING_SPLITS.csv`, add your Ethereum address next to it.
28 changes: 26 additions & 2 deletions DB_MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

By using the Java Persistence API (JPA), classed annotated by @Entity (in the [`model`](src/main/java/ai/elimu/model) package) get mapped automatically to database tables/columns: [`src/main/resources/META-INF/jpa-persistence.xml`](https://github.com/elimu-ai/webapp/blob/main/src/main/resources/META-INF/jpa-persistence.xml)

However, when _deleting, modifying or renaming_ an entity class/attribute, we have to manually update the underlying database structure.
> [!IMPORTANT]
> However, when _deleting, modifying or renaming_ an entity class/attribute, we have to manually update the underlying database structure.
## Migration Scripts

Expand All @@ -27,4 +28,27 @@ For an example of a previous database migration script, see https://github.com/e

## Caveats 😅

Note that DB migration performed automatically by the ORM provider (Hibernate), e.g. when adding a new property to an @Entity, is executed _before_ our custom migration scripts.
> [!WARNING]
> Note that DB migration performed automatically by the ORM provider (Hibernate), e.g. when adding a new property to an `@Entity`, is executed _before_ our custom migration scripts.
---

<p align="center">
<img src="https://github.com/elimu-ai/webapp/blob/main/src/main/webapp/static/img/logo-text-256x78.png" />
</p>
<p align="center">
elimu.ai - Free open-source learning software for out-of-school children ✨🚀
</p>
<p align="center">
<a href="https://elimu.ai">Website 🌐</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki#readme">Wiki 📃</a>
&nbsp;&nbsp;
<a href="https://github.com/orgs/elimu-ai/projects?query=is%3Aopen">Projects 👩🏽‍💻</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki/milestones">Milestones 🎯</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki#open-source-community">Community 👋🏽</a>
&nbsp;&nbsp;
<a href="https://www.drips.network/app/drip-lists/41305178594442616889778610143373288091511468151140966646158126636698">Support 💜</a>
</p>
2 changes: 1 addition & 1 deletion FUNDING.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"drips": {
"ethereum": {
"ownedBy": "0x883753Beab357A2c29f3766C6ad158e72A78ce51"
"ownedBy": "0xB1C409722B23Cba26dE8660b180d4B55Ed8CB4c0"
}
}
}
11 changes: 11 additions & 0 deletions FUNDING_SPLITS.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
ethereum_address,github_username,impact_percentage
0x5D388Ec24Cc2C0C77458338696aa63AFB706A7b1,nya-elimu,51.02
0xd46Cc93E3eE6a4fb532D9B48E95be7eD8f8f1DA0,jo-elimu,38.77
0x3965d420cde24fe00f742cb31257ca90e04556a7,tomaszsmy,1.20
0x819e4F5E912abb36c8f6c03790e7508e03cc37a3,UmenR,1.12
0x5367a6d4F5991327Bb20466684790e394bE000dE,Shubham-Vishwakarma,0.76
0x0000000000000000000000000000000000000000,aschworer,0.73
0x6321286F9B73f427C72e1f9F1bC6b3d25eF06605,hhio618,0.57
0x0000000000000000000000000000000000000000,urosht,0.57
0x4709ebf314c6492d57f4c6d4f57357d5b2bb074e,vrudas,0.56
0x914dBEe36BcAb63B2D15fAED08839Be43797b421,watr-sheep,0.38
37 changes: 28 additions & 9 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ Next, to access the application in your browser, go to [http://localhost:8080/we

### Debug 🪲

To run the application in debug mode, replace `mvn` with `mvnDebug` in the command above ☝️
> [!TIP]
> To run the application in debug mode, replace `mvn` with `mvnDebug` in the command above ☝️

## Code Coverage
Expand All @@ -57,11 +58,29 @@ open target/site/jacoco/index.html

## Supported languages 🇺🇸🇵🇭🇮🇳🇹🇿

A list of the currently supported languages is available at https://github.com/elimu-ai/model/blob/main/src/main/java/ai/elimu/model/enums/Language.java

The default language used during development is English (`ENG`). To switch to another language, edit the `content.language` property in [src/main/resources/config.properties](src/main/resources/config.properties).


## Contributing guidelines

For guidelines on how to work on issues, see [CONTRIBUTING.md](CONTRIBUTING.md)
A list of the currently supported languages is available at https://github.com/elimu-ai/model/blob/main/src/main/java/ai/elimu/model/v2/enums/Language.java

> [!NOTE]
> The default language used during development is English (`ENG`). To switch to another language, edit the `content.language` property in [src/main/resources/config.properties](src/main/resources/config.properties).
---

<p align="center">
<img src="https://github.com/elimu-ai/webapp/blob/main/src/main/webapp/static/img/logo-text-256x78.png" />
</p>
<p align="center">
elimu.ai - Free open-source learning software for out-of-school children ✨🚀
</p>
<p align="center">
<a href="https://elimu.ai">Website 🌐</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki#readme">Wiki 📃</a>
&nbsp;&nbsp;
<a href="https://github.com/orgs/elimu-ai/projects?query=is%3Aopen">Projects 👩🏽‍💻</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki/milestones">Milestones 🎯</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki#open-source-community">Community 👋🏽</a>
&nbsp;&nbsp;
<a href="https://www.drips.network/app/drip-lists/41305178594442616889778610143373288091511468151140966646158126636698">Support 💜</a>
</p>
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 elimu.ai Community DAO
Copyright (c) 2020 elimu.ai

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
22 changes: 22 additions & 0 deletions LOCALIZE.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,25 @@ Another strategy for adding words is to go to the "Words Pending" page, where yo
<img width="329" src="https://user-images.githubusercontent.com/15718174/101676791-527d0e00-3a64-11eb-9937-a8299f4cd7e8.png">

1. Then, proceed as described above in ["Adding Words"](#adding-words).

---

<p align="center">
<img src="https://github.com/elimu-ai/webapp/blob/main/src/main/webapp/static/img/logo-text-256x78.png" />
</p>
<p align="center">
elimu.ai - Free open-source learning software for out-of-school children ✨🚀
</p>
<p align="center">
<a href="https://elimu.ai">Website 🌐</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki#readme">Wiki 📃</a>
&nbsp;&nbsp;
<a href="https://github.com/orgs/elimu-ai/projects?query=is%3Aopen">Projects 👩🏽‍💻</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki/milestones">Milestones 🎯</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki#open-source-community">Community 👋🏽</a>
&nbsp;&nbsp;
<a href="https://www.drips.network/app/drip-lists/41305178594442616889778610143373288091511468151140966646158126636698">Support 💜</a>
</p>
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# elimu.ai Webapp

[![codecov](https://codecov.io/gh/elimu-ai/webapp/branch/main/graph/badge.svg?token=T1F9OTQVOH)](https://codecov.io/gh/elimu-ai/webapp)
[![commits](https://img.shields.io/github/commit-activity/m/elimu-ai/webapp)](https://github.com/elimu-ai/webapp/commits)
[![last commit](https://img.shields.io/github/last-commit/elimu-ai/webapp)](https://github.com/elimu-ai/webapp/commits)
[![contributors](https://img.shields.io/github/contributors/elimu-ai/webapp)](https://github.com/elimu-ai/webapp/graphs/contributors)
[![closed issues](https://img.shields.io/github/issues-closed/elimu-ai/webapp)](https://github.com/elimu-ai/webapp/issues?q=is%3Aissue+is%3Aclosed)

Web application:

Expand All @@ -15,37 +19,38 @@ This web application hosts Android apps and educational content (e.g. texts, aud

See [src/main/java/ai/elimu/rest/](src/main/java/ai/elimu/rest/)

The webapp's REST API is used by four Android applications:
The webapp's REST API is used by three Android applications:
1. [elimu.ai Appstore](https://github.com/elimu-ai/appstore)
1. [elimu.ai Content Provider](https://github.com/elimu-ai/content-provider)
1. [elimu.ai Analytics](https://github.com/elimu-ai/analytics)
1. [elimu.ai Crowdsource](https://github.com/elimu-ai/crowdsource)

## Software architecture

See [elimu.ai Wiki: SOFTWARE_ARCHITECTURE.md](https://github.com/elimu-ai/wiki/blob/main/SOFTWARE_ARCHITECTURE.md)

## Run webapp locally 👩🏽‍💻

See [INSTALL.md](INSTALL.md)

## Localization

See [LOCALIZE.md](LOCALIZE.md)

## Database migration

See [DB_MIGRATION.md](DB_MIGRATION.md)

## Contributing guidelines
See [CONTRIBUTING.md](CONTRIBUTING.md)

See [CONTRIBUTING.md](CONTRIBUTING.md)

---

<p align="center">
<img src="https://github.com/elimu-ai/webapp/blob/main/src/main/webapp/static/img/logo-text-256x78.png" />
</p>
<p align="center">
elimu.ai - Free open source learning software for out-of-school children ✨🚀
elimu.ai - Free open-source learning software for out-of-school children ✨🚀
</p>
<p align="center">
<a href="https://elimu.ai">Website 🌐</a>
Expand All @@ -57,4 +62,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)
<a href="https://github.com/elimu-ai/wiki/milestones">Milestones 🎯</a>
&nbsp;&nbsp;
<a href="https://github.com/elimu-ai/wiki#open-source-community">Community 👋🏽</a>
&nbsp;&nbsp;
<a href="https://www.drips.network/app/drip-lists/41305178594442616889778610143373288091511468151140966646158126636698">Support 💜</a>
</p>
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@
<dependency>
<groupId>org.apache.maven.scm</groupId>
<artifactId>maven-scm-provider-gitexe</artifactId>
<version>1.11.3</version>
<version>1.13.0</version>
</dependency>
<dependency>
<groupId>org.apache.maven.scm</groupId>
<artifactId>maven-scm-api</artifactId>
<version>1.11.3</version>
<version>1.13.0</version>
</dependency>
</dependencies>
</plugin>
Expand Down
5 changes: 2 additions & 3 deletions src/main/webapp/WEB-INF/jsp/contributions/privacy-policy.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,8 @@

<ol class="browser-default">
<li>
When a community contributor signs onto this website or the
<a href="https://github.com/elimu-ai/crowdsource" target="_blank">Crowdsource</a>
Android app for the first time, we store the anonymous provider ID (from
When a community contributor signs onto this website
for the first time, we store the anonymous provider ID (from
Google/GitHub) in order to recognize the same contributor when
she/he returns at a later point in time.
</li>
Expand Down

0 comments on commit 272ce3d

Please sign in to comment.