|
1 | 1 | LaunchKit |
2 | 2 | ========= |
3 | 3 |
|
4 | | -This repo contains an unbranded version of all the code that once powered [LaunchKit](https://techcrunch.com/2015/03/11/for-those-about-to-launch-their-apps/). This notably includes **Screenshot Builder**, a web UI for creating App Store screenshots, and **Review Monitor**, which monitors Apple App Store review RSS feeds for new reviews and optionally notifies you about them. |
5 | | - |
6 | | -**DISCLAIMER** This code was originally a subscription-supported consumer product, serving millions of web requests across many servers. If you are not technical, it will probably be difficult to make this work. |
7 | | - |
8 | | -There's a bunch of other code in here for supporting the old [LaunchKit SDK](https://github.com/launchkit/launchkit-ios), in case you want to, for example, host a whitelabel in-app analytics platform or build a hosted server-configurable feature flags offering. |
9 | | - |
10 | | -## Overview |
11 | | - |
12 | | -We have packaged things up to run easily with [Vagrant](https://www.vagrantup.com) and [Ansible](https://www.ansible.com), so getting started running LaunchKit's services locally should be fairly straightforward in theory. |
13 | | - |
14 | | -* [Getting Started](#getting-started) → HOWTO install & run your own instance of LK. |
15 | | -* [System Configuration](#system-configuration) → Easily editable settings to enable LK to work with third-party providers. |
16 | | -* [Architecture Overview](#architecture-overview) → Overview of how LK works. |
17 | | -* [Code Organization](#code-organization) → Overview of how code is organized in this repository. |
18 | | - |
19 | | -If anything in this guide is not accurate or if you run into any issues installing & running LaunchKit, please send us a pull request. No one is actively addressing bug reports, but we will happily review and integrate pull requests. |
20 | | - |
21 | | -## Getting Started - Vagrant |
22 | | - |
23 | | -Getting your LK instance up and running is fairly simple. This process has been tested thoroughly on **Mac OS 10.11**, but should also work on other systems compatible with Vagrant, VirtualBox and Ansible. |
24 | | - |
25 | | -### STEP 1 |
26 | | - |
27 | | -(OS X only -- on Linux & other systems you might need various other build tools in order to install Vagrant/Ansible.) |
28 | | - |
29 | | -Install **Xcode dev tools** if you don’t have them yet. Running `cc` from the command line on OS X Terminal should prompt you to install them. |
30 | | - |
31 | | - $ cc |
32 | | - |
33 | | -If the command complains about clang input, you're all set. |
34 | | - |
35 | | -### STEP 2 |
36 | | - |
37 | | -Install **Vagrant**. You can find the installer here: https://www.vagrantup.com/downloads.html |
38 | | - |
39 | | -Once the installer finishes, you don't need to do anything else. |
40 | | - |
41 | | -### STEP 3 |
42 | | - |
43 | | -Install **VirtualBox** 5.0. You can find 5.0.x here: https://www.virtualbox.org/wiki/Download_Old_Builds_5_0 (The latest 5.1.x versions are not yet compatible for some reason, so use 5.0.x.) |
44 | | - |
45 | | -Once the installer finishes, you don't need to open the VirtualBox app. (You can close it if it opens.) |
46 | | - |
47 | | -### STEP 4 |
48 | | - |
49 | | -Install **ansible**: |
50 | | - |
51 | | - # You need pip and a newer version of setuptools to use ansible |
52 | | - $ sudo easy_install pip |
53 | | - $ pip install --upgrade setuptools --user python |
54 | | - |
55 | | - # Install ansible globally |
56 | | - $ sudo pip install ansible |
57 | | - |
58 | | -`ansible` should now work as a command: |
| 4 | +## Fork Notes |
59 | 5 |
|
60 | | - $ ansible |
| 6 | +This is a fork of original LaunchKit repository, which adds support of Docker. |
61 | 7 |
|
62 | | -(Output should be an error message about missing targets, that's fine.) |
63 | | - |
64 | | -### STEP 5 |
65 | | - |
66 | | -Get the LaunchKit code and configure your LK settings. |
67 | | - |
68 | | - $ git clone https://github.com/LaunchKit/LaunchKit.git |
69 | | - $ cd LaunchKit |
70 | | - |
71 | | -Edit your [System Configuration](#system-configuration) according to the various configuration detailed in the next section. (If you do this after the server is started, you will have to reboot.) |
72 | | - |
73 | | -### STEP 6 |
74 | | - |
75 | | -Start LaunchKit (this might take awhile): |
76 | | - |
77 | | - $ vagrant up --provision |
78 | | - |
79 | | -After that command finishes, your LK instance should be up and running at `http://localhost:9100/` — woohoo! (The instance might not be ready right away, check 30 seconds after provision is done.) |
80 | | - |
81 | | -If you're **all done** using LaunchKit, you can stop the machine by running: |
82 | | - |
83 | | - $ vagrant halt |
84 | | - |
85 | | -If you're never going to use LaunchKit again, you can destroy the machine altogether: |
86 | | - |
87 | | - $ vagrant destroy |
| 8 | +This fork is not meant to create a high-grade production docker environment, but rather to give an option to run |
| 9 | +LaunchKit in Docker locally. |
88 | 10 |
|
89 | 11 | ## Getting Started - Docker |
90 | 12 |
|
@@ -113,6 +35,26 @@ It might take some time to initialize all components. |
113 | 35 |
|
114 | 36 | Navigate to http://localhost:9100/ |
115 | 37 |
|
| 38 | +## Original Repository Notes |
| 39 | + |
| 40 | +This repo contains an unbranded version of all the code that once powered [LaunchKit](https://techcrunch.com/2015/03/11/for-those-about-to-launch-their-apps/). This notably includes **Screenshot Builder**, a web UI for creating App Store screenshots, and **Review Monitor**, which monitors Apple App Store review RSS feeds for new reviews and optionally notifies you about them. |
| 41 | + |
| 42 | +**DISCLAIMER** This code was originally a subscription-supported consumer product, serving millions of web requests across many servers. If you are not technical, it will probably be difficult to make this work. |
| 43 | + |
| 44 | +There's a bunch of other code in here for supporting the old [LaunchKit SDK](https://github.com/launchkit/launchkit-ios), in case you want to, for example, host a whitelabel in-app analytics platform or build a hosted server-configurable feature flags offering. |
| 45 | + |
| 46 | +## Overview |
| 47 | + |
| 48 | +We have packaged things up to run easily with [Vagrant](https://www.vagrantup.com) and [Ansible](https://www.ansible.com), so getting started running LaunchKit's services locally should be fairly straightforward in theory. |
| 49 | + |
| 50 | +* [Getting Started](#getting-started) → HOWTO install & run your own instance of LK. |
| 51 | +* [System Configuration](#system-configuration) → Easily editable settings to enable LK to work with third-party providers. |
| 52 | +* [Architecture Overview](#architecture-overview) → Overview of how LK works. |
| 53 | +* [Code Organization](#code-organization) → Overview of how code is organized in this repository. |
| 54 | + |
| 55 | +If anything in this guide is not accurate or if you run into any issues installing & running LaunchKit, please send us a pull request. |
| 56 | +No one is actively addressing bug reports, but we will happily review and integrate pull requests. |
| 57 | + |
116 | 58 | ## System Configuration |
117 | 59 |
|
118 | 60 | LaunchKit will work largely out of the box, but each service has some **external dependencies** that you will need to configure if you wish the service to work properly. |
|
0 commit comments