Skip to content

Commit

Permalink
docs: Update references to old branch name
Browse files Browse the repository at this point in the history
  • Loading branch information
nya-elimu committed Apr 15, 2022
1 parent b0915be commit ea7d440
Show file tree
Hide file tree
Showing 19 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See https://github.com/elimu-ai/wiki/blob/master/CONTRIBUTING.md#workflow-example-webapp
See https://github.com/elimu-ai/wiki/blob/main/CONTRIBUTING.md#workflow-example-webapp
6 changes: 3 additions & 3 deletions DB_MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# DB Migration 🔀

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/master/src/main/resources/META-INF/jpa-persistence.xml)
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.

## Migration Scripts

Every time the webapp completes initialization, the [`DbMigrationHelper`](src/main/java/ai/elimu/util/db/DbMigrationHelper.java) checks if there are any database migration scripts at [`src/main/resources/db/migration`](https://github.com/elimu-ai/webapp/tree/master/src/main/resources/db/migration) matching the current webapp version. You can find the version in [`pom.xml`](pom.xml#L7).
Every time the webapp completes initialization, the [`DbMigrationHelper`](src/main/java/ai/elimu/util/db/DbMigrationHelper.java) checks if there are any database migration scripts at [`src/main/resources/db/migration`](https://github.com/elimu-ai/webapp/tree/main/src/main/resources/db/migration) matching the current webapp version. You can find the version in [`pom.xml`](pom.xml#L7).

## How to Add a New Migration Script

Follow these steps:

1. Lookup the current webapp version in [`pom.xml`](pom.xml#L7)
2. Add a new file to [`src/main/resources/db/migration`](https://github.com/elimu-ai/webapp/tree/master/src/main/resources/db/migration). E.g. `2003004.sql` for version `2.3.4`.
2. Add a new file to [`src/main/resources/db/migration`](https://github.com/elimu-ai/webapp/tree/main/src/main/resources/db/migration). E.g. `2003004.sql` for version `2.3.4`.
3. Add the SQL script that will be executed on the `TEST`/`PROD` server.

## Sample
Expand Down
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To run the application in debug mode, replace `mvn` with `mvnDebug` in the comma

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

A list of the currently supported languages is available at https://github.com/elimu-ai/model/blob/master/src/main/java/ai/elimu/model/enums/Language.java
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).

Expand Down
2 changes: 1 addition & 1 deletion LOCALIZE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ See [INSTALL.md](INSTALL.md#supported-languages-)

## Adding Support for a New Language

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


## Adding Educational Content
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The webapp's REST API is used by four Android applications:

## Software architecture

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

## Run application locally 👩🏽‍💻
See [INSTALL.md](INSTALL.md)
Expand All @@ -39,5 +39,5 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)

![elimu ai-tagline](https://user-images.githubusercontent.com/15718174/54360503-e8e88980-465c-11e9-9792-32b513105cf3.png)

* For a high-level description of the project, see https://github.com/elimu-ai/wiki/blob/master/README.md.
* For a high-level description of the project, see https://github.com/elimu-ai/wiki/blob/main/README.md.
* For project milestones, see https://github.com/elimu-ai/wiki/projects.
2 changes: 1 addition & 1 deletion src/main/resources/config.properties
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs.enabled = true
pom.version=${project.version}

# The language of the educational content
# See https://github.com/elimu-ai/model/blob/master/src/main/java/ai/elimu/model/enums/Language.java
# See https://github.com/elimu-ai/model/blob/main/src/main/java/ai/elimu/model/enums/Language.java
content.language=ENG

# Create free API key using https://www.covalenthq.com/platform/#/auth/register/
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/emoji/create.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<a href="https://emojipedia.org" target="_blank">📙 Emojipedia</a>
</li>
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki: Localization</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki: Localization</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/emoji/edit.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<a href="https://emojipedia.org/<c:out value='${emoji.glyph}' />" target="_blank">📙 Emojipedia</a>
</li>
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md#" target="_blank">elimu.ai Wiki: Localization</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md#" target="_blank">elimu.ai Wiki: Localization</a>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
General resources:
<ol style="list-style-type: inherit;">
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@
General resources:
<ol style="list-style-type: inherit;">
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/letter/create.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
General resources:
<ul>
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki: Localization</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki: Localization</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/letter/edit.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
General resources:
<ul>
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki: Localization</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki: Localization</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/number/create.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
General resources:
<ol style="list-style-type: inherit;">
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/number/edit.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@
General resources:
<ol style="list-style-type: inherit;">
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/sound/create.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
General resources:
<ol style="list-style-type: inherit;">
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/sound/edit.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@
General resources:
<ol style="list-style-type: inherit;">
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/word/create.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@
<a href="<spring:url value='/content/word/pending' />"><fmt:message key="words.pending" /></a>
</li>
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/WEB-INF/jsp/content/word/edit.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@
<a href="<spring:url value='/content/word/pending' />"><fmt:message key="words.pending" /></a>
</li>
<li>
<a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
<a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">elimu.ai Wiki</a>
</li>
<li>
<a href="https://docs.google.com/document/d/e/2PACX-1vSZ7fc_Rcz24PGYaaRiy3_UUj_XZGl_jWs931RiGkcI2ft4DrN9PMb28jbndzisWccg3h5W_ynyxVU5/pub#h.835fthbx76vy" target="_blank">Creating Localizable Learning Apps</a>
Expand Down
4 changes: 2 additions & 2 deletions src/main/webapp/WEB-INF/jsp/welcome.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
The <a href="https://github.com/elimu-ai/appstore" target="_blank">elimu.ai Appstore</a> makes it easy to download and use the software.
</p>
<p>
Also, anyone is welcome to take the existing code and <a href="https://github.com/elimu-ai/wiki/blob/master/LOCALIZATION.md" target="_blank">adapt</a> it to their local needs.
Also, anyone is welcome to take the existing code and <a href="https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md" target="_blank">adapt</a> it to their local needs.
</p>
</div>
<div class="col s12 m4">
Expand Down Expand Up @@ -185,7 +185,7 @@
<h2><i class="material-icons medium">local_shipping</i></h2>
<h5><fmt:message key="distribute.the.software" /></h5>

<p>Do you live near a child who does not have access to quality basic education? Help us <a href="https://github.com/elimu-ai/wiki/blob/master/SOFTWARE_ARCHITECTURE.md#distribution">distribute</a> the learning software.</p>
<p>Do you live near a child who does not have access to quality basic education? Help us <a href="https://github.com/elimu-ai/wiki/blob/main/SOFTWARE_ARCHITECTURE.md#distribution">distribute</a> the learning software.</p>
</div>
</div>
</div>
Expand Down

0 comments on commit ea7d440

Please sign in to comment.