Giter Club home page Giter Club logo

the-captain-api's Introduction

The Captain API

This is the captain (or “myth") API. It contains simple endpoints for quick use on your basic projects.

Endpoints

The following routes are accessible at the moment, all living under /v1:

  • /captain/adjectives/, return one random Mariliz Pereira Jorge's adjective about The Captain.
  • /captain/adjectives/all, return the full list of adjectives.

For example, to get a single adjective you may access the heroku (free!) deploy at https://powerful-waters-90294.herokuapp.com/v1/captain/adjectives

Developing

Run it Locally

The Captain API is a Node.js app using Express 4. Make sure you have Node.js and the Heroku CLI installed to run it locally.

$ git clone https://github.com/tiagovignatti/the-captain-api # or clone your own fork
$ cd the-captain-api
$ npm install
$ npm start # or heroku local web

Your app should now be running on localhost:5000.

Deploying to Heroku

$ heroku create
$ git push heroku main
$ heroku open

License

MIT license © Tiago Vignatti

the-captain-api's People

Contributors

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