<commit_before># swagger-portal-server
A portal that allows CRUD operations to upload swagger documentation.

## Installation
This project requires node to be installed, view the [official Node Installation Guide](https://nodejs.org/en/download/), for how to install Node.

Run the following command to install all npm packages

```
npm install && npm install --only=dev
```

## Available Commands

* `npm start`: Starts the server using nodemon (dev only)
* `npm run build`: Starts the server using babel-node
* `npm run test`: Run through Jest spec tests
* `npm run lint`: Run through Eslint requirements (required for pull request)
* `npm run coverage`: Run trough Jest coverage tests
<commit_msg>docs: updated readme with swagger information<commit_after># swagger-portal-server
A portal that allows CRUD operations to upload swagger documentation.

## Installation
This project requires node to be installed, view the [official Node Installation Guide](https://nodejs.org/en/download/), for how to install Node.

Run the following command to install all npm packages

```
npm install && npm install --only=dev
```

## Available Commands

* `npm start`: Starts the server using nodemon (dev only)
* `npm run build`: Starts the server using babel-node
* `npm run test`: Run through Jest spec tests
* `npm run lint`: Run through Eslint requirements (required for pull request)
* `npm run coverage`: Run trough Jest coverage tests

## View API documentation
This server comes with a defined API specification (yes, you can upload the swagger for the api documentation portal to the api documentation portal).

[View the API Documentation](https://rebilly.github.io/ReDoc/?url=https://raw.githubusercontent.com/joshferrell/swagger-portal-server/master/documentation/swagger.yaml)

{'fraction_non_alphanumeric': 0.08707865168539326, 'fraction_numerical': 0.0, 'mean_word_length': 4.9966329966329965, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1906143', 'n_tokens_mistral': 501, 'n_tokens_neox': 466, 'n_words': 218}