geo-api

Geo Api

The geo api is used to handle the addition of gps tracks coming from our mobile app but also for the deletion of any user data (either coming from the website or the mobile app).
Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Built With

• C#
• Entity Framework Core

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

For this project to run you need .NET Core 3.1 installed on your computer you can follow this link to download it (Windows, Linux, macOS

Installation

1. Clone the repo

git clone https://github.com/bikedataproject/geo-api.git

2. Restore the package.

As we are using a homemade NuGet package, create a nuget.config file in the local root folder of your freshly cloned repository Paste the following in the file, replace GitHubUsername with your own GitHub username and AccessPassword with a GitHub Token tutorial to get the informations needed in the file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear />
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
        <add key="github" value="https://nuget.pkg.github.com/bikedataproject/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="GitHubUsername" />
            <add key="ClearTextPassword" value="AccessPassword" />
        </github>
    </packageSourceCredentials>
</configuration>

3. Restore the dependencies

In the project folder (./src/BikeDataProject.API/), use the following command:

dotnet restore

4. Launch the project

You can launch the project by typing the following command in the project folder (./src/BikeDataProject.API/):

dotnet run

Usage

This API is used to store gps tracks that comes from our mobile application but also to delete data from users (those who linked their Strava account with our service, those who donated their data via .GPX/.FIT files or those who used our mobile application).

Roadmap

See the open issues for a list of proposed features (and known issues).

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/MyFeature)
3. Commit your Changes (git commit -m 'Add some great feature')
4. Push to the Branch (git push origin feature/MyFeature)
5. Open a Pull Request with the develop branch as its target.

To know more about how to contribute to this project please refer to the CONTRIBUTING.md file.

License

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

Contact

Bike Data Project - @bikedataproject - [email protected] / [email protected]

Project Link: https://github.com/bikedataproject/geo-api