Skip to content

JoeFerri/algorithms

Repository files navigation

License: LGPL v3 GitHub issues Contributor Covenant

Project status: DESIGN

Algorithms

Study of algorithms.


Index

How to get started

Dependencies

see package.json file for versions:

testing

@types/chai
@types/mocha
chai
mocha
nyc
chalk
cross-env

compilation

npm-run-all
del-cli
ts-node
typescript

How to install

$ git clone https://github.com/JoeFerri/algorithms
$ cd ../path/to/the/file
$ npm i -D del-cli
$ npm i -D npm-run-all
$ npm i -D typescript
$ npm start

install dependencies for testing

$ cd ../path/to/the/file
$ npm i -D chai mocha nyc ts-node typescript
$ npm i -D @types/chai @types/mocha
$ npm i -D @types/node
$ npm i -D chalk
$ npm i -D cross-env

start the tests

$ npm t

start test coverage

$ npm run coverage

Documentation

For the documentation see the notes inside the source code or wiki page

Structure of the project

under development

files hierarchy

under development

Community

none

Code of conduct

ENG

ITA

examples

under development

License

General license

GNU Lesser General Public License v3.0 only

Copyright (C) 2021 Giuseppe Ferri

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

About

Study of algorithms.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published