Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/murraco/paint-shop-problem-ts
Solution in TypeScript for the paint shop problem
https://github.com/murraco/paint-shop-problem-ts
coding-challenge mocha node paint-shop-problem typescript
Last synced: 18 days ago
JSON representation
Solution in TypeScript for the paint shop problem
- Host: GitHub
- URL: https://github.com/murraco/paint-shop-problem-ts
- Owner: murraco
- License: mit
- Created: 2019-01-12T22:20:13.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T20:43:47.000Z (about 2 months ago)
- Last Synced: 2024-12-10T21:33:41.360Z (about 2 months ago)
- Topics: coding-challenge, mocha, node, paint-shop-problem, typescript
- Language: TypeScript
- Homepage:
- Size: 760 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Paint Shop Problem TS
# Stack
***
Please help this repo with a ⭐ or Sponsor Me if you find it useful! :blush:
***
# File structure
```
paint-shop-problem-ts/
│
├── examples/
│ └── *.txt * Input/output examples
│
├── src/
│ ├── components/
│ │ ├── parser.ts
│ │ ├── solver.ts
│ │ └── utils.ts
│ │
│ ├── models/
│ │ ├── preference.ts
│ │ └── request.ts
│ │
│ └── index.ts * Entry point of our Node's app
│
├── test/
│ ├── components/
│ │ ├── parser.test.ts
│ │ ├── solver.test.ts
│ │ └── utils.test.ts
│ │
│ ├── models/
│ │ ├── preference.test.ts
│ │ └── request.test.ts
│ │
│ └── index.test.ts
│
├── .gitignore * Git ignore file for Node
├── LICENSE * MIT License
├── package-lock.json * Defines our exact JavaScript dependencies tree
├── package.json * Defines our JavaScript dependencies
├── README.md * This file
├── tsconfig.json * Specifies the root files and the compiler options required to compile the project
├── tslint.json * Configures which rules get run and each of their options
└── yarn.lock * Stores exactly which versions of each dependency were installed
```
# Introduction
You can find a description of the problem in [this](https://github.com/murraco/paint-shop-problem-ts/blob/master/PAINT-SHOP-PROBLEM.md) link.
## How to use this code?
1. Make sure you have [Node.js](https://nodejs.org/en/) v8+ installed
```
$ sudo npm cache clean -f
$ sudo npm install -g n
$ sudo n stable
```
> NOTE: I recommend you to use [nvm](https://github.com/creationix/nvm) for managing multiple node versions
2. Clone this repository
```
$ git clone https://github.com/murraco/paint-shop-problem-ts
```
3. Navigate into the folder
```
$ cd paint-shop-problem-ts
```
4. Install NPM dependencies
```
$ npm install
```
7. Build the project
```
$ node run build
```
8. Run the `index.js` file inside the just generated `build` folder and use stdin to specify the path to a file with a set of customer requirements (look at the examples folder)
```
$ node build/index < path_to_file
```
## Test
After installing the dependencies, run the following command in order to execute the tests:
```
$ npm run test
```
# Contribution
- Report issues
- Open pull request with improvements
- Spread the word
- Reach out to me directly at