Home

Introduction

Straightforward guide how to configure how your app is presented on our website, and what purpose each option fulfills. If it's too hard to wrap your head around it please checkout .akai folder of our repo and page of our app. Begin by creating .akai folder in root of your project where you will put all your files and it has to be on branch named main, it is required because of how we fetch the data from github.

Readme files

There should be two readme files, one in english and one in polish language. Name for each file has to follow readme<locale>.md pattern in camelCase e.g. readmePl.md. Markdown formatting syntax should be compliant with github's flavored markdown. See this guide

Logo

At this moment there are no restrictions to logo file, other than that it has to be an image file and named exactly logo.<extension> (extension for example jpg, png, webp etc.)

Config

For now config.json structure and type for each property look like this. Every property has to be written precisely as in this snippet:

{
  "name": string,
  "technologies": string[],
  "description_pl": string,
  "description_en": string,
  "contributors": [
    {
      "name": string,
      "url": string
    }
  ]
}

• Name - sometimes name of the repository isn't as elegant, descriptive or is a bit too technical. Now you have a chance to redeem yourself and choose name of your project which will be displayed in our showcase.
• Technologies - on Githubs repository page there is only overview of detected used languages. That doesn't tell us much about project. For instance if you look on language summary of "Akai Apps" there is no CSS so does it mean that whole app is pure HTML and JS scripts? No. We are using tailwind for styling. So you can flex what new, trendy, fresh stack you have used without worry that nobody will notice (:
• Description pl/en - these are used on our home page where all projects are displayed in grid view. By default we are displaying description used on github, but perhaps you may want to supply translation of existing description or write something entirely new.
• Contributors - active contributors are displayed when viewing default github repository page, but our idea is that in some projects there are people who take part in building process but don't even have github account e.g. designers, project managers etc. This way you can give credit to everyone involved.