Code Monkey home page Code Monkey logo

falling-fruit-api's Introduction

Status

Falling Fruit API

NodeJS API using express, pg-promise, and bluebird. The code structure is inspired by this pg-promise demo and this more general tutorial.

You can browse the OpenAPI definition for the main branch here, and for the live API here.

Status

Live at https://fallingfruit.org/api/0.3. Used by https://fallingfruit.org (falling-fruit) and extensively by https://beta.fallingfruit.org (falling-fruit-web).

Layout

  • index.js: Define routes and generic handlers. Start server.
  • helpers.js: Define helper functions.
  • db/
    • index.js: Define database connection. Load pg-promise with repos:
    • repos/
      • index.js: Compile all classes:
      • {class}.js: Class definition with methods.
    • sql/
      • index.js: Load all SQL query files:
      • {class}/
        • *.sql: Raw SQL with variable substitutions.

Development

Installation

  1. Install Node JS
  2. Install Yarn
  3. Clone this repo, cd into the directory, and install node modules:
git clone https://github.com/falling-fruit/api.git
cd api
yarn
  1. Copy .env.example to .env and update the values as needed.
cp .env.example .env

Usage

  1. Run yarn start
  2. Visit http://localhost:3300

falling-fruit-api's People

Contributors

ezwelty avatar dependabot[bot] 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.