# Welcome

![](https://491712002-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LmQsTbnN_53C2m6WT2s%2F-LmUw9Kj6aJKP6MJtOxY%2F-LmUwB8dzp_4dQiMU8As%2Fbanner.png?alt=media\&token=170eb37e-10c4-450e-8a25-6d70dab14c09)

![](https://circleci.com/gh/dan-online/spring.js.svg?style=svg\&circle-token=f474a522a9749f7c41056ba4c2f1044cc3f65bf3) ![](https://img.shields.io/badge/dependencies-up%20to%20date-lime.svg) ![](https://api.codacy.com/project/badge/Grade/d6edf679d05f4da183d94b9ffcfc5dff)

![](https://api.travis-ci.org/dan-online/spring.js.svg?branch=master) [![Actions Status](https://github.com/dan-online/spring.js/workflows/GitCI/badge.svg)](https://github.com/dan-online/spring.js/actions)

## Features

* Mongo Database
* Express connection
* Production ready
* Session
* Helmet
* Trust proxy
* Logging
* Body parsing
* Cookie parsing
* CLI
* Optimised

## Install

```bash
$ npm install -g --save js-spring
```

## Basic Use

```javascript
const SpringJS = require("js-spring");
const { app, database } = new SpringJS({ name: "test" });
```

## Documentation

* [Startup](https://spring.js.org/startup)
  * [Options](https://spring.js.org/startup#options)
  * [Name](https://spring.js.org/startup#name)
  * [Port](https://spring.js.org/startup#port)
  * [Log](https://spring.js.org/startup#log)
  * [Mongo](https://spring.js.org/startup#mongo)
  * [Views directory](https://spring.js.org/startup#views-directory)
  * [Public directory](https://spring.js.org/startup#public-directory)
* [Express](https://spring.js.org/express)
* [Database](https://spring.js.org/database)

## License

(The MIT License)

Copyright (c) 2019 DanCodes <dan@dancodes.online>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://spring.js.org/undefined.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.