Palantir project - Web UI

The web UI of the Palantir Information Radiator Project
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
  • Getting Started
  • Prerequisites
  • Installation
  • Installation (with the Palantir web API project)
• Usage
• Roadmap
• Contributing
• License
• Contact
• Additional bibliography and acknowledgements

About The Project

Web frontend built with HTML, JavaScript and CSS for the Palantir Information Radiator project. Main objective: to show on computers and Samsung Smart TVs, which run Tizen OS, information obtained from the Palantir Web API.

Built With

• Bootstrap
• JQuery
• Tizen Studio and Tizen SDK

Getting Started

To get a local copy up and running consider these recommendations and follow these simple example steps:

Prerequisites

This project was designed to work in conjunction with the Palantir Web API project. Please read the installation instructions on its README.

However, if you are interested in developing this project, you can clone this repo with git:

git clone https://gitlab.com/untref-ingsoft/tfi-cozzi/palantir-tizen-ui.git

Additionally, you can run this website on a web server such as Apache or nginx.

Installation

If you are not interested in developing this project or using it in conjunction with the Palantir Web API project, you can download it from Docker Hub with the following command:

• For AMD64 (x86-64) Docker installations:

docker pull gonzalocozzi/palantir-web-amd64

• For ARM64 (aarch64) Docker installations:

docker pull gonzalocozzi/palantir-web-arm64

...and run the Docker container with:

• For AMD64 (x86-64) Docker installations (with port 8080 exposed):

docker run -d -p 8080:80 gonzalocozzi/palantir-web-amd64

• For ARM64 (aarch64) Docker installations (with port 8080 exposed):

docker run -d -p 8080:80 gonzalocozzi/palantir-web-arm64

You can also generate the Docker image locally, after cloning the repository, from the Dockerfile available in the project:

docker build -t docker-image-name path-to-dockerfile

Installation (with the Palantir web API project)

You can use this project in conjunction with the Palantir Web API project, using Docker Compose. This requires three files which must be located in the same folder:

• a configuration file for this API, called apiConfig.json (example at this link)

• a configuration file for the web frontend called webConfig.json (example at this link)

• a Docker Compose file (example at this link).

To run the Docker Compose and start the application, the following command must be run in the folder in which the three files are stored:

docker-compose up -d

Usage

If you followed the previous instructions, you should be able to see the web frontend running in any web browser by opening the address http://localhost:8080. If this is the case, you will see a screen similar to this one:

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

License

Distributed under the GPL License. See LICENSE for more information.

Contact

Gonzalo Alejandro Cozzi - gcozzi@untref.edu.ar

Additional bibliography and acknowledgements

• Scrum Patterns
• Agile Software Development: Forming Teams that Communicate and Cooperate
• Information radiator
• Create Your First Samsung Smart TV Web Application
• Deploying NGINX and NGINX Plus with Docker
• Tips for Deploying NGINX (Official Image) with Docker
• Build and run your Docker image
• Share images on Docker Hub
• Overview of Docker Compose
• Choose an Open Source License