Code Monkey home page Code Monkey logo

ganjoorapi-swift's Introduction

Ganjoor API - Swift

Ganjoor.net REST API done in swift

Local Development

Database is needed for local development.

MacOS

You need latest version of Xcode and Install mysql using Homebrew

$ brew install mysql

make sure you are in project directory and start a build

$ swift build

Run

$ ./.build/debug/GanjoorAPI

Generate Xcode project

If you like to build/edit project in xcode you can generate xcode project by using this command

$ swift package generate-xcodeproj

Ubuntu 16.04 LTS

Install swift 3.1 by following getstarted and after install these packages

$ apt -y install clang libicu-dev libcurl4-openssl-dev libssl-dev libmysqlclient-dev

make sure you are in project directory and start a build

$ swift build

Run

$ ./.build/debug/GanjoorAPI

Development Docker

If you just want to run a docker container locally to host the API and the Database for you:

$ docker-compose pull
$ docker-compose up

This might take a while, wait until you see "GanjoorAPI is connected to database" Which means everything went as expected.

Making requests

When server starts you will be provided with an access key which is something like this:

new token with accessLevel developer: TOKENHERE

You should send that token on every request as header parameter like:

Authorization: Barear TOKENHERE

can see the list of acceptable requests here

This software is released under the MIT License.

ganjoorapi-swift's People

Contributors

euwars avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

psyguy

ganjoorapi-swift's Issues

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.