diff --git a/CODEOWNERS b/.github/CODEOWNERS similarity index 100% rename from CODEOWNERS rename to .github/CODEOWNERS diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index eb7574691..695b6b1da 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -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'] diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 72dd391c5..24a04f0bd 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14443b7eb..3fbb6175a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/DB_MIGRATION.md b/DB_MIGRATION.md index 9cd7a694d..15f69fc0f 100644 --- a/DB_MIGRATION.md +++ b/DB_MIGRATION.md @@ -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 @@ -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. + +--- + +

+ +

+

+ elimu.ai - Free open-source learning software for out-of-school children ✨🚀 +

+

+ Website 🌐 +  •  + Wiki 📃 +  •  + Projects 👩🏽‍💻 +  •  + Milestones 🎯 +  •  + Community 👋🏽 +  •  + Support 💜 +

diff --git a/FUNDING.json b/FUNDING.json index 883b47c34..9a0fb60fb 100644 --- a/FUNDING.json +++ b/FUNDING.json @@ -1,7 +1,7 @@ { "drips": { "ethereum": { - "ownedBy": "0x883753Beab357A2c29f3766C6ad158e72A78ce51" + "ownedBy": "0xB1C409722B23Cba26dE8660b180d4B55Ed8CB4c0" } } } diff --git a/FUNDING_SPLITS.csv b/FUNDING_SPLITS.csv new file mode 100644 index 000000000..0cab33ef7 --- /dev/null +++ b/FUNDING_SPLITS.csv @@ -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 diff --git a/INSTALL.md b/INSTALL.md index 4c90e8532..d14e559f9 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -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 @@ -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). + +--- + +

+ +

+

+ elimu.ai - Free open-source learning software for out-of-school children ✨🚀 +

+

+ Website 🌐 +  •  + Wiki 📃 +  •  + Projects 👩🏽‍💻 +  •  + Milestones 🎯 +  •  + Community 👋🏽 +  •  + Support 💜 +

diff --git a/LICENSE b/LICENSE index a72b048df..4523a59c7 100644 --- a/LICENSE +++ b/LICENSE @@ -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 diff --git a/LOCALIZE.md b/LOCALIZE.md index 9f51f3bfb..ba40cb3d3 100644 --- a/LOCALIZE.md +++ b/LOCALIZE.md @@ -135,3 +135,25 @@ Another strategy for adding words is to go to the "Words Pending" page, where yo 1. Then, proceed as described above in ["Adding Words"](#adding-words). + +--- + +

+ +

+

+ elimu.ai - Free open-source learning software for out-of-school children ✨🚀 +

+

+ Website 🌐 +  •  + Wiki 📃 +  •  + Projects 👩🏽‍💻 +  •  + Milestones 🎯 +  •  + Community 👋🏽 +  •  + Support 💜 +

diff --git a/README.md b/README.md index e95ad57ea..a54fb1a07 100644 --- a/README.md +++ b/README.md @@ -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: @@ -15,20 +19,21 @@ 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 @@ -36,8 +41,8 @@ See [LOCALIZE.md](LOCALIZE.md) See [DB_MIGRATION.md](DB_MIGRATION.md) ## Contributing guidelines -See [CONTRIBUTING.md](CONTRIBUTING.md) +See [CONTRIBUTING.md](CONTRIBUTING.md) --- @@ -45,7 +50,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)

- elimu.ai - Free open source learning software for out-of-school children ✨🚀 + elimu.ai - Free open-source learning software for out-of-school children ✨🚀

Website 🌐 @@ -57,4 +62,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) Milestones 🎯  •  Community 👋🏽 +  •  + Support 💜

diff --git a/pom.xml b/pom.xml index 17e963be8..b98a8093a 100644 --- a/pom.xml +++ b/pom.xml @@ -64,12 +64,12 @@ org.apache.maven.scm maven-scm-provider-gitexe - 1.11.3 + 1.13.0 org.apache.maven.scm maven-scm-api - 1.11.3 + 1.13.0 diff --git a/src/main/webapp/WEB-INF/jsp/contributions/privacy-policy.jsp b/src/main/webapp/WEB-INF/jsp/contributions/privacy-policy.jsp index 33590bc8d..a871f1e06 100644 --- a/src/main/webapp/WEB-INF/jsp/contributions/privacy-policy.jsp +++ b/src/main/webapp/WEB-INF/jsp/contributions/privacy-policy.jsp @@ -12,9 +12,8 @@
  1. - When a community contributor signs onto this website or the - Crowdsource - 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.