📢 Create a product roadmap website with GitLab Issue Boards as a backend!
Clone or download
Latest commit 78d4d5f Jan 9, 2019

README.md

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

Development Setup

Want to contribute? Awesome! First checkout the contribution guidelines 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.

<div id="glrm-widget"></div>
<script>
(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" });
</script>

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use semantic-release for versioning. Every commit to master will generate a release. For the versions available, see the releases on the repositories.

Credits

  • Noah Prail - Project Lead - @nprail

See also the list of contributors who participated in this project.

License

MIT