Thot

String Comparator System

Introduction

Thot is a web app to execute operations in strings extensible to any operation you want.

It is built using React, Ruby on Rails and Java spark to simulate a Frontend-Backend interation with an integration with remote operation REST service server (Siwa).

View all the changes realized in CHANGELOG.md

Get Started

If you want to review the code in the app, probably you want to start the app in developer mode. Please folow the instructions detailed in Dependencies and Development Environment.

If you only want to test the app, please go to Deploy Instructions and follow the instructions.

Let's go!

Dependencies

To develop, test and deploy the app, you need the following dependencies

• Install Docker

# In Debian based linux
sudo apt-get install -y docker 
# In RHEL based linux
sudo yum install -y docker

• Install Ruby and Ruby on Rails

# In Debian based linux
sudo apt-get install ruby-full
gem install rails
# In RHEL based linux
sudo yum install ruby
gem install rails

• Install Nodejs and NPM

# In Debian based linux
sudo apt-get install nodejs npm
# In RHEL based linux
sudo yum install nodejs

• Install yarn

sudo npm install yarn -g

• Install JAVA 8

# In Debian based linux
sudo add-apt-repository ppa:webupd8team/java
sudo apt-get update
sudo apt-get install oracle-java8-installer
# In RHEL based linux
# Normally java 8 comes with RHEL but is important check the version
java -version
# If lower to 8 use the command
yum install java-1.8.0-openjdk

• Install Maven

# In Debian based linux
sudo apt-get install mvn
# In RHEL based linux
sudo yum install mvn

Develop environment

To use the development environment you must start the docker container that contains the database. To do this you need to write the following command.

docker-compose up -d

To start Thot Rails app, you must enter to thot directory and execute the following command.

rails server

To start Thot-ui React app, you must enter to thot-ui directory and execute the following command.

yarn start

To start Siwa Spark app, you must enter to thot directory and execute the following command.

mvn clean package
java -jar /target/siwa-jar-with-dependencies.jar

The database tools and the app will be available in the local machine in the following locations.

# Thot-ui App
http://localhost:3001
# Thot App
http://localhost:3000
# Siwa App
http://localhost:4567
# phpmyadmin
http://localhost:7000

Deploy Instructions

To deploy and test, Thot App and Siwa you need to run the following commands

docker-compose -f docker-compose.production.yml build
docker-compose -f docker-compose.production.yml up -d

The Thot and Siwa app are available in the following locations

# Thot-ui App
http://localhost:80
# Thot App (Splash screen)
http://localhost:8080
# Siwa App (Splash screen)
http://localhost:8090
# phpmyadmin
http://localhost:7000

Api Documentation

Both Siwa and Thot, when in production mode, have an API REST Reference manual built with Apidoc. In this manual you can see the reference of both APIs.

To access the reference, deploy the project in production docker mode and open the following links:

# Siwa Splash screem
http://localhost:8090/api/
# Thot API reference
http://localhost:8080/api/

Testing

To test Siwa use Junit and maven

mvn test

To test RoR App use Rspec

bundle exec rspec

How it Works

Thot and Siwa work like an API Services Servers, working in paralel like two remotes servers. The client app load an app built with React, and works like another server instance. The three parts are separated and comunicate between them across RESTFul services built in them.

To simulate this environment we use docker to set each application in a separate container, simulating with this way the servers and his properties.

If your want more information about the functionality and software arquitecture used, please visit ARCHITECTURE.es.md (Spanish Reference)

License

MIT

To

Made with ❤ for Lemontech and 🐇