Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardxia committed Nov 7, 2015
1 parent d6aa62a commit 647aad8
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
# UCI-Directory

Demo app used in iOS Workshop on Nov 6, 2015
Demo app used in iOS Workshop on Nov 6, 2015 by Edward Xia.

# Download

``` sh
git clone --recursive https://github.com/ICSSC/UCI-Directory.git
```

If you forget "--recursive":

``` sh
git submodule sync
git submodule update --init
```

# Install Dependencies

NodeJS is required for the server app.

``` sh
cd Server
npm install
npm install coffee-script -g
```

# Start Server

``` sh
cd Server
coffee server.coffee
```

Note: server requires on campus network or UCI VPN.

# Build and Run the app

Open "UCI Directory.xcodeproj" and build.

# Play!

This app is build in a single afternoon, so code may be hacky.

0 comments on commit 647aad8

Please sign in to comment.