Kroftig - Frontend

Kroftig ('git fork' backwards) is a web-based tool for auditing multiple related git repositories. This repository holds the front end, which is written using React and Relay. The back end is here.

Development of Kroftig is suspended, for two reasons:

The original project for which I planned to use Kroftig ceased to have value, and
Graphene, the Python GraphQL framework upon which the Kroftig backend is built, is not mature enough for anything but very straightforward use. When I return to this project, if Graphene hasn't matured, I will re-write the backend using Node.js and express-graphql.

At its present stage of development, Kroftig presents a React-based single-page application in the browser, with which one may browse git repositories on the backend server in much the same way as GitHub. As such, it may be an valuable base for custom web-based git tools.

Installation

$ git clone https://github.com/smbolton/kroftig-frontend.git
$ cd kroftig-frontend
$ npm install
$ npm start

That last command will start the development server, and open a browser window which will load the app from:

http://localhost:3000/

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

smbolton / kroftig-frontend Goto Github PK