# brocoli

> **Brocoli is a REST API template based on the Express framework.**

Latest version **1.1.3** (published 2017-04-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install brocoli
pnpm add brocoli
yarn add brocoli
bun add brocoli
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2017-04-14 |
| First published | 2017-04-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | cbinet |

## Links

- npm: https://www.npmjs.com/package/brocoli
- npm.io page: https://npm.io/package/brocoli

## Dependencies (1)

- [express](https://npm.io/package/express.md) ^4.15.2

## Recent versions

- 1.1.3 (latest) — 2017-04-14
- 1.1.2 — 2017-04-14
- 1.1.1 — 2017-04-14
- 1.1.0 — 2017-04-14
- 1.0.3 — 2017-04-14
- 1.0.2 — 2017-04-14
- 1.0.1 — 2017-04-14
- 1.0.0 — 2017-04-14

## README

# Brocoli - REST API Template
**Brocoli is a REST API template based on the Express framework.**

## Setup

### Install with git

Clone the repository
```sh
git clone https://github.com/CBinet/Brocoli.git
```

Install dependencies
```sh
npm install
```

Launch the application
```sh
npm start
```

### Install with npm

Download the npm module
```sh
npm install brocoli
```
Extract the brocoli module into the current folder then :
Launch the application
```sh
npm start
```

## Using Brocoli

Once the server is started, you can access it at http://localhost:8000/. <br>
If the server is running, you should get the following message :
```sh
Brocoli is alive :)
```

## Adding routes example

If you want to add another route, simply add this block of code in your *server.py* file :
```javascript
// ...
app.get('/new-route', function (req, res) {
  res.send('I am the new route.');
});
```
To do a **POST**, **PUT**, **DELETE**, **etc**, simply change *app.get* for the desired option.

---
_Source: https://npm.io/package/brocoli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._