scoopit / scoop-demo-server

Demo server that gets data from scoop.it api. Backend in Rust, frontend in JS/React

Modern demo of accessing the Scoop.it API.

This repository consists in two parts:

The backend, responsible for requesting Scoop.it API and serving frontend files (only in production mode). It is written in the Rust programming language. Under the hood it's using warp to handle HTTP request, and scoopit-api to make requests to Scoop.it.

The frontend, responsible for getting data from the backend and presenting it in your browser. It is a regular Create React App. State management is done with Recoil and RxJS.

Building

Development

You need the Rust toolchain to build the backend, yarn and nodejs 12+ to build the frontend.

First create a .env file containing needed configuration for the backend:

# Backend config
APP_CLIENT_ID=ABCDEF_MY_KEY
APP_CLIENT_SECRET=GHIYJ_MY_SECRET
APP_BIND_ADDRESS="[::]:5001"
# Tell rust env_logger to log a bit
RUST_LOG=info

Build and run the backend:

cargo run

Then, build and run the frontend

cd front
yarn start

It should open a browser tab on http://localhost:3000

Build for production

# build
cargo build --release
cd front
yarn build

When running the produced backend binary you need to set the APP_STATIC_HTML environment variable to tell the backend to server frontend files. Note that is this done automatically in the provided Dockerfile

Alternatively you can use the provided Dockerfile:

# build the image
docker build -t scoop-demo-server .

# run the image with correct args
docker run --init -p 5001:5001 \
  -e RUST_LOG=info \
  -e APP_BIND_ADDRESS=0.0.0.0:5501 \
  -e APP_CLIENT_ID=my_client_id \
  -e APP_CLIENT_SECRET=my_secret \
  scoop-demo-server

Prebuilt Docker image

A docker image is provided containing the latest build for this demo server: zenria/scoop-demo-server.

docker run -p 5001:5001 \
  -e RUST_LOG=info \
  -e APP_BIND_ADDRESS=0.0.0.0:5501 \
  -e APP_CLIENT_ID=my_client_id \
  -e APP_CLIENT_SECRET=my_secret \
  zenria/scoop-demo-server

Configuration parameters

Configuration are read from environment variables.

• APP_BIND_ADDRESS bind address
• APP_CLIENT_ID oauth client id
• APP_CLIENT_SECRET oauth secret id
• RUST_LOG logging configuration see env_logger

If a .env file is present in the current directory or its parents environments variables declared in it will expand the current environment.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.