funkyOne / facts

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Facts

This projects tries to solve common issue with documentations. It turns your issue tracker into project documentation.

It requires you to rethink the way you create issues. Instead of "this button should save currently opened document " you write it as already implemented fact - "the save button saves currently opened document".

Also documentation starts to reflect current state of the application. So it's becomes visible what part of the app is done and working, what are in progress, what is broken.

How to run

Install dependecies

From client and server folders

npm install

Compile client app

From client folder

gulp default

Start database server

On Windows with default mongo installation

    C:\mongodb\bin\mongod.exe --dbpath C:\mongodb\bin\data

Start web server

From server folder

npm start

Oper app URL

Default development URL is http://localhost:3000/

License

Facts is Apache licensed.

About

License:Apache License 2.0


Languages

Language:CSS 57.3%Language:JavaScript 21.0%Language:HTML 9.5%Language:C# 8.6%Language:PLpgSQL 3.5%Language:SQLPL 0.1%