Skip to content

Latest commit

 

History

History
115 lines (77 loc) · 4.14 KB

README.md

File metadata and controls

115 lines (77 loc) · 4.14 KB
Raw

UNCode linter service

Codacy Badge License Contributors GitHub issues CLA assistant Gitter

This code creates a linting service for UNCode, via a container which is in Docker Hub in the repository unjudge/linter-web-service.

Getting started

Dependencies

Currently, the linter supports C/C++, Java and Python3.6+.

Install

Using docker

This is recommended option, because all the dependencies are already installed, as coala requires other additional dependencies that might be a pain.

Build container

In case new changes where added, run next command to update the container with the new changes:

docker build -t unjudge/linter-web-service ./
Run container

To start the container, run next command:

docker run -d -p 4567:4567 unjudge/linter-web-service

You can either do this with docker-compose.

Linux

Some initial dependencies are required first, please run next commands:

sudo apt-get install -y ruby
sudo gem install bundler #bundler
sudo apt-get install -y python3-pip
pip3 install coala-bears #coala, better if you use a virtualenv

We recommend you use a python virtual environment to avoid issues with other dependencies. Additionally, coala requires some other dependencies to correctly lint the supported languages, such as Java and GCC, check the Dockerfile to see the installed and required dependencies.

To start the linter service, run:

bundle install #this will install all ruby dependencies
ruby src/linter-webapp.rb

This will start the service in port 4567.

Possible problems

  • Please make sure that you have installed all the executables dependencies for coala.

Documentation

For additional documentation about UNCode, please refer to the Wiki.

Roadmap

See the UNCode GitHub Project for a list of proposed features for UNCode, known issues and how they are being tackled.

Contributing

Go to CONTRIBUTING to see the guidelines and how to start contributing to UNCode.

License

Distributed under the AGPL-3.0 License. See LICENSE for more information.

Contact

In case of technical questions, please use the gitter communication channel.

In case you want to host your course on our deployment, email us on: [email protected]

UNCode: https://uncode.unal.edu.co

Project page: https://juezun.github.io/