Journey

Journey is an Android application developed in Kotlin and Java. The application allows users to create and save their own stories written in markdown and includes a database of countries fetched from the REST Countries API. It uses Room for local data storage and Espresso for UI testing.

The UI was done after a brainstorming session with the team on Figma. The design is available here.

Installation

Clone this repository and import into Android Studio

git clone https://github.com/Raideeen/journey-app.git

Usage

After installing the application, users can log in to access their personal notebook. They can create and save their own stories. The application also includes a database of countries that users can explore. The login page is made with hard-coded credentials for demonstration purposes. The username is user and the password is 1234.

Running the tests

To run the existing unit tests, use the following command:

./gradlew test

To run the existing UI tests, use the following command:

./gradlew connectedAndroidTest

Note that the UI test doesn't work for an obscure reason. The test is supposed to click on the "Create a new story" button and check if the user is redirected to the story creation page. However, the test fails because the addStoryButton is not found. We tried to fix the issue but we didn't find any solution.

Dependencies

The project is built with the following dependencies:

• Kotlin - The main programming language
• Java - Used for some parts of the application
• Gradle - Dependency Management
• Room - Used for local data storage
• Espresso - Used for UI testing
• Retrofit - Used for API calls
• Markwon - Used to display markdown text

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contact Information

For any questions or discussions about the project, please reach out to us at adrien.djebar@proton.me.

Acknowledgments

This simple application was developed as part of the Android course at the École supérieure d'ingénieurs Léonard-de-Vinci (ESILV) located at Paris La Défense with our amazing team composed of Lucile Dresler, Ridge Lowao, Abdelhak Hacib and myself.

We would like to thanks our Android professor, Arnaud Chirat, for his guidance and support.

Thanks to all the contributors of the libraries used in this project.