Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improvement in Documentation #122

Merged
merged 1 commit into from
Dec 10, 2016
Merged

Improvement in Documentation #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@ Please join our mailing list to discuss questions regarding the project: https:/

Our chat channel is on gitter here: https://gitter.im/loklak/loklak

## Installation
## Requirements
* [Angular-cli](https://github.com/angular/angular-cli#installation)
* node >= 6
* npm >= 3

There is no 'installation' process for loklak_search, it consist of web pages which must work in a local environment, hosted in the file system and hosted as github pages as well. This repository will host the pages as github pages.
## Installation
* ```npm install```

## Technology Stack

Expand All @@ -38,6 +42,16 @@ There is no 'installation' process for loklak_search, it consist of web pages wh

The goal is to use [Bower](http://bower.io) to manage front-end dependencies in future.

## How to deploy?

#### How to deploy locally?
* [Install loklak_search](https://github.com/fossasia/loklak_search#installation)
* ```ng serve```

#### How to deploy with [Github Pages](https://pages.github.com/)?
* ```git checkout master```
* ```ng github-pages:deploy --message "Optional commit message"```

### Loklak Server
See here to run your own https://github.com/loklak/loklak_server (recommended), and change `apiUrl` in config accordingly. Last resource, or for production is `http://api.loklak.org

Expand Down