README

API Project Manager Dashboard

Dashboard plugin for project related data.
Report Bug · Request Feature

Table of Contents
About API Project Manager Dashboard
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Deploy
Roadmap
Contributing
License
Acknowledgements

About API Project Manager Dashboard

Here's a blank template to get started:

Built With

PHP
NPM
Webpack
Modularity

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them (mac os).

composer

brew install composer

brew install node

Installation

Clone the repo

git clone https://github.com/helsingborg-stad/api-project-manager-dashboard.git

Install and build NPM packages

npm install && npm run build

Install composer packages

composer install

Usage

Mount App.tsx on your page, providing configuation on host page like

      <div data-dashboard-api-endpoint="https://beta.api.helsingborg.se/innovation/wp-json/wp/v2/project"></div>
      <div data-dashboard-content-endpoint="https://innovation.hbgtest.se/initiativ"></div>

Deploy

Instructions for deploys.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License.

Acknowledgements

othneildrew Best README Template

helsingborg-stad / api-project-manager-dashboard

Maintainers

Details