Git Product home page Git Product logo

readme_template's Introduction

Service Name

Owner: Zhukov Max

Contacts: [email protected]

-----------------------------------------------------

πŸ“– Description

Simple project description with few examples, schemas and gifs if any.


AREG SDK distributed services

-----------------------------------------------------

🎯 Todo

  • One
  • Two
  • Three
  • Four

-----------------------------------------------------

πŸ”— Links

-----------------------------------------------------

☁️ Deployment

To run server:

  1. Fill yaml in github actions dir
  2. Run workflow
  3. ...
  4. Profit

-----------------------------------------------------

πŸ’» Usage

java -jar df.jar [OPTIONS] [FLAGS] [COMMANDS]                                 
                                                                              
OPTIONS:                                                                       
   --host <host>            host name, default: localhost                      
   --port <number>          HTTP TCP port number, default: 8080                

                                                                               
FLAGS:                                                                         
   --no-log                 disable request/response console logging           
   --no-log-request-info    disable request info in console logging            
   --no-log-headers         disable request/response headers in console logging
       
                                                                               
COMMANDS:                                                                      
   --help                   print help message                                 
   --print-info             print dump files statistics to stdout as json/yaml 
   --print-requests         print dump requests to stdout as json/yaml         
   --print-openapi          print OpenAPI specification to stdout as json/yaml

-----------------------------------------------------

πŸ”­ Usage Examples

Start server on dump file:

java -jar df.jar --dump dump.txt

Start server with built-in OpenAPI client:

java -jar df.jar --openapi-path /api --dump dump.txt
more examples…
Start server on few dump files:
java -jar df.jar --dump dump1.txt dump2.txt dump3.txt
Start server with built-in OpenAPI client with custom title:
java -jar df.jar --openapi-path /api --openapi-title 'My REST API v18.2.1' --dump dump.txt

-----------------------------------------------------

🧐 Code analysis

We use some tools to ensure code quality:

  • flake8 – code style
  • isort – imports order
  • mypy – types annotation
  • bandit – security: our code

To perform all checks, run:

make check

-----------------------------------------------------

πŸ§ͺ Tests

make test

-----------------------------------------------------

πŸ“¦ Containerization

Docker

You can use docker and docker-compose to work with your project.

To build a docker image, use:

docker build --ssh default . -t my-service

And run with:

docker run my-service

Options for docker run are:

  • -d: Run in detached mode, does not hang your terminal session.
  • --rm: Removes container after finish
  • -it: Runs interactively
  • docker run -it --rm my-service <command>: run a command using the container image

Additional docker commands

  • docker ps: Checks docker images running.
  • docker exec -it <container_id> <command>: Runs a command inside the running container.

readme_template's People

Contributors

max-zorn avatar

Watchers

 avatar

Forkers

sayr777

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.