Bike diary

🚧 WORK IN PROGRESS 🚧

An Android app that allows users to record their cycling routes, save memorable photos, and track their personal improvement goals & statistics while discovering new places.

Screenshots

coming soon

Documentation

Functional specifications

• Authentication portal — Access the login and registration page
• Login — Log in to a user account

Development setup

Prerequisites

Once you have the keys, you can define them in your ./gradle.properties file.

1. Server Url: The application uses a dedicated API server to handle HTTP requests. Follow these instructions to configure and run the server locally on your system.

# ./gradle.properties

API_SERVER_URL=<insert>

2. Mapbox download and public API keys: You can find information on how to generate these keys via this link:

   https://docs.mapbox.com/android/maps/guides/install/

# ./gradle.properties

MAPBOX_DOWNLOAD_TOKEN=<insert>
MAPBOX_PUBLIC_TOKEN=<insert>

3. Sentry DNS (optional): If you use Sentry for app monitoring, you can add the DNS.

# ./gradle.properties

SENTRY_DNS=<insert>

Note: replace <insert> with the correct values

Building and Testing

This project uses the Gradle build system. To build or test this project, use the gradlew build or gradlew test command, respectively.

License

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