Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myat-hsu-mon/GuardRails-FullStack-Engineer-Challenge
Application security scanning results challenge
https://github.com/myat-hsu-mon/GuardRails-FullStack-Engineer-Challenge
Last synced: 8 days ago
JSON representation
Application security scanning results challenge
- Host: GitHub
- URL: https://github.com/myat-hsu-mon/GuardRails-FullStack-Engineer-Challenge
- Owner: myat-hsu-mon
- Created: 2022-08-26T07:34:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-26T17:16:51.000Z (about 2 years ago)
- Last Synced: 2024-08-01T21:58:23.288Z (4 months ago)
- Language: TypeScript
- Size: 466 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Security Scanning Challenge
This projects aims for adding and checking security scanning results.
## Folder Structure
- [api]()
- [dashboard]()
- [docker-compose.yml]()
- [README.md]()
## To run server:
Please do the following instructions for node.js application.
- cd api
- npm install
- npm run start ( To run )
- npm run build ( To build )
- npm run test ( To test )
## API Reference
#### Get all scanning results
```http
GET /api/v1/results
```
#### Post a new scanning result
```http
POST /api/v1/results
```
#### Get scanning result
```http
GET /api/v1/results/${id}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `id` | `string` | **Required**. Id of item to fetch |
#### Update result
```http
PUT /api/v1/results/${id}
```
| Parameter | Type | Description |
| :-------- | :------- | :--------------------------------- |
| `id` | `string` | **Required**. Id of item to update |
#### Delete result
```http
DELETE /api/v1/results/${id}
```
| Parameter | Type | Description |
| :-------- | :------- | :--------------------------------- |
| `id` | `string` | **Required**. Id of item to delete |
## To Run Client
Please do the following instructions for react.js application.
- cd dashboard
- npm install
- npm start ( To run )
- npm run build ( To build )
- npm run test ( To test )
## Run Locally
Clone the project
```bash
git clone https://github.com/myat-hsu-mon/monorepo
```
Go to the project directory
```bash
cd monorepo
```
Run the docker-compose file
```bash
docker-compose up
```
Start the server on your browser
```bash
http://localhost:3000
```