Coder Social home page Coder Social logo

swingheil-rest-api's Introduction

SwingHeil Logo

swingheil-rest-api

The swingheil-rest-api is a RESTful API server for the SwingHeil Andoird app (swingheil-android-app) and iOS app (swingheil-ios-app). It provides swing dance related Info in JSON format. It requires swingheil-service library.

Check the API Server running on Heroku https://swingheil-rest.herokuapp.com. It may take a few minutes to start up the server, because it uses free tier of Heroku.

SwingHeil App Banner

Table of content

Installation

The SwingHeil REST API project requires swingheil-service project.

DB setup

SwingHeil uses Heroku as PaaS, add JawsDB MySQL add-ons. It uses the same DB with Web Server for Admin.

Set Config Vars

Heroku Dashboard > Settings > Config Vars

  • JAVA_OPTS : -Dspring.profiles.active=dev
  • SWINGHEIL_DB_CONNECTION_STRING : jdbc:log4jdbc:mysql://DOMAIN_FROM_JAWSDB:3306/DATABASE_NAME_FROM_JAWSDB?verifyServerCertificate=false&useSSL=false&requireSSL=false
  • SWINGHEIL_DB_USERNAME : the username from JawsDB Dashboard
  • SWINGHEIL_DB_PASSWORD : the password from JawsDB Dashboard

Upload to Heroku

Heroku Dashboard > Deploy > App connected to Github : connect the github project.

Manual deploy : push the Deploy Branch button

Technology

  • Spring Boot, JPA, Java 8, Java EE, Hibernate, gradle, yml, Heroku, MySQL

Development RoadMap

  • initial setup springboot project
  • setup MySQL DB
  • add event CRUD RESTFul API
  • upload RESTFul API server to Heroku
  • add Swagger UI for API Documentation
  • add member feature
  • add login feature
  • add security feature

License

The swingheil-rest-api is licensed under the terms of the GPL Open Source license and is available for free.

Links

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.