alex/restaurant-search
1
Fork 0
Code Releases Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2016-07-08 22:55:14 -07:00
parent fee43de75a
commit bfd19ad66b
1 changed files with 13 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -2,56 +2,39 @@
This work-in-progress represents a prototype semantic search web application that I'm developing as part of my master's
thesis at [Keio University](http://www.sfc.keio.ac.jp/). You can get a better understanding of the goals of my research
by referring to the [overview presentation](https://foosoft.net/projects/restaurant-search/slides).
by referring to the [overview presentation](https://foosoft.net/projects/restaurant-search/slides). Although I no longer make the prototype accessible on the web, it
is easy to get it up and running locally.
This installation guide is designed with [Ubuntu](http://www.ubuntu.com/)-based distributions in mind (I'm using [Linux
Mint](http://www.linuxmint.com/) for development), but I expect it to be trivial to get this application running on
other flavors of Linux.
<iframe width="800" height="500" src="https://www.youtube.com/embed/Ic7Sq-oQ2DI" frameborder="0" allowfullscreen></iframe>
## Dependencies ##
* [Bower](https://bower.io/)
* [Go](https://golang.org/)
* [Node.js](https://nodejs.org/)
## Installation ##
1. Install the system dependencies:
```
# apt-get install nodejs-legacy nodejs npm
```
2. Install the Node dependencies:
```
# npm install -g bower
```
3. Install the Go tool chain:
```
$ wget https://godeb.s3.amazonaws.com/godeb-amd64.tar.gz
$ tar xzvf godeb-amd64.tar.gz
# ./godeb install
```
4. Set the `GOPATH` environment variable (read the [docs](https://github.com/golang/go/wiki/GOPATH)).
5. Install the search application:
1. Install the search application:
```
$ go get github.com/FooSoft/search
```
6. Install the client libraries (from the `search/static` directory):
2. Install the client libraries (from the `search/static` directory):
```
$ bower install
```
7. Build and start the server (from the `search/cmd` directory):
3. Build and start the server (from the `search/cmd` directory):
```
$ go build
$ ./cmd
```
8. Access the web application at `localhost:8080`.
4. Access the web application at `localhost:8080`.
## License ##