Sharks is an educational app that helps pre-tertiary Ghanaian students to take tailored lessons based on the new curriculum.
This repository is where I build the sharks app. The web app (/web) provides a dashboard through which contents can be added, updated, or deleted. The mobile client version (/mobile) is the mobile app that students use to access the contents as well.
- Python 3.8
- Django 3
Clone the repository and open it in an editor.
git clone https://github.com/dodziraynard/sharks.gitcd sharks/web
pip install -r requirements.txt
python .\manage.py makemigrations
python .\manage.py migrate- Run the command below to create an administrative account to access the dashboard.
python .\manage.py createsuperuser Run this command to spin up the development server.
python .\manage.py runserver 0.0.0.0:8000- Finally, open http://127.0.0.1:8000/ in the browser and enter the credentials to login.
- Create some contents and run the mobile app (android) to view them in the app as well.
View the dashboard currently hosted on google cloud here
- Java
- Kotlin
- Native Android SDK
Clone the repository and open /mobile directory in android studio.
git clone https://github.com/dodziraynard/sharks.gitIn order to enable the mobile app connect to the local running instance of the backend, you may want to edit app/src/main/java/com/innova/sharks/utils/Constants.java
by changing the IP address in the TEST_BASE_API_URL constant.
...
// TESTING BASE API URL
public static final String TEST_BASE_API_URL = "http://YOUR_LOCAL_TEST_IP:8000/api/v1.0/";
...- Better still, you may test the app using the live backend server; either build the release version of the app or assign
http://34.67.115.110/api/v1.0/to theTEST_BASE_API_URLconstant. - Connect a real device or start the emulator.
- Run the app from android studio.
Here is the release built (apk) of the app.