Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yadamvinay369/securinserver

This is the server side project for Securin CVE dashboard
https://github.com/yadamvinay369/securinserver

api-rest cors expressjs mongoose nodejs

Last synced: 6 days ago
JSON representation

This is the server side project for Securin CVE dashboard

Host: GitHub
URL: https://github.com/yadamvinay369/securinserver
Owner: YadamVinay369
Created: 2024-12-17T13:31:45.000Z (7 days ago)
Default Branch: main
Last Pushed: 2024-12-17T14:36:33.000Z (6 days ago)
Last Synced: 2024-12-17T15:38:14.351Z (6 days ago)
Topics: api-rest, cors, expressjs, mongoose, nodejs
Language: JavaScript
Homepage: https://securinserver.onrender.com
Size: 4.88 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Securin CVE server

This is the backend for the Securin CVE Dashboard, built with Node.js and Express.js. It provides APIs to fetch, store, and manage CVE (Common Vulnerabilities and Exposures) data.

My deployed link: https://securinserver.onrender.com/

## Salient Features

- RESTful APIs to fetch CVE data.
- Pagination support for large datasets.
- Customizable results per page.
- Data storage using MongoDB.
- Environment variable support for secure configurations

## Tech Stack

- Node.js - JavaScript runtime.
- Express.js - Web framework for Node.js.
- MongoDB - NoSQL database.
- Mongoose - ODM for MongoDB.
- dotenv - Environment variable management.
- Jest - JavaScript testing framework.

## Install Packages and Run the App

- Clone the repository

```bash
git clone https://github.com/YadamVinay369/SecurinServer.git
```

- Install dependencies

```bash
npm install
```

- Create a `.env` file in the root directory.
- Add the following configuration:

```bash
PORT=8000
MONGODB_URI=your_mongodb_connection_string
CVE_API_URL=https://api.example.com/cve
```

- Run the server

```bash
npm start
```

- Or for development:

```bash
npm run dev
```

- Server will run at: http://localhost:8000

## API Reference

#### Get all items

```http
GET /api/cve
```

![Screenshot of getCVE postman ](./screenshots/getCVE.png)

#### Get all items with page and limit

```http
GET /api/cve?page=1&limit=10
```

![Screenshot of getCVEbyPageAndLimit postman ](./screenshots/getCVEbyPageAndLimit.png)

#### Get CVE based on `id`

```http
GET /api/cve/:id
```

| Parameter | Type | Description |
| :-------- | :------- | :------------------------------- |
| `id` | `string` | **Required**. Id of CVE to fetch |

![Screenshot of getCVEbyID postman ](./screenshots/getCVEbyID.png)

#### Get item based on published `year`

```http
GET /api/cve/year/:year
```

![Screenshot of getCVEbyYear postman ](./screenshots/getCVEbyYear.png)

#### Get item based on `baseScore`

```http
GET /api/cve/score/:score
```

![Screenshot of getCVEbyBaseScore postman ](./screenshots/getCVEbyBaseScore.png)

#### Get item based on `range`

```http
GET /api/cve/lastModified/:range
```

![Screenshot of getCVEbyBaseScore postman ](./screenshots/getCVEbyRange.png)

## Running Tests

- Install Jest (if not already installed):

```bash
npm install jest --save-dev
```

- Run the tests:

```bash
npm test
```

- Tests are located in the `__tests__` folder, including:

- Unit tests for `cveController` logic.
- Example: `__tests__/cveController.test.js`

## Dependencies

- express: Fast and minimal web framework.
- mongoose: MongoDB object modeling.
- dotenv: Load environment variables.
- axios: For external API requests.
- jest: JavaScript testing framework for unit testing.