Skip to main content

Get started

To get started with your project you need to create GitHub repository, but instead of commiting anything there, we'll do it a little differently.

Make sure you have git installed, if you don't have it, use this guide to do it.

Pull runtyme-kit​

Pulling runtyme-kit is available using git clone with your personal access token.

info

You'll receive [YOUR_PERSONAL_ACCESS_TOKEN] value in email sent to you after buying runtyme-kit. Make sure to save it in a safe space.

You can do it using this command:

$ git clone --depth 1 -b v1.2.0 https://[YOUR_PERSONAL_ACCESS_TOKEN]@github.com/mazxaxz/runtyme-kit.git
tip

Make sure you replace [YOUR_PERSONAL_ACCESS_TOKEN] with your actual personal access token

Initialize runtyme-kit for your project​

To start developing your project, you'll need to do few adjustments to the boilerplate, fortunatelly it's just a oneliner (using make)

info

Note that in this guide, [YOUR_PROJECT_NAME] and [YOUR_REPOSITORY] are the same value

GNU Make​

To initialize pulled repository you can (if make installed) run this oneliner, so the script will make it for you.

$ make -C ./runtyme-kit init GH_REPOSITORY_NAME=[YOUR_PROJECT_NAME] GH_USERNAME=[YOUR_USERNAME] SSH=true # default: ssh=true
tip

SSH flag set to true is recommended for security reasons, if set to false remote origin with HTTPS URL will be used

Manual way​

Pulled repository can be renamed from runtyme-kit directory name to your own choice.

It can be easily done using this bash command:

$ mv ./runtyme-kit ./[YOUR_PROJECT_NAME]
$ cd ./[YOUR_PROJECT_NAME]

Let's re-init GitHub metadata, since you don't need any of meta contents of runtyme-kit repository.

$ rm -rf ./.git
$ git init

To be able to push code to your repository, you'll need to add git remote origin to point to your repository.

You can do it using this command:

# using SSH
$ git remote add origin [email protected]:[YOUR_USERNAME]/[YOUR_REPOSITORY].git
# or using HTTPS
$ git remote add origin https://github.com/[YOUR_USERNAME]/[YOUR_REPOSITORY].git

Let's create an initial commit of base boilerplate of this repository for your project.

$ git add .
$ git commit -a -m "Initial commit" # or something more meaningful

Renaming default values for your app​

Email templates in runtyme-kit by default contains placeholder values like [your_app] or [your_app_url], you want to change it to your application's name and site URL.

  • [your_app] - is a placeholder for your applications name, it's used for example as alt text for logo images in email templates
  • [your_app_url] - some template parsers are lacking dynamic value for your application's site URL, this is a placeholder for you to manually specify it.

You can do it either via your IDE (or editor) by search and replace feature or use bash commands:

## execute this in root directory of your project

## [your_app]
$ find ./infra/_templates/emails -name '*.html' -exec sed -i '' -e 's/\[your_app\]/your_new_name_of_your_project/g' {} \;

## [your_app_url] - we're just updating here domain name (and optionally a path), by default it'll be of HTTPS schema
$ find ./infra/_templates/emails -name '*.html' -exec sed -i '' -e 's/\[your_app_url\]/example.com/g' {} \;

If you desire to have a specified path in [your_app_url] you'll need to escape / characters, like this:

$ find ./infra/_templates/emails -name '*.html' -exec sed -i '' -e 's/\[your_app_url\]/example.com\/foo\/bar/g' {} \;