https://github.com/ericafenyo/bike-diary

An android application that helps users to create and track their self-improvement goals.
https://github.com/ericafenyo/bike-diary

Last synced: over 1 year ago
JSON representation

An android application that helps users to create and track their self-improvement goals.

• Host: GitHub
• URL: https://github.com/ericafenyo/bike-diary
• Owner: ericafenyo
• License: mit
• Created: 2020-11-02T22:30:51.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T09:58:44.000Z (over 2 years ago)
• Last Synced: 2025-02-05T01:31:02.701Z (over 1 year ago)
• Language: Kotlin
• Size: 4.06 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Bike diary

🚧 WORK IN PROGRESS 🚧

![GitHub workflow build](https://github.com/ericafenyo/bike-diary/actions/workflows/android.yml/badge.svg)

[![GitHub](https://img.shields.io/github/license/ericafenyo/bike-diary)](LICENSE)

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/ericafenyo/bike-diary?label=version)][version]

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.

[version]: https://github.com/ericafenyo/bike-diary/releases

## Screenshots

> coming soon

## Documentation

### Functional specifications

* [Authentication portal](docs/functional-specifications/auth-portal.md) — Access the login and registration page

* [Login](docs/functional-specifications/login.md) — 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](https://github.com/ericafenyo/bike-diary-api/blob/main/README.md) to configure and run the server locally on your system.

```yml

# ./gradle.properties

API_SERVER_URL=

```

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/

```yml

# ./gradle.properties

MAPBOX_DOWNLOAD_TOKEN=

MAPBOX_PUBLIC_TOKEN=

```

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

```yml

# ./gradle.properties

SENTRY_DNS=

```

> Note: replace `` 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](LICENSE) file for details.