Merge pull request #265 from CatalystCode/readme-updates

updating readme
This commit is contained in:
Mor Shemesh 2017-08-09 13:41:03 +03:00 коммит произвёл GitHub
Родитель e8bbbc478d 3a938ef6a1
Коммит faf976476d
2 изменённых файлов: 54 добавлений и 2 удалений

Просмотреть файл

@ -30,7 +30,9 @@ yarn start
yarn start:dev
```
1. Open **http://localhost:3000**
Open **http://localhost:3000**
For contribution and code documentation, [follow this link](/docs/README.md).
(For more information on development environment, see https://www.fullstackreact.com/articles/using-create-react-app-with-a-server/)
@ -102,7 +104,6 @@ This project is built using:
The server approach was added using:
* https://www.fullstackreact.com/articles/using-create-react-app-with-a-server/
* https://medium.com/@patriciolpezjuri/using-create-react-app-with-react-router-express-js-8fa658bf892d#.14dex6478
Thinking about integrating with:

51
docs/README.md Normal file
Просмотреть файл

@ -0,0 +1,51 @@
# Ibex Dashboard Development Guide
## Framework
This project is built using [create-react-app](https://github.com/facebookincubator/create-react-app).
The server side appraoch was addopted [through this link](https://www.fullstackreact.com/articles/using-create-react-app-with-a-server/).
* [Creating a new Dashboard Template](dashboard-creation.md)
# Orchestrators
## DataSourceConnector
[DataSourceConnector](../client/src/data-sources/DataSourceConnector.ts) is a class that created and initializes the various data sources.
ElementsConnector
## Plugins
Many of the aspects in this project are extendible. The following are possibilities to donate your own plugins.
# Connection Plugins
## Data Source Plugins
* Constant
* Sample
* Application Insights
* [CosmosDB](./cosmos-db.md)
* [Bot Framework](./bot-framework.md)
* GraphQL
* Azure
## Elements Plugins
* [Area Chart](area.md)
* [Bar Chart](bar.md)
* [Detail View](detail.md)
* [Pie Chart](pie.md)
* [Request Button](requestbutton.md)
* [Scatter Chart](scatter.md)
* [Scorecard](scorecard.md)
* [Split View Panel](splitpanel.md)
* [Table](table.md)
* [Timeline Chart](timeline.md)
## data-formats plugins
# Additional Features
* [Two Modes Elements](two-modes-element.md)
* [Filter Plugins](filter.md)
* [Dialogs](dialog.md)
* Settings [TODO]