Skip to content

TheGiftsProject/katalog

Repository files navigation

Katalog

The place to manage your passion projects logo

Katalog is a passion-projects and ideas tracking web app. It allows your development team to suggest ideas for side-project, discuss about them, and kickstart them into live projects.

Setup

Katalog requires several environment variables to be set in order to work.

Rails secret key base

  • RAILS_SECRET_KEY_BASE - Use rake secret to generate a value for this variable.

Github Application Credentials

Set up a new Github application under your account and add these corresponding environment variables:

  • GITHUB_KEY - The app public key.
  • GITHUB_SECRET - The app secret key.

AWS Credentials

The Katalog app requires an AWS S3 account for image uploading:

  • KATALOG_AWS_ID - AWS access key id.
  • KATALOG_AWS_ACCESS_KEY - AWS secret access key id.
  • KATALOG_AWS_BUCKET_NAME - The S3 bucket the images will be uploaded to.

Postmark

You can create a project from email if you configure an app in postmarkapp.com, and map it's inbound web hook to http://<host>/postmark.

In order to test this feature you can do one of two things:

  • A curl POST command like the following:
curl -X POST "127.0.0.1/postmark" \
  {
    "From" : "sender@example.com",
    "To" : "receiver@example.com",
    "Cc" : "copied@example.com",
    "Bcc": "blank-copied@example.com",
    "Subject" : "Test",
    "Tag" : "Invitation",
    "HtmlBody" : "<b>Hello</b>",
    "TextBody" : "Hello",
    "ReplyTo" : "reply@example.com",
    "Headers" : [{ "Name" : "CUSTOM-HEADER", "Value" : "value" }]
  }
  • Setup an account on https://postmarkapp.com and configure the inbound hook URL to http://<host>/postmark. Note that postmarkapp.com will need access to your server, so this can be a bit tricky to test in development.

Version

0.6

License

Katalog is available under the MIT license. See the LICENSE file for more info.

About

A catalog for Katas

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors