Issueage

Generate Website/Github Pages with Github Issues.

Live Demo

https://zeikar.github.io/issueage/

How to use

Create new Issueage based repository

Use this template

Create repository from this template. docs

vi config.json

Configure your config.json and commit it.

git add config.json
git commit -m "Apply Issueage"
git push origin master

And set Source to gh-pages in Github Pages settings. docs

Then you can access your Github Pages!

Add Issueage to existing repository

Add Issueage to your repository.

git remote add issueage https://github.com/zeikar/issueage
git fetch issueage
git checkout -f -b issueage issueage/master
vi config.json

Configure your config.json and commit it.

git add config.json
git commit -m "Apply Issueage"
git push origin issueage

And set Source to gh-pages in Github Pages settings. docs

Then you can access your Github Pages!

Build and run locally

Run in development mode

Install the dependencies

npm install
npm run dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Sites using Issueage

• https://zeikar.github.io/
• and many more...

License

Distributed under the MIT License. See LICENSE for more information.