summaryrefslogtreecommitdiff
path: root/README
blob: 4808b42e3da4115bc828271482cb15541a6de19c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Ick UI README
=============

This is a web user interface for [Ick2][] CI system.

[Ick2]: https://ick.liw.fi

Dependencies
------------

Ick web UI is a [React][] application. Other dependencies include:

* [Babel][]
* [ESLint][]
* [Jest][]
* [webpack][]

To install them, you will need [npm][] (or a compatible package manager) and
[make][]:

    make install

[React]: https://reactjs.org/
[Babel]: https://babeljs.io/
[ESLint]: https://eslint.org/
[Jest]: https://facebook.github.io/jest/
[webpack]: https://webpack.js.org/
[npm]: https://www.npmjs.com/
[make]: https://www.gnu.org/software/make/

Usage
-----

To start development server run:

    make run

And point your browser to `http://localhost:3000/`.

Development
-----------

FIXME

License
-------

Ick UI in its entirety is copyright by its authors, and released under the GNU
General Public License v3.0 or later.

    Ick UI - a web UI for Ick2
    Copyright (C) 2018 Ivan Dolgov

    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 <http://www.gnu.org/licenses/>.