> For the complete documentation index, see [llms.txt](https://spring.js.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spring.js.org/startup.md).

# Startup

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

## Options

* [Name](/startup.md#name)
* [Port](/startup.md#port)
* [Log](/startup.md#log)
* [Mongo](/startup.md#mongo)
* [Routes](/startup.md#routes)
* [Views directory](/startup.md#views-directory)
* [Public directory](/startup.md#public-directory)

### Name

* Kind: String
* Example: name: "test"
* Description: This will be used just for logging purposes

```javascript
new SpringJS({ name: "test" });
```

### Port

* Kind: Integer (0-65536)
* Example: port: 8080
* Description: What port to run the web server on

```javascript
new SpringJS({
  name: "test",
  port: 8080
});
```

{% hint style="info" %}
We suggest port 8080 for development but you are free to use any port number between 0 and 65536
{% endhint %}

### Log

* Kind: Boolean
* Example: log: true
* Description: Whether or not to log requests to the console

```javascript
new SpringJS({
  name: "test",
  port: 8080,
  log: true
});
```

{% hint style="success" %}
Logging will show path of request, speed and status code sent
{% endhint %}

### Mongo

* Kind: String
* Example: mongo: "mongodb://localhost:27017/"
* Description: Mongo server to connect to your database

```javascript
new SpringJS({
  name: "test",
  port: 8080,
  log: true,
  mongo: "mongodb://localhost:27017/"
});
```

{% hint style="warning" %}
We use enmap and enmap-mongo for connecting and using your mongo database both of which work but are no longer supported.
{% endhint %}

### Routes

* Kind: Array
* Example: routes: \[{ url:'/', router: require('./api.js') }]
* Description: For assigning routes to your application.

```javascript
new SpringJS({
  name: "test",
  port: 8080,
  log: true,
  routes: [
    {
     url:'/api',
     router: require('./api.js')
    },
    {
     url:'/api2',
     router: require('./api2.js')
    }
  ],
  mongo: "mongodb://localhost:27017/"
});
```

### Views Directory

* Kind: String
* Example: viewsDir: "./test/views"
* Description: The views directory

```javascript
new SpringJS({
  name: "test",
  port: 8080,
  log: true,
  mongo: "mongodb://localhost:27017/",
  viewsDir: "./test/views"
});
```

{% hint style="info" %}
We recommend this option only if you are setting a view engine like ejs or pug
{% endhint %}

### Public Directory

* Kind: String
* Example: publicDir: "./test/views"
* Description: The public directory for express

```javascript
new SpringJS({
  name: "test",
  port: 8080,
  log: true,
  mongo: "mongodb://localhost:27017/",
  viewsDir: "./test/views",
  publicDir: "./test/public"
});
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://spring.js.org/startup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.