Sark

Sark is an application that helps you build an Xcode project on your Mac from any OS without the use of any applications. All you need to do is set up your Mac and open a browser!

The goal of this application is not to replace Xcode or to compete with Macs. Instead, we aim to help young programmers who have an iMac or know someone who does and can't afford a Macbook. We aim to help those who, for some reason, need to edit and test Xcode projects, but forgot their Macbook at home. Using Sark, those people will be able to edit their project using a native application like Sublime Text, using all of their computer's speed efficiently without needing to rely on a fast internet connection to remotely access their Mac.

How does it work?

If you follow along the usage instructions, you'll notice that Sark is a Node.js server that runs on a Mac that should be accessible through the Internet. The server will execute commands and use Socket.io to communicate with the client.

Usage example

What does Sark need to run?

• A Mac running OS X with Xcode installed (duh!)
• XCPretty
• Node / NPM
• Git with cached credentials

How to use it?

Downloading

• Download the source code
• Uncompress the downloaded zip
• Open terminal and navigate to the folder created

Running the server

• Leave the terminal window open, and open Finder
• Navigate to the newly decompressed folder
• Open the file "config.json" with any text editor.
• Change "123" to your desired password
• Type in terminal:

  gulp dev

Now your server is up and running. If you go to http://localhost:3000 you should get the Sark's homepage. But if you don't have a public-facing IP, you'll need to...

Make your Mac accessible from anywhere

I like to use NoIP as a easy (and free) way to remember my iMac IP address.

• Create a NoIP account
• Download the OS X client
• Add a new host (your Mac). (Almost) Like this:

• Open the NoIP app that you've downloaded and go to the hosts tab
• Select the host you've created before
• Configure your router to do port forwarding

This should get you up and running!

I want to contribute!

Thank you! Here are some things that might help you:

Running tests:

• Mocha
• Istanbul

> npm install
> gulp test

Running the server in development mode (the same as running the server normally for now):

• Babel
• Copy package.json to /dist
• Copy public folder to /dist
• Lint
• nodemon

> npm install
> gulp dev

FAQ

I found a bug, what should I do?

• Can you reproduce the bug?
• Do you know how to fix it?
• If you know to fix the bug, create a pull request. If you don't, create a issue on Github.
• Do you need more help? Head over to our chat.

Why don't you use Travis CI?

• Sark uses a lot of specific stuff and using Travis was becoming more of a problem than a solution.

But don't you use Coveralls?

• Run the tests locally and you'll see the coverage status.