Table of contents

• About the project
  • Built with
• Getting started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• TODO's
• Contributing
• License
• Contact

About the project

With Road Report, cyclists and pedestrians can easily report problems they encounter on the road. For example, broken bike paths, holes in the road or loose cobblestones.

In this way citizens support the city to discover problems at an early stage, so the city can improve the quality of the walking and cycling paths!

Road Report is a project of TMaaS, built by The Guardians of the Road at Open Summer of Code 2019.

This repo is for the frontend of the project, for the backend go to Road Report Backend

Built with

• React Native
• Expo
• Best Addresses (API for geocoding, autocomplete, ...)

Getting started

Prerequisites

• npm

You will need npm do get the used packages.

• Expo CLI

You will need the Expo CLI to run the app and use certain used features.

npm install -g expo-cli

Installation

1. Clone the repo

git clone https://github.com/oSoc19/RoadReport.git

2. Install the used npm packages

npm install

3. Run the app

You can run it by scanning the QR code with your phone (you need the expo app) or you can run it in a simulator on your computer (you need android studio/Xcode)

Expo start

Usage

Roadmap

• IOS

  • No known bugs

• Android

  • When going into the AddressScreen the loadingscreen immediatly appears and doesn't go away
  • Once tested the app and the phone got hot

TODO's

• UI needs to improve overall, next button placement, etc.
• Screen where you choose the problem needs to be more accessible
• The API sometimes doesn't give the expected result (like in Brussel, Brussel won't get filled in in the city field)
• Address screen needs to be redesigned, UX problems
• Add a screen where you can add multiple pictures, also from your library
• Code needs to get refactored. This code needed to written fast, so there where no custom components used, etc.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

[email protected]

Project link : https://github.com/oSoc19/RoadReport