View on GitHub

gitlab-roadmap

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

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

Slower Start (AWS Lambda)

If you want to deploy to AWS Lambda, follow the steps below:

Clone the repository

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

Install the dependencies

$ npm install

Copy config.example.yml to config.yml and edit it to your liking

$ cp config.example.yml config.yml

Setup the domain (see here for more instructions)

$ npx sls create_domain

And finally, deploy

$ npx sls 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/Filiosoft/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

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

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

License

MIT