Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sczyh30/vertx-twitter-wall-scala

Vert.x Twitter Wall Sample
https://github.com/sczyh30/vertx-twitter-wall-scala

asynchronous scala vertx

Last synced: 20 days ago
JSON representation

Vert.x Twitter Wall Sample

Awesome Lists containing this project

README

        

# Vert.x Twitter Wall

[![Build Status](https://travis-ci.org/sczyh30/vertx-twitter-wall.svg?branch=master)](https://travis-ci.org/sczyh30/vertx-twitter-wall)

A simple Twitter Wall application written in Vert.x Scala.

## Build

To build the code and generate package:

```
sbt clean assembly
```

Before running the application, you need to put your Twitter OAuth credentials in the config file.
Then you can run the application directly in terminal:

```
java -jar target/scala-2.12/vertx-twitter-wall-assembly-1.0.jar -conf project/config.json
```

Now you can visit the Twitter Wall in the browser:

![Vert.x Twitter Wall](docs/twitter-wall-demo.png)

## Configuration

You can put your config into a JSON file and provide the path when running the application.
Here are the configurations:

- `app.port`: the port of the application, by default **8080**
- `app.update.interval`: the interval of fetching the latest tweets
- `app.consumerKey`: your consumer key of Twitter API
- `app.consumerSecret`: your consumer secret key of Twitter API

## Credit

Some frontend architecture is inspired from [@yunyul](https://github.com/yunyul).