jalmeida1994/gatherchain-app repository overview

⁠

⁠GatherChain Web Server

Web server for the GatherChain solution.
Explore the docs »⁠

Report Bug⁠ · Request Feature⁠

Table of Contents

1. About The Project⁠
   • Built With⁠
2. Getting Started⁠
   • Prerequisites⁠
   • Installation⁠
3. Roadmap⁠
4. Contributing⁠
5. License⁠
6. Contact⁠
7. Acknowledgements⁠

⁠About The Project

GatherChain is the solution created for my Master Thesis: Tracing Responsibility in Evolution of Model's Life Cycle in Collaborative Projects in Education. In the paper, it is proposed a blockchain-based solution for version control of model-driven engineering artefacts. The goal is to facilitate collaboration in a multi-user area, like the education field, and track changes in a trusted and secure manner. This solution is based on using the Hyperledger Fabric Network to govern and regulate file version control functions among students and teachers. This repository is a part of the larger GatherChain solution.

The other GatherChain projects are:

• GatherChain Desktop Client: https://github.com/Jalmeida1994/GatherChain-DesktopClient⁠
• GatherChain ARM Template: https://github.com/Jalmeida1994/GatherChain-ARM-Template⁠
• GatherChain Blockchain Server: https://github.com/Jalmeida1994/GatherChain-BlockChain-Server⁠
• GatherChain Admin Commands: https://github.com/Jalmeida1994/GatherChain-AdminCommands⁠

This repository serves as the Web server for the blockchain solution. It acts as a middle-man between the final users and the VM hosting the blockchain network. The Docker image can be found at jalmeida1994/gatherchain-app⁠.

⁠Built With

The web server is built with:

• Go⁠
• Docker⁠

⁠Getting Started

The web app is used automatically by the GatherChain ARM Template⁠. If you want to deploy this web app in your environment

⁠Prerequisites

If you want to build the Docker image on premises and use it as you own, you'll need:

• Docker⁠

⁠Installation

If the default installation is followed, using Azure as the cloud provider, you don't need to worry about this repository. The ARM template can be found in the repository GatherChain ARM Template⁠.

For more information, please refer to the Documentation⁠

If you want to build the Docker image on premises and use it as you own, follow the next steps:

1. Clone the repo

   git clone https://github.com/Jalmeida1994/GatherChain-Web-Server.git
   

   Copy

2. The server hosting the web app needs to have configured 5 environment variables to work correctly:

   • VM_PUBLIC_IP: Public IP of the server hosting the blockchain network.
   • VM_USERNAME: Username used to login to the server hosting the blockchain network.
   • VM_PASSWORD: Password used to login to the server hosting the blockchain network.
   • REDIS_HOST: URL of the Redis cache.
   • REDIS_PASSWORD: Password of the Redis cache.

   More information about setting environment variables can be found here⁠

3. Build the image

   docker build -t ${imageName} -f Dockerfile ${pathToDockerfile} 
   

   Copy

4. Run the Docker image and connects the 8010 ports

   docker run -it -p 8010:8010 ${imageName}
   

   Copy

⁠Roadmap

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

⁠Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

⁠License

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

⁠Contact

João Almeida - @João Almeida⁠ - [email protected]⁠

Project Link: https://github.com/Jalmeida1994/GatherChain-Web-Server⁠

⁠Acknowledgements

• FCT-UNL⁠
• Professor Vasco Amaral⁠