Git Product home page Git Product logo

codeshovel-webservice's Introduction

codeshovel - webservice

A simple Spring based web service, delivering ataraxie/codeshovel online.

Running the Web Service

docker-compose

Use this method to run the web service accompanied by a frontend. Create a .env file in the root of the project with all the variables listed in .env.sample. Then from the project directory, run:

docker-compose build && docker-compose up -d

Docker

To build an image, from the project directory run:

Docker build -t csweb .

To run a container, run:

Docker run -p <Port to listen on>:8080 \
           -v <Path to csv on host for logging requests>:/requests.csv \
           -v <Path to dir on host for caching repositories>:/cache \
           -e GITHUB_TOKEN=<GitHub Personal Access Token with Read permissions> \
           csweb

IntelliJ IDEA

Requires Java 8 or higher

Add a Run Configuration following the Spring Boot Application template. Add the recommended environment variables listed below to the Run Configuration. Save the configuration and run the application within IntelliJ IDEA with ^R.

Command Line

Requires Java 8 or higher

In order to run from the command line, first download the most recent version from the releases page. Set the recommended environment variables listed below. Finally, run it as follows:

java -Xmx<Amount of Heap Memory> -jar codeshovel-webservice-XXX.jar

Recommended Environment Variables for use with IntelliJ IDEA and Command Line:

GITHUB_TOKEN=<GitHub Personal Access Token with Read permissions>
LANG=java
DISABLE_ALL_OUTPUTS=false
REPO_DIR=.

codeshovel-webservice's People

Contributors

braxtonhall avatar dependabot[bot] avatar nickbradley avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.