Skip to content

waridrox/FLINT-UI

 
 

Repository files navigation

FLINT UI logo

FLINT UI

A FLINT client, written in Vue, to provide an awesome user interface for configuring simulations using the FLINT.Cloud APIs


Table of Contents
  1. About The Project
  2. Getting Started
  3. Developer notes
  4. How to Get Involved?
  5. FAQ and Other Questions
  6. Contributors
  7. Maintainers Reviewers Ambassadors Coaches
  8. License

About The Project

This project provides an intuitive way for new to explore some preconfigured FLINT modules, including the Generic Budget Carbon Model (GCBM), in order to better understand how the FLINT system works. Our client is written as a Web application and can be used in a local or remote environment. Please contact us if you'd like help deploying your cloud instance or customizing the client.

Built with

Getting started

Prerequisites

In order to use and work on this project you need to install Docker for running the Docker image and Yarn to run the Vue app locally.

You can install Docker following the download's instructions.

In order to install Yarn, open a terminal and type:

npm install -g yarn

Installation

To set up this project locally follow the below procedure:

  1. Pull the below docker image to run flint.example:
docker pull shubhamkarande13/flint.example:bionic
  1. Clone FLINT.UI repository:

When using submodules the installation code needs to be:

git clone --recursive https://github.com/moja-global/flint-ui

Or if you've already initialized the repository without the submodule

git submodule update --init --recursive
  1. Now get inside the repository directory and build the docker-compose.yml file by following the below command:
docker-compose up

This will build all the docker images inside the docker-compose.yml file. It will take some time and after that, you can see all images list in the Docker app.


docker-compose.yml file is composed of three services i.e. flint.example.api, flint.gcbm.api, flint.ui.

Now you can start all the containers by clicking on the START button or using the command docker-compose up. You can also use the command docker start {name of the container} to start the only specific container.

All containers list will look like this in the Docker app:


If you want to shut down a specific container click on the STOP button of that specific container in the Docker app. You can also use the command line to stop a specific container by using the command docker stop {name of the container you want to stop}.

To shut down, the whole docker-compose.yml file and all services inside it then use the command docker-compose down.

You can also run docker-compose.yml in Detached mode. Detached mode, shown by the option --detach or -d, means that a Docker container runs in the background of your terminal. It does not receive input or display output. So the command for running docker-compose up in Detached mode is docker-compose up -d.

  1. To view the UI please navigate to 127.0.0.1:8000. UI will look something like this:

Developer notes

Go through the Development Notes here..

Contributing

To contribute to FLINT-UI:

Go through our contributing guidelines over here..

How to Get Involved?

moja global welcomes a wide range of contributions as explained in Contributing document and the About moja-global Wiki.

FAQ and Other Questions

Contributors

Thanks go to these wonderful people (emoji key):

moja global
moja global

📆

This project follows the all-contributors specification. Contributions of any kind are welcome!

Maintainers Reviewers Ambassadors Coaches

The following people are Maintainers, Reviewers, Ambassadors, or Coaches.

moja global
moja global

📆
  • Maintainers review and accept proposed changes
  • Reviewers check proposed changes before they go to the Maintainers
  • Ambassadors are available to provide training related to this repository
  • Coaches are available to provide information to new contributors to this repository

License

This project is released under the Mozilla Public License Version 2.0.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 63.3%
  • JavaScript 34.5%
  • Other 2.2%