falling-fruit-api

KO | EN

gitlite — search

#javascript #react #ai #llm #android #linux #windows #awesome #vue #awesome-list #pytorch #ios #openai #open-source

falling-fruit-api

(★ 14)

API (v0.3) for Falling Fruit

falling-fruit-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Status](https://img.shields.io/badge/Status-Actively%20developed-darkgreen.svg?style=flat-square)

Falling Fruit API
=================

NodeJS API using [express](https://github.com/expressjs/express), [pg-promise](https://github.com/vitaly-t/pg-promise), and [bluebird](https://github.com/petkaantonov/bluebird). The code structure is inspired by this [pg-promise demo](https://github.com/vitaly-t/pg-promise-demo) and this more general [tutorial](http://mherman.org/blog/2016/03/13/designing-a-restful-api-with-node-and-postgres/#.WgOMrhNSyEI).

You can browse the OpenAPI definition for the main branch [here](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/falling-fruit/api/main/docs/openapi.yml), and for the live API [here](https://petstore.swagger.io/?url=https://fallingfruit.org/api/0.3/openapi.yml).

# Status

Live at https://fallingfruit.org/api/0.3 and powers https://fallingfruit.org ([falling-fruit-web](https://github.com/falling-fruit/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

- Clone the repo and change into the new directory.

```sh
  git clone https://github.com/falling-fruit/falling-fruit-api
  cd falling-fruit-api
  ```

- Install the [`node`](https://nodejs.org) version specified in the `.nvmrc` file. This is easiest using [`nvm`](https://github.com/nvm-sh/nvm#installing-and-updating).

```sh
  nvm install
  nvm use
  ```

- [`yarn`](https://classic.yarnpkg.com/en/docs/install) is already provided (see [`.yarn/releases`](.yarn/releases)). Use it to install dependencies.

```sh
  yarn
  ```

- Copy `.env.example` to `.env` and update the values as needed.

```bash
cp .env.example .env
```

## Usage

```sh
yarn start
```

Visit http://localhost:3300.

## Documentation

Validate and build the OpenAPI documentation:

```sh
yarn validate && yarn build
```

falling-fruit-api

falling-fruit-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

falling-fruit-api

falling-fruit-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README