Giter Club home page Giter Club logo

fitnessapi's Introduction

FITNESS API

PHP API used to store health and fitness data. This example code base is currently only set up to handle a single user. A users table with unique API keys will be added in the future.

This API will be used to store fitness data collected from a native Android app. Data will be displayed to the user on the web and within the mobile app.

Technologies Used

PHP, MySQL, Slim Framework, API DOC

SETUP

MySQL Database

Create a database named fitness. Add the following table:

CREATE TABLE `heartrate` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `heartrate` int(11) DEFAULT NULL,
  PRIMARY KEY (`id`)
)

PHP Server

Install composer to project (similar to npm but on a per project basis)

curl -s https://getcomposer.org/installer | php

Get dependencies (similar to npm install)

php composer.phar install

Start local server (similar to npm start)

php -S localhost:8000

Create a config.php file using the config-sample.php as a template. Pass the X-API-KEY header you set in the config.php file with all requests.

Postman Configuration

postman screenshot

API Documentation

Run the following to generate API documentation:

apidoc -i ./ -e apidoc/ -o apidoc/

After running the command, documentation can be found in the apidoc folder.

RESOURCES

fitnessapi's People

Contributors

blackcj avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.