An open API service indexing awesome lists of open source software.

https://github.com/eventonehq/gitlab-roadmap

📢 Create a product roadmap website with GitLab Issue Boards as a backend!
https://github.com/eventonehq/gitlab-roadmap

gitlab gitlab-roadmap issue-board product-roadmap roadmap

Last synced: 23 days ago
JSON representation

📢 Create a product roadmap website with GitLab Issue Boards as a backend!

Awesome Lists containing this project

README

        

GitLab Roadmap


GitHub license
Build Status
Commitizen friendly
JavaScript Style Guide
semantic-release


📢 Create a product roadmap website with GitLab Issue Boards as a backend!

## Setup

### Quick Start (Heroku)

Click the button below to deploy on Heroku!

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/eventOneHQ/gitlab-roadmap)

### Development Setup

Want to contribute? Awesome! First checkout the [contribution guidelines](#contributing) then follow these steps to get setup.

Clone the repository

```
$ git clone https://github.com/eventOneHQ/gitlab-roadmap
```

Install the dependencies

```
$ npm install
```

Copy `example.env` to `.env` and edit it to your liking

```
$ cp example.env .env
```

Start the dev server

```
$ npm run dev
```

## Embed
Replace `localhost:3000` with your URL.
```html

(function (w,d,s,o,f,js,fjs) {
w['GLRM_Widget']=o;w[o] = w[o] || function () { (w[o].q = w[o].q || []).push(arguments) };
js = d.createElement(s), fjs = d.getElementsByTagName(s)[0];
js.id = o; js.src = f; js.async = 1; fjs.parentNode.insertBefore(js, fjs);
}(window, document, 'script', 'glrm', '//localhost:3000/widget.js'));
glrm("init", { widgetRef: "glrm-widget" });

```

## Contributing

Please read [CONTRIBUTING.md](https://github.com/eventOneHQ/gitlab-roadmap/blob/develop/CONTRIBUTING.md) for details on our [code of conduct](https://github.com/eventOneHQ/gitlab-roadmap/blob/develop/CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.

## Versioning

We use [semantic-release](https://github.com/semantic-release/semantic-release) for versioning. Every commit to `master` will generate a release. For the versions available, see the [releases on the repositories](https://github.com/eventOneHQ/gitlab-roadmap/releases).

## Credits

- **Noah Prail** - _Project Lead_ - [@nprail](https://github.com/nprail)

See also the list of [contributors](https://github.com/eventOneHQ/gitlab-roadmap/contributors) who participated in this project.

## License

[MIT](https://github.com/eventOneHQ/gitlab-roadmap/blob/develop/LICENSE)