Skip to content

Commit 38fec78

Browse files
committed
chore: adding a dockerfile for the integration tests
1 parent 9564434 commit 38fec78

File tree

3 files changed

+92
-0
lines changed

3 files changed

+92
-0
lines changed

Dockerfile

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
FROM node:11.5.0
2+
MAINTAINER Jason Shin <[email protected]>
3+
4+
# System Deps
5+
RUN apt-get update -y
6+
RUN apt-get install tmux -y
7+
RUN apt-get clean
8+
9+
ENV CORE /home/node/app
10+
RUN mkdir $CORE
11+
RUN echo $CORE
12+
WORKDIR $CORE
13+
14+
RUN git init
15+
# Install baseline cache
16+
COPY ./package.json $CORE
17+
COPY ./yarn.lock $CORE
18+
RUN yarn
19+
20+
RUN yarn global add typescript
21+
22+
# Finally add remaining project source code to the docker container
23+
ADD . $CORE
24+
25+
CMD ["yarn", "start"]

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Kalimdor.js
2+
3+
Kalimdor.js is a Machine Learning library written in Typescript. It solves Machine Learning problems
4+
and teaches users how Machine Learning algorithms work.
5+
6+
[![Build status](https://ci.appveyor.com/api/projects/status/0e70aia5vi2h35hs/branch/master?svg=true)](https://ci.appveyor.com/project/JasonShin/kalimdorjs/branch/master)
7+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FJasonShin%2Fkalimdorjs.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FJasonShin%2Fkalimdorjs?ref=badge_shield)
8+
[![Slack](https://slack.bri.im/badge.svg)](https://slack.bri.im)
9+
10+
<img src="https://i.imgur.com/CpZA2U7.png">
11+
12+
# User Installation
13+
14+
Using yarn
15+
16+
```bash
17+
$ yarn add machinelearn-node
18+
```
19+
20+
Using NPM
21+
22+
```bash
23+
$ npm install --save machinelearn-node
24+
```
25+
26+
Then you should require the package in your project
27+
28+
```javascript
29+
require('machinelearn-node');
30+
```
31+
32+
# Accelerations
33+
34+
By default, machinelearning.js will use pure Javascript version of tfjs. To enable acceleration
35+
through C++ binding or GPU, you must
36+
37+
# Highlights
38+
39+
- Machine Learning on the browser and Node.js
40+
- Learning APIs for users
41+
- Low entry barrier
42+
43+
# Development
44+
45+
We welcome new contributors of all level of experience. The development guide will be added
46+
to assist new contributors to easily join the project.
47+
48+
- You want to participate in a Machine Learning project, which will boost your Machine Learning skills and knowledge
49+
- Looking to be part of a growing community
50+
- You want to learn Machine Learning
51+
- You like Typescript :heart: Machine Learning
52+
53+
# Testing
54+
55+
Testing ensures you that you are currently using the most stable version of Kalimdor.js
56+
57+
```bash
58+
$ npm run test
59+
```
60+
61+
# Supporting
62+
63+
Simply give us a :star2: by clicking on <img width="45" src="https://i.imgur.com/JEOaKBk.png">
64+
65+
# Contributing
66+
67+
We simply follow "fork-and-pull" workflow of Github. Please read CONTRIBUTING.md for more detail.

test/require.test.ts

Whitespace-only changes.

0 commit comments

Comments
 (0)