Personal Journal App

Hello There Welcome to My Personal Journal App repository

I have put a lot of effort to make the finished app available to those:

• who want to see the finished product
• who want to see how the app works like testing the api endpoints and running the Frontend locally
• who want to test the whole app locally

Okay, let's get started: For starters, here is the demo of the working app:

App Demo

https://youtu.be/8AJ0KJUAmpg

The Finished App (.apk)

The finished application is contained in a zip file right here As for the steps of downloading it:

• On the page you are redirected to, you will notice a download icon appearing on the left at the topbar. Click on it  
• When the zip file has finished downloading, unzip it then install the apk found inside it (personaljournal.apk) from an android mobile device (sadly I was not able to deploy on ios devices due to unavoidable circumstances).
  • incase of "app not installed" errors:
    • Try to:
      • Switch off google play protect first then try installing it again
      • allow installation from unknown app sources

---

Frontend setup

1. Node.js and npm: Ensure you have Node.js and npm installed. You can download them from Node.js Official Website or Yarn Package Website

2. To install expo run

npm install -g expo-cli

or (depending with package manager)

yarn global add expo-cli

3. Clone the repository

git clone https://github.com/RafaelJohn9/Personal-Journaling-App/

4. Navigate to the frontend directory

cd Personal-Journaling-App/frontend

5. To install dependencies run

npm install

or (depending with package manager)

yarn install

6. Run the app

npx expo start

7. To Download the expo go app on your mobile device (click here) or you can use an android simulator to run the app

---

Backend setup

There is no need for setting up the Backend as it runs at

https://www.johnmkagunda.me/api/v2/<endpoint>

If you still wish to build and run it locally, please follow through

For the Backend, I made a docker image for it to prevent library conflicts though there are some dependencies needed locally.

MySQL (server and client) >= 5.7
Redis
Docker

If you don't have them, please install them.

1. After this you are needed to run mysql

sudo mysql

2. Run this inside mysql shell

CREATE DATABASE journaling_db;
CREATE USER 'journal_user'@'localhost' IDENTIFIED BY '';
GRANT ALL PRIVILEGES ON journaling_db.* TO 'journal_user'@'localhost';
FLUSH PRIVILEGES;
EXIT;

3. Run the run.sh script to set it up

cd Personal-Journaling-App/backend
./run.sh 

And you are done!

For more on each End's architecture please refer to:

• Frontend/README.md - Contains the frontend program structure
• Backend/README.md - Detailed view on the API endpoints and program structure