Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pierrechls/tweetscape

A WebVR experience displaying tweets in real-time along a 3D timeline
https://github.com/pierrechls/tweetscape

3d a-frame experience interactive threejs timeline tweet twitter vuejs webvr

Last synced: 3 months ago
JSON representation

A WebVR experience displaying tweets in real-time along a 3D timeline

Awesome Lists containing this project

README

        





T W E E T S C A P E

A WebVR experience displaying tweets in real-time along a 3D timeline



## 🚀 How to use it

### Clone the repo

```bash
$ git clone https://github.com/pierrechls/tweetscape
```

### Connect your Twitter API

- Duplicate the `.env.example` file and rename it to `.env`
- Get your application settings from the [Twitter Application Management](https://apps.twitter.com/)
- Remplace the default values into your `.env` file by your Twitter Application values
- Keep `NODE_ENV` value to `production` from your [Heroku application](https://heroku.com) to deploy the API

### Install dependencies

```bash
$ npm install
```

### Serve the client port

```bash
$ npm run dev
```

### Serve the API port

```bash
$ npm run server
```

### Build for production

```bash
$ npm run build
```

### Lint your code

```bash
$ npm run lint
```

### Deploy your build

```bash
$ npm run deploy
```

Set API production URL from the `default.json` file into `settings` folder.

## 🛠 Prior installation

You have to download [Node.js](https://nodejs.org/en/download/)

## 🎉 Credits

Project developed by [Pierre Charles](https://github.com/pierrechls/), [Jules Tantot](https://github.com/lujlujluj) and [Victor Viale](https://github.com/Koroeskohr), 3 students of [IMAC](http://www.ingenieur-imac.fr/) Engineering school.