Skip to content

Commit

Permalink
Small adjustments to README (#17)
Browse files Browse the repository at this point in the history
* Make small adjustments to the README

* Add Ionic installation instructions

* Add account links
  • Loading branch information
Michiel Leyman authored Jul 13, 2017
1 parent 1ef560e commit 1aa207e
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
# Project Prisma App

This is a repository for an Ionic app for [Project Prisma](http://www.frederikvincx.com/project-prisma-helping-people-with-dementia). The Ionic app is meant for Android and iOS devices.
This is a repository for an Ionic app for [Project Prisma](http://www.frederikvincx.com/project-prisma-helping-people-with-dementia). The Ionic app works on both Android and iOS devices.

The app communicates with a RESTful [backend](https://github.com/oSoc17/prisma-backend) API.
The app communicates with a [RESTful API](https://github.com/oSoc17/prisma-backend).

## About

Project Prisma part of [open Summer of Code 2017](https://osoc17.slack.com/messages). A student team coached by Frederik Vincx is working on it now:
- Michiel Leyman (@MichielLeyman) - backend & project management
- Simon Westerlinck (@siimonco) - backend
- Jean-Pacifique Mboynincungu (@oxnoctisxo) - frontend & system analysis
- Thor Galle (@th0rgall) - frontend & user testing
Project Prisma is part of [open Summer of Code 2017](http://2017.summerofcode.be/). A student team coached by Frederik Vincx is working on it now:
- Michiel Leyman [(@MichielLeyman)](https://github.com/MichielLeyman) - backend & project management
- Simon Westerlinck [(@siimonco)](https://github.com/siimonco) - backend
- Jean-Pacifique Mboynincungu [(@oxnoctisxo)](https://github.com/oxnoctisxo) - frontend & system analysis
- Thor Galle ([@th0rgall)](https://github.com/th0rgall) - frontend & user testing

## Installation

Run `npm install` on your command line. Of course, you'll need to have [npm](https://www.npmjs.com/) installed first.

## Running the app

Local web server:
Install Ionic:
```bash
npm install -g ionic
```

Local web server:
```bash
ionic serve
```

Publish to Android:

Publish to Android:
```bash
ionic cordova platform add android
ionic cordova run android
Expand Down

0 comments on commit 1aa207e

Please sign in to comment.