Skip to content

Commit 5756edf

Browse files
committed
2 parents 599a296 + dbe6513 commit 5756edf

File tree

25 files changed

+322
-62
lines changed

25 files changed

+322
-62
lines changed

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules/

LICENCE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) [2020] [Dnotebook]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,49 @@
1-
# notebookjs
2-
A Jupyter-like notebook for javaScript environment
1+
2+
<div align="center">
3+
<img src="dnotebook/src/public/images/dnotebook.png"><br>
4+
</div>
5+
6+
-----------------
7+
8+
**Dnotebooks** is a Jupyter-like library for javaScript environment. It allows you to create and share pages that contain live code, text and visualizations in a textbook-like manner.
9+
10+
## What can it be used for?
11+
Dnotebooks helps you to:
12+
- Easily perform interactive data exploration and analysis using efficient JavaScript packages like Danfo.js.
13+
- Easily build, train and prototype machine learning models using different tools like Tensorflow.js
14+
- Learn JavaScript in an interactive/visual style. This can hasten learning and understanding.
15+
- Plain Experimentation/Prototyping. Any experimentation performed in JavaScript can run on Dnotebooks.
16+
17+
18+
## How to install
19+
Dnotebook is hosted on NPM, and can installed via package managers like npm and yarn
20+
21+
```sh
22+
npm install dnotebook
23+
```
24+
25+
### Example usage in the browser
26+
After installing dnotebook, you can start the server by running the command `dnotebook` in the terminal. This opens a new notebook in your default browser.
27+
28+
```sh
29+
dnotebook
30+
```
31+
32+
![](assets/node-rec.gif)
33+
34+
35+
#### [See the Official Getting Started Guide](https://dnotebook.jsdata.org/getting-started)
36+
37+
<!-- ## Documentation
38+
The official documentation can be found [here](https://danfo.jsdata.org) -->
39+
40+
## Discussion and Development
41+
Development discussions take place on our [issues](https://github.com/opensource9ja/dnotebook/issues) tab.
42+
43+
## Contributing to Dnotebook
44+
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
45+
46+
#### Licence [MIT](https://github.com/opensource9ja/dnotebook/blob/master/LICENCE)
47+
48+
#### Created by [Rising Odegua](https://github.com/risenW) and [Stephen Oni](https://github.com/steveoni)
49+
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ var path = require('path');
44
var cookieParser = require('cookie-parser');
55
var logger = require('morgan');
66

7-
var indexRouter = require('./routes/index');
8-
97
var app = express();
108

119
// view engine setup
File renamed without changes.

notebookjs/src/public/javascripts/addons/closebrackets.js renamed to dnotebook/src/public/javascripts/addons/closebrackets.js

File renamed without changes.

0 commit comments

Comments
 (0)