Giter Club home page Giter Club logo

clojure-simple-api's Introduction

clojure-simple-api

Build Status Coverage Status Dependencies Status

This application is a simple demonstration api used for an ippon-article about Clojure. It demonstrates usage of compojure, ring, cheshire, mock, schema ...

Prerequisites

You will need Leiningen 2.0.0 or above installed. See the dependencies status above for more info on libraries status.

Testing

To launch tests for this application, run :

lein test

To test coverage, the project uses the Cloverage plugin, just launch :

lein cloverage

If you want to launch the linter, use the following command :

lein eastwood

Running

Before running the server for the first time, don't forget to run the following command :

lein migrate

To start a web server for the application, run:

lein ring server

Then, to access the swagger ui, go to http://localhost:8080/api-docs/

The application resorts to an h2 database for both testing and running, since it is just a demonstration. You don't need to start a database or anything, everything is stored temporarily in the resources/env/db folder.

Packaging

To package this application for production, use the following command :

lein ring uberjar

However do not forget to :

  • Add production paths for resources to project.clj
  • Add a production folder to the project in resources, containing corresponding configuration files

Quick look

License

Apache 2.0 License

clojure-simple-api's People

Contributors

matthieusb 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.