- { items.map(renderTodo).toArray() }
![](\"./docs/images/slack_join_button_github.png\")
\n ![](\"./docs/images/roadmap_button_github.png\")
\n![](\"./docs/images/kuwala_header_github.png\")
\n\n\n \n \n
![](\"./docs/images/tool_description_github.png\")
\n\n### Extract and Load with Airbyte\n\nCurrently we support the following databases and data warehouses\n\n- [x] Postgres\n- [x] BigQuery\n- [x] Snowflake\n\n For connecting and loading all your tooling data into a data warehouse, we are integrating with Airbyte connectors. \n For everything related to third-party data, such as POI and demographics data, we are building separate data pipelines.\n\n### Transform with dbt\n\nTo apply transformations on your data, we are integrating dbt which is running on top of your data warehouses. \nEngineers can easily create dbt models and make them reusable for the frontend. We have already a catalog of several \ntransformations that you can use on the canvas. The complete documentation can be found here: \n[https://docs.kuwala.io/](https://docs.kuwala.io/transformation-catalog)\n\n### Run a Data Science Model\n\nWe are going to include open-source data science and AI models as blocks (e.g., \n[Meta's Robyn Marketing Mix Modeling](https://github.com/facebookexperimental/Robyn)).\n\n### Report\n\nYou can easily connect your preferred visualization tool and connect it to a saved table on the canvas in the future. \nWe will make the results exportable to Google Sheets and also available in a Medium-style markdown editor.\n\n---\n\n# How can I use Kuwala?\n\n### Canvas\n\nWith the canvas you can connect to your data warehouse and start building data pipelines. To start the canvas, simply\nrun the following command from inside the root directory:\n\n```zsh\ndocker-compose --profile kuwala up\n```\n\nNow open http://localhost:3000 in your browser, and you are good to go. \ud83d\ude80\n\n### Third-party data connectors\n\nWe currently have five pipelines for different third-party data sources which can easily be imported into a Postgres \ndatabase. The following pipelines are integrated:\n\n - [Admin Boundaries](https://github.com/kuwala-io/kuwala/tree/master/kuwala/pipelines/admin-boundaries/README.md)\n - [Google POIs](https://github.com/kuwala-io/kuwala/tree/master/kuwala/pipelines/google-poi/README.md)\n - [Google Trends](https://github.com/kuwala-io/kuwala/tree/master/kuwala/pipelines/google-trends/README.md)\n - [OSM POIs](https://github.com/kuwala-io/kuwala/tree/master/kuwala/pipelines/osm-poi/README.md)\n - [Population Density](https://github.com/kuwala-io/kuwala/tree/master/kuwala/pipelines/population-density/README.md)\n\n### Using Kuwala components individually\n\nTo use Kuwala's components, such as the data pipelines or the Jupyter environment, individually, please refer to the\n[instructions under `/kuwala`](https://github.com/kuwala-io/kuwala/blob/master/kuwala/README.md).\n\n---\n\n# Use cases\n\n- [How to build an Uber-like analytics system with Kuwala](https://kuwala.io/data-pipelines/how-to-build-an-uber-like-intelligence-system-for-your-new-mobility-startup-without-a-big-data-team/)\n- [Perform location analytics for a grocery store with Kuwala](https://kuwala.io/case-studies/why-instant-grocery-delivery-should-follow-a-data-driven-path-like-uber-to-survive-part-1/)\n- [Querying the most granular demographics data set with Kuwala](https://kuwala.io/data-pipelines/querying-the-most-granular-demographics-dataset/)\n\n---\n\n# How can I contribute?\n\nEvery new issue, question, or comment is a contribution and very welcome! This project lives from your feedback and\ninvolvement!\n\n## Be part of our community\n\nThe best first step to get involved is to join the \n[Kuwala Community on Slack](https://join.slack.com/t/kuwala-community/shared_invite/zt-l5b2yjfp-2cdhReNACXDkLhuh0jFzZw). \nThere we discuss everything related to our roadmap, development, and support. \n\n## Contribute to the project\n\nPlease refer to our [contribution guidelines](https://github.com/kuwala-io/kuwala/tree/master/CONTRIBUTING.md) for further information on how to get involved.\n\n---\n\n# Get more content about Kuwala\n Link | Description \n-------------|-------------\n[Blog](https://kuwala.io/blog/) | Read all our blog articles related to the stuff we are doing here. \n[Join Slack](https://join.slack.com/t/kuwala-community/shared_invite/zt-l5b2yjfp-2cdhReNACXDkLhuh0jFzZw) | Our Slack channel with over 250 data engineers and many discussions.\n[Jupyter notebook - Popularity correlation](https://mybinder.org/v2/gh/kuwala-io/kuwala_examples/1def41ded01dbb67ecada9dc227c834cd93d0721?urlpath=lab%2Ftree%2Fnotebooks%2F1.%20Popularity%20Correlation.ipynb) | Open a Jupyter notebook on Binder and merge external popularity data with Uber traversals by making use of convenient dbt functions. \n[Podcast](https://anchor.fm/kuwala-io) | Listen to our community podcast and maybe join us on the next show.\n[Digital coffee break](https://calendly.com/kuwala_io/kuwala-community-chat?month=2022-02) | Are you looking for new inspiring tech talks? Book a digital coffee chit-chat with one member of the core team.\n[Our roadmap](https://github.com/orgs/kuwala-io/projects/3/views/6) | See our upcoming milestones and sprint planing.\n[Contribution guidelines](https://github.com/kuwala-io/kuwala/tree/master/CONTRIBUTING.md) | Further information on how to get involved.\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "theophilusx/ssh2-sftp-client", "link": "https://github.com/theophilusx/ssh2-sftp-client", "tags": [], "stars": 673, "description": "a client for SSH2 SFTP ", "lang": "JavaScript", "repo_lang": "", "readme": "#+OPTONS: H:2 toc:2\n#+TITLE: SSH2 SFTP Client\n\n* Overview\n\nan SFTP client for node.js, a wrapper around [[https://github.com/mscdex/ssh2][SSH2]] which provides a high level\nconvenience abstraction as well as a Promise based API.\n\nDocumentation on the methods and available options in the underlying modules can\nbe found on the [[https://github.com/mscdex/ssh2][SSH2]] project pages.\n\nCurrent stable release is *v9.0.4*.\n\nCode has been tested against Node versions 14.20.0, 16.17.2 and 18.8.0\n\nNode versions < 14.x are not supported. \n\n** Version 9.x Changes\n - Fix bug in ~connect()~ method when private key data was corrupted. The method was not\n handling errors fro corrupted ssh private keys and would hang indefinitely without\n reporting any error. Now reports that it was unable to parse the private key. \n - Fix bug in ~end()~ method where it was possible for the module to attempt calling\n the underlying ssh2 ~end()~ method when ssh2 has not been initialised. This could\n lead to undefined reference errors.\n - Fix bug in ~get()~ method where supplied destination streams were not close, creating\n a possible resource leak. If the remote file did not exist, the method would return\n an error, but failed to close any passed in stream supplied as the destination for\n the data in the ~get()~ call. \n - Change the default end and close handlers not to throw error or reject\n promises. Previously, an end or close event would cause an error to be raised or a\n promise to be rejected if the event was deemed to be /unexpected/. However,\n classification of events as being unexpected was unreliable and didn't add much real\n value. Both these handlers will now invalidate the SFTP connection object and log that\n the event fired and nothing else.\n - Changed when event handled flags are reset. Now they are reset after a new set of\n temporary listeners are added.\n - Don't throw an error when calling end() if there is no active SFTP connection. It does\n no harm to call end() when there is no connection, so no need to raise an error.\n - Use nullish coalescing when setting retry parameters instead of or'ing with\n defaults. Allows setting values to 0. \n - *Breaking Change*: This version uses syntax not supported in node versions\n prior to v14. Therefore, node versions less than v14 will not work.\n - *Breaking Change*: This ~list()~ method no longer accepts a regular expression\n for filtering the entries to be returned. You can now specify a filter\n function instead. The function is called for each item in the list of items\n to be returned, passing in the item object as its only argument.\n Essentially, this is just a call to ~Array.filter()~, so the filter function\n should behave in the same way i.e. return true for items to be retained and\n false for those to be dropped.\n - *Breaking Change*: The ability to set ~autoClose~ on read and write streams and\n the ability to set ~end~ on ~pipe~ operations has been removed. These options\n caused confusion for users and were too easy to get wrong, plus it made the\n methods overly complicated. For those use-cases where you want to control\n streams at a low level, two new methods have been added, ~createReadStream()~ and\n ~createWriteStream()~. However, it should be noted that client code is 100%\n responsible for managing streams obtained using these methods. Use at your\n own risk!\n - *Breaking Change*: The 3rd argument to ~uploadDir()~ and ~downloadDir()~ methods\n has been change. Previously, the argument was a filter function used to\n select which directories and files to be transferred. The 3rd argument is\n now an options object with two supported properties, ~filter~ and ~useFastput~\n (for ~uploadDir()~) or ~useFastget~ (for ~downloadDir()~). If ~useFastput~ is true,\n the ~fastPut()~ method will be used to upload files. If ~false~ or missing, the\n slower, but better supported, ~put()~ method will be used. Likewise, the\n ~useFastget~ options can be set to ~true~ to use the ~fastGet()~ method for\n downloading files, otherwise the slower, but more reliable, ~get()~ method\n will be used.\n - The ~uploadDir()~ and ~downloadDir()~ methods now use asynchronous processes to\n upload/download files. This should result in improved performance for these\n two methods.\n - New Methods: Two new methods, ~createWriteStream()~ and ~createReadStream()~\n have been added. These methods will return a stream object connected to a\n remote file on the ~SFTP~ server. Client code is responsible for managing\n these stream objects. This includes adding any necessary event listeners and\n disposing of the objects once finished with them.\n - Re-factoring of Listeners: The library manages temporary listeners in order\n to provide a way to catch events and processes them inside a ~Promise~\n context. Previously, every method added its own set of temporary listeners.\n However, this could result in multiple sets of listeners being added,\n especially for methods which call other methods as part of their processing\n e.g. ~rmdir(),~ ~uploadDir()~ and ~dowqnloadDir()~. To avoid this, /internal only/\n versions of each method have been created. These internal methods use an\n /underscore/ ~_~ prefix. Client code should not use these methods directly. \n - New method: Added ~rcopy()~ method to perform a remote copy of a file on the remote SFTP server. \n - Bumped ssh2 version to 1.11.0\n\n* Installation\n\n#+begin_src shell\n npm install ssh2-sftp-client\n#+end_src\n\n* Basic Usage\n\n#+begin_src javascript\n let Client = require('ssh2-sftp-client');\n let sftp = new Client();\n\n sftp.connect({\n host: '127.0.0.1',\n port: '8080',\n username: 'username',\n password: '******'\n }).then(() => {\n return sftp.list('/pathname');\n }).then(data => {\n console.log(data, 'the data info');\n }).catch(err => {\n console.log(err, 'catch error');\n });\n#+end_src\n\n* Documentation\n\nThe connection options are the same as those offered by the underlying SSH2\nmodule. For full details, please see [[https://github.com/mscdex/ssh2#user-content-client-methods][SSH2 client methods]]\n\nAll the methods will return a Promise, except for ~on()~ and\n~removeListener()~, which are typically only used in special use cases.\n\n** Specifying Paths\n\n The convention with both FTP and SFTP is that paths are specified using a\n 'nix' style i.e. use ~/~ as the path separator. This means that even if your\n SFTP server is running on a win32 platform, you should use ~/~ instead of ~\\~\n as the path separator. For example, for a win32 path of ~C:\\Users\\fred~ you\n would actually use ~/C:/Users/fred~. If your win32 server does not support\n the 'nix' path convention, you can try setting the ~remotePathSep~ property\n of the ~SftpClient~ object to the path separator of your remote server. This\n *might* work, but has not been tested. Please let me know if you need to do\n this and provide details of the SFTP server so that I can try to create an\n appropriate environment and adjust things as necessary. At this point, I'm\n not aware of any win32 based SFTP servers which do not support the 'nix' path\n convention.\n\n All remote paths must either be absolute e.g. ~/absolute/path/to/file~ or\n they can be relative with a prefix of either ~./~ (relative to current remote\n directory) or ~../~ (relative to parent of current remote directory) e.g.\n ~./relative/path/to/file~ or ~../relative/to/parent/file~. It is also\n possible to do things like ~../../../file~ to specify the parent of the\n parent of the parent of the current remote directory. The shell tilde (~~~)\n and common environment variables like ~$HOME~ are NOT supported.\n\n It is important to recognise that the current remote directory may not always\n be what you may expect. A lot will depend on the remote platform of the SFTP\n server and how the SFTP server has been configured. When things don't seem to\n be working as expected, it is often a good idea to verify your assumptions\n regarding the remote directory and remote paths. One way to do this is to\n login using a command line program like ~sftp~ or ~lftp~.\n\n There is a small performance hit for using ~./~ and ~../~ as the module must\n query the remote server to determine what the root path is and derive the\n absolute path. Using absolute paths are therefore more efficient and likely\n more robust.\n\n When specifying file paths, ensure to include a full path i.e. include the\n remote file name. Don't expect the module to append the local file name to the\n path you provide. For example, the following will not work\n\n #+begin_src javascript\n client.put('/home/fred/test.txt', '/remote/dir');\n #+end_src\n\n will not result in the file ~test.txt~ being copied to\n ~/remote/dir/test.txt~. You need to specify the target file name as well e.g.\n\n #+begin_src javascript\n client.put('/home/fred/test.txt', '/remote/dir/test.txt');\n #+end_src\n\n Note that the remote file name does not have to be the same as the local file\n name. The following works fine;\n\n #+begin_src javascript\n client.put('/home/fred/test.txt', '/remote/dir/test-copy.txt');\n #+end_src\n\n This will copy the local file ~test.txt~ to the remote file ~test-copy.txt~\n in the directory ~/remote/dir~.\n\n** Methods\n\n*** new SftpClient(name) ===> SFTP client object\n\nConstructor to create a new ~ssh2-sftp-client~ object. An optional ~name~ string\ncan be provided, which will be used in error messages to help identify which\nclient has thrown the error.\n\n**** Constructor Arguments\n\n- name :: string. An optional name string used in error messages\n\n**** Example Use\n\n#+begin_src javascript\n 'use strict';\n\n const Client = require('ssh2-sftp-client');\n\n const config = {\n host: 'example.com',\n username: 'donald',\n password: 'my-secret'\n };\n\n const sftp = new Client('example-client');\n\n sftp.connect(config)\n .then(() => {\n return sftp.cwd();\n })\n .then(p => {\n console.log(`Remote working directory is ${p}`);\n return sftp.end();\n })\n .catch(err => {\n console.log(`Error: ${err.message}`); // error message will include 'example-client'\n });\n#+end_src\n\n*** connect(config) ===> SFTP object\n\nConnect to an sftp server. Full documentation for connection options is\navailable [[https://github.com/mscdex/ssh2#user-content-client-methods][here]]\n\n**** Connection Options\n\nThis module is based on the excellent [[https://github.com/mscdex/ssh2#client][SSH2]] module. That module is a general SSH2\nclient and server library and provides much more functionality than just SFTP\nconnectivity. Many of the connect options provided by that module are less\nrelevant for SFTP connections. It is recommended you keep the config options to\nthe minimum needed and stick to the options listed in the ~commonOpts~ below.\n\nThe ~retries~, ~retry_factor~ and ~retry_minTimeout~ options are not part of the\nSSH2 module. These are part of the configuration for the [[https://www.npmjs.com/package/retry][retry]] package and what\nis used to enable retrying of sftp connection attempts. See the documentation\nfor that package for an explanation of these values.\n\n#+begin_src javascript\n // common options\n\n let commonOpts {\n host: 'localhost', // string Hostname or IP of server.\n port: 22, // Port number of the server.\n forceIPv4: false, // boolean (optional) Only connect via IPv4 address\n forceIPv6: false, // boolean (optional) Only connect via IPv6 address\n username: 'donald', // string Username for authentication.\n password: 'borsch', // string Password for password-based user authentication\n agent: process.env.SSH_AGENT, // string - Path to ssh-agent's UNIX socket\n privateKey: fs.readFileSync('/path/to/key'), // Buffer or string that contains\n passphrase: 'a pass phrase', // string - For an encrypted private key\n readyTimeout: 20000, // integer How long (in ms) to wait for the SSH handshake\n strictVendor: true, // boolean - Performs a strict server vendor check\n debug: myDebug,// function - Set this to a function that receives a single\n // string argument to get detailed (local) debug information.\n retries: 2, // integer. Number of times to retry connecting\n retry_factor: 2, // integer. Time factor used to calculate time between retries\n retry_minTimeout: 2000, // integer. Minimum timeout between attempts\n };\n\n // rarely used options\n\n let advancedOpts {\n localAddress,\n localPort,\n hostHash,\n hostVerifier,\n agentForward,\n localHostname,\n localUsername,\n tryKeyboard,\n authHandler,\n keepaliveInterval,\n keepaliveCountMax,\n sock,\n algorithms,\n compress\n };\n#+end_src\n\n**** Example Use\n\n#+begin_src javascript\n sftp.connect({\n host: example.com,\n port: 22,\n username: 'donald',\n password: 'youarefired'\n });\n#+end_src\n\n*** list(path, filter) ==> Array[object]\n\nRetrieves a directory listing. This method returns a Promise, which once\nrealised, returns an array of objects representing items in the remote\ndirectory.\n\n- path :: {String} Remote directory path\n- filter :: (optional) {function} A function used to filter the items included\n in the returned array. The function is called for each item with the item\n object being passed in as the argument. The function is passed to\n Array.filter() to perform the filtering.\n\n**** Example Use\n\n#+begin_src javascript\n const Client = require('ssh2-sftp-client');\n\n const config = {\n host: 'example.com',\n port: 22,\n username: 'red-don',\n password: 'my-secret'\n };\n\n let sftp = new Client;\n\n sftp.connect(config)\n .then(() => {\n return sftp.list('/path/to/remote/dir');\n })\n .then(data => {\n console.log(data);\n })\n .then(() => {\n sftp.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n**** Return Objects\n\nThe objects in the array returned by ~list()~ have the following properties;\n\n#+begin_src javascript\n {\n type: '-', // file type(-, d, l)\n name: 'example.txt', // file name\n size: 43, // file size\n modifyTime: 1675645360000, // file timestamp of modified time\n accessTime: 1675645360000, // file timestamp of access time\n rights: {\n user: 'rw',\n group: 'r',\n other: 'r',\n },\n owner: 1000, // user ID\n group: 1000, // group ID\n longname: '-rw-r--r-- 1 fred fred 43 Feb 6 12:02 exaple.txt', // like ls -l line\n }\n#+end_src\n\n*** exists(path) ==> boolean\n\nTests to see if remote file or directory exists. Returns type of remote object\nif it exists or false if it does not.\n\n**** Example Use\n\n#+begin_src javascript\n const Client = require('ssh2-sftp-client');\n\n const config = {\n host: 'example.com',\n port: 22,\n username: 'red-don',\n password: 'my-secret'\n };\n\n let sftp = new Client;\n\n sftp.connect(config)\n .then(() => {\n return sftp.exists('/path/to/remote/dir');\n })\n .then(data => {\n console.log(data); // will be false or d, -, l (dir, file or link)\n })\n .then(() => {\n sftp.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** stat(path) ==> object\n\nReturns the attributes associated with the object pointed to by ~path~.\n\n- path :: String. Remote path to directory or file on remote server\n\n**** Attributes\n\nThe ~stat()~ method returns an object with the following properties;\n\n#+begin_src javascript\n let stats = {\n mode: 33279, // integer representing type and permissions\n uid: 1000, // user ID\n gid: 985, // group ID\n size: 5, // file size\n accessTime: 1566868566000, // Last access time. milliseconds\n modifyTime: 1566868566000, // last modify time. milliseconds\n isDirectory: false, // true if object is a directory\n isFile: true, // true if object is a file\n isBlockDevice: false, // true if object is a block device\n isCharacterDevice: false, // true if object is a character device\n isSymbolicLink: false, // true if object is a symbolic link\n isFIFO: false, // true if object is a FIFO\n isSocket: false // true if object is a socket\n };\n#+end_src\n\n**** Example Use\n\n#+begin_src javascript\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.stat('/path/to/remote/file');\n })\n .then(data => {\n // do something with data\n })\n .then(() => {\n client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** get(path, dst, options) ==> String|Stream|Buffer\n\nRetrieve a file from a remote SFTP server. The ~dst~ argument defines the\ndestination and can be either a string, a stream object or undefined. If it is a\nstring, it is interpreted as the path to a location on the local file system\n(path should include the file name). If it is a stream object, the remote data\nis passed to it via a call to pipe(). If ~dst~ is undefined, the method will put\nthe data into a buffer and return that buffer when the Promise is resolved. If\n~dst~ is defined, it is returned when the Promise is resolved.\n\nIn general, if you're going to pass in a string as the destination, you are\nbetter off using the ~fastGet()~ method.\n\n- path :: String. Path to the remote file to download\n- dst :: String|Stream. Destination for the data. If a string, it\n should be a local file path.\n- options :: Options for the ~get()~ command (see below).\n\n**** Options\n\nThe ~options~ argument can be used to pass options to the underlying streams and\npipe call used by this method. The argument is an object with three possible\nproperties, ~readStreamOptions~, ~writeStreamOptions~ and ~pipeOptions~. The\nvalues for each of these properties should be an object containing the required\noptions. For example, possible read stream and pipe options could be defined as\n\n#+begin_src javascript\n let options = {\n readStreamOptions: {\n flags: 'r',\n encoding: null,\n handle: null,\n mode: 0o666,\n autoClose: true\n },\n pipeOptions: {\n end: false\n }};\n \n#+end_src\n\nMost of the time, you won't want to use any options. Sometimes, it may be useful\nto set the encoding. For example, to 'utf-8'. However, it is important not to do\nthis for binary files to avoid data corruption. \n\n**** Example Use\n\n#+begin_src javascript\n let client = new Client();\n\n let remotePath = '/remote/server/path/file.txt';\n let dst = fs.createWriteStream('/local/file/path/copy.txt');\n\n client.connect(config)\n .then(() => {\n return client.get(remotePath, dst);\n })\n .then(() => {\n client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n- Tip :: See examples file in the Git repository for more examples. You can pass\n any writeable stream in as the destination. For example, if you pass in\n ~zlib.createGunzip()~ writeable stream, you can both download and\n decompress a gzip file 'on the fly'.\n\n*** fastGet(remotePath, localPath, options) ===> string\n\nDownloads a file at remotePath to localPath using parallel reads for faster\nthroughput. This is the simplest method if you just want to download a file.\n\n- remotePath :: String. Path to the remote file to download\n- localPath :: String. Path on local file system for the downloaded file. The\n local path should include the filename to use for saving the\n file.\n- options :: Options for ~fastGet()~ (see below)\n\n**** Options\n\n#+begin_src javascript\n {\n concurrency: 64, // integer. Number of concurrent reads to use\n chunkSize: 32768, // integer. Size of each read in bytes\n step: function(total_transferred, chunk, total) // callback called each time a\n // chunk is transferred\n }\n#+end_src\n\n- Warning :: Some servers do not respond correctly to requests to alter chunk\n size. This can result in lost or corrupted data.\n\n**** Sample Use\n\n#+begin_src javascript\n let client = new Client();\n let remotePath = '/server/path/file.txt';\n let localPath = '/local/path/file.txt';\n\n client.connect(config)\n .then(() => {\n client.fastGet(remotePath, localPath);\n })\n .then(() => {\n client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** put(src, remotePath, options) ==> string\n\nUpload data from local system to remote server. If the ~src~ argument is a\nstring, it is interpreted as a local file path to be used for the data to\ntransfer. If the ~src~ argument is a buffer, the contents of the buffer are\ncopied to the remote file and if it is a readable stream, the contents of that\nstream are piped to the ~remotePath~ on the server.\n\n- src :: string | buffer | readable stream. Data source for data to copy to the\n remote server.\n- remotePath :: string. Path to the remote file to be created on the server.\n- options :: object. Options which can be passed to adjust the read and write stream used\n in sending the data to the remote server or the pipe call used to\n make the data transfer (see below).\n\n**** Options\n\nThe options object supports three properties, ~readStreamOptions~,\n~writeStreamOptions~ and ~pipeOptions~. The value for each property should be an\nobject with options as properties and their associated values representing the\noption value. For example, you might use the following to set ~writeStream~ options.\n\n#+begin_src javascript\n {\n writeStreamOptions: {\n flags: 'w', // w - write and a - append\n encoding: null, // use null for binary files\n mode: 0o666, // mode to use for created file (rwx)\n }}\n#+end_src\n\nThe most common options to use are mode and encoding. The values shown above are\nthe defaults. You do not have to set encoding to utf-8 for text files, null is\nfine for all file types. However, using utf-8 encoding for binary files will\noften result in data corruption.\n\nNote that you cannot set ~autoClose: false~ for ~writeStreamOptions~. If you\nattempt to set this property to false, it will be ignored. This is necessary to\navoid a race condition which may exist when setting ~autoClose~ to false on the\nwriteStream. As there is no easy way to access the writeStream once the promise\nhas been resolved, setting this to autoClose false is not terribly useful as\nthere is no easy way to manually close the stream after the promise has been\nresolved.\n\n**** Example Use\n\n#+begin_src javascript\n let client = new Client();\n\n let data = fs.createReadStream('/path/to/local/file.txt');\n let remote = '/path/to/remote/file.txt';\n\n client.connect(config)\n .then(() => {\n return client.put(data, remote);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n- Tip :: If the src argument is a path string, consider just using ~fastPut()~.\n\n*** fastPut(localPath, remotePath, options) ==> string\n\nUploads the data in file at ~localPath~ to a new file on remote server at\n~remotePath~ using concurrency. The options object allows tweaking of the fast put process.\n\n- localPath :: string. Path to local file to upload\n- remotePath :: string. Path to remote file to create\n- options :: object. Options passed to createWriteStream (see below)\n\n**** Options\n\n#+begin_src javascript\n {\n concurrency: 64, // integer. Number of concurrent reads\n chunkSize: 32768, // integer. Size of each read in bytes\n mode: 0o755, // mixed. Integer or string representing the file mode to set\n step: function(total_transferred, chunk, total) // function. Called every time\n // a part of a file was transferred\n }\n#+end_src\n\n- Warning :: There have been reports that some SFTP servers will not honour\n requests for non-default chunk sizes. This can result in data loss\n or corruption.\n\n**** Example Use\n\n#+begin_src javascript\n let localFile = '/path/to/file.txt';\n let remoteFile = '/path/to/remote/file.txt';\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n client.fastPut(localFile, remoteFile);\n })\n .then(() => {\n client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** append(input, remotePath, options) ==> string\n\nAppend the ~input~ data to an existing remote file. There is no integrity\nchecking performed apart from normal writeStream checks. This function simply\nopens a writeStream on the remote file in append mode and writes the data passed\nin to the file.\n\n- input :: buffer | readStream. Data to append to remote file\n- remotePath :: string. Path to remote file\n- options :: object. Options to pass to writeStream (see below)\n\n**** Options\n\nThe following options are supported;\n\n#+begin_src javascript\n {\n flags: 'a', // w - write and a - append\n encoding: null, // use null for binary files\n mode: 0o666, // mode to use for created file (rwx)\n autoClose: true // automatically close the write stream when finished\n }\n#+end_src\n\nThe most common options to use are mode and encoding. The values shown above are\nthe defaults. You do not have to set encoding to utf-8 for text files, null is\nfine for all file types. Generally, I would not attempt to append binary files.\n\n**** Example Use\n\n#+begin_src javascript\n let remotePath = '/path/to/remote/file.txt';\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.append(Buffer.from('Hello world'), remotePath);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** mkdir(path, recursive) ==> string\n\nCreate a new directory. If the recursive flag is set to true, the method will\ncreate any directories in the path which do not already exist. Recursive flag\ndefaults to false.\n\n- path :: string. Path to remote directory to create\n- recursive :: boolean. If true, create any missing directories in the path as\n well\n\n**** Example Use\n\n#+begin_src javascript\n let remoteDir = '/path/to/new/dir';\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.mkdir(remoteDir, true);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** rmdir(path, recursive) ==> string\n\nRemove a directory. If removing a directory and recursive flag is set to\n~true~, the specified directory and all sub-directories and files will be\ndeleted. If set to false and the directory has sub-directories or files, the\naction will fail.\n\n- path :: string. Path to remote directory\n- recursive :: boolean. If true, remove all files and directories in target\n directory. Defaults to false\n\n*Note*: There has been at least one report that some SFTP servers will allow\nnon-empty directories to be removed even without the recursive flag being set to\ntrue. While this is not standard behaviour, it is recommended that users verify\nthe behaviour of rmdir if there are plans to rely on the recursive flag to\nprevent removal of non-empty directories.\n\n**** Example Use\n\n#+begin_src javascript\n let remoteDir = '/path/to/remote/dir';\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.rmdir(remoteDir, true);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** delete(path, noErrorOK) ==> string\n\nDelete a file on the remote server.\n\n- path :: string. Path to remote file to be deleted.\n\n- noErrorOK :: boolean. If true, no error is raised when you try to delete a\n non-existent file. Default is false.\n\n**** Example Use\n\n#+begin_src javascript\n let remoteFile = '/path/to/remote/file.txt';\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.delete(remoteFile);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** rename(fromPath, toPath) ==> string\n\nRename a file or directory from ~fromPath~ to ~toPath~. You must have the\nnecessary permissions to modify the remote file.\n\n- fromPath :: string. Path to existing file to be renamed\n- toPath :: string. Path to new file existing file is to be renamed to. Should\n not already exist.\n\n**** Example Use\n\n#+begin_src javascript\n let from = '/remote/path/to/old.txt';\n let to = '/remote/path/to/new.txt';\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.rename(from, to);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** posixRename(fromPath, toPath) ==> string\n\nThis method uses the openssh POSIX rename extension introduced in OpenSSH 4.8.\nThe advantage of this version of rename over standard SFTP rename is that it is\nan atomic operation and will allow renaming a resource where the destination\nname exists. The POSIX rename will also work on some file systems which do not\nsupport standard SFTP rename because they don't support the system hardlink()\ncall. The POSIX rename extension is available on all openSSH servers from 4.8\nand some other implementations. This is an extension to the standard SFTP\nprotocol and therefore is not supported on all sftp servers.\n\n- fromPath :: string. Path to existing file to be renamed.\n- toPath :: string. Path for new name. If it already exists, it will be replaced\n by file specified in fromPath\n\n#+begin_src javascript\n let from = '/remote/path/to/old.txt';\n let to = '/remote/path/to/new.txt';\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.posixRename(from, to);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** chmod(path, mode) ==> string\n\nChange the mode (read, write or execute permissions) of a remote file or\ndirectory.\n\n- path :: string. Path to the remote file or directory\n- mode :: octal. New mode to set for the remote file or directory\n\n**** Example Use\n\n#+begin_src javascript\n let path = '/path/to/remote/file.txt';\n let newMode = 0o644; // rw-r-r\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n return client.chmod(path, newMode);\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** realPath(path) ===> string\n\nConverts a relative path to an absolute path on the remote server. This method\nis mainly used internally to resolve remote path names.\n\n*Warning*: Currently, there is a platform inconsistency with this method on\nwin32 platforms. For servers running on non-win32 platforms, providing a path\nwhich does not exist on the remote server will result in an empty e.g. '',\nabsolute path being returned. On servers running on win32 platforms, a\nnormalised path will be returned even if the path does not exist on the remote\nserver. It is therefore advised not to use this method to also verify a path\nexists. instead, use the ~exist()~ method.\n\n- path :: A file path, either relative or absolute. Can handle '.' and '..', but\n does not expand '~'.\n\n*** cwd() ==> string\n\nReturns what the server believes is the current remote working directory.\n\n*** uploadDir(srcDir, dstDir, options) ==> string\n\nUpload the directory specified by ~srcDir~ to the remote directory specified by\n~dstDir~. The ~dstDir~ will be created if necessary. Any sub directories within\n~srcDir~ will also be uploaded. Any existing files in the remote path will be\noverwritten.\n\nThe upload process also emits 'upload' events. These events are fired for each\nsuccessfully uploaded file. The ~upload~ event calls listeners with 1 argument,\nan object which has properties source and destination. The source property is\nthe path of the file uploaded and the destination property is the path to where\nthe file was uploaded. The purpose of this event is to provide some way for\nclient code to get feedback on the upload progress. You can add your own listener\nusing the ~on()~ method.\n\nThe 3rd argument is an options object with two supported properties, ~filter~ and ~useFastput~. \n\nThe ~filter~ option is a function which will be called for each item\nto be uploaded. The function will be called with two arguments. The first\nargument is the full path of the item to be uploaded and the second argument is\na boolean, which will be true if the target path is for a directory. The filter\nfunction will be called for each item in the source path. If the function\nreturns true, the item will be uploaded. If it returns false, it will be\nfiltered and not uploaded. The filter function is called via the ~Array.filter~\nmethod. These array comprehension methods are known to be unsafe for\nasynchronous functions. Therefore, only synchronous filter functions are\nsupported at this time.\n\nThe ~useFastput~ option is a boolean option. If ~true~, the method will use the\nfaster ~fastPut()~ method to upload files. Although this method is faster, it is\nnot supported by all SFTP servers. Enabling this option when unsupported by the\nremote SFTP server will result in failures.\n\n- srcDir :: A local file path specified as a string\n- dstDir :: A remote file path specified as a string\n- options :: An options object which supports two properties, ~filter~ and\n ~useFastput~. A filter predicate function which is called for each item in the\n source path. The argument will receive two arguments. The first is the full\n path to the item and the second is a boolean which will be true if the item is\n a directory. If the function returns true, the item will be uploaded,\n otherwise it will be filtered out and ignored. The ~useFastput~ option is a\n boolean option. If ~true~, the method will use the faster, but less supported,\n ~fastPut()~ method to transfer files. The default is to use the slightly slower,\n but better supported, ~put()~ method.\n \n**** Example\n\n #+begin_src javascript\n 'use strict';\n\n // Example of using the uploadDir() method to upload a directory\n // to a remote SFTP server\n\n const path = require('path');\n const SftpClient = require('../src/index');\n\n const dotenvPath = path.join(__dirname, '..', '.env');\n require('dotenv').config({path: dotenvPath});\n\n const config = {\n host: process.env.SFTP_SERVER,\n username: process.env.SFTP_USER,\n password: process.env.SFTP_PASSWORD,\n port: process.env.SFTP_PORT || 22\n };\n\n async function main() {\n const client = new SftpClient('upload-test');\n const src = path.join(__dirname, '..', 'test', 'testData', 'upload-src');\n const dst = '/home/tim/upload-test';\n\n try {\n await client.connect(config);\n client.on('upload', info => {\n console.log(`Listener: Uploaded ${info.source}`);\n });\n let rslt = await client.uploadDir(src, dst);\n return rslt;\n } catch (err) {\n console.error(err);\n } finally {\n client.end();\n }\n }\n\n main()\n .then(msg => {\n console.log(msg);\n })\n .catch(err => {\n console.log(`main error: ${err.message}`);\n });\n\n #+end_src\n\n*** downloadDir(srcDir, dstDir, options) ==> string\n\nDownload the remote directory specified by ~srcDir~ to the local file system\ndirectory specified by ~dstDir~. The ~dstDir~ directory will be created if\nrequired. All sub directories within ~srcDir~ will also be copied. Any existing\nfiles in the local path will be overwritten. No files in the local path will be\ndeleted.\n\nThe method also emits ~download~ events to provide a way to monitor download\nprogress. The download event listener is called with one argument, an object\nwith two properties, source and destination. The source property is the path to\nthe remote file that has been downloaded and the destination is the local path\nto where the file was downloaded to. You can add a listener for this event using\nthe ~on()~ method.\n\nThe ~options~ argument is an options object with two supported properties, ~filter~\nand ~useFastget~. The ~filter~ argument is a predicate function which will be called\nwith two arguments for each potential item to be downloaded. The first argument\nis the full path of the item and the second argument is a boolean, which will be\ntrue if the item is a directory. If the function returns true, the item will be\nincluded in the download. If it returns false, it will be filtered and ignored.\nThe filter function is called via the ~Array.filter~ method. These array\ncomprehension methods are known to be unsafe for asynchronous functions.\nTherefore, only synchronous filter functions are supported at this time.\n\nIf the ~useFastget~ property is set to ~true~, the method will use ~fastGet()~ to\ntransfer files. The ~fastGet~ method is faster, but not supported by all SFTP\nservices.\n\n- srcDir :: A remote file path specified as a string\n- dstDir :: A local file path specified as a string\n- options :: An object with two supported properties, ~filter~ and ~useFastget~. The\n filter property is a function accepting two arguments, the full path to an\n item and a boolean value which will be true if the item is a directory. The\n function is called for each item in the download path and should return true\n to include the item and false to exclude it in the download. The ~useFastget~\n property is a boolean. If true, the ~fastGet()~ method will be used to transfer\n files. If ~false~ (the default), the slower but better supported ~get()~ method is\n used. .\n \n**** Example\n\n#+begin_src javascript\n 'use strict';\n\n // Example of using the downloadDir() method to upload a directory\n // to a remote SFTP server\n\n const path = require('path');\n const SftpClient = require('../src/index');\n\n const dotenvPath = path.join(__dirname, '..', '.env');\n require('dotenv').config({path: dotenvPath});\n\n const config = {\n host: process.env.SFTP_SERVER,\n username: process.env.SFTP_USER,\n password: process.env.SFTP_PASSWORD,\n port: process.env.SFTP_PORT || 22\n };\n\n async function main() {\n const client = new SftpClient('upload-test');\n const dst = '/tmp';\n const src = '/home/tim/upload-test';\n\n try {\n await client.connect(config);\n client.on('download', info => {\n console.log(`Listener: Download ${info.source}`);\n });\n let rslt = await client.downloadDir(src, dst);\n return rslt;\n } finally {\n client.end();\n }\n }\n\n main()\n .then(msg => {\n console.log(msg);\n })\n .catch(err => {\n console.log(`main error: ${err.message}`);\n });\n\n#+end_src\n\n*** createReadStream(remotePath, options)) ==> stream object\n\n Returns a read stream object which is attached to the remote file specified by\n the ~remotePath~ argument. This is a low level method which just returns a read\n stream object. Client code is fully responsible for managing and releasing the\n resources associated with the stream once finished i.e. closing files,\n removing listeners etc. \n\n - remotePath :: A remote file path specified as a string\n - options :: An options object. Supported properties are \n - flags :: defaults to 'r'\n - encoding :: defaults to null\n - handle :: defaults to null\n - mode :: 0o666\n - autoClose :: defaults to true. If set to false, client code is responsible\n for closing file descriptors when finished\n - start :: Default 0. Position to start reading bytes from (inclusive)\n - end :: Position to stop reading bytes (inclusive). \n\n*** createWriteStream(remotePath, options) ==> stream object\n\n Returns a write stream object which is attached to the remote file specified\n in the ~remotePath~ argument. This is a low level function which just returns\n the stream object. Client code is fully responsible for managing that object,\n including closing any file descriptors and removing listeners etc.\n\n - remotePath :: Path to the remote file specified as a string\n - options :: An object containing stream options. Supported properties include \n - flags :: default 'w'\n - encoding :: default null\n - mode :: 0o666\n - autoClose :: true \n - start :: Byte position to start writing from (inclusive). May require\n changing flag to 'r+'.\n\n*** rcopy(srcPath, dstPath) ==> string\n\n Perform a remote file copy. The file identified by the ~srcPath~ argument will\n be copied to the file specified as the ~dstPath~ argument. The directory where\n ~dstPath~ will be placed must exist, but the actual file must not i.e. no\n overwrites allowed. \n\n - srcPath :: Path to remote file to be copied specified as a string\n - dstPath :: Path to where the copy will be created specified as a string\n\n*** end() ==> boolean\n\nEnds the current client session, releasing the client socket and associated\nresources. This function also removes all listeners associated with the client.\n\n**** Example Use\n\n#+begin_src javascript\n let client = new Client();\n\n client.connect(config)\n .then(() => {\n // do some sftp stuff\n })\n .then(() => {\n return client.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n*** Add and Remove Listeners\n\nAlthough normally not required, you can add and remove custom listeners on the\nssh2 client object. This object supports a number of events, but only a few of\nthem have any meaning in the context of SFTP. These are\n\n- error :: An error occurred. Calls listener with an error argument.\n- end :: The socket has been disconnected. No argument.\n- close :: The socket was closed. \n\n**** on(eventType, listener)\n\nAdds the specified listener to the specified event type. It the event type is\n~error~, the listener should accept 1 argument, which will be an Error object.\nThe event handlers for =end= and =close= events have no arguments.\n\nThe handlers will be added to the beginning of the listener's event handlers, so\nit will be called before any of the =ssh2-sftp-client= listeners.\n\n**** removeListener(eventType, listener)\n\nRemoves the specified listener from the event specified in eventType. Note that\nthe ~end()~ method automatically removes all listeners from the client object.\n\n* Platform Quirks & Warnings\n** Server Capabilities\n\n All SFTP servers and platforms are not equal. Some facilities provided by\n ~ssh2-sftp-client~ either depend on capabilities of the remote server or the\n underlying capabilities of the remote server platform. As an example,\n consider ~chmod()~. This command depends on a remote file system which\n implements the 'nix' concept of users and groups. The /win32/ platform does\n not have the same concept of users and groups, so ~chmod()~ will not behave\n in the same way.\n\n One way to determine whether an issue you are encountering is due to\n ~ssh2-sftp-client~ or due to the remote server or server platform is to use a\n simple CLI sftp program, such as openSSH's sftp command. If you observe the\n same behaviour using plain ~sftp~ on the command line, the issue is likely\n due to server or remote platform limitations. Note that you should not use a\n GUI sftp client, like ~Filezilla~ or ~winSCP~ as such GUI programs often\n attempt to hide these server and platform incompatibilities and will take\n additional steps to simulate missing functionality etc. You want to use a CLI\n program which does as little as possible.\n\n** Issues with ~fastPut()~ and ~fastGet()~ Methods\n\n The ~fastPut()~ and ~fastGet()~ methods are known to be somewhat dependent on\n SFTP server capabilities. Some SFTP servers just do not work correctly with\n concurrent connections and some are known to have issues with negotiating\n packet sizes. These issues can sometimes be resolved by tweaking the options\n supplied to the methods, such as setting number of concurrent connections or\n a specific packet size.\n\n To see an example of the type of issues you can observe with ~fastPut()~ or\n ~fastGet()~, have a look at [[https://github.com/theophilusx/ssh2-sftp-client/issues/407][issue 407]], which describes the experiences of one\n user. Bottom line, when it works, it tends to work well and be significantly\n faster than using just ~get()~ or ~put()~. However, when developing code to\n run against different SFTP servers, especially where you are unable to test\n against each server, you are likely better off just using ~get()~ and ~put()~\n or structuring your code so that users can select which method to use (this\n is what =ssh2-sftp-client= does - for example, see the ~!downloadDir()~ and\n ~uploadDir()~ methods.\n \n** Promises, Events & Managing Exceptions\n\n One of the challenges in providing a Promise based API over a module like\n SSH2, which is event based is how to ensure events are handled appropriately.\n The challenge is due to the synchronous nature of events. You cannot use\n =try/catch= for events because you have no way of knowing when the event\n might fire. For example, it could easily fire after your =try/catch= block as\n completed execution.\n\n Things become even more complicated once you mix in Promises. When you define\n a promise, you have to methods which can be called to fulfil a promise,\n =resolve= and =reject=. Only one can be called - once you call =resolve=, you\n cannot call =reject= (well, you can call it, but it won't have any impact on\n the fulfilment status of the promise). The problem arises when an event, for\n example an =error= event is fired either after you have resolved a promise or\n possibly in-between promises. If you don't catch the =error= event, your\n script will likely crash with an =uncaught exception= error.\n\n To make matters worse, some servers, particularly servers running on a\n Windows platform, will raise multiple errors for the same error /event/. For\n example, when you attempt to connect with a bad username or password, you\n will get a =All authentication methods have failed= exception. However, under\n Windows, you will also get a =Connection reset by peer= exception. If we\n reject the connect promise based on the authentication failure exception,\n what do we do with the =reset by peer= exception? More critically, what will\n handle that exception given the promise has already been fulfilled and\n completed? To make matters worse, it seems that Windows based servers also\n raise an error event for /non-errors/. For example, when you call the =end()=\n method, the connection is closed. On windows, this also results in a\n /connection reset by peer/ error. While it could be argued that the remote\n server resetting the connection after receiving a disconnect request is not\n an error, it doesn't change the fact that one is raised and we need to\n somehow deal with it.\n\n To handle this, =ssh2-sftp-client= implements a couple of strategies.\n Firstly, when you call one of the module's methods, it adds =error=, =end=\n and =close= event listeners which will call the =reject= method on the\n enclosing promise. It also keeps track of whether an error has been handled\n and if it has, it ignores any subsequent errors until the promise ends.\n Typically, the first error caught has the most relevant information and any\n subsequent error events are less critical or informative, so ignoring them\n has no negative impact. Provided one of the events is raised before the\n promise is fulfilled, these handlers will consume the event and deal with it\n appropriately.\n\n In testing, it was found that in some situations, particularly during connect\n operations, subsequent errors fired with a small delay. This prevents the\n errors from being handled by the event handlers associated with the connect\n promise. To deal with this, a small 500ms delay has been added to the\n connect() method, which effectively delays the removal of the event handlers\n until all events have been caught.\n\n The other area where additional events are fired is during the end() call. To\n deal with these events, the =end()= method sets up listeners which will\n simply ignore additional =error=, =end= and =close= events. It is assumed\n that once you have called =end()= you really only care about any main error\n which occurs and no longer care about other errors that may be raised as the\n connection is terminated.\n\n In addition to the promise based event handlers, =ssh2-sftp-client= also\n implements global event handlers which will catch any =error=, =end= or\n =close= events. Essentially, these global handlers only reset the =sftp=\n property of the client object, effectively ensuring any subsequent calls are\n rejected and in the case of an error, send the error to the console.\n\n*** Adding Custom Handlers\n\n While the above strategies appear to work for the majority of use cases,\n there are always going to be edge cases which require more flexible or\n powerful event handling. To support this, the =on()= and =removeListener()=\n methods are provided. Any event listener added using the =on()= method will\n be added at the beginning of the list of handlers for that event, ensuring\n it will be called before any global or promise local events. See the\n documentation for the =on()= method for details.\n \n** Windows Based Servers\n\n It appears that when the sftp server is running on Windows, a /ECONNRESET/\n error signal is raised when the end() method is called. Unfortunately, this\n signal is raised after a considerable delay. This means we cannot remove the\n error handler used in the end() promise as otherwise you will get an uncaught\n exception error. Leaving the handler in place, even though we will ignore\n this error, solves that issue, but unfortunately introduces a new problem.\n Because we are not removing the listener, if you re-use the client object for\n subsequent connections, an additional error handler will be added. If this\n happens more than 11 times, you will eventually see the Node warning about a\n possible memory leak. This is because node monitors the number of error\n handlers and if it sees more than 11 added to an object, it assumes there is\n a problem and generates the warning.\n\n The best way to avoid this issue is to not re-use client objects. Always\n generate a new sftp client object for each new connection.\n\n** Don't Re-use SftpClient Objects\n\n Due to an issue with /ECONNRESET/ error signals when connecting to Windows\n based SFTP servers, it is not possible to remove the error handler in the\n end() method. This means that if you re-use the SftpClient object for\n multiple connections e.g. calling connect(), then end(), then connect() etc,\n you run the risk of multiple error handlers being added to the SftpClient\n object. After 11 handlers have been added, Node will generate a possible\n memory leak warning.\n\n To avoid this problem, don't re-use SftpClient objects. Generate a new\n SftpClient object for each connection. You can perform multiple actions with\n a single connection e.g. upload multiple files, download multiple files etc,\n but after you have called end(), you should not try to re-use the object with\n a further connect() call. Create a new object instead.\n\n* FAQ\n\n** Remote server drops connections with only an end event\n\nMany SFTP servers have rate limiting protection which will drop connections once\na limit has been reached. In particular, openSSH has the setting ~MaxStartups~,\nwhich can be a tuple of the form =max:drop:full= where =max= is the maximum\nallowed unauthenticated connections, =drop= is a percentage value which\nspecifies percentage of connections to be dropped once =max= connections has\nbeen reached and =full= is the number of connections at which point all\nsubsequent connections will be dropped. e.g. =10:30:60= means allow up to 10\nunauthenticated connections after which drop 30% of connection attempts until\nreaching 60 unauthenticated connections, at which time, drop all attempts.\n\nClients first make an unauthenticated connection to the SFTP server to begin\nnegotiation of protocol settings (cipher, authentication method etc). If you are\ncreating multiple connections in a script, it is easy to exceed the limit,\nresulting in some connections being dropped. As SSH2 only raises an 'end' event\nfor these dropped connections, no error is detected. The ~ssh2-sftp-client~ now\nlistens for ~end~ events during the connection process and if one is detected,\nwill reject the connection promise.\n\nOne way to avoid this type of issue is to add a delay between connection\nattempts. It does not need to be a very long delay - just sufficient to permit\nthe previous connection to be authenticated. In fact, the default setting for\nopenSSH is =10:30:60=, so you really just need to have enough delay to ensure\nthat the 1st connection has completed authentication before the 11th connection\nis attempted.\n\n** How can I pass writeable stream as dst for get method?\n\nIf the dst argument passed to the get method is a writeable stream, the remote\nfile will be piped into that writeable. If the writeable you pass in is a\nwriteable stream created with ~fs.createWriteStream()~, the data will be written\nto the file specified in the constructor call to ~createWriteStream()~.\n\nThe writeable stream can be any type of write stream. For example, the below code\nwill convert all the characters in the remote file to upper case before it is\nsaved to the local file system. This could just as easily be something like a\ngunzip stream from ~zlib~, enabling you to decompress remote zipped files as you\nbring them across before saving to local file system.\n\n#+begin_src javascript\n 'use strict';\n\n // Example of using a writeable with get to retrieve a file.\n // This code will read the remote file, convert all characters to upper case\n // and then save it to a local file\n\n const Client = require('../src/index.js');\n const path = require('path');\n const fs = require('fs');\n const through = require('through2');\n\n const config = {\n host: 'arch-vbox',\n port: 22,\n username: 'tim',\n password: 'xxxx'\n };\n\n const sftp = new Client();\n const remoteDir = '/home/tim/testServer';\n\n function toupper() {\n return through(function(buf, enc, next) {\n next(null, buf.toString().toUpperCase());\n });\n }\n\n sftp\n .connect(config)\n .then(() => {\n return sftp.list(remoteDir);\n })\n .then(data => {\n // list of files in testServer\n console.dir(data);\n let remoteFile = path.join(remoteDir, 'test.txt');\n let upperWtr = toupper();\n let fileWtr = fs.createWriteStream(path.join(__dirname, 'loud-text.txt'));\n upperWtr.pipe(fileWtr);\n return sftp.get(remoteFile, upperWtr);\n })\n .then(() => {\n return sftp.end();\n })\n .catch(err => {\n console.error(err.message);\n });\n#+end_src\n\n** How can I upload files without having to specify a password?\n\nThere are a couple of ways to do this. Essentially, you want to setup SSH keys\nand use these for authentication to the remote server.\n\nOne solution, provided by @KalleVuorjoki is to use the SSH agent\nprocess. *Note*: SSH_AUTH_SOCK is normally created by your OS when you load the\nssh-agent as part of the login session.\n\n#+begin_src javascript\n let sftp = new Client();\n sftp.connect({\n host: 'YOUR-HOST',\n port: 'YOUR-PORT',\n username: 'YOUR-USERNAME',\n agent: process.env.SSH_AUTH_SOCK\n }).then(() => {\n sftp.fastPut(/* ... */)\n }\n#+end_src\n\nAnother alternative is to just pass in the SSH key directly as part of the\nconfiguration.\n\n#+begin_src javascript\n let sftp = new Client();\n sftp.connect({\n host: 'YOUR-HOST',\n port: 'YOUR-PORT',\n username: 'YOUR-USERNAME',\n privateKey: fs.readFileSync('/path/to/ssh/key')\n }).then(() => {\n sftp.fastPut(/* ... */)\n }\n#+end_src\n\n** How can I connect through a Socks Proxy\n\nThis solution was provided by @jmorino.\n\n#+begin_src javascript\n import { SocksClient } from 'socks';\n import SFTPClient from 'ssh2-sftp-client';\n\n const host = 'my-sftp-server.net';\n const port = 22; // default SSH/SFTP port on remote server\n\n // connect to SOCKS 5 proxy\n const { socks } = await SocksClient.createConnection({\n proxy: {\n host: 'my.proxy', // proxy hostname\n port: 1080, // proxy port\n type: 5, // for SOCKS v5\n },\n command: 'connect',\n destination: { host, port } // the remote SFTP server\n });\n\n const client = new SFTPClient();\n client.connect({\n host,\n sock: socks.socket, // pass the socket to proxy here (see ssh2 doc)\n username: '.....',\n privateKey: '.....'\n })\n\n // client is connected\n#+end_src\n\n** Timeout while waiting for handshake or handshake errors\n\nSome users have encountered the error 'Timeout while waiting for handshake' or\n'Handshake failed, no matching client->server ciphers. This is often due to the\nclient not having the correct configuration for the transport layer algorithms\nused by ssh2. One of the connect options provided by the ssh2 module is\n~algorithm~, which is an object that allows you to explicitly set the key\nexchange, ciphers, hmac and compression algorithms as well as server\nhost key used to establish the initial secure connection. See the SSH2\ndocumentation for details. Getting these parameters correct usually resolves the\nissue.\n\nWhen encountering this type of problem, one worthwhile approach is to use\nopenSSH's CLI sftp program with the =-v= switch to raise logging levels. This\nwill show you what algorithms the CLI is using. You can then use this\ninformation to match the names with the accepted algorithm names documented in\nthe =ssh2= README to set the properties in the =algorithms= object.\n\n** How can I limit upload/download speed\n\n If you want to limit the amount of bandwidth used during upload/download of\n data, you can use a stream to limit throughput. The following example was\n provided by /kennylbj/. Note that there is a caveat that we must set the\n ~autoClose~ flag to false to avoid calling an extra ~_read()~ on a closed stream\n that may cause _get Permission Denied error in ssh2-streams.\n\n\n #+begin_src javascript\n\n\n const Throttle = require('throttle');\n const progress = require('progress-stream');\n\n // limit download speed\n const throttleStream = new Throttle(config.throttle);\n\n // download progress stream\n const progressStream = progress({\n length: fileSize,\n time: 500,\n });\n progressStream.on('progress', (progress) => {\n console.log(progress.percentage.toFixed(2));\n });\n\n const outStream = createWriteStream(localPath);\n\n // pipe streams together\n throttleStream.pipe(progressStream).pipe(outStream);\n\n try {\n // set autoClose to false\n await client.get(remotePath, throttleStream, { autoClose: false });\n } catch (e) {\n console.log('sftp error', e);\n } finally {\n await client.end();\n }\n #+end_src\n** Connection hangs or fails for larger files\n\n This was contributed by Ladislav Jacho. Thanks. \n\n A symptom of this issue is that you are able to upload small files, but\n uploading larger ones fail. You probably have an MTU/fragmentation problem. For\n each network interface on both client and server set the MTU to 576, e.g.\n =ifconfig eth0 mtu 576=. If that works, you need to find the largest MTU which\n will work for your network. An MTU which is too small will adversely affect\n throughput speed. A common value to use is an MTU of 1400.\n \n For more explanation, see [[https://github.com/theophilusx/ssh2-sftp-client/issues/342][issue #342]].\n \n* Examples\n\nI have started collecting example scripts in the example directory of the\nrepository. These are mainly scripts I have put together in order to investigate\nissues or provide samples for users. They are not robust, lack adequate error\nhandling and may contain errors. However, I think they are still useful for\nhelping developers see how the module and API can be used.\n\n* Troubleshooting\n\nThe ~ssh2-sftp-client~ module is essentially a wrapper around the ~ssh2~ and\n~ssh2-streams~ modules, providing a higher level ~promise~ based API. When you\nrun into issues, it is important to try and determine where the issue lies -\neither in the ssh2-sftp-client module or the underlying ~ssh2~ and\n~ssh2-streams~ modules. One way to do this is to first identify a minimal\nreproducible example which reproduces the issue. Once you have that, try to\nreplicate the functionality just using the ~ssh2~ and ~ssh2-streams~ modules. If\nthe issue still occurs, then you can be fairly confident it is something related\nto those later 2 modules and therefore and issue which should be referred to the\nmaintainer of that module.\n\nThe ~ssh2~ and ~ssh2-streams~ modules are very solid, high quality modules with\na large user base. Most of the time, issues with those modules are due to client\nmisconfiguration. It is therefore very important when trying to diagnose an\nissue to also check the documentation for both ~ssh2~ and ~ssh2-streams~. While\nthese modules have good defaults, the flexibility of the ssh2 protocol means\nthat not all options are available by default. You may need to tweak the\nconnection options, ssh2 algorithms and ciphers etc for some remote servers. The\ndocumentation for both the ~ssh2~ and ~ssh2-streams~ module is quite\ncomprehensive and there is lots of valuable information in the issue logs.\n\nIf you run into an issue which is not repeatable with just the ~ssh2~ and\n~ssh2-streams~ modules, then please log an issue against the ~ssh2-sftp-client~\nmodule and I will investigate. Please note the next section on logging issues.\n\nNote also that in the repository there are two useful directories. The first is\nthe examples directory, which contain some examples of using ~ssh2-sftp-client~\nto perform common tasks. A few minutes reviewing these examples can provide that\nadditional bit of detail to help fix any problems you are encountering.\n\nThe second directory is the validation directory. I have some very simple\nscripts in this directory which perform basic tasks using only the ~ssh2~\nmodules (no ~ssh2-sftp-client~ module). These can be useful when\ntrying to determine if the issue is with the underlying ~ssh2~ module or\nthe ~ssh2-sftp-client~ wrapper module.\n\n** Common Errors\n\n There are some common errors people tend to make when using Promises or\n Async/Await. These are by far the most common problem found in issues logged\n against this module. Please check for some of these before logging your\n issue.\n\n*** Not returning the promise in a ~then()~ block\n\n All methods in ~ssh2-sftp-client~ return a Promise. This means methods are\n executed /asynchrnously/. When you call a method inside the ~then()~ block\n of a promise chain, it is critical that you return the Promise that call\n generates. Failing to do this will result in the ~then()~ block completing\n and your code starting execution of the next ~then()~, ~catch()~ or\n ~finally()~ block before your promise has been fulfilled. For example, the\n following will not do what you expect\n\n #+begin_src javascript\n sftp.connect(config)\n .then(() => {\n sftp.fastGet('foo.txt', 'bar.txt');\n }).then(rslt => {\n console.log(rslt);\n sftp.end();\n }).catch(e => {\n console.error(e.message);\n });\n #+end_src\n\n In the above code, the ~sftp.end()~ method will almost certainly be called\n before ~sftp.fastGet()~ has been fulfilled (unless the /foo.txt/ file is\n really small!). In fact, the whole promise chain will complete and exit even\n before the ~sftp.end()~ call has been fulfilled. The correct code would be\n something like\n\n #+begin_src javascript\n sftp.connect(config)\n .then(() => {\n return sftp.fastGet('foo.txt', 'bar.txt');\n }).then(rslt => {\n console.log(rslt);\n return sftp.end();\n }).catch(e => {\n console.error(e.message);\n });\n #+end_src\n\n Note the ~return~ statements. These ensure that the Promise returned by the\n client method is returned into the promise chain. It will be this promise\n the next block in the chain will wait on to be fulfilled before the next\n block is executed. Without the return statement, that block will return the\n default promise for that block, which essentially says /this block has been\n fulfilled/. What you really want is the promise which says /your sftp client\n method call has been fulfilled/.\n\n A common symptom of this type of error is for file uploads or download to\n fail to complete or for data in those files to be truncated. What is\n happening is that the connection is being ended before the transfer has\n completed.\n\n*** Mixing Promise Chains and Async/Await\n\n Another common error is to mix Promise chains and async/await calls. This is\n rarely a great idea. While you can do this, it tends to create complicated\n and difficult to maintain code. Select one approach and stick with it. Both\n approaches are functionally equivalent, so there is no reason to mix up the\n two paradigms. My personal preference would be to use async/await as I think\n that is more /natural/ for most developers. For example, the following is\n more complex and difficult to follow than necessary (and has a bug!)\n\n #+begin_src javascript\n sftp.connect(config)\n .then(() => {\n return sftp.cwd();\n }).then(async (d) => {\n console.log(`Remote directory is ${d}`);\n try {\n await sftp.fastGet(`${d}/foo.txt`, `./bar.txt`);\n }.catch(e => {\n console.error(e.message);\n });\n }).catch(e => {\n console.error(e.message);\n }).finally(() => {\n sftp.end();\n });\n #+end_src\n\n The main bug in the above code is the ~then()~ block is not returning the\n Promise generated by the call to ~sftp.fastGet()~. What it is actually\n returning is a fulfilled promise which says the ~then()~ block has been run\n (note that the await'ed promise is not being returned and is therefore\n outside the main Promise chain). As a result, the ~finally()~ block will be\n executed before the await promise has been fulfilled.\n\n Using async/await inside the promise chain has created unnecessary\n complexity and leads to incorrect assumptions regarding how the code will\n execute. A quick glance at the code is likely to give the impression that\n execution will wait for the ~sftp.fastGet()~ call to be fulfilled before\n continuing. This is not the case. The code would be more clearly expressed\n as either\n\n #+begin_src javascript\n sftp.connect(config)\n .then(() => {\n return sftp.cwd();\n }).then(d => {\n console.log(`remote dir ${d}`);\n return sftp.fastGet(`${d}/foot.txt`, 'bar.txt');\n }).catch(e => {\n console.error(e.message);\n }).finally(() => {\n return sftp.end();\n });\n #+end_src\n\n *or, using async/await*\n\n #+begin_src javascript\n async function doSftp() {\n try {\n let sftp = await sftp.connect(conf);\n let d = await sftp.cwd();\n console.log(`remote dir is ${d}`);\n await sftp.fastGet(`${d}/foo.txt`, 'bat.txt');\n } catch (e) {\n console.error(e.message);\n } finally {\n await sftp.end();\n }\n }\n #+end_src\n\n*** Try/catch and Error Handlers\n\n Another common error is to try and use a try/catch block to catch event\n signals, such as an error event. In general, you cannot use try/catch blocks\n for asynchronous code and expect errors to be caught by the ~catch~ block.\n Handling errors in asynchronous code is one of the key reasons we now have\n the Promise and async/await frameworks.\n\n The basic problem is that the try/catch block will have completed execution\n before the asynchronous code has completed. If the asynchronous code has not\n completed, then there is a potential for it to raise an error. However, as\n the try/catch block has already completed, there is no /catch/ waiting to\n catch the error. It will bubble up and probably result in your script\n exiting with an uncaught exception error.\n\n Error events are essentially asynchronous code. You don't know when such\n events will fire. Therefore, you cannot use a try/catch block to catch such\n event errors. Even creating an error handler which then throws an exception\n won't help as the key problem is that your try/catch block has already\n executed. There are a number of alternative ways to deal with this\n situation. However, the key symptom is that you see occasional uncaught\n error exceptions that cause your script to exit abnormally despite having\n try/catch blocks in your script. What you need to do is look at your code\n and find where errors are raised asynchronously and use an event handler or\n some other mechanism to manage any errors raised.\n\n*** Server Differences\n\n Not all SFTP servers are the same. Like most standards, the SFTP protocol\n has some level of interpretation and allows different levels of compliance.\n This means there can be differences in behaviour between different servers\n and code which works with one server will not work the same with another.\n For example, the value returned by /realpath/ for non-existent objects can\n differ significantly. Some servers will throw an error for a particular\n operation while others will just return null, some servers support\n concurrent operations (such as used by fastGet/fastPut) while others will\n not and of course, the text of error messages can vary significantly. In\n particular, we have noticed significant differences across different\n platforms. It is therefore advisable to do comprehensive testing when the\n SFTP server is moved to a new platform. This includes moving from to a cloud\n based service even if the underlying platform remains the same. I have\n noticed that some cloud platforms can generate unexpected events, possibly\n related to additional functionality or features associated with the cloud\n implementation. For example, it appears SFTP servers running under Azure\n will generate an error event when the connection is closed even when the\n client has requested the connection be terminated. The same SFTP server\n running natively on Windows does not appear to exhibit such behaviour.\n\n*** Avoid Concurrent Operations\n\n Technically, SFTP should be able to perform multiple operations\n concurrently. As node is single threaded, what we a really talking about is\n running multiple execution contexts as a pool where node will switch\n contexts when each context is blocked due to things like waiting on network\n data etc. However, I have found this to be extremely unreliable and of very\n little benefit from a performance perspective. My recommendation is to\n therefore avoid executing multiple requests over the same connection in\n parallel (for example, generating multiple ~get()~ promises and using\n something like ~Promise.all()~ to resolve them.\n\n If you are going to try and perform concurrent operations, you need to test\n extensively and ensure you are using data which is large enough that context\n switching does occur (i.e. the request is not completed in a single run).\n Some SFTP servers will handle concurrent operations better than others.\n\n** Debugging Support\n\nYou can add a ~debug~ property to the config object passed in to ~connect()~ to\nturn on debugging. This will generate quite a lot of output. The value of the\nproperty should be a function which accepts a single string argument. For example;\n\n#+begin_src javascript\n config.debug = msg => {\n console.error(msg);\n };\n\n#+end_src\n\nEnabling debugging can generate a lot of output. If you use console.error() as\nthe output (as in the example above), you can redirect the output to a file\nusing shell redirection e.g.\n\n#+begin_src shell\n node script.js 2> debug.log\n\n#+end_src\n\nIf you just want to see debug messages from ~ssh2-sftp-client~ and exclude debug\nmessages from the underlying ~ssh2~ and ~ssh2-streams~ modules, you can filter\nbased on messages which start with 'CLIENT' e.g.\n\n#+begin_src javascript\n {\n debug: (msg) => {\n if (msg.startsWith('CLIENT')) {\n console.error(msg);\n }\n }\n }\n#+end_src\n* Logging Issues\n\nPlease log an issue for all bugs, questions, feature and enhancement\nrequests. Please ensure you include the module version, node version and\nplatform.\n\nI am happy to try and help diagnose and fix any issues you encounter while using\nthe ~ssh2-sftp-client~ module. However, I will only put in effort if you are\nprepared to put in the effort to provide the information necessary to reproduce\nthe issue. Things which will help\n\n- Node version you are using\n- Version of ssh2-sftp-client you are using\n- Platform your client is running on (Linux, macOS, Windows)\n- Platform and software for the remote SFTP server when possible\n- Example of your code or a minimal script which reproduces the issue you are\n encountering. By far, the most common issue is incorrect use of the module\n API. Example code can usually result in such issues being resolved very\n quickly.\n\nPerhaps the best assistance is a minimal reproducible example of the issue. Once\nthe issue can be readily reproduced, it can usually be fixed very quickly.\n\n* Pull Requests \n\nPull requests are always welcomed. However, please ensure your changes pass all\ntests and if you're adding a new feature, that tests for that feature are\nincluded. Likewise, for new features or enhancements, please include any\nrelevant documentation updates.\n\n*Note*: The =README.md= file is generated from the =README.org= file. Therefore,\nany documentation updates or fixes need to be made to the =README.org= file.\nThis file is /tangled/ using =Emacs= org mode. If you don't use Emacs or\norg-mode, don't be too concerned. The org-mode syntax is straight-forward and\nsimilar to /markdown/. I will verify any updates to =README.org= and generate a\nnew =README.md= when necessary. The main point to note is that any changes made\ndirectly to =README.md= will not persist and will be lost when a new version is\ngenerated, so don't modify that file. \n\nThis module will adopt a standard semantic versioning policy. Please indicate in\nyour pull request what level of change it represents i.e.\n\n- Major :: Change to API or major change in functionality which will require an\n increase in major version number.\n- Minor :: Minor change, enhancement or new feature which does not change\n existing API and will not break existing client code.\n- Bug Fix :: No change to functionality or features. Simple fix of an existing\n bug.\n\n* Contributors\n\nThis module was initially written by jyu213. On August 23rd, 2019, theophilusx\ntook over responsibility for maintaining this module. A number of other people\nhave contributed to this module, but until now, this was not tracked. My\nintention is to credit anyone who contributes going forward.\n\nThanks to the following for their contributions -\n\n- jyu213 :: Original author\n- theophilusx :: Current maintainer\n- henrytk :: Documentation fix\n- waldyrious :: Documentation fixes\n- james-pellow :: Cleanup and fix for connect method logic\n- jhorbulyk :: Contributed posixRename() functionality\n- teenangst :: Contributed fix for error code 4 in stat() method\n- kennylbj :: Contributed example of using a throttle stream to limit\n upload/download bandwidth.\n- anton-erofeev :: Documentation fix\n- Ladislav Jacho :: Contributed solution explanation for connections hanging\n when transferring larger files.\n- Emma Milner :: Contributed fix for put() bug\n- Witni Davis :: Contributed PR to fix put() RCE when using 'finish' rather than\n 'close' to resolve promise\n- Maik Marschner :: Contributed fix for connect() not returning sftp object.\n Also included test to check for this regression in future.\n- cakemasher :: Contributed fix for removeTempListeners().\n \n", "readme_type": "text", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "nodkz/conf-talks", "link": "https://github.com/nodkz/conf-talks", "tags": ["graphql"], "stars": 672, "description": "GraphQL \u043d\u0430 \u0440\u0443\u0441\u0441\u043a\u043e\u043c \u2014 \u0437\u0434\u0435\u0441\u044c \u043c\u043d\u043e\u0433\u043e \u0441\u0442\u0430\u0442\u0435\u0439 \u0438 \u0432\u0438\u0434\u0435\u043e \u043e\u0431 \u044d\u0442\u043e\u0439 \u0437\u0430\u043c\u0435\u0447\u0430\u0442\u0435\u043b\u044c\u043d\u043e\u0439 \u0442\u0435\u0445\u043d\u043e\u043b\u043e\u0433\u0438\u0438.", "lang": "JavaScript", "repo_lang": "", "readme": "# In this turnip, my articles and presentations about GraphQL\n\nPS. A bunch of spelling and grammatical errors is the norm for me. I warned you, so stay strong. But you can help correct the mistake - click the \"Edit\" button and send a Pull Request with edits. Thank you.\n\n## Articles\n\n### GraphQL\n\n- [GraphQL types](./articles/graphql/types)\n- [GraphQL schema](./articles/graphql/schema)\n- [Ways to build GraphQL schemas](./articles/graphql/schema-build-ways)\n- [GraphQL server](./articles/graphql/server)\n- [Authentication and Authorization](./articles/graphql/auth)\n- [Working with files](./articles/graphql/fileUploads)\n- [i18n - internationalization in GraphQL](./articles/graphql/i18n)\n- [How to deal with errors in GraphQL?](./articles/graphql/errors)\n- [DataLoader - correctly solve the problem of N + 1 requests] (./articles/graphql/dataloader)\n- **PRO:** [GraphQL schema design - making API convenient, avoiding pain and suffering](./articles/graphql/schema-design) \ud83c\udf36\ud83c\udf36\ud83c\udf36\n- [GraphQL on frontend](./articles/graphql/clients)\n- [Why does graphql have a problem with N+1](./articles/graphql/dataloader/N+1.md)\n- [What is Node Interface?](./articles/graphql/schema-design/NodeInterface.md)\n\n### Other\n\n- [GraphQL or No-GraphQL [EN] - a good article about the pros and cons of GraphQL](https://levelup.gitconnected.com/graphql-or-no-graphql-395c80edc3d)\n- [Swagger - last century](./articles/swagger)\n- [Redux - boilerplate](./articles/redux)\n- [Difference in `graphql-compose` and `Prisma` approaches](./articles/graphql-compose/graphql-compose-vs-prisma.md)\n\n## Upcoming performances (planned)\n\n- April 18, 2022, Online, [HolyJS](https://holyjs.ru/en/)\n## Past events\n\n- November 2, 2021, Online, [HolyJS](https://holyjs-moscow.ru/en/)\n- September 25, 2021, Online, [404fest](https://2021.404fest.ru/)\n- July 12, 2021, Online, [Podlodka Frontend Crew, season #2](https://podlodka.io/)\n- April 20-23, 2021, Online, [HolyJS](https://holyjs-piter.ru/2021/spb/talks/2p1h40vvmegpfqutj8ji4h/)\n- April 4, 2021, Online, [Podlodka Backend Crew Season #1](https://podlodka.io/)\n- 2November 5-28, 2020, Online, [HolyJS](https://holyjs-moscow.ru/2020/msk/talks/5xx2i0vcleyeatztadt6ap/)\n- June 24, 2020, St. Petersburg, [HolyJS online](https://holyjs-piter.ru/2020/spb/talks/26ewxf0eetneqysa49i6sh/)\n- May 19, 2020, Online, [Hard morning with HolyJS #2](https://www.youtube.com/watch?v=ZIE2_c6MRZ0)\n- February 29, 2020, Moscow, [Ya\u2764\ufe0fFrontend](https://yandex.ru/promo/yandex4developers/yalovefrontend2020#form)\n- December 7, 2019, Krasnodar, [GDG Krasnodar DevFest 2019](https://www.meetup.com/gdgkrasnodar/events/264023548/)\n- November 8-9, 2019, Moscow, [HolyJS](https://holyjs-moscow.ru/people/5sspmntbo4kaeioeywg86m/)\n- October 5-6, 2019, Kharkiv, [KharkivJS](https://kharkivjs.org/) \n- August 24, St. Petersburg, [TechTrain](https://techtrain.ru/2019/talks/16mjji8u09ybzcd9ecpgna/)\n- June 29, 2019, Almaty, [AlmatyJS](https://almatyjs.timepad.ru/event/996360/)\n- June 15, 2019, Nur-Sultan, [AstanaJS](https://astanajs.timepad.ru/event/978851/)\n- May 28, 2019, Moscow, Skolkovo, [BackendConf (RIT++)](https://backendconf.ru/moscow-rit/2019/abstracts/4874)\n- May 27, 2019, Moscow, Skolkovo, [FrontendConf (RIT++)](https://frontendconf.ru/moscow-rit/2019/abstracts/5127)\n- May 24, 2019, St. Petersburg, [HolyJS](https://holyjs-piter.ru/talks/5aijmcmhxyojks5vdbf5ct/)\n- May 12, 2019, Kyiv, [YouTube stream recording: Dawn of GraphQL](https://youtu.be/jd3BpKv7LZ8), Zlit Tech, InLight Studio\n- May 11, 2019, Kyiv, Workshop [Apollo-client with fragments and static analysis](https://zlit.events/dawn-of-the-graphql/the-first-flight-of-apollo), Wix Office ([ photo](https://photos.app.goo.gl/uYY1Fn6qoTMyqaA57)\n- March 23, 2019, Minsk, [workshop in the SPACE event space](https://vk.com/@-178787432-varim-graphql-klient-so-staticheskim-analizom) ([photo](https://www .facebook.com/pg/MinskJS/photos/?tab=album&album_id=2017956155174105\n), [repo](https://github.com/nodkz/graphql-workshop-by))\n- February 16, 2019, Nizhny Novgorod, [GraphQL meetup](https://career.orioninc.ru/meetups/b01da9a8-898b-421b-8b43-7d27a827ff66) from Mera.ru\n- January 26, 2019, St. Petersburg, [GraphQL workshop](https://graphql-course.ru/) \u2013 server, client and static analysis ([repo](https://github.com/nodkz/graphql-workshop -ru))\n- January 24, 2019, St. Petersburg, [GraphQL meetup](https://habr.com/ru/company/wrike/blog/438124/) in Wrike\n- November 27, 2018, Moscow, [Moscow GraphQL Meetup](https://habr.com/en/post/430626/)\n- November 24, 2018, Moscow, [HolyJS 2018](https://2018.holyjs-moscow.ru/talks/5ulreiooe80eao6qwwkyyi/)\n\n## Video of my performances\n\n### Which projects should use GraphQL and which should not?, July 12, 2021, Podlodka Frontend Crew, season #2\n\nGraphQL is a tool, not a silver bullet. And each tool is convenient for its category of tasks.\n\nGraphQL is needed if:\n- models are constantly evolving and the number of fields is growing;\n- there is an interaction between the backend and the frontend, which is supposed to have a state manager;\n- you need static typing on the frontend according to the server data scheme;\n- if there are many different entities (models), there are many connections between them and the client needs their aggregation (a la LEFT JOIN) and preferably in one http request.\n\nGraphQL is not needed if:\n- work is being done with files or other binary data;\n- authentication, oidc and/or oauth2;\n- CRDT and multi-user editing;\n- there is an active server-to-server communication that is demanding on speed, memory and/or traffic.\n\nDuration 92 minutes.\n\n![\"Which](\"https://img.youtube.com/vi/O8a6DJxA4Q4/0.jpg\")
\n\n### Round table: Protocol features, April 4, 2021, Podlodka Backend Crew, season #1\n\nWe discuss the applicability of the JSON-RPC, GraphQL, gRPC protocols. Their strengths and weaknesses.\n\nDuration 87 minutes.\n\n![\"Roundtable:](\"https://img.youtube.com/vi/HMTIUQPAbRs/0.jpg\")
\n\n### Roarmicrofrontend integration, module federation, Webpack 5, HolyJS 2020, Online\n\nI'm talking about module federation in Webpack 5, about a new technology for the microfrontend industry. It allows you to import into your application any external module / component from somewhere on another server deployed separately assembled by webpack application. In simple words, for business, different teams develop pieces of applications and deploy them separately, and the final assembly of the application takes place in the user's browser.\n[Link to presentation](http://bit.ly/module-federation).\n\nDuration 73 minutes.\n\n![\"Revolution](\"https://img.youtube.com/vi/pcY8-pDGLkI/0.jpg\")
\n\n### Wrapping an existing REST API in GraphQL (methodology for 1000000 rubles), HolyJS 2020, Online\n\nIs it really possible to wrap the REST API in GraphQL? And how to do R&D for this technology? Usually it is customary to run a technology on TodoMVC - I did just that. In the report, I analyzed Entity, relations between types (drawn an analogy with LEFT JOIN), solved the problems of N + 1, QueryCost and Authentication. And I calculated how long it would take to develop such a GraphQL proxy.\n[Link to presentation](http://bit.ly/rest2graphql).\n\nDuration 74 minutes.\n\n![\"Wrapping](\"https://img.youtube.com/vi/RDBEfvZT1yQ/0.jpg\")
\n\n### ApolloClient 3 - say goodbye to Redux, REST API and Relay (I \ud83d\udc9b Frontend 2020, Moscow 2020)\n\nThe report deals with the current sores of the REST API and Redux; how with GraphQL the Developer Experience for developers rises to a completely new level; what's new and good in ApolloClient 3.\n[Link to presentation](http://bit.ly/apollo-client-3).\n\nDuration 49 minutes.\n\n![\"ApolloClient](\"https://user-images.githubusercontent.com/1946920/77333244-57baf100-6d4d-11ea-8190-4c5397d94d32.png\")
\n\n### GraphQL and how the academic environment idolizes it (HolyJS Moscow 2019)\n\n\u201cgrey\u201d scientific papers began to appear in the academic environment, which painfully describe the possibilities of GraphQL: \"We'll show that GraphQL can reduce the size of the JSON documents returned by REST APIs in 94% (in number of fields) and in 99 % (in number of bytes), both median results\". GraphQL is certainly good, but not that good. [Link to presentation](http://bit.ly/fragment-model#/10).\n\nDuration 11 minutes.\n\n![\"GraphQL](\"https://img.youtube.com/vi/1L7tGvtCzPY/0.jpg\")
\n\n### GraphQL fragments on the client: History of appearance, usage errors (HolyJS Moscow 2019)\n\nThe report will discuss the following approaches: JSON Models (hard manual labor), Type Models (similar to generating models from Swagger), Response Models (ApolloClient approach), Fragment Models (Relay approach). The speaker will also share common front-end mistakes that are made when working with GraphQL fragments. [Link to presentation](http://bit.ly/fragment-model). Feedback (chart , reviews).\n\nDuration 60 minutes.\n\n![\"GraphQL](\"https://img.youtube.com/vi/0bpZiMVJh14/0.jpg\")
\n\n### GraphQL: fragment model on the client (KharkivJSx10)\n\nThe GraphQL query language hascomfort fragments, but not everyone understands why exactly they are needed. Facebook works with GraphQL on clients with the so-called fragment model, which helps to scale and prevent errors even at the development stage. What kind of animal is this, we will figure it out together. [Link to presentation](http://bit.ly/graphql-fragment-model).\n\nDuration 57 minutes.\n\n![\"GraphQL:](\"https://img.youtube.com/vi/RQR_6NW_xvo/0.jpg\")
\n\n### Forming a picture of the GraphQL world (TechTrain 2019)\n\nThe report is aimed at beginners and skeptics, both back-enders and front-enders. I describe and show what GraphQL is in simple words. I tell you what parts the GraphQL server consists of. What is he responsible for, and what will the backender have to implement on its own. I show several ways how you can request data from a GraphQL server. I tell you why we need fancy GraphQL clients. How they allow you to generate GraphQL queries at the development stage without errors. How they allow you to send requests to the server, cache responses and work with data. [Link to presentation](http://bit.ly/techtrain-graphql).\n\nDuration 45 minutes.\n\n![\"Generating](\"https://img.youtube.com/vi/kMARjBBe4FM/0.jpg\")
\n\n### GraphQL Schema Design - Building Schemas Correctly (Version 2) (Backend Conf 2019, RIT++)\n\nGraphQL schema can turn into a headache and a lot of additional code for developers. Therefore, the more convenient the scheme, the faster, easier and with fewer errors your client applications will be developed. [These rules](https://github.com/nodkz/conf-talks/tree/master/articles/graphql/schema-design) allow you to develop a convention for your backend developers. [Link to presentation](http://bit.ly/rit-graphql-design).\n\nDuration 49 minutes.\n\n![\"GraphQL](\"https://img.youtube.com/vi/tASEYJXdO_c/0.jpg\")
\n\n### ApolloClient or Relay with fragments, hairy GraphQL (HolyJS Piter 2019)\n\nComparing architecture of ApolloClient and Relay. I analyze the fragmented approach, in which requests are collected from the bottom up. I explain that a good GraphQL is a \u201chairy\u201d GraphQL that has many connections. And if there are few connections, then this is already RestQL and it is almost impossible to use a fragment approach with it. [Link to presentation](http://bit.ly/piter-graphql-client).\n\nPerformance feedback: chart, reviews.\n\nDuration 58 minutes.\n\n![\"ApolloClient](\"https://img.youtube.com/vi/VdoPraj0QqU/0.jpg\")
\n\n### 5 approaches to building GraphQL schemas (Kyiv 2019, Zlit Tech)\n\nLet's analyze what a GraphQL server is and what parts it consists of. Let's dwell on the description of the GraphQL schema. Consider 5 approaches to building schemas using: graphql, graphql-tools, graphql-compose, type-graphql, nexus. Let's compare the approaches with each other, understand the strengths and weaknesses of each of them. [Article and code](https://github.com/nodkz/conf-talks/tree/master/articles/graphql/schema-build-ways) allows you to develop a convention for your backend developers. [Link to presentation](http://bit.ly/kyiv-graphql).\n\nDuration 49 minutes.\n\n![\"5](\"https://img.youtube.com/vi/RmGxUfmksck/0.jpg\")
\n\n### Designand GraphQL schema design patterns (Piter GraphQL Meetup 2019, Wrike)\n\nI talk about the rules that must be used when building GraphQL schemas. I explain the situations in which they allow you to avoid reworking the circuits in the future. [These rules](https://github.com/nodkz/conf-talks/tree/master/articles/graphql/schema-design) allow you to develop a convention for your backend developers. [Link to presentation](http://bit.ly/piter-graphql-meetup).\n\nDuration 52 minutes.\n\n![\"GraphQL](\"https://img.youtube.com/vi/nkv0eDE5FbA/0.jpg\")
\n\n### Building a GraphQL server (HolyJS Moscow 2018)\n\nI\u2019m talking about what packages the GraphQL server consists of, what ways to build a schema in NodeJS exist in 2018. I analyze in detail how to organize Authorizations and how to use the DataLoader correctly (to solve the N + 1 Problem). The report was well appreciated (chart< /a>, reviews ), because it touches and covers the most basic problems of GraphQL. [Link to presentation](http://bit.ly/holy-graphql).\n\n![\"Building](\"https://img.youtube.com/vi/NnnvOPdstzg/0.jpg\")
\n\n### How to deal with errors in GraphQL (GraphQL Moscow Meetup at Rambler 2018)\n\nI tell you in detail about how to work with errors in GraphQL. And how can you wind up Union-types in order to return custom errors. The video starts at 28 minutes.\n\n![\"GraphQL](\"https://img.youtube.com/vi/F4vHSHzpO1g/0.jpg\")
\n\n### React, Relay and GraphQL are quite a normal component approach (FrontTalks, Yekaterinburg 2016)\n\nIntroduction to GraphQL, component approach and Relay.\n\n![\"React,](\"https://img.youtube.com/vi/jrJQ2B027Xk/0.jpg\")
\n\n### Backend, Frontend - everything is mixed up. Sightseeing tour into the future of web development (FrontendFellows, Almaty 2016)\n\nMy very first report. I recommend skipping the first 10 minutes blah blah blah.\n\n![\"Backend,](\"https://img.youtube.com/vi/i6i1xGlaVwY/0.jpg\")
\n\n## Translations\n\n### GraphQL: The Documentary (Russian version)\n\nAs part of HolyJS 2019Moscow participated in the translation of the film.\n\nLee Byron, Dan Schafer and Nick Schrock (Creators of GraphQL) and other well-known members of the #GraphQL community, \"GraphQL: The Documentary\" tells the story of the emergence of GraphQL, its impact on the entire web development industry and on such technology giants as Facebook, Twitter, Airbnb and Github.\n\n![\"GraphQL:](\"https://img.youtube.com/vi/i_rsfHMF3x4/0.jpg\")
", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "ireaderlab/zkdash", "link": "https://github.com/ireaderlab/zkdash", "tags": ["zookeeper", "qconf", "dashboard"], "stars": 672, "description": "A dashboard for zookeeper and Qconf", "lang": "JavaScript", "repo_lang": "", "readme": "# zkdash\n\nzkdash\u662f\u4e00\u4e2azookeeper\u7684\u7ba1\u7406\u754c\u9762\uff0c\u4e5f\u53ef\u4ee5\u4f5c\u4e3a\u4efb\u4f55\u57fa\u4e8ezookeeper\u7684\u914d\u7f6e\u7ba1\u7406\u9879\u76ee\u6bd4\u5982\uff1aQconf\n\n## \u5f00\u53d1\u89c4\u5212\n\nzkdash\u76ee\u524d\u6b63\u5728\u5f00\u53d1\u7b2c\u4e8c\u7248\u672c\uff0c\u66f4\u6613\u7528\uff0c\u66f4\u5f00\u53d1\uff0c\u62e5\u6709\u5b8c\u5584\u6743\u9650\u7ba1\u7406\uff0c\u652f\u6301zk\uff0c\u66f4\u6613\u7528\u3002\n\u7b2c\u4e8c\u7248\u5df2\u7ecf\u5728\u7740\u624b\u5f00\u6e90\u76f8\u5173\u5de5\u4f5c\uff0c\u4f1a\u6253\u9020\u4e00\u4e2a\u57fa\u4e8e\u914d\u7f6e\u4e2d\u5fc3\uff0c\u670d\u52a1\u53d1\u73b0\uff0cCICD\uff0cCMDB\u4e00\u4f53\u5316\u7684\u5fae\u670d\u52a1\u7ba1\u7406\u5e73\u53f0\u3002\n\n### zkdash\u9875\u9762\u5c55\u793a\n\n\n\n\n\n\n\n\n\n\n### \u5b89\u88c5\u4e0e\u8fd0\u884c\n\u5b89\u88c5\u6b65\u9aa4\n\n - \u5b89\u88c5\u5e76\u8fd0\u884cmysql\n \n - \u5b89\u88c5python2.7, \u7248\u672c\u6700\u597d >= 2.7.6\n\n - \u4e0b\u8f7dzkdash `git clone https://github.com/ireaderlab/zkdash.git`\n\n - \u5b89\u88c5\u4f9d\u8d56\u9879\n\t\n\t```\n cd zkdash\n pip install -r requirements.txt\n ```\n\n - \u8bbe\u7f6e\u914d\u7f6e\u6587\u4ef6\n \n \t\u6839\u636e\u9700\u8981\u4fee\u6539\u5f53\u524d\u76ee\u5f55\u4e0b./conf/conf.yml\u4e2d\u76f8\u5173\u914d\u7f6e\u4fe1\u606f\uff0c\u914d\u7f6e\u6587\u4ef6\u8be6\u7ec6\u8bf4\u660e\u89c1\u540e\u9762\n\n - \u540c\u6b65\u6570\u636e\u5e93\u8868\u7ed3\u6784\n \u9996\u5148\u521b\u5efa\u6570\u636e\u5e93zkdash\uff0c\u5e76\u8bbe\u7f6e\u6570\u636e\u5e93\u7684\u7528\u6237\u540d\u548c\u5bc6\u7801\n \u5c06\u914d\u7f6e\u6587\u4ef6\u7684\u6570\u636e\u5e93\u7684\u7528\u6237\u540d\u548c\u5bc6\u7801\u8fdb\u884c\u4fee\u6539\n \n ```\n DATABASE:\n db: 'zkdash'\n host: '192.168.1.1' # \u4fee\u6539\u4e3a\u4f60\u7684\u6570\u636e\u5e93\u5730\u5740\n port: 3306 # \u8bbe\u7f6e\u7aef\u53e3\u53f7\n user: 'tokyo' # \u4fee\u6539\u7528\u6237\u540d\n passwd: 'tokyo!' # \u4fee\u6539\u5bc6\u7801\n ```\n \n \u8bbe\u7f6e\u5b8c\u6210\u540e\u8fdb\u884c\u521d\u59cb\u5316\u6570\u636e\u5e93\n \t\n ```\n cd zkdash\n python ./bin/syncdb.py # \u6ce8\u610f\u6267\u884c\u8def\u5f84\u5fc5\u987b\u4e3a./bin/syncdb.py\n ```\n\t\n\t\u8bf4\u660e\uff1a\u6570\u636e\u5e93\u4f7f\u7528mysql\uff0c\u521b\u5efa\u8868\u7ed3\u6784\u524d\u8bf7\u5148\u914d\u7f6e\u6570\u636e\u5e93\u8fde\u63a5\u4fe1\u606f\n\n - \u8fd0\u884c\n\n\t```\n\tcd zkdash\n\tpython init.py -port=8888\n\t```\n\t\n\t\u8bf4\u660e\uff1a\u521d\u6b21\u8fd0\u884czkdash\u65f6\u9700\u8981\u5230zookeeper\u7ba1\u7406\u83dc\u5355\u4e0b\u589e\u52a0\u76d1\u63a7\u7684zookeeper\u96c6\u7fa4ip\u4fe1\u606f\n\n\n### \u914d\u7f6e\u6587\u4ef6\u8bf4\u660e\n\n\u914d\u7f6e\u6587\u4ef6\u8be6\u7ec6\u8bf4\u660e\n\n\u6570\u636e\u5e93\u914d\u7f6e\u9879(DATABASE)\n\n - db: \u6570\u636e\u5e93\u540d\u79f0\n - host: ip\u5730\u5740\n - port: \u7aef\u53e3\u53f7\n - user: \u7528\u6237\u540d\n - passwd: \u5bc6\u7801\n\n\u5168\u5c40\u914d\u7f6e\u9879\n\n - USE_QCONF: \u662f\u5426\u901a\u8fc7QConf\u83b7\u53d6zookeeper\u6570\u636e\uff08\u4f7f\u7528\u8be5\u9879\u53ef\u4ee5\u63d0\u9ad8\u6811\u5f62\u5c55\u793a\u914d\u7f6e\u4fe1\u606f\u7684\u54cd\u5e94\u901f\u5ea6\uff09\n\n\n### \u4e0eQConf\u7684\u642d\u914d\u4f7f\u7528\n\n - \u53cd\u9988\u670d\u52a1\u5668\u5730\u5740\uff1ahttp://ip:port/api/v1/feedback\uff08Agent\u540c\u6b65\u72b6\u51b5\u67e5\u770b\u4f9d\u8d56\u6b64\u53cd\u9988\u4fe1\u606f\uff09\n\n\n### \u6ce8\u610f\u4e8b\u9879\n 1. \u65b0\u589e\u8282\u70b9\u9700\u8981\u5148\u6307\u5b9a\u7236\u8282\u70b9\uff0c\u5e76\u4e14\u53ea\u80fd\u9010\u7ea7\u589e\u52a0\n 2. \u5f53\u8bbe\u7f6e\u4f7f\u7528QConf\u83b7\u53d6zookeeper\u6570\u636e\u65f6\uff0czookeeper\u7ba1\u7406\u83dc\u5355\u4e0b\u7684zookeeper\u96c6\u7fa4\u540d\u79f0\u9700\u8981\u4e0eQConf\n \u5ba2\u6237\u7aefAgent\u914d\u7f6e\u6587\u4ef6\u7684idc\u540d\u79f0\u4e00\u81f4\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "falling-sky/source", "link": "https://github.com/falling-sky/source", "tags": [], "stars": 673, "description": "Main source for falling-sky. Mostly HTML, JavaScript.", "lang": "JavaScript", "repo_lang": "", "readme": "[](https://travis-ci.org/falling-sky/source)\n\nsource\n======\n\nMain source for falling-sky. Mostly HTML, JavaScript.\n\nDepnds on Go 1.6. Newer versions *may* work but are untested at this time.\n\nDepends on \"fsbuilder\". Use `make fsbuilder` to make.\n\nReading/writing latest translations from Crowdin depends on credentials, and crowdin-cli.\nIf you're working with the cached .po files in git, building won't block on crowdin.\n\nSee the `Makefile` for what all can be set or done.\n\n\nmaintainers\n===========\n\nI've asked a couple people to step in and help with care and feeding.\n\n * Check the latest [crowdin translations](https://crowdin.com/project/falling-sky/activity_stream)\n * Spot check recent changes with Google Translate\n * Look for evil JavaScript\n * Check for any support related [issues](https://github.com/falling-sky/source/issues) filed.\n * If there are mirror updates to be made:\n * Edit `sites.json` [here](https://github.com/falling-sky/source/tree/master/sites) \n * If this is for \"Other Sites\" instead of a full mirror, specify `mirror: false`\n * If there were translations changed, and no other recent config changes, give a gratuitious kick to the [build system](https://travis-ci.org/falling-sky/source).\n * Builds take ~2 minutes\n * Builds check all mirrors, and suppress any that are unreachable\n * Builds push to the live site http://master.test-ipv6.com\n * Builds push to the distribution server \n\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "TyCoding/tumo", "link": "https://github.com/TyCoding/tumo", "tags": [], "stars": 672, "description": ":rocket: Best Beautiful Java Blog", "lang": "JavaScript", "repo_lang": "", "readme": "#Tumo Blog\n\n> Tumo Blog is a simple and beautiful blog system based on SpringBoot2.X + Vue.js.\n\n [](https://github.com/TyCoding/tumo/stargazers) \n\n[Tumo](https://github.com/TyCoding/tumo) is a blog system based on SpringBoot2.x. [Tumo](https://github.com/TyCoding/tumo) The system has a concise and standardized code design, with the help of Vue.js and Thymeleaf to build traditional single architecture projects; at the same time, [Tumo-Vue](https: //github.com/TyCoding/tumo-vue) A system with a front-end and back-end separation architecture also came into being. The two projects are implemented with the same back-end logic, the difference is that the former uses a single architecture, while the latter uses Vue2.x to implement a front-end and back-end separation architecture. The combination of the two better helps developers get familiar with the rapid development of the SpringBoot framework and learn how the project transitions from a single architecture to a front-end and back-end separation architecture.\n\n- Online preview: [http://tumo.tycoding.cn/](http://tumo.tycoding.cn/)\n- Background address: [http://tumo.tycoding.cn/login](http://tumo.tycoding.cn/login)\n- Development documentation: [http://docs.tumo.tycoding.cn/#/](http://docs.tumo.tycoding.cn/#/)\n\n## Vue version\n\nOn the basis of the back-end project of this blog, a Vue-based single-page version has been developed, which is the best practice for you **transition from a single architecture to a front-end and back-end separation architecture**.\n\nProject source code: [https://github.com/TyCoding/tumo-vue](https://github.com/TyCoding/tumo-vue) I hope everyone will support star and fork.\n\n## Technology Selection\n\n| Name | Version | Env | Version |\n| -- | -- | -- | -- |\n| Spring Boot | 2.3.1.RELEASE | JDK | 1.8 |\n| Mybatis | 2.1.3 | MySQL | 5.7 |\n| Spring-Shiro | 1.5.2 | IDEA | 2020.1 |\n\n## Documentation\n\nTeach you the actual combat of SpringBoot projects.\n\nPlease move to project development and use documents: [http://docs.tumo.tycoding.cn](http://docs.tumo.tycoding.cn)\n\n\nThe document will be published on my official account **Programmer Tu Mo** as soon as possible, please continue to pay attention!\n\n| Programmer Tu Mo |\n| -------------------------------------------------- ---------- |\n|  |\n\n## please drink juice\n\n| Alipay | WechatPay |\n| -------------------------------------------------- --------- | ---------------------------------------- ------------------ |\n|  |  |\n\n## preview\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## comminicate\n\nQQGroup: 671017003\n\nWeChatGroup: Follow the official account to view\n\n## contact me\n\n- [Blog@TyCoding's blog](http://www.tycoding.cn)\n\n- [GitHub@TyCoding](https://github.com/TyCoding)", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "rafaelw/mutation-summary", "link": "https://github.com/rafaelw/mutation-summary", "tags": [], "stars": 672, "description": "A JavaScript library that makes observing changes to the DOM easy", "lang": "JavaScript", "repo_lang": "", "readme": "# What is this? #\n\nMutation Summary is a JavaScript library that makes observing changes to the DOM fast, easy and safe.\n\nIt's built on top of (and requires) a new browser API called [DOM Mutation Observers](http://dom.spec.whatwg.org/#mutation-observers).\n\n * [Browsers which currently implement DOM Mutation Observers](DOMMutationObservers.md#browser-availability).\n * [DOM Mutation Observers API and its relationship to this library and (the deprecated) DOM Mutation Events](DOMMutationObservers.md).\n\n
\n\n# Why do I need it? #\n\nMutation Summary does five main things for you:\n\n * **It tells you how the document is different now from how it was.** As its name suggests, it summarizes what\u2019s happened. It\u2019s as if it takes a picture of the document when you first create it, and then again after each time it calls you back. When things have changed, it calls you with a concise description of exactly what\u2019s different now from the last picture it took for you.\n * **It handles any and all changes, no matter how complex.** All kinds of things can happen to the DOM: values can change and but put back to what they were, large parts can be pulled out, changed, rearranged, put back. Mutation Summary can take any crazy thing you throw at it. Go ahead, tear the document to shreds, Mutation Summary won\u2019t even blink.\n * **It lets you express what kinds of things you\u2019re interested in.** It presents a query API that lets you tell it exactly what kinds of changes you\u2019re interested in. This includes support for simple CSS-like selector descriptions of elements you care about.\n * **It\u2019s fast.** The time and memory it takes is dependant on number of changes that occurred (which typically involves only a few nodes) -- not the size of your document (which is commonly thousands of nodes).\n * **It can automatically ignore changes you make during your callback.** Mutation Summary is going to call you back when changes have occurred. If you need to react to those changes by making more changes -- won\u2019t you hear about those changes the next time it calls you back? Not unless you [ask for that](APIReference.md#configuration-options). By default, it stops watching the document immediately before it calls you back and resumes watching as soon as your callback finishes.\n\n# What is it useful for? #\n\nLots of things, here are some examples:\n\n * **Browser extensions.** Want to make a browser extension that creates a link to your mapping application whenever an address appears in a page? You\u2019ll need to know when those addresses appear (and disappear).\n * **Implement missing HTML capabilities.** Think building web apps is too darn hard and you know what\u2019s missing from HTML that would make it a snap? Writing the code for the desired behavior is only half the battle--you\u2019ll also need to know when those elements and attributes show up and what happens to them. In fact, there\u2019s already two widely used classes of libraries which do exactly this, but don\u2019t currently have a good way to observe changes to the DOM.\n * **UI Widget** libraries, e.g. Dojo Widgets\n * **Templating** and/or **Databinding** libraries, e.g. Angular or KnockoutJS\n * **Text Editors.** HTML Text editors often want to observe what\u2019s being input and \u201cfix it up\u201d so that they can maintain a consistent WYSWIG UI.\n\n# What is this _not_ useful for? #\n\nThe intent here isn't to be all things to all use-cases. Mutation Summary is not meant to:\n\n * **Use the DOM as some sort of state-transition machine.** It won't report transient states that the DOM moved through. It will only tell you what the difference is between the previous state and the present one.\n * **Observing complex selectors.** It offers support for a simple [subset of CSS selectors](APIReference.md#supported-selector-syntax). Want to observe all elements that match `\u201cdiv[foo] span.bar > p:first-child\u201d`? Unfortunately, efficiently computing that is much harder and currently outside the scope of this library.\n\nNote that both of the above use cases are possible given the data that the underlying Mutation Observers API provides -- we simply judged them to be outside the \"80% use case\" that we targeted with this particular library.\n\n# Where can Mutation Summary be used? #\n\nThe Mutation Summary library depends on the presence of the Mutation Observer DOM API. Mutation Observers are available in\n\n * [Google Chrome](https://www.google.com/chrome)\n * [Firefox](http://www.mozilla.org/en-US/firefox/new/) \n * [Safari](http://www.apple.com/safari/)\n * [Opera](http://www.opera.com/)\n * [IE11](http://www.microsoft.com/ie)\n\nMutation Observers is the work of the [W3C WebApps working group](http://www.w3.org/2008/webapps/). In the future it will be implemented in other browsers (we\u2019ll keep the above list of supporting browsers as up-to-date as possible).\n\n# Great. I want to get started. What\u2019s next? #\n\n * Check out the [tutorial](Tutorial.md) and the [API reference](APIReference.md).\n\n# Google groups discussion list #\n\n * [mutation-summary-discuss@googlegroups.com](https://groups.google.com/group/mutation-summary-discuss)\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "moreartyjs/moreartyjs", "link": "https://github.com/moreartyjs/moreartyjs", "tags": [], "stars": 672, "description": "Morearty.js - centralized state management for React in pure JavaScript", "lang": "JavaScript", "repo_lang": "", "readme": "[npm-url]: https://npmjs.org/package/morearty\n[npm-image]: http://img.shields.io/npm/v/morearty.svg?style=flat\n\n# Morearty.js\n[![NPM version][npm-image]][npm-url] [](https://travis-ci.org/moreartyjs/moreartyjs) [](https://gitter.im/moreartyjs/moreartyjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://david-dm.org/moreartyjs/moreartyjs#info=devDependencies)\n\n* [Introduction](#introduction)\n* [Download](#download)\n* [Dependencies](#dependencies)\n* [Current status](#current-status)\n* [Documentation](#documentation)\n* [Usage](#usage)\n* [TodoMVC](#todomvc)\n * [App component](#app-component)\n * [Header component](#header-component)\n * [TodoList component](#todolist-component)\n * [TodoItem component](#todoitem-component)\n * [Footer component](#footer-component)\n * [Starting the application](#starting-the-application)\n * [Principal differences from raw React](#principal-differences-from-raw-react)\n* [Flux implementation](#flux-implementation)\n* [React Native support](#react-native-support)\n* [Care to help?](#care-to-help)\n * [Building Morearty](#building-morearty)\n* [Credits](#credits)\n\n# Introduction\n\n**Morearty.js** is a thin layer on top of [React](http://facebook.github.io/react/index.html) (implemented as a mixin) providing better state management facilities in the manner of [Om](https://github.com/swannodette/om) but written in pure JavaScript.\n\nUnderneath, Morearty leverages immutable data structures, provided by Facebook's [Immutable](https://github.com/facebook/immutable-js) library, which hold the state of an application. That state is described by a single [Binding](https://rawgit.com/moreartyjs/moreartyjs/master/doc/Binding.html) object and all state transitions are performed through it. When an application component needs to delegate a part of its state to a sub-component, it can create a [sub-binding](https://rawgit.com/moreartyjs/moreartyjs/master/doc/Binding.html#sub) which points to a nested location within the global state and is fully synchronized with the original binding. This way every component knows only what it should know and the entire state is effectively encapsulated. Morearty detects any changes automatically and triggers re-rendering. Moreover, each component gets a correctly defined [shouldComponentUpdate](http://facebook.github.io/react/docs/component-specs.html#updating-shouldcomponentupdate) method that compares the component's state using straightforward JavaScript strict equals operator `===`. So, only the components whose state was altered are re-rendered.\n\nMorearty puts state updates in a render queue and applies them asynchronously in [requestAnimationFrame](http://www.paulirish.com/2011/requestanimationframe-for-smart-animating/) in one pass, falling back to `setTimeout` when `requestAnimationFrame` is not available. This dramatically simplifies reasoning about the application and improves performance.\n\nSee [documentation](#documentation) for more info.\n\n# Download\n\nBrowser, AMD, Node.js environments are supported. You can get [production](https://raw.githubusercontent.com/moreartyjs/moreartyjs/master/dist/morearty.min.js) or [development](https://raw.githubusercontent.com/moreartyjs/moreartyjs/master/dist/morearty.js) versions. Or just `npm install morearty`.\n\n# Dependencies\n\nMorearty requires React version 0.13 or higher ([download](http://facebook.github.io/react/downloads.html)) and Immutable 3.7 and above ([download](https://github.com/facebook/immutable-js/releases)). **Both should be available as global variables with names `React` and `Immutable` unless you're using NPM.** Require.js users can do something like:\n\n```javascript\nrequire.config({\n paths: {\n react: 'path/to/react',\n immutable: 'path/to/immutable'\n }\n});\n\nrequire(['react', 'immutable'], function (React, Imm) {\n window.React = React;\n window.Immutable = Imm;\n\n require(['component/Bootstrap'], function (Bootstrap) {\n React.renderComponent(\n Bootstrap(),\n document.getElementById('root')\n );\n });\n});\n```\n\n# Current status\n\n**Morearty** 0.7 series changes:\n\n* Support React 0.14 (starting from `0.7.25`).\n* React Native [support](#react-native-support) (thanks to @gilbox).\n* Support React 0.13 and Immutable 3.7.\n* Asynchronous rendering is the default, synchronous mode is no longer supported.\n* Support [cancelling](https://rawgit.com/moreartyjs/moreartyjs/master/doc/TransactionContext.html#cancel) transactions.\n* Support `this.addBindingListener(...)` in components for component lifecycle bounded listeners creation. Just listen for changes, all required cleanup is performed in `componentWillUnmount` automatically.\n* Support `renderOnce` configuration parameter useful to ensure rendering is performed only once. Other server rendering corrections.\n* `Context.bootstrap` helper method simplifying application bootstrapping.\n* Support dynamic bindings ([#36](https://github.com/moreartyjs/moreartyjs/issues/36)).\n* Support passing custom React context ([#37](https://github.com/moreartyjs/moreartyjs/issues/37)).\n* Introduced [observed bindings](https://github.com/moreartyjs/moreartyjs/wiki/Authoring-components#using-observed-bindings) and [observed props](https://github.com/moreartyjs/moreartyjs/wiki/Authoring-components#using-observed-props).\n* Support IE8. Deprecate `Binding.delete` in favor of `remove`.\n* Support `getDefaultMetaState` in components.\n\n**Morearty** 0.6 series changes:\n\n* React 0.12 and Immutable 3.0 or higher now required.\n* Introduce [bindings meta info](https://github.com/moreartyjs/moreartyjs/wiki/Binding#attaching-meta-information) that allows to store data you don't want to put in the main state, e.g. validation info, history, and so on.\n* Generate less garbage during render.\n* History module migrated on meta binding API.\n\nSee [releases page](https://github.com/moreartyjs/moreartyjs/releases) for detailed per-release changes descriptions.\n\n# Documentation\n\nSee Wiki [pages](https://github.com/moreartyjs/moreartyjs/wiki) for a thourough explanation of Morearty concepts.\n\nAuto-generated API documentation is available [here](https://rawgit.com/moreartyjs/moreartyjs/master/doc/index.html).\n\n# Usage\n\nTo start using Morearty.js add the script to the page or load it with your favorite AMD loader, e.g. [Require.js](http://requirejs.org/), and create Morearty context using [createContext](https://rawgit.com/moreartyjs/moreartyjs/master/doc/Morearty.html#createContext) method:\n\n```javascript\nvar Ctx = Morearty.createContext({\n initialState: {\n nowShowing: 'all',\n items: [{\n title: 'My first task',\n completed: false,\n editing: false\n }]\n }\n});\n```\n\nWhen you create components this way, each acquires a correctly defined `shouldComponentUpdate` method which uses that component's binding (if any) to determine if its state was changed. By default, state is transferred to sub-components in the `binding` attribute and can be retrieved using the `getDefaultBinding` method.\n\n# TodoMVC\nTo continue this introduction, [TodoMVC](http://todomvc.com/) implementation based on Morearty.js will be used ([repository](https://github.com/moreartyjs/todomvc-moreartyjs), [application](https://rawgit.com/moreartyjs/todomvc-moreartyjs/master/index.html)). You should have some previous React knowledge to follow painlessly, only Morearty-specific parts will be described.\n\n## App component\nLet's now define main application module `App`:\n\n```javascript\nvar NOW_SHOWING = Object.freeze({ ALL: 'all', ACTIVE: 'active', COMPLETED: 'completed' });\n\nvar App = React.createClass({\n displayName: 'App',\n\n mixins: [Morearty.Mixin],\n\n componentDidMount: function () {\n var binding = this.getDefaultBinding();\n Router({\n '/': binding.set.bind(binding, 'nowShowing', NOW_SHOWING.ALL),\n '/active': binding.set.bind(binding, 'nowShowing', NOW_SHOWING.ACTIVE),\n '/completed': binding.set.bind(binding, 'nowShowing', NOW_SHOWING.COMPLETED)\n }).init();\n },\n\n render: function () {\n var binding = this.getDefaultBinding();\n return (\n ![\"Preact\"](\"https://cdn.rawgit.com/developit/b4416d5c92b743dbaec1e68bc4c27cda/raw/8dd78c9d138f13e3fec98cbdd6d1c619cf986ee0/preact-logo-trans.svg\" "\\"Preact\\""){kind=logo}
](https://github.com/developit/preact)\n\n[**JSFiddle Demo**](https://jsfiddle.net/developit/9q0vyskg/)\n\n---\n\n\n## Installation\n\nVia npm:\n\n`npm install --save vhtml`\n\n\n---\n\n\n## Usage\n\n```js\n// import the library:\nimport h from 'vhtml';\n\n// tell babel to transpile JSX to h() calls:\n/** @jsx h */\n\n// now render JSX to an HTML string!\nlet items = ['one', 'two', 'three'];\n\ndocument.body.innerHTML = (\n Here is a list of {items.length} items:
\n![\"Digital](\"https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg\"){kind=logo}
\n \n ![\"Sauce](\"media/sponsors/saucelabs-logo.svg\"){kind=logo}
\n \n\n## License\n\nMIT\n", "readme_type": "markdown", "hn_comments": "Hi HN!My name is Antoni, I'm 16 years old self-taught developer from Poland. During my free time, I enjoy creating small open-source projects. Today, I'm happy to announce my biggest project ever, which is PizzaQL. It's an order placement & management system for pizza restaurants, built using modern technologies, like React, Next.js, GraphQL & more. Even though it is not finished yet, it is usable :) I would really like to receive constructive criticism & suggestions. Also, if you liked the project, consider starring it on Github - it means a lot to me.Thanks!~ Antoni Kepinski (aka xxczaki)![](\"app/static/Icon.png\"){kind=icon}
\n \n ![\"Version\"](\"https://img.shields.io/github/release/denysdovhan/inboxer.svg?style=flat-square\")
\n ![\"Travis](\"https://img.shields.io/travis/denysdovhan/inboxer.svg?style=flat-square\")
\n ![\"Platform\"](\"https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey.svg?style=flat-square\"){kind=icon}
\n ![\"Donate](\"https://img.shields.io/badge/donate-LiqPay-blue.svg?style=flat-square\"){kind=icon}
\n ![\"Donate](\"https://img.shields.io/badge/donate-BTC-yellow.svg?style=flat-square\"){kind=icon}
\n ![\"Donate](\"https://img.shields.io/badge/donate-ETH-gray.svg?style=flat-square\"){kind=icon}
\n
![](\"https://cloud.githubusercontent.com/assets/3459374/25771981/6f2ba08c-3268-11e7-9fc8-49e3f7b9e0e5.png\")
| ![](\"https://user-images.githubusercontent.com/3459374/33760933-1c9b81b4-dc10-11e7-8e4b-22d81f98c138.png\")
| ![](\"https://user-images.githubusercontent.com/3459374/33760932-1c7b3fb2-dc10-11e7-9774-411264d533da.png\")
|\n\nI would appreciate your support! _Thank you!_\n\n[donate-readme]: https://github.com/denysdovhan/inboxer#donate\n[donate-card-url]: https://www.liqpay.com/en/checkout/380951100392\n[donate-card-image]: https://img.shields.io/badge/donate-LiqPay-blue.svg?style=flat-square\n[donate-btc-image]: https://img.shields.io/badge/donate-BTC-yellow.svg?style=flat-square\n[donate-eth-image]: https://img.shields.io/badge/donate-ETH-gray.svg?style=flat-square\n\n## License\n\nMIT \u00a9 [Denys Dovhan](http://denysdovhan.com)\n\n\n\n[download]: https://github.com/denysdovhan/inboxer/releases/latest\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "RoderickQiu/wnr", "link": "https://github.com/RoderickQiu/wnr", "tags": ["timer", "pomodoro", "electron-app", "floss", "windows", "macos", "linux", "time-managment", "pomodoro-technique", "productivity-timer", "productivity-booster", "electron"], "stars": 671, "description": "\u23f1\ufe0f Work/Rest Timer. Stricter. Prettier. More features. Win/Mac/Linux. Will update when there are new issues.", "lang": "JavaScript", "repo_lang": "", "readme": "![](\"https://i.loli.net/2020/01/27/bOvLlYmT7dQFRjr.png\"\n)
\n \u4e00\u500b\u64c1\u6709\u9ad8\u53ef\u64f4\u5c55\u6027\u7684\u6642\u9593\u7ba1\u7406\u8a08\u7b97\u6a5f\u8edf\u4ef6 | \u4e2d\u6587\u7db2\u7ad9\n
\n\n\n \u4e0b\u8f09\u5730\u5740 (Win/Mac/Linux): GitHub Release |
\n English README | \u7b80\u4f53\u4e2d\u6587\u7b80\u4ecb | \u6b63\u9ad4\u4e2d\u6587\u7c21\u4ecb | \u958b\u767c\u5c0e\u5f15\u6587\u6a94 | \u806f\u7e6b\u6211\n
\n\n---\n\n## \u8ca2\u737b\n\n\u975e\u5e38\u611f\u8b1d\u4f60\u7684\u8ca2\u737b\u3002\n\n- \u5982\u679c\u4f60\u60f3\u5831\u544a\u4e00\u4e9b\u671f\u671b\u7684\u7279\u6027\u6216\u6f0f\u6d1e\uff0c\u8acb\u96a8\u6642 [\u63d0\u4ea4 Issue](https://github.com/RoderickQiu/wnr/issues/new) \u3002\n\n- \u5982\u679c\u4f60\u505a\u4e86\u4e9b\u4e0d\u932f\u7684\u6539\u9032\uff0c\u90a3\u9ebc\u8acb [\u63d0\u4ea4 Pull Request](https://github.com/RoderickQiu/wnr/pulls) \u3002\n\n- \u5982\u679c\u4f60\u60f3\u7232 wnr \u6dfb\u52a0\u4e00\u7a2e\u8a9e\u8a00\u7684\u652f\u6301\uff0c [\u8acb\u5148\u95b1\u8b80\u9019\u4efd\u6307\u5357](https://github.com/RoderickQiu/wnr/blob/master/locales/README.md) \u3002\n\n## \u5982\u4f55\u69cb\u5efa\n\n```shell\nyarn # \u5b89\u88dd\u4f9d\u8cf4\n\nyarn start # \u904b\u884c\u7a0b\u5e8f\n\nyarn dir # \u50c5\u50c5\u6253\u5305\u57fa\u790e\u53ef\u57f7\u884c\u6587\u4ef6\n\nyarn nsis # Windows\u5e73\u81faNSIS\u5b89\u88dd\u5305\u6253\u5305\n\nyarn nsis-ia32 # Windows\u5e73\u81faNSIS\u5b89\u88dd\u5305\u6253\u5305\uff0832\u4f4d\uff09\n\nyarn 7zip # Windows\u5e73\u81fa7z\u4fbf\u651c\u7248\u6253\u5305\n\nyarn 7zip-ia32 # Windows\u5e73\u81fa7z\u4fbf\u651c\u7248\u6253\u5305\uff0832\u4f4d\uff09\n\nyarn mac # macOS\u7248\u672c\u6253\u5305\n\nyarn linux # Linux\u7248\u672c\u6253\u5305\n\nyarn appimage # linux AppImage\u6253\u5305\n```\n\n\u66f4\u591a\u6709\u95dc wnr \u7684\u6280\u8853\u7d30\u7bc0\u548c\u958b\u767c\u5efa\u8b70\uff0c\u8acb\u67e5\u770b **[DEVELOPMENT_GUIDE](https://github.com/RoderickQiu/wnr/blob/master/DEVELOPMENT_GUIDE.md)** \u3002\n\n## \u7248\u6b0a\u548c\u9cf4\u8b1d\n\n\u7248\u6b0a\u6240\u6709 (c) 2019-2022 **[Roderick Qiu](https://r-q.name)** \u548c\u5176\u4ed6\u8ca2\u737b\u8005\u3002\u4fdd\u7559\u6240\u6709\u6b0a\u5229\u3002\n\n\u4f7f\u7528 **[MPL 2.0 \u8a31\u53ef\u8b49](https://github.com/RoderickQiu/wnr/blob/master/LICENSE)** \u9032\u884c\u8a31\u53ef\u3002\n\n### \u4f7f\u7528\u7684\u8edf\u4ef6\u5305\n\n#### \u4e3b\u7a0b\u5e8f\n\n\u5b8c\u6574\u7684\u8a31\u53ef\u8b49\u6587\u672c\u53c3\u898b [\u9019\u500b\u6587\u4ef6](https://github.com/RoderickQiu/wnr/blob/master/NOTICE.md) \uff0c\u540c\u6642\u4e5f\u5305\u542b\u5728\u6bcf\u4e00\u4efd wnr \u7684\u526f\u672c\u4e2d\u3002\n\n- node-shi\uff0c[**\u6211\u81ea\u5df1\u7684\u9805\u76ee**](https://www.npmjs.com/package/node-shi) \u4f7f\u7528 MIT \u8a31\u53ef\u8b49\u3002\n- cmd-or-ctrl\uff0c[**\u53e6\u4e00\u500b\u6211\u81ea\u5df1\u7684\u9805\u76ee**](https://www.npmjs.com/package/cmd-or-ctrl) \u4f7f\u7528 MIT \u8a31\u53ef\u8b49\u3002\n- node-auto-launch\uff0cTeamwork\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- compare-version\uff0ckevva\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- electron-store\uff0csindresorhus\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- i18n-node\uff0cmashpie\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- crypto-js\uff0cbrix\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- copy-to-clipboard\uff0csudodoki\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- request\uff0crequest\uff0cApache-2.0 \u8a31\u53ef\u8b49\u3002\n- winreg\uff0cfresc81\uff0cBSD 2-Clause \u8a31\u53ef\u8b49\u3002\n- **electron\uff0celectron\uff0cMIT \u8a31\u53ef\u8b49**\u3002\n- electron-builder\uff0celectron-userland\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- jquery\uff0cjquery\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- bootstrap\uff0ctwbs\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- iconfont\uff0cALIMAMA MUX\uff0c\u8a31\u53ef\u8b49\u53c3\u898b [\u6b64\u7db2\u7ad9](https://www.iconfont.cn/) \u3002\n- node-md5\uff0cpvorb\uff0cBSD-3-Clause \u8a31\u53ef\u8b49\u3002\n- dotenv\uff0cmotdotla\uff0cBSD-2-Clause \u8a31\u53ef\u8b49\u3002\n- electron-debug\uff0csindresorhus\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- node-fetch\uff0cnode-fetch\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- node-notifier\uff0cmikaelbr\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- popper.js\uff0cpopperjs\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- schart.js\uff0clin-xin\uff0cMIT \u8a31\u53ef\u8b49\u3002\n- cross-env\uff0ckentcdodds\uff0cMIT \u8a31\u53ef\u8b49\u3002\n\n### \u958b\u767c\u74b0\u5883\n\n- **node\uff0cnodejs\uff0c**[**\u8a31\u53ef\u8b49**](https://github.com/nodejs/node/blob/master/LICENSE) \u3002\n- NSIS\uff0cNullsoft\uff0czlib/libpng \u8a31\u53ef\u8b49\u3002\n- WebStorm\uff0cJetBrains\uff0c[\u8a31\u53ef\u8b49](https://www.jetbrains.com/legal/#licensing) \u3002\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "spekt8/spekt8", "link": "https://github.com/spekt8/spekt8", "tags": ["kubernetes", "kubernetes-cluster", "kubernetes-monitoring", "docker", "docker-container", "docker-image", "visualization"], "stars": 671, "description": "Visualize your Kubernetes cluster in real time", "lang": "JavaScript", "repo_lang": "", "readme": "", "readme_type": "markdown", "hn_comments": "I'd love to tinker with this. What is a classic problem or demo for graph neural networks? Is there an equivalent to the MNIST problem for GNNs that would make a good learning exercise?![](\"https://a16545fb495c8760fb33-4cec33efbe2744e99ba863e52edb2075.ssl.cf2.rackcdn.com/stripe-membership-app-screenshot.png\")
\n\n\n### System Requirements\n\n- mongodb\n- nodejs\n\n### Getting Started\n\nFirst update `/server/config/secrets.js` with the following credentials:\n\n- Stripe [API keys](https://dashboard.stripe.com/account/apikeys) and [plan info](https://dashboard.stripe.com/test/plans)\n- [Mailgun](https://mailgun.com/signup) for sending forgot/reset password confirmations.\n- session secret\n- google analytics id\n\nInstall dependencies with `npm install`.\n\nStart the server with `node server`.\n\nNote: Stripe webhooks can be recieved at `https://your-url.com/stripe/events`.\n\n### Heroku Deployment\n\n```\nheroku create your-awesome-saas-product\nheroku addons:add mongohq\nheroku config:set SESSION_SECRET='your_secret';\nheroku config:set STRIPE_KEY='sk_test_example'\nheroku config:set STRIPE_PUB_KEY='pk_test_example'\nheroku config:set MAILGUN_USER='example.org'\nheroku config:set MAILGUN_PASSWORD='key-secret'\nheroku config:set GOOGLE_ANALYTICS='UA-XXXXXX-1'\n```\n\nWant add a heroku deploy button? Pull requests welcome :]\n", "readme_type": "markdown", "hn_comments": "Dude Nice! I'm glad you published this. Will let you know if I hit any issues.\n ![\"Dashboard](\"https://user-images.githubusercontent.com/48997634/153762057-3b3792ec-cfd6-4994-ba77-f973b610bac8.png\"\n) \n \n Dashboard Page \n | \n |
\n ![\"Login](\"https://user-images.githubusercontent.com/48997634/153762072-2c1fb032-f987-4587-938b-589886d6f02d.png\"\n) \n \n Login \n | \n \n ![\"Signup\"](\"https://user-images.githubusercontent.com/48997634/153762076-2d353ff0-1269-4d52-a5f8-155a2406c927.png\"\n) \n \n Signup \n | \n
\n ![\"Account](\"https://user-images.githubusercontent.com/48997634/153762042-58d55b0d-61cb-4e4e-a702-a46f455d7454.png\"\n) \n \n Account Page \n | \n \n ![\"Reset](\"https://user-images.githubusercontent.com/48997634/153762075-62f5f946-93fa-4777-b663-fd8cfd6eb198.png\"\n) \n \n Reset Password \n | \n
\n ![\"Home](\"https://user-images.githubusercontent.com/48997634/153762070-9ce6e657-d1a3-4549-9d8b-245f1470d440.png\"\n) \n \n Home Page \n | \n
\n \n ![\"geekedtv\"](\"https://avatars.githubusercontent.com/u/57927413?v=4\") \n \n Geeked\n \n | \n \n \n ![\"Ben](\"https://avatars.githubusercontent.com/u/69650356?v=4\") \n \n Ben Notix\n \n | \n \n \n ![\"rizwan95\"](\"https://pbs.twimg.com/profile_images/845698052820090880/rbSoa4Bs_400x400.jpg\") \n \n Rizwan Ahmed\n \n | \n \n \n ![\"Add](\"https://user-images.githubusercontent.com/48997634/174815737-111b70a6-7fd1-4ebf-a2db-7a05dd0bfb62.png\"\n) \n \n [Add your support]\n \n | \n
![](\"https://user-images.githubusercontent.com/48997634/153762066-548fe751-e681-4af0-8672-0a459895a8b2.png\"\n)
\n Here's how everything fits into the scene
\n\n \n ![\"Just-Moh-it\"](\"https://avatars.githubusercontent.com/u/48997634?v=4\") \n \n Mohit Yadav\n \n | \n \n \n ![\"ItzDerock\"](\"https://avatars.githubusercontent.com/u/14848722?v=4\") \n \n Derock\n \n | \n \n \n ![\"rizwan95\"](\"https://avatars.githubusercontent.com/u/10910174?s=60&v=4\") \n \n Rizwan Ahmed\n \n | \n \n \n ![\"petrleocompel\"](\"https://avatars.githubusercontent.com/u/9423543?s=60&v=4\") \n \n Petr Leo Compel\n \n | \n \n \n ![\"Sujith46\"](\"https://avatars.githubusercontent.com/u/37608689?v=4\") \n \n Sujith\n \n | \n
\n \n ![\"Join](\"https://user-images.githubusercontent.com/48997634/153762069-df7f5900-e685-45c9-8d30-a1a73bc28a8f.png\"\n) \n For installation support \n \n | \n \n \n ![\"Buy](\"https://user-images.githubusercontent.com/48997634/174812602-496e76e1-0651-4b29-8933-4acaf2a9e89e.png\"\n) \n To support Projects \n \n | \n \n \n ![\"Visit](\"https://user-images.githubusercontent.com/48997634/174813027-6b64959f-66d5-4c73-b405-a5322ed16fc9.png\"\n) \n Awesome projects \n \n | \n
![](\"http://postcss.github.io/sugarss/logo.svg\" "\\"SugarSS"){kind=logo}
\n\nIndent-based CSS syntax for [PostCSS].\n\n```sass\na\n color: blue\n\n.multiline,\n.selector\n box-shadow: 1px 0 9px rgba(0, 0, 0, .4),\n 1px 0 3px rgba(0, 0, 0, .6)\n\n// Mobile\n@media (max-width: 400px)\n .body\n padding: 0 10px\n```\n\nAs any PostCSS custom syntax, SugarSS has source map, [stylelint]\nand [postcss-sorting] support out-of-box.\n\nIt was designed to be used with [postcss-simple-vars] and [postcss-nested].\nBut you can use it with any PostCSS plugins\nor use it without any PostCSS plugins.\nWith [postcss-mixins] you can use `@mixin` syntax as in Sass.\n\n\n ![\"Sponsored](\"https://evilmartians.com/badges/sponsored-by-evil-martians.svg\"\n)
\n\n\n[postcss-mixins]: https://github.com/postcss/postcss-mixins\n[postcss-nested]: https://github.com/postcss/postcss-nested\n[postcss-simple-vars]: https://github.com/postcss/postcss-simple-vars\n[postcss-sorting]: https://github.com/hudochenkov/postcss-sorting\n[stylelint]: http://stylelint.io/\n[PostCSS]: https://github.com/postcss/postcss\n\n\n## Syntax\n\nSugarSS MIME-type is `text/x-sugarss` with `.sss` file extension.\n\n\n### Indent\n\nWe recommend 2 spaces indent. However, SugarSS autodetects indent\nand can be used with tabs or spaces.\n\nBut it is prohibited to mix spaces and tabs in SugarSS sources.\n\n\n### Multiline\n\nSugarSS was designed to have intuitively multiline selectors and declaration\nvalues.\n\nThere are 3 rules for any types of nodes:\n\n```sass\n// 1. New line inside brackets will be ignored\n@supports ( (display: flex) and\n (display: grid) )\n\n// 2. Comma at the end of the line\n@media (max-width: 400px),\n (max-height: 800px)\n\n// 3. Backslash before new line\n@media screen and \\\n (min-width: 600px)\n```\n\nIn a selector you can put a new line anywhere. Just keep same indent\nfor every line of selector:\n\n```sass\n.parent >\n.child\n color: black\n```\n\nIn a declaration value you can put a new line anywhere. Just keep a bigger indent\nfor the value:\n\n```sass\n.one\n background: linear-gradient(rgba(0, 0, 0, 0), black)\n linear-gradient(red, rgba(255, 0, 0, 0))\n\n.two\n background:\n linear-gradient(rgba(0, 0, 0, 0), black)\n linear-gradient(red, rgba(255, 0, 0, 0))\n```\n\n\n### Comments\n\nSugarSS supports two types of comments:\n\n```sass\n/*\n Multiline comments\n */\n\n// Inline comments\n```\n\nThere is no \u201csilent\u201d comment in SugarSS. Output CSS will contain all comments\nfrom `.sss` source. But you can use [postcss-discard-comments]\nfor Sass\u2019s silent/loud comments behaviour.\n\n[postcss-discard-comments]: https://www.npmjs.com/package/postcss-discard-comments\n\n\n### Rule and Declarations\n\nSugarSS separates selectors and declarations by `:\\s` or `:\\n` token.\n\nSo you must write a space after the property name: `color: black` is good,\n`color:black` is prohibited.\n\n\n### Other\n\nSugarSS is just a syntax, it change the way how you write CSS,\nbut do not add preprocessor features build-in.\n\nHere are PostCSS plugins which could add you preprocessor features:\n\n* **[postcss-simple-vars]** adds variables.\n* **[postcss-nested]** adds nested rules.\n* **[postcss-import]** adds `@import` directive support.\n* **[postcss-import-ext-glob]** extends [postcss-import] path resolver to allow glob usage as a path.\n* **[postcss-mixins]** add `@mixin` support.\n* **[postcss-functions]** allows you to define own CSS functions in JS.\n\n[postcss-functions]: https://github.com/andyjansson/postcss-functions\n[postcss-mixins]: https://github.com/postcss/postcss-mixins\n[postcss-import-ext-glob]: https://github.com/dimitrinicolas/postcss-import-ext-glob\n[postcss-import]: https://github.com/postcss/postcss-import\n[postcss-nested]: https://github.com/postcss/postcss-nested\n[postcss-simple-vars]: https://github.com/postcss/postcss-simple-vars\n\n\n## Text Editors\n\n* SublimeText: [Syntax Highlighting for .SSS SugarSS]\n* Atom: [language-postcss], [source-preview-postcss] and [build-sugarss]\n* Vim: [vim-sugarss]\n* VSCode: [vetur](https://vuejs.github.io/vetur/), and [postcss-sugarss-language](https://github.com/MhMadHamster/vscode-postcss-language)\n\nWe are working on syntax highlight support in text editors.\n\nRight now, you can set `Sass` or `Stylus` syntax highlight for `.sss` files.\n\n[Syntax Highlighting for .SSS SugarSS]: https://packagecontrol.io/packages/Syntax%20Highlighting%20for%20SSS%20SugarSS\n[source-preview-postcss]: https://atom.io/packages/source-preview-postcss\n[language-postcss]: https://atom.io/packages/language-postcss\n[build-sugarss]: https://atom.io/packages/build-sugarss\n[vim-sugarss]: https://github.com/hhsnopek/vim-sugarss\n\n\n## Usage\n\nSugarSS needs PostCSS compiler. Install [`postcss-loader`] for webpack,\n[`gulp-postcss`] for Gulp, [`postcss-cli`] for npm scripts.\n[Parcel] has build-in support for PostCSS.\n\nThen install SugarSS: `npm install --save-dev postcss sugarss` if you use npm\nand `yarn add --dev postcss sugarss` if you use Yarn.\n\nThen create `.postcssrc` file:\n\n```json\n{\n \"parser\": \"sugarss\",\n \"plugins\": {\n \"postcss-simple-vars\": {}\n }\n}\n```\n\n[`postcss-loader`]: https://github.com/postcss/postcss-loader\n[`gulp-postcss`]: https://github.com/postcss/gulp-postcss\n[`postcss-cli`]: https://github.com/postcss/postcss-cli\n[Parcel]: https://parceljs.org/transforms.html\n\n\n### Imports\n\nIf you doesn\u2019t use Webpack or Parcel, you need some PostCSS plugin\nto process `@import` directives.\n\nIf you want `@import`, install [postcss-import] and add it to `.postcssrc` file:\n\n```diff js\n{\n \"parser\": \"sugarss\",\n \"plugins\": {\n+ \"postcss-import\": {},\n \"postcss-simple-vars\": {}\n }\n}\n```\n\n[postcss-import]: https://github.com/postcss/postcss-import\n\n\n### Mixins\n\nFor mixins support, install [postcss-mixins] and add it to `.postcssrc` file:\n\n```diff js\n{\n \"parser\": \"sugarss\",\n \"plugins\": {\n+ \"postcss-mixins\": {\n+ \"mixinsDir\": \"./mixins\"\n+ },\n \"postcss-simple-vars\": {}\n }\n}\n```\n\nNow you can define your mixins in `mixins/` dir.\nFor example create `mixins/circle.sss` with:\n\n```sss\n@define-mixin circle $size\n border-radius: 50%\n width: $size\n height: $size\n```\n\n\n### Functions\n\nTo define custom functions you need to install [postcss-functions]\nand add it to `.postcssrc` file:\n\n```diff js\n{\n \"parser\": \"sugarss\",\n \"plugins\": {\n+ \"postcss-functions\": {\n+ \"glob\": \"./functions\"\n+ },\n \"postcss-simple-vars\": {}\n }\n}\n```\n\nThen you can define functions in `functions/` dir. For example,\n`functions/foo.js` will define `foo()` function in CSS:\n\n```js\nmodule.exports = function (args) {\n return 'foo'\n}\n```\n\n\n### SugarSS to SugarSS\n\nSometimes we use PostCSS not to build CSS, but to fix source files.\nFor example, to sort properties by [postcss-sorting].\n\nFor this cases use the `syntax` option, instead of `parser`:\n\n```js\ngulp.task('sort', function () {\n return gulp.src('src/**/*.sss')\n .pipe(postcss([sorting], { syntax: sugarss }))\n .pipe(gulp.dest('src'));\n});\n```\n\n[postcss-sorting]: https://github.com/hudochenkov/postcss-sorting\n\n\n### CSS to SugarSS\n\nYou can even compile existing CSS sources to SugarSS syntax.\nJust use `stringifier` option instead of `parser`:\n\n```js\npostcss().process(css, { stringifier: sugarss }).then(function (result) {\n result.content // Converted SugarSS content\n});\n```\n\n\n## Thanks\n\nCute project logo was made by [Maria Keller](http://www.mariakellerac.com/).\n", "readme_type": "markdown", "hn_comments": "Why not use SugarCRM with its built in email. Use IMAP to fetch your email from Gmail, and send from within SugarCRM to your contacts. I have used SugarCRM this way before and it worked ok. I am not a massive fan of the software, but it does seem to have the features you want. It has a limited activity stream too. You could always fork the code to make it do exactly what you want, since it is open source.![\"bundle-wizard](\"./reddit-mobile-analysis.png\")
\n\n\n[Check out a live demo of this visualization](https://bundle-wizard-spectrum.netlify.app/)\n\n## Try it out on a production app:\n\nTry any of the following commands to take a peek at the JavaScript code different sites are shipping:\n\n1. `npx bundle-wizard reddit.com`\n2. `npx bundle-wizard codesandbox.io`\n3. `npx bundle-wizard gatsbyjs.org`\n4. `npx bundle-wizard codecademy.com`\n5. `npx bundle-wizard id.atlassian.com`\n\n## Try it out on an app running locally:\n\nWant to use bundle-wizard but haven't deployed your app yet? It's as easy as:\n\n#### 1. Build your app locally\n\ne.g. `npm run build`\n\n#### 2. Serve the build folder\n\ne.g. `npx serve -s build`\n\n#### 3. Call bundle-wizard with the correct localhost url\n\ne.g. `npx bundle-wizard localhost:5000/sign-up`\n\n## Additional features\n\n### View source code\n\nIf sourcemaps are properly configured you should be able to click on a square to see the code it represents:\n\n\n\n(Note: for performance reasons, this functionality will be automatically stripped if you decide to package your bundle-wizard files in order to host or share them).\n\n### Filter bundles with regex\n\nWant to know all the bundles that contain code from certain library (say, `momentjs` or `lodash`)? Wondering how much weight in your bundles is from `node_modules` vs custom code? You can answer questions like these by putting a search string or regex into the bottom search bar that allows you to filter the view based on the name of the containing folder bundle name, or script:\n\n\n\n## Optional command line arguments\n\n### `url` (initial argument)\n\nTo skip the initial prompt, provide a url as a first argument:\n\n`npx bundle-wizard reddit.com`\n\n### `interact` flag\n\nIf you need to do some work in the browser getting the page ready for analysis (perhaps by signing in and then visiting a certain page), use the following command:\n\n`npx -p puppeteer -p bundle-wizard bundle-wizard --interact`\n\nThe persistent npm equivalent would be running:\n\n`npm install -g puppeteer bundle-wizard`\n\n`bundle-wizard --interact`\n\nYou might be wondering why you have to install puppeteer as a peer dependency to use the interact command. By default `bundle-wizard` uses `puppeteer-core`, which is faster to download than `puppeteer` because it doesn't come bundled with a version of chromium. Since the `--interact` command opens a browser in non-headless mode, unlike the default `bundle-wizard` command, it requires the full `puppeteer` package to work reliably.\n\nAfter running this command and specifying a url, you will see a browser window that will pop up that you can interact with. When you are ready to proceed, type `y` into the console in respond to the waiting prompt to reload the page and start measuring performance.\n\n**Note**: While this tool does not record any data, it's still recommended from a common sense perspective to enter login information only for test accounts.\n\n### `desktop` flag\n\nBy default, `bundle-wizard` will analyze a mobile version of the site. To analyze the desktop version instead, pass the `--desktop` flag:\n\n`npx bundle-wizard --desktop`\n\n### `ignoreHTTPSErrors` flag\n\nIf you are running an HTTPS connection on localhost and want to test a local site, you'll need to use this setting to prevent self-signed certificate errors:\n\n`npx bundle-wizard https://localhost:5000 --ignoreHTTPSErrors`\n\n### `port` argument\n\nBy default, `bundle-wizard` will try to find an open port in the 3000 range. However, if you'd like it to run on a certain port, you can do so by passing in a value for `--port`:\n\n`npx bundle-wizard https://localhost:3000 --port=4000`\n\n## How it works\n\n`bundle-wizard` uses [Puppeteer](https://github.com/puppeteer/puppeteer) to download a web page, measure performance, and examine the JavaScript it sends to the client. It then analyzes the code using the awesome [source-map-explorer](https://github.com/danvk/source-map-explorer) library and creates a custom visualization.\n\n### Requirement: downloadable sourcemaps\n\nThis utility downloads sourcemaps from the url you provide. This requires the sourcemaps to be publically available, or at least available on your network. You might need to point to a testing instead of production build, for instance, as some apps disable sourcemaps in production.\n\nDon't have access to sourcemaps in your prod app? Try [building your app locally.](#try-it-out-on-an-app-running-locally)\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "codevise/pageflow", "link": "https://github.com/codevise/pageflow", "tags": ["scrollytelling", "multimedia-storytelling", "storytelling"], "stars": 670, "description": "Multimedia story telling for the web.", "lang": "JavaScript", "repo_lang": "", "readme": "# Pageflow\n\n[](http://badge.fury.io/rb/pageflow)\n[](https://github.com/codevise/pageflow/actions)\n[](https://coveralls.io/github/codevise/pageflow?branch=master)\n[](https://codeclimate.com/github/codevise/pageflow)\n[](https://houndci.com)\n\nMultimedia storytelling for the web. Built in cooperation with [WDR](https://wdr.de).\n\nFor a high level introduction and example Pageflow stories see\n[pageflow.io](https://pageflow.io).\n\n* [Getting Started](https://github.com/codevise/pageflow/wiki/Getting-Started)\n* [Guides](https://github.com/codevise/pageflow/blob/master/doc/index.md)\n* [JavaScript API Reference of `pageflow` package](http://codevise.github.io/pageflow-docs/js/master/index.html)\n* [List of Plugins](https://github.com/codevise/pageflow/wiki/List-of-Plugins)\n\n## Updating\n\nFor instructions on how to update from a prior version of the gem see\nthe\n[Updating Pageflow](https://github.com/codevise/pageflow/wiki/Updating-Pageflow)\nwiki page.\n\n## Ingredients\n\nPageflow is a Rails engine which roughly consists of the following\ncomponents:\n\n* A full MVC stack to manage and display Pageflow stories\n* User and permission management with support for isolated accounts\n and user collaboration\n* A client side application for live preview editing of stories\n* Background jobs to process and encode images, audios and videos\n* Generators to quickly bootstrap a new Rails application\n\nPageflow assumes the following choice of libraries:\n\n* [Devise](https://github.com/plataformatec/devise) for authentication\n* [CanCanCan](https://github.com/CanCanCommunity/cancancan) for authorization\n* [ActiveAdmin](http://activeadmin.info/) for administration\n* [Resque](https://github.com/resque/resque) for as default for background jobs\n* [FriendlyId](https://github.com/norman/friendly_id) for pretty URLs\n* [Paperclip](https://github.com/thoughtbot/paperclip) for attachment handling\n* [Backbone](http://backbonejs.org/) [Marionette](http://marionettejs.com/) for the editor\n* [React](https://facebook.github.io/react/)/[Redux](http://redux.js.org/) for the frontend\n\n## Requirements\n\nPageflow runs in environments with:\n\n* Ruby >= 2.1 (see `.travis.yml` for supported versions)\n* Node >= 10.18\n* Rails 4.2\n* Redis server (for Resque)\n* A database server supported by Active Record (tested with MySQL)\n* ImageMagick\n* [Audio Waveform Image Generator](https://github.com/bbc/audiowaveform#installation)\n\nAccounts of the following cloud services have to be registered:\n\n* [Amazon Web Services](http://aws.amazon.com) for S3 file storage and\n (optionally) Cloudfront content delivery\n* [Zencoder](http://zencoder.com) for video/audio encoding\n\n## Installation\n\nGenerate a new Rails application using the MySQL database adapter:\n\n $ rails new my_pageflow --database=mysql\n $ cd my_pageflow\n\nDo not name your application `\"pageflow\"` since it will cause conflicts\nwhich constant names created by Pageflow itself.\n\n### Database Setup\n\nEnter valid MySQL credentials inside `config/database.yml` and create\nthe database:\n\n $ rake db:create\n\n### Gem Dependencies\n\nAdd these lines to your application's Gemfile, replacing `X.Y.Z` with\nthe current Pageflow version number. It is recommended to depend on a\nspecific minor version using the pessimistic version constraint\noperator. See Pageflow's\n[versioning policy](https://github.com/codevise/pageflow/blob/master/doc/versioning_policy.md)\nfor details.\n\n # Gemfile\n gem 'pageflow', '~> X.Y.Z'\n\n # The install generator sets up Resque as Active Job backend\n gem 'resque', '~> 1.25'\n gem 'resque-scheduler', '~> 2.5'\n gem 'ar_after_transaction', '~> 0.5.0'\n gem 'redis', '~> 3.0'\n gem 'redis-namespace', '~> 1.5'\n\nRun bundler to install dependencies:\n\n $ bundle install\n\n### Running the Generator\n\nNow you can run the generator to setup Pageflow and its dependencies:\n\n $ rails generate pageflow:install\n\nThe generator will invoke Active Admin and Devise generators in turn\nand apply some configuration changes. When asked to overwrite the\n`db/seeds.rb` file, choose yes.\n\nTo better understand Pageflow's configuration choices, you can run the\nsingle steps of the `install` generator one by one. See the wiki page\n[The Install Generator in Detail](https://github.com/codevise/pageflow/wiki/The-Install-Generator-in-Detail)\nfor more. If you'd rather not look behind the scenes for now, you can\nsafely read on.\n\n### Database Migration\n\nNow you can migrate the database.\n\n $ rake db:migrate\n\nFinally, you can populate the database with some example data, so\nthings do not look too blank in development mode.\n\n $ rake db:seed\n\n## Configuration\n\nPageflow stores files in S3 buckets also in development\nmode. Otherwise there's no way to have Zencoder encode them. See\n[setting up external services](./doc/setting_up_external_services.md).\n\nThe host application can utilize environment variables to configure the API keys for S3 and Zencoder. The variables can be found in the generated Pageflow initializer.\n\nFor available configuration options and examples see the inline docs\nin `config/initializers/pageflow.rb` in your generated rails app.\n\nEnsure you have defined default url options in your environments\nfiles. Here is an example of `default_url_options` appropriate for a\ndevelopment environment in `config/environments/development.rb`:\n\n config.action_mailer.default_url_options = {host: 'localhost:3000'}\n\nIn production, `:host` should be set to the actual host of your\napplication.\n\n## Running Pageflow\n\nIn addition to the Rails server, you need to start two Rake tasks for\nthe background job processing. These tasks are listed in `Procfile` which\nis generated in the project root folder by the Pageflow installer.\n\nConsider using the [foreman gem](https://github.com/ddollar/foreman) to start all of\nthese processes (including the Rails server) with a single command in your\ndevelopment environment.\n\nThe built-in Resque web server is mounted at `/background_jobs`. Use it to\ninspect the state of background jobs, and restart failed jobs. This functionality\nis only available for admins.\n\n## Troubleshooting\n\nIf you run into problems during the installation of Pageflow, please refer to the [Troubleshooting](doc/troubleshooting.md) docs. If that doesn't help, consider [filing an issue](https://github.com/codevise/pageflow/issues?state=open).\n\n## Security Policy\n\nSee [`SECURITY.md`](https://github.com/codevise/pageflow/blob/master/SECURITY.md).\n\n## Contributing\n\nPull requests are welcome on GitHub at\nhttps://github.com/codevise/pageflow. Everyone interacting in the\nproject's codebases, issue trackers and mailing lists is expected to\nfollow the\n[code of conduct](https://github.com/codevise/pageflow/blob/master/CODE_OF_CONDUCT.md).\n\nSee the\n[Contributing section](https://github.com/codevise/pageflow/blob/master/doc/index.md#contributing)\nin the guides list for instructions on how to setup your development\nenvironment. The\n[GitHub wiki](https://github.com/codevise/pageflow/wiki#contributing-to-pageflow)\ncontains high level guides on common development workflows.\n\n## License\n\nThe gem is available as open source under the terms of the\n[MIT License](https://github.com/codevise/pageflow/blob/master/MIT-LICENSE).\n\n## Special Thanks\n\nBuilt in cooperation with:\n\n[](https://wdr.de)\n\nWe would like to express our special thanks to the following services\nfor supporting Pageflow through free open source plans:\n\n[](https://browserstack.com)\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "annnhan/vue-spa-template", "link": "https://github.com/annnhan/vue-spa-template", "tags": [], "stars": 670, "description": "The base code of vue.js project.", "lang": "JavaScript", "repo_lang": "", "readme": "## Project Description\n\nThe front-end development environment based on vue.js is used for the development of single-page applications after the front-end and back-end separation, and the latest language features such as ES Next and scss can be used during development. Items include:\n\n- Basic libraries: `vue.js`, `vue-router`, `vuex`, `whatwg-fetch`\n- Compilation/packaging tools: `webpack`, `babel`, `node-sass`\n- Unit testing tools: `karma`, `mocha`, `sinon-chai`\n- Local server: `express`\n\n## Directory Structure\n\n \u251c\u2500\u2500 README.md project introduction\n \u251c\u2500\u2500 index.html entry page\n \u251c\u2500\u2500 build build script directory\n \u2502 \u251c\u2500\u2500 build-server.js runs the local build server and can access the built page\n \u2502 \u251c\u2500\u2500 build.js production environment build script\n \u2502 \u251c\u2500\u2500 dev-client.js development server hot reload script, mainly used to realize the automatic page refresh in the development stage\n \u2502 \u251c\u2500\u2500 dev-server.js run local development server\n \u2502 \u251c\u2500\u2500 utils.js build related tools\n \u2502 \u251c\u2500\u2500 webpack.base.conf.js wabpack basic configuration\n \u2502 \u251c\u2500\u2500 webpack.dev.conf.js wabpack development environment configuration\n \u2502 \u2514\u2500\u2500 webpack.prod.conf.js wabpack production environment configuration\n \u251c\u2500\u2500 config project configuration\n \u2502 \u251c\u2500\u2500 dev.env.js development environment variables\n \u2502 \u251c\u2500\u2500 index.js project configuration file\n \u2502 \u251c\u2500\u2500 prod.env.js production environment variables\n \u2502 \u2514\u2500\u2500 test.env.js test environment variables\n \u251c\u2500\u2500 mock mock data directory\n \u2502 \u2514\u2500\u2500 hello.js\n \u251c\u2500\u2500 package.json npm package configuration file, which defines the npm script of the project, dependent packages and other information\n \u251c\u2500\u2500 src source directory\n \u2502 \u251c\u2500\u2500 main.js entry js file\n \u2502 \u251c\u2500\u2500 app.vue root component\n \u2502 \u251c\u2500\u2500 components public component directory\n \u2502 \u2502 \u2514\u2500\u2500 title.vue\n \u2502 \u251c\u2500\u2500 assets resource directory, the resources here will be built by wabpack\n \u2502 \u2502 \u2514\u2500\u2500 images\n \u2502 \u2502 \u2514\u2500\u2500 logo.png\n \u2502 \u251c\u2500\u2500 routes front-end routing\n \u2502 \u2502 \u2514\u2500\u2500 index.js\n \u2502 \u251c\u2500\u2500 store application-level data (state)\n \u2502 \u2502 \u2514\u2500\u2500 index.js\n \u2502 \u2514\u2500\u2500 views page directory\n \u2502 \u251c\u2500\u2500 hello.vue\n \u2502 \u2514\u2500\u2500 notfound.vue\n \u251c\u2500\u2500 static Pure static resources, will not be constructed by wabpack.\n \u2514\u2500\u2500 test test file directory (unit&e2e)\n \u2514\u2500\u2500 unit unit test\n \u251c\u2500\u2500 index.jsentry script\n \u251c\u2500\u2500 karma.conf.js karma configuration file\n \u2514\u2500\u2500 specs single test case directory\n \u2514\u2500\u2500 Hello.spec.js\n\n## Environment installation\n\nThis project depends on node.js, install node.js and cnpm before use (significantly increase the download speed of dependent packages).\n1. Download and install node.js by yourself: [https://nodejs.org/en/download/](https://nodejs.org/en/download/)\n2. Then install the cnpm command:\n\n npm install -g cnpm --registry=https://registry.npm.taobao.org\n\n\n## Quick start\n\n git clone https://github.com/hanan198501/vue-spa-template.git\n cd vue-spa-template\n cnpm install\n npm run dev\n\n## Command list:\n\n #Open the local development server, monitor the changes of project files, build in real time and automatically refresh the browser, and visit http://localhost:8081 in the browser\n npm run dev\n\n #Use the production environment configuration to build the project, and the built files will be output to the \"dist\" directory,\n npm run build\n\n #Run the build server, you can view the built page\n npm run build-server\n\n # run unit tests\n npm run unit\n \n## Separation of front and rear ends\n\nThe project realizes the front-end and back-end separation based on the spa method, and the server distinguishes the front-end page and back-end interface requests through nginx, and distributes them to different services. The front end physically has only one entry page, and the routing is controlled by the front end (based on vue-router), and the corresponding data and components are loaded for rendering according to different urls.\n\n## interface mock\n\nAfter the front-end and back-end are separated, you need to define the interface information (request address, parameters, return information, etc.) with the back-end classmates before development. The front-end can start coding by mocking without waiting for the back-end interface to be ready.\nThe local development server of the project is built based on express. Through the express middleware mechanism, we have added the interface mock function to dev-server.\nDuring development, the mock data of the interface is placed in the mock directory, and each file is as follows:\n\n\n module.exports = {\n \n // interface address\n api: '/api/hello',\n \n // return data refer to http://expressjs.com/zh-cn/4x/api.html\n response: function (req, res) {\n res. send(`\n hello vue!
\n `);\n }\n }\n\n\n## Modularity\n\nES2015 module syntax can be used during development, and each file will be compiled into an amd module during construction.\n\n## Componentization\n\nThe whole application is built by vue components, and the display of corresponding components is controlled by vue-router. The component tree structure is as follows:\n\n app.vue root component (there is only one for the whole application)\n \u251c\u2500\u2500view1.vue page-level component, placed in the views directory, when there are sub-components, you can create a sub-directory\n \u2502 \u251c\u2500\u2500component1.vue Functional components, public ones are placed in the components directory, otherwise they are placed in the views subdirectory\n \u2502 \u251c\u2500\u2500component2.vue\n \u2502 \u2514\u2500\u2500component3.vue\n \u251c\u2500\u2500view2.vue\n \u2502 \u251c\u2500\u2500component1.vue\n \u2502 \u2514\u2500\u2500component4.vue\n \u2514\u2500\u2500view3.vue\n \u251c\u2500\u2500component5.vue\n ...\n\n\n## unit test\n\nUnit tests can be written for each component and placed under the `test/unit/specs` directory. The directory structure of the unit test case is recommended to be consistent with the test file (relative to src), and the file name of each test case starts with `.spec .js` ending.\nWhen executing `npm run unit`, all `spec.js` files will be traversed, and the test report will be generated in the `test/unit/coverage` directory.\n\n\n## joint debugging method\n\nAfter the front-end and back-end are separated, since the server-side and front-end development environments are on two different machines, the asynchronous requests from the front-end need to be proxied to the back-end machine.\nWhen joint debugging, just run the dev script through the proxy parameter, and all the interfaces defined in the mock directory will be forwarded to the machine specified by the proxy parameter:\n\n # 172.16.36.90:8083 is the environment address of the backend machine\n npm run dev -- --proxy=172.16.36.90:8083\n\nIn this way, if the interface /api/hello is defined in the mock directory, it will be forwarded to http://172.16.36.90/:8083/api/hello\n\n## related resources\n\n- QQ group: 568815621\n- vue.js official website: [https://vuejs.org/](https://vuejs.org/)\n- vue.js Chinese website: [http://vuefe.cn/](http://vuefe.cn/)\n- vue-router documentation: [http://router.vuejs.org/zh-cn/index.html/](http://router.vuejs.org/zh-cn/index.html)\n- vuex documentation: [http://vuex.vuejs.org/](http://vuex.vuejs.org/)\n- webpack documentation: [https://webpack.github.io/docs/](https://webpack.github.io/docs/)\n- ES2015 Getting Started Tutorial: [http://es6.ruanyifeng.com/](http://es6.ruanyifeng.com/)\n- scss documentation: [http://sass-lang.com/documentation/file.SASS_REFERENCE.html](http://sass-lang.com/documentation/file.SASS_REFERENCE.html)\n- mocha documentation: [http://mochajs.org/](http://mochajs.org/)\n- Express Chinese official website: [http://expressjs.com/zh-cn/](http://expressjs.com/zh-cn/)", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "dominictarr/through", "link": "https://github.com/dominictarr/through", "tags": [], "stars": 670, "description": "simple way to create a ReadableWritable stream that works", "lang": "JavaScript", "repo_lang": "", "readme": "#through\n\n[](http://travis-ci.org/dominictarr/through)\n[](https://ci.testling.com/dominictarr/through)\n\nEasy way to create a `Stream` that is both `readable` and `writable`. \n\n* Pass in optional `write` and `end` methods.\n* `through` takes care of pause/resume logic if you use `this.queue(data)` instead of `this.emit('data', data)`.\n* Use `this.pause()` and `this.resume()` to manage flow.\n* Check `this.paused` to see current flow state. (`write` always returns `!this.paused`).\n\nThis function is the basis for most of the synchronous streams in \n[event-stream](http://github.com/dominictarr/event-stream).\n\n``` js\nvar through = require('through')\n\nthrough(function write(data) {\n this.queue(data) //data *must* not be null\n },\n function end () { //optional\n this.queue(null)\n })\n```\n\nOr, can also be used _without_ buffering on pause, use `this.emit('data', data)`,\nand this.emit('end')\n\n``` js\nvar through = require('through')\n\nthrough(function write(data) {\n this.emit('data', data)\n //this.pause() \n },\n function end () { //optional\n this.emit('end')\n })\n```\n\n## Extended Options\n\nYou will probably not need these 99% of the time.\n\n### autoDestroy=false\n\nBy default, `through` emits close when the writable\nand readable side of the stream has ended.\nIf that is not desired, set `autoDestroy=false`.\n\n``` js\nvar through = require('through')\n\n//like this\nvar ts = through(write, end, {autoDestroy: false})\n//or like this\nvar ts = through(write, end)\nts.autoDestroy = false\n```\n\n## License\n\nMIT / Apache2\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "emn178/js-md5", "link": "https://github.com/emn178/js-md5", "tags": ["javascript", "md5"], "stars": 670, "description": "A simple MD5 hash function for JavaScript supports UTF-8 encoding.", "lang": "JavaScript", "repo_lang": "", "readme": "# js-md5\n[](https://travis-ci.org/emn178/js-md5)\n[](https://coveralls.io/r/emn178/js-md5?branch=master) \n[](https://nodei.co/npm/js-md5/)\n\nA simple MD5 hash function for JavaScript supports UTF-8 encoding.\n\n## Demo\n[MD5 Online](http://emn178.github.io/online-tools/md5.html) \n[MD5 File Checksum Online](http://emn178.github.io/online-tools/md5_checksum.html)\n\n## Download\n[Compress](https://raw.github.com/emn178/js-md5/master/build/md5.min.js) \n[Uncompress](https://raw.github.com/emn178/js-md5/master/src/md5.js)\n\n## Installation\nYou can also install js-md5 by using Bower.\n\n bower install md5\n\nFor node.js, you can use this command to install:\n\n npm install js-md5\n\n## Notice\n`buffer` method is deprecated. This maybe confuse with Buffer in node.js. Please use `arrayBuffer` instead.\n\n## Usage\nYou could use like this:\n```JavaScript\nmd5('Message to hash');\nvar hash = md5.create();\nhash.update('Message to hash');\nhash.hex();\n```\nIf you use node.js, you should require the module first:\n```JavaScript\nmd5 = require('js-md5');\n```\nIt supports AMD:\n```JavaScript\nrequire(['your/path/md5.js'], function(md5) {\n// ...\n});\n```\n[See document](https://emn178.github.com/js-md5/doc/)\n\n## Example\n```JavaScript\nmd5(''); // d41d8cd98f00b204e9800998ecf8427e\nmd5('The quick brown fox jumps over the lazy dog'); // 9e107d9d372bb6826bd81d3542a419d6\nmd5('The quick brown fox jumps over the lazy dog.'); // e4d909c290d0fb1ca068ffaddf22cbd0\n\n// It also supports UTF-8 encoding\nmd5('\u4e2d\u6587'); // a7bac2239fcdcb3a067903d8077c4a07\n\n// It also supports byte `Array`, `Uint8Array`, `ArrayBuffer`\nmd5([]); // d41d8cd98f00b204e9800998ecf8427e\nmd5(new Uint8Array([])); // d41d8cd98f00b204e9800998ecf8427e\n\n// Different output\nmd5(''); // d41d8cd98f00b204e9800998ecf8427e\nmd5.hex(''); // d41d8cd98f00b204e9800998ecf8427e\nmd5.array(''); // [212, 29, 140, 217, 143, 0, 178, 4, 233, 128, 9, 152, 236, 248, 66, 126]\nmd5.digest(''); // [212, 29, 140, 217, 143, 0, 178, 4, 233, 128, 9, 152, 236, 248, 66, 126]\nmd5.arrayBuffer(''); // ArrayBuffer\nmd5.buffer(''); // ArrayBuffer, deprecated, This maybe confuse with Buffer in node.js. Please use arrayBuffer instead.\nmd5.base64(''); // 1B2M2Y8AsgTpgAmY7PhCfg==\n```\n\n## License\nThe project is released under the [MIT license](http://www.opensource.org/licenses/MIT).\n\n## Contact\nThe project's website is located at https://github.com/emn178/js-md5 \nAuthor: Chen, Yi-Cyuan (emn178@gmail.com)\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "aws-actions/amazon-ecr-login", "link": "https://github.com/aws-actions/amazon-ecr-login", "tags": [], "stars": 672, "description": "Logs into Amazon ECR with the local Docker client.", "lang": "JavaScript", "repo_lang": "", "readme": "## Amazon ECR \"Login\" Action for GitHub Actions\n\nLogs in the local Docker client to one or more Amazon ECR Private registries or an Amazon ECR Public registry.\n\n**Table of Contents**\n\n\n\n- [Example of Usage](#examples-of-usage)\n- [Credentials and Region](#credentials-and-region)\n- [Permissions](#permissions)\n- [Troubleshooting](#troubleshooting)\n- [License Summary](#license-summary)\n- [Security Disclosures](#security-disclosures)\n\n\n\n## Examples of Usage\n\n### Building and pushing an image\n\n#### Before each of the following examples, make sure to include the following:\n```yaml\n - name: Checkout repo\n uses: actions/checkout@v3\n\n - name: Configure AWS credentials\n uses: aws-actions/configure-aws-credentials@v1 # More information on this action can be found below in the 'AWS Credentials' section\n with:\n role-to-assume: arn:aws:iam::123456789012:role/my-github-actions-role\n aws-region: aws-region-1\n```\n\n#### Login to Amazon ECR Private, then build and push a Docker image:\n```yaml\n - name: Login to Amazon ECR\n id: login-ecr\n uses: aws-actions/amazon-ecr-login@v1\n\n - name: Build, tag, and push docker image to Amazon ECR\n env:\n REGISTRY: ${{ steps.login-ecr.outputs.registry }}\n REPOSITORY: my-ecr-repo\n IMAGE_TAG: ${{ github.sha }}\n run: |\n docker build -t $REGISTRY/$REPOSITORY:$IMAGE_TAG .\n docker push $REGISTRY/$REPOSITORY:$IMAGE_TAG\n```\n\n#### Login to Amazon ECR Public, then build and push a Docker image:\n```yaml\n - name: Login to Amazon ECR Public\n id: login-ecr-public\n uses: aws-actions/amazon-ecr-login@v1\n with:\n registry-type: public\n\n - name: Build, tag, and push docker image to Amazon ECR Public\n env:\n REGISTRY: ${{ steps.login-ecr-public.outputs.registry }}\n REGISTRY_ALIAS: my-ecr-public-registry-alias\n REPOSITORY: my-ecr-public-repo\n IMAGE_TAG: ${{ github.sha }}\n run: |\n docker build -t $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG .\n docker push $REGISTRY/$REGISTRY_ALIAS/$REPOSITORY:$IMAGE_TAG\n```\n\n#### Login to Amazon ECR Private, then package and push a Helm chart:\n```yaml\n - name: Login to Amazon ECR\n id: login-ecr\n uses: aws-actions/amazon-ecr-login@v1\n\n - name: Package and push helm chart to Amazon ECR\n env:\n REGISTRY: ${{ steps.login-ecr.outputs.registry }}\n REPOSITORY: my-ecr-repo\n run: |\n helm package $REPOSITORY\n helm push $REPOSITORY-0.1.0.tgz oci://$REGISTRY\n```\n\n#### Login to Amazon ECR Public, then package and push a Helm chart:\n```yaml\n - name: Login to Amazon ECR Public\n id: login-ecr-public\n uses: aws-actions/amazon-ecr-login@v1\n with:\n registry-type: public\n\n - name: Package and push helm chart to Amazon ECR Public\n env:\n REGISTRY: ${{ steps.login-ecr-public.outputs.registry }}\n REGISTRY_ALIAS: my-ecr-public-registry-alias\n REPOSITORY: my-ecr-public-repo\n run: |\n helm package $REPOSITORY\n helm push $REPOSITORY-0.1.0.tgz oci://$REGISTRY/$REGISTRY_ALIAS\n```\n\n(Helm uses the same credential store as Docker, so Helm can authenticate with the same credentials that you use for Docker)\n\n#### Login to ECR on multiple AWS accounts\n\n```yaml\n - name: Configure AWS credentials\n uses: aws-actions/configure-aws-credentials@v1\n with:\n role-to-assume: arn:aws:iam::123456789012:role/my-github-actions-role\n aws-region: aws-region-1\n\n - name: Login to Amazon ECR\n id: login-ecr\n uses: aws-actions/amazon-ecr-login@v1\n with:\n registries: \"123456789012,998877665544\"\n```\n\nThe repository on account `998877665544` needs to explicitly grant access to role:\n`arn:aws:iam::123456789012:role/my-github-actions-role` in order for cross-account access to work\n\nPlease refer to [AWS docs](https://aws.amazon.com/premiumsupport/knowledge-center/secondary-account-access-ecr/)\nfor details on how to configure ECR policies\n\n### Using an image as a service\n\nLogin to Amazon ECR Private, then use the outputted Docker credentials to run your private image as a service in another job\n```yaml\njobs:\n login-to-amazon-ecr:\n runs-on: ubuntu-latest\n steps:\n - name: Configure AWS credentials\n uses: aws-actions/configure-aws-credentials@v1\n with:\n role-to-assume: arn:aws:iam::123456789012:role/my-github-actions-role\n aws-region: us-east-1\n mask-aws-account-id: 'false'\n - name: Login to Amazon ECR\n id: login-ecr\n uses: aws-actions/amazon-ecr-login@v1\n outputs:\n registry: ${{ steps.login-ecr.outputs.registry }}\n docker_username: ${{ steps.login-ecr.outputs.docker_username_123456789012_dkr_ecr_us_east_1_amazonaws_com }} # More information on these outputs can be found below in the 'Docker Credentials' section\n docker_password: ${{ steps.login-ecr.outputs.docker_password_123456789012_dkr_ecr_us_east_1_amazonaws_com }}\n\n run-with-internal-service:\n name: Run something with an internal image as a service\n needs: login-to-amazon-ecr\n runs-on: ubuntu-latest\n services:\n internal-service:\n image: ${{ needs.login-to-amazon-ecr.outputs.registry }}/my-ecr-repo:latest\n credentials:\n username: ${{ needs.login-to-amazon-ecr.outputs.docker_username }}\n password: ${{ needs.login-to-amazon-ecr.outputs.docker_password }}\n ports:\n - '80:80'\n steps:\n - name: Run steps in container\n run: echo \"run steps in container\"\n```\n\nSee [action.yml](action.yml) for the full documentation for this action's inputs and outputs.\n\n## Credentials and Region\n\n### AWS Credentials\n\nThis action relies on the [default behavior of the AWS SDK for Javascript](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) to determine AWS credentials and region. Use [the `aws-actions/configure-aws-credentials` action](https://github.com/aws-actions/configure-aws-credentials) to configure the GitHub Actions environment with a role using GitHub's OIDC provider and your desired region.\n\n```yaml\n - name: Configure AWS credentials\n uses: aws-actions/configure-aws-credentials@v1\n with:\n role-to-assume: arn:aws:iam::123456789012:role/my-github-actions-role\n aws-region: us-east-1\n\n - name: Login to Amazon ECR Private\n id: login-ecr\n uses: aws-actions/amazon-ecr-login@v1\n```\n\nWe recommend following [Amazon IAM best practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) when using AWS services in GitHub Actions workflows, including:\n* [Assume an IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-workloads-use-roles) to receive temporary credentials. See the [Sample IAM Role CloudFormation Template](https://github.com/aws-actions/configure-aws-credentials#sample-iam-role-cloudformation-template) in the `aws-actions/configure-aws-credentials` action to get an example.\n* [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege) to the IAM role used in GitHub Actions workflows. Grant only the permissions required to perform the actions in your GitHub Actions workflows. See the Permissions section below for the permissions required by this action.\n* [Monitor the activity](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#remove-credentials) of the IAM role used in GitHub Actions workflows.\n\n### Docker Credentials\nThe registry URIs for ECR Private and ECR Public are as follows:\n- Registry URI for ECR Private: `123456789012.dkr.ecr.aws-region-1.amazonaws.com`\n- Registry URI for ECR Public: `public.ecr.aws`\n\nAfter logging in, you can access the docker username and password via action outputs using the following format:\n\nIf using ECR Private:\n- Docker username output: `docker_username_123456789012_dkr_ecr_aws_region_1_amazonaws_com`\n- Docker password output: `docker_password_123456789012_dkr_ecr_aws_region_1_amazonaws_com`\n\nIf using ECR Public:\n- Docker username output: `docker_username_public_ecr_aws`\n- Docker password output: `docker_password_public_ecr_aws`\n\nTo push Helm charts, you can also login through Docker. By default, Helm can authenticate with the same credentials that you use for Docker.\n\n## Permissions\n\n### ECR Private\n\nTo see how and where to implement the permissions below, see the [IAM section in the Amazon ECR User Guide](https://docs.aws.amazon.com/AmazonECR/latest/userguide/security-iam.html).\n\nThis action requires the following minimum set of permissions to login to ECR Private:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"GetAuthorizationToken\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ecr:GetAuthorizationToken\"\n ],\n \"Resource\": \"*\"\n }\n ]\n}\n```\n\nDocker commands in your GitHub Actions workflow, like `docker pull` and `docker push`, may require additional permissions attached to the credentials used by this action.\n\nThe following minimum permissions are required for pulling an image from an ECR Private repository:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"AllowPull\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ecr:BatchGetImage\",\n \"ecr:GetDownloadUrlForLayer\"\n ],\n \"Resource\": \"arn:aws:ecr:us-east-1:123456789012:repository/my-ecr-repo\"\n }\n ]\n}\n```\n\nThe following minimum permissions are required for pushing and pulling images in an ECR Private repository:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"AllowPushPull\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ecr:BatchGetImage\",\n \"ecr:BatchCheckLayerAvailability\",\n \"ecr:CompleteLayerUpload\",\n \"ecr:GetDownloadUrlForLayer\",\n \"ecr:InitiateLayerUpload\",\n \"ecr:PutImage\",\n \"ecr:UploadLayerPart\"\n ],\n \"Resource\": \"arn:aws:ecr:us-east-1:123456789012:repository/my-ecr-repo\"\n }\n ]\n}\n```\n\n### ECR Public\n\nTo see how and where to implement the permissions below, see the [IAM section in the Amazon ECR Public User Guide](https://docs.aws.amazon.com/AmazonECR/latest/public/security-iam.html).\n\n\nThis action requires the following minimum set of permissions to login to ECR Public:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"GetAuthorizationToken\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ecr-public:GetAuthorizationToken\",\n \"sts:GetServiceBearerToken\"\n ],\n \"Resource\": \"*\"\n }\n ]\n}\n```\n\nDocker commands in your GitHub Actions workflow, like `docker push`, may require additional permissions attached to the credentials used by this action. There are no permissions needed for pulling images from ECR Public.\n\nThe following minimum permissions are required for pushing an image to an ECR Public repository:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"AllowPush\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ecr-public:BatchCheckLayerAvailability\",\n \"ecr-public:CompleteLayerUpload\",\n \"ecr-public:InitiateLayerUpload\",\n \"ecr-public:PutImage\",\n \"ecr-public:UploadLayerPart\"\n ],\n \"Resource\": \"arn:aws:ecr-public::123456789012:repository/my-ecr-public-repo\"\n }\n ]\n}\n```\n\n## Troubleshooting\n\n### Configure credentials\n\n`Inaccessible host: 'api.ecr-public.aws-region-1.amazonaws.com' at port 'undefined'. This service may not be available in the 'aws-region-1' region.`\n\n- The `AWS_DEFAULT_REGION` environment variable is configured as a region where ECR Public isn't available.\n- ECR Public can only be logged into from the `us-east-1` region. In the `aws-actions/configure-aws-credentials` action, the `aws-region` input must be `us-east-1`.\n\n`GetAuthorizationToken command is only supported in us-east-1.`\n\n- The `AWS_DEFAULT_REGION` environment variable is configured as `us-west-2`.\n- ECR Public can only be logged into from the `us-east-1` region. In the `aws-actions/configure-aws-credentials` action, the `aws-region` input must be `us-east-1`.\n\n### Inputs\n\n`Invalid parameter at 'registryIds' failed to satisfy constraint: 'Member must satisfy constraint: [Member must satisfy regular expression pattern: [0-9]{12}]'`\n\n- One of the registries you provided in the `registries` input isn't a sequence of 12 digits\n- For users providing only a single registry ID in the `registries` input, if the ID begins with a 0, make sure to enclose it in quotes. GitHub Actions will read an input as a number if all of the characters in the input are digits. So if your registry ID begins with a 0, the 0 will be truncated. See issue [#225](https://github.com/aws-actions/amazon-ecr-login/issues/225).\n\n## License Summary\n\nThis code is made available under the MIT license.\n\n## Security Disclosures\n\nIf you would like to report a potential security issue in this project, please do not create a GitHub issue. Instead, please follow the instructions [here](https://aws.amazon.com/security/vulnerability-reporting/) or [email AWS security directly](mailto:aws-security@amazon.com).\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "soulwire/WTFEngine", "link": "https://github.com/soulwire/WTFEngine", "tags": [], "stars": 670, "description": "An HTML / CSS / JavaScript template for creating WhatTheFuckIsMyMashup.com style web sites", "lang": "JavaScript", "repo_lang": "", "readme": "# WTF Engine\n\nInspired by [WhatTheFuckShouldIMakeForDinner.com](http://whatthefuckshouldimakefordinner.com/), in 2011 I made [WhatTheFuckIsMyMashup.com](http://whatthefuckismymashup.com/) and released this simple tool, the [WTFEngine](https://github.com/soulwire/WTFEngine/), for generating similar websites.\n\nIt's very simple to use and now allows you to populate it using either vanilla JavaScript objects, JSON files or direct feeds from Google spreadsheets.\n\n## How to use it\n\nTo make your own, simply [clone](github-mac://openRepo/https://github.com/soulwire/WTFEngine) or [download](https://github.com/soulwire/WTFEngine/archive/master.zip) this repository and start populating the engine with your content.\n\nYou can populate it using one of three different methods. Each is controlled from [`main.js`](https://github.com/soulwire/WTFEngine/blob/master/scripts/main.js) (where you will find commented examples of each technique.)\n\n1. JavaScript Object literal\n2. A JSON file\n3. A live feed from a Google spreadsheet\n\nIf you choose to use a Google spreadsheet, you must [publish it first](https://support.google.com/drive/answer/37579?hl=en) and be sure to manually republish it after editing if you want changes to propagate immediately, otherwise they will take around 15 minutes.\n\nHere's an [example spreadsheet](https://docs.google.com/a/soulwire.co.uk/spreadsheet/ccc?key=0AvG1Hx204EyydF9ub1M2cVJ3Z1VGdDhTSWg0ZV9LNGc), which you can clone and use a base for your data source.\n\n_**Note**: For local testing (when using loaded JSON or Google spreadsheet data), you'll need to serve the site from a local webserver. You can easily do this using tools like [SimpleHTTPServer](http://www.linuxjournal.com/content/tech-tip-really-simple-http-server-python) for Python or [http-server](https://github.com/nodeapps/http-server) for Node._\n\n## How it works\n\nThe process is very simple. The WTF Engine takes a sentence template and fills in different types of blanks with different types of words, much like the game [Mad Libs](http://en.wikipedia.org/wiki/Mad_Libs). You can nominate any amount of templates and as many different categories of words or phrases as you like.\n\nFor example, here is a basic corpus\n\n {\n template: [ \"Big @color @animal\", \"Silly @animal with @color fur\" ],\n animal: [ \"dog\", \"cat\", \"rabbit\" ],\n color: [ \"red\", \"blue\", \"green\", \"yellow\" ]\n };\n \nAs you can see, in a template you use the __@__ symbol, followed by the type of word you wish to use to tell the WTF Engine to pick a random word of that type from the corpus and insert it at that point.\n\n## Showcase\n\nI've been pleasantly surprised to find several people using this template to create their own sites. Among them are:\n\n- [WTF is my bot](http://wtfismybot.tech/)\n- [WTF is my startup idea? ](http://whatthefuckismystartup.tech)\n- [Shit UX Ideas](http://shituxideas.com/)\n- [Nordic Larp Generator](http://www.messagefromtheinternet.com/nordiclarp/)\n- [WTF Are My Weekend Plans](http://www.wtfplans.com/)\n- [What The Fuck Is My Hydration Strategy](http://theplan.co.uk/hydration/)\n- [What The Fuck Is Birmingham's Transport Strategy](http://toys.paradisecircus.com/transport/)\n- [What's your fucking weapon](http://scottyboy76567.github.io/WeaponGenerator/)\n- [Who the Fuck is my Superhero Character](http://vanor.co.il/heroes/)\n- [What the Fuck is my Quest](http://whatthefuckismyquest.com/)\n- [What the Fuck is this Japanese Food](http://whatthefuckisthisjapanesefood.com/)\n- [What is my Pony](http://whoismypony.ponyfinder.net/)\n- [Game of Thrones spoiler generator](http://takephive.com/got_spoilergen/)\n- [Who the Fuck is my D&D Character](http://whothefuckismydndcharacter.com/)\n- [RPG Focused Character Idea Generator](http://enklave-23.de/WTF/)\n- [Startup Pitch Generator](http://startuppitchperfect.sebastianruder.com/)\n- [DevOps Vision generator](http://www.percussiverepair.net/devopsvision/)\n- [What the Fuck am I Bringing to Burning Man](http://whatthefuckamibringingtoburningman.com/)\n- [Insult Generator](http://www.omglmaowtf.com/insult-generator)\n- [MasterChef Me](http://www.masterchef.me)\n- [Bieber Blotter](http://www.linkalope.com/bieber-blotter)\n- [What the Fuck is my Wearable Strategy](http://whatthefuckismywearablestrategy.com/)\n- [What the Fuck is my Next TV Format](http://www.whatthefuckismynexttvformat.com/)\n- [What the Fuck is my Twitter Bio](http://whatthefuckismytwitterbio.com/)\n- [What the Fuck is my Award Idea](http://whatthefuckismyawardidea.com/)\n- [What is my SEO Doing](http://www.clicksandclients.com/what-is-my-seo-doing/)\n- [Fucking Valentines](http://fuckingvalentines.com/)\n- [Tony Abbott Excuse](http://abbottexcuse.1apps.com/)\n- [Why the Fuck are you Running Late](http://www.whythefuckareyourunninglate.com/)\n- [What the Fuck is my Brief](http://www.whatthefuckismybrief.com/)\n- [Whip-o-matic](http://whipomatic.com/)\n- [What the Fuck is my SXSW Panel](http://wtfismypanel.com/)\n- [Pitchfork Review Generator](http://pitchforkreviewgenerator.com/)\n- [Shit PR Ideas](http://shitprideas.com/)\n- [What the Fuck is my Mashup](http://whatthefuckismymashup.com/)\n\nIf you have made one, or know of any, please [let me know](https://github.com/soulwire/WTFEngine/issues/new).\n\n## Notes\n\nThis was written simply as a bit of fun. Zach's site was so popular that it inspired references based on other subjects, such as [What The Fuck Is My Social Media Strategy?](http://whatthefuckismysocialmediastrategy.com) (and consequently [What The Fuck Is My Mashup?](http://whatthefuckismymashup.com/)). As far as I am aware, this idea was Zach's alone and so credit to him for the inspiration. As a meme, there are doubtlessly many topics that could do with the WTF treatment; which is why I decided to create this (very) simple platform.\n\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "dollarshaveclub/scrolldir", "link": "https://github.com/dollarshaveclub/scrolldir", "tags": ["javascript", "scroll", "scrolling", "css", "y-axis", "sticky-elements", "sticky-headers"], "stars": 669, "description": "0 dependency JS plugin to leverage scroll direction with CSS \u2b06\u2b07 \ud83d\udd0c\ud83d\udc89", "lang": "JavaScript", "repo_lang": "", "readme": "\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f
\n\n \n This software is maintained under a new repository located at yowainwright/scrolldir\n \n
\n\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f\u26a0\ufe0f
\n\n***\n\n![\"scrolldir](\"https://cloud.githubusercontent.com/assets/1074042/22093384/09f3c2a6-ddba-11e6-8706-7e63be185448.jpg\")
\nLeverage Vertical Scroll Direction with CSS \ud83d\ude0e
\n\n\n \n ![\"Build](\"https://travis-ci.org/dollarshaveclub/scrolldir.svg?branch=master\")
\n \n \n ![\"CDNJS\"](\"https://img.shields.io/cdnjs/v/scrolldir.svg\")
\n \n \n ![\"Greenkeeper\"](\"https://badges.greenkeeper.io/dollarshaveclub/scrolldir.svg\")
\n \n \n ![\"npm](\"https://badge.fury.io/js/scrolldir.svg\"){kind=icon}
\n \n \n ![\"Bower](\"https://badge.fury.io/bo/scrolldir.svg\"){kind=icon}
\n \n \n ![\"Share](\"https://img.shields.io/twitter/url/http/shields.io.svg?style=social&maxAge=2592000\")
\n \n
\n \n ![\"Scrolldir](\"https://cloud.githubusercontent.com/assets/1074042/22451992/ebe879b0-e727-11e6-8799-511209695e26.gif\")
\n \n
\n ![](\"https://user-images.githubusercontent.com/214063/46479857-4cd66e80-c7f0-11e8-9585-5748409c9490.png\")
\n
\n \n ![\"Build](\"https://travis-ci.org/FNNDSC/ami.svg?branch=master\"\n)
\n \n \n ![\"CDNJS](\"https://img.shields.io/cdnjs/v/ami.js.svg\"\n)
\n \n \n ![\"NPM](\"https://img.shields.io/npm/v/ami.js/next.svg\"\n)
\n \n \n ![\"Slack\"](\"https://img.shields.io/badge/slack-join-blue.svg\"\n){kind=icon}
\n \n
\n \n ![\"lesson00\"](\"https://unpkg.com/ami.js@next/lessons/00/assets/thumbnail-128x128.jpg\" "\\"Click") \n \n | \n \n \n Lesson 00: Load\n \n \n Load DICOM Data and get a nice Series/Stack/Frame structure.\n \n | \n\n \n \n \n ![\"lesson01\"](\"https://cloud.githubusercontent.com/assets/214063/14734707/8963a142-086c-11e6-99e2-35125f5ebb83.gif\" "\\"Click") \n \n | \n \n \n Lesson 01: Visualize 3D\n \n \n Look at the data we loaded in 3D.\n \n | \n
\n \n ![\"lesson00\"](\"https://cloud.githubusercontent.com/assets/214063/14734782/1aa3006c-086d-11e6-9f56-6476e5ac6188.gif\" "\\"Click") \n \n | \n \n \n Lesson 02: Mesh\n \n \n Add a mesh to the scene.\n \n | \n\n \n \n \n ![\"lesson00\"](\"https://cloud.githubusercontent.com/assets/214063/14734860/99882c22-086d-11e6-99ae-16b7e5371f40.gif\" "\\"Click") \n \n | \n \n \n Lesson 03: Visualize 2D\n \n \n Look at the data in 2D.\n \n | \n
\n \n ![\"lesson00\"](\"https://cloud.githubusercontent.com/assets/214063/16259390/b04a7d96-3862-11e6-8937-3019b913a21f.gif\" "\\"Click") \n \n | \n \n \n Lesson 04: Labelmap\n \n \n Overlays on top of you data.\n \n | \n\n \n \n \n \n \n \n | \n\n \n Lesson 05: TRK\n \n \n TRK - coming soon.\n \n | \n
\n \n ![\"lesson00\"](\"https://cloud.githubusercontent.com/assets/214063/20212355/fdf512b2-a802-11e6-884d-bfafd0a1ec7d.gif\" "\\"Click") \n \n | \n \n \n Lesson 06: Volume Rendering\n \n \n Volume Rendering.\n \n | \n\n \n \n \n \n \n \n | \n\n \n Lesson 07: Lookup tables\n \n \n Lookup Tables - coming soon.\n \n | \n
\n \n ![\"lesson00\"](\"https://cloud.githubusercontent.com/assets/214063/20597899/9b7ec102-b246-11e6-804b-be8ac6dc9a68.gif\" "\\"Click") \n \n | \n \n \n Lesson 08: Custom progress bar\n \n \n Custom progress bars.\n \n | \n
\n ![\"LiteApp\"](\"https://github.com/iqiyi/LiteApp/blob/master/Images/logo.png?raw=true\" "\\"LiteApp\\""){kind=logo}
\n
![\"Architecture\"/](\"https://github.com/iqiyi/LiteApp/blob/master/Images/Architecture.png?raw=true\")
\n![\"iOS](\"https://github.com/iqiyi/LiteApp/blob/master/Images/iOS_Video.gif?raw=true\")
\n>\n> ![\"Android](\"https://github.com/iqiyi/LiteApp/blob/master/Images/Andriod_Video.gif?raw=true\")
\n![\"iOS](\"https://github.com/iqiyi/LiteApp/blob/master/Images/liteApp.gif?raw=true\")
\n>\n> ![\"Android](\"https://github.com/iqiyi/LiteApp/blob/master/Images/html5.gif?raw=true\")
\n![\"hiproxy\"](\"https://avatars0.githubusercontent.com/u/29273417?v=3\")
\n\n**hiproxy** is a lightweight web proxy tool based on [Node.js][node]. The primary purpose of **hiproxy** is to solve the problem of host management and reverse proxy needs of developers.\n\nFor example, if you are working as a team and each of the developers in the team need a different proxy setting, you will no longer need to modify your hosts file or use a web server like [Nginx][nginx] as a reverse proxy.\n\n**hiproxy** extends the syntax of hosts file to support **port numbers**. Besides, hiproxy also supports configuration through a syntax similar to the [Nginx configuration file][nginx-config].\n\n[nginx]: https://nginx.org/\n[nginx-config]: http://nginx.org/en/docs/beginners_guide.html \"nginx Beginner\u2019s Guide\"\n[node]: https://nodejs.org \"Node.js\"\n\n[\u4e2d\u6587\u7248\u6587\u6863](https://github.com/hiproxy/hiproxy/blob/master/README-zh.md)\n\n[](https://travis-ci.org/hiproxy/hiproxy)\n[](https://ci.appveyor.com/project/zdying/hiproxy/branch/master)\n[](https://codecov.io/gh/hiproxy/hiproxy)\n[](https://github.com/Flet/semistandard)\n[](https://www.npmjs.com/package/hiproxy)\n[](https://nodejs.org/)\n[](https://github.com/hiproxy/hiproxy/blob/master/LICENSE)\n\n## Why Hiproxy?\n\nIf you are a front-end developer, it is not uncommon for you to encounter the following problems:\n\n**Debugging web pages locally**: To develop your web projects in a local development environment, you\u2019ll have to run a back-end server (such as a **Node.js** *express* application, or a **Java SpringBoot** application). As a front-end developer, you might not be familiar with the back-end technology stack, simply setting up the development environment can consume a lot of your time.\n\n**Cross-Origin Issues**: While developing your front-end projects locally, you might need to solve cross-domain and cross-origin resource sharing issues. To address these problems, you will need to modify the response header. \n\n\n**Self-Signed Certificates**: You\u2019ll often need to test https pages. When you visit https pages with a self-signed certificate, your browser will raise security warnings.\n\nOne common way to modify the response header is to put a **proxy** as a \u201cman in the middle\u201d. *NGINX*, for example, has a nice syntax that you can configure as a reverse-proxy to handle all these needs.\n\n\nAlthough NGINX is a great tool to address all the above problems, when setting up NGINX, you\u2019ll also modify your hosts file a lot to proxy the requests to a local NGINX service. This can especially turn out to be a burden if you are working on multiple projects.\n\nCan we have a better way to solve this problem?\n\nWell, yes. Meet **hiproxy**!\n\n\n## Features\n\n* **Nginx.config-style configuration** file syntax with a simple and intuitive configuration\n* **Extended** hosts configuration with **port numbers**.\n* **Plugin extensions** to rewrite *directives*, *command line interface*, and *pages*\n* Automatic generation and management of **TLS certificates**\n* **Auto-detection** of configuration file\n* **Proxy auto-configuration**\n* You can run hiproxy as a **background service** and redirect its output to a log file.\n* You can open a browser window and configure your proxy from its **web interface**.\n* **hiproxy** provides a **Node.js API** for fine-tuning and lower-level control.\n\n## Installation\n\n```bash\nnpm install -g hiproxy\n```\n\n> If you want to experience the latest features of hiproxy, you can install the next version.\n```\nnpm install -g hiproxy@next\n```\n\n## Usage\n\n### CLI\n\nStart proxy server:\n\n```bash\nhiproxy start -p 5525 --debug --workspace ${PATH_TO_WORKSPACE}\n```\n\nConfigure proxy:\n\n```bash\n127.0.0.1:5525\n```\n\n## CLI Usage\n\n```bash\n> hiproxy --help\n\nUsage:\n\n hiproxy [command] [option]\n\nCommands:\n\n start Start a local proxy server\n stop Stop the local proxy server (Only works in daemon mode)\n restart Restart the local proxy service (Only works in daemon mode)\n state Show all the servers state (Only works in daemon mode)\n open Open browser and set proxy\n hello A test command that say hello to you.\n\nOptions:\n\n -v, --version Display version information\n -h, --help Display help information\n --log-dir {{ $t('content', {'type': 'nice'}) }}
\n\t\t\n \n ![\"Animated](\"https://tympanus.net/codrops/wp-content/uploads/2019/01/MeshLines_Featured-2.jpg\")
\n \n
\n \n ![\"Animated](\"https://github.com/Jeremboo/animated-mesh-lines/blob/master/previews/preview.gif?raw=true\")
\n \n \n ![\"Animated](\"https://github.com/Jeremboo/animated-mesh-lines/blob/master/previews/preview3.gif?raw=true\")
\n \n \n ![\"Animated](\"https://github.com/Jeremboo/animated-mesh-lines/blob/master/previews/preview4.gif?raw=true\")
\n \n \n ![\"Animated](\"https://github.com/Jeremboo/animated-mesh-lines/blob/master/previews/preview5.gif?raw=true\")
\n \n
\n ![\"Repository](\"https://img.shields.io/github/repo-size/billbarsch/myzap\")
![\"GitHub](\"https://img.shields.io/github/last-commit/billbarsch/myzap\")
![\"Stargazers\"](\"https://img.shields.io/github/stars/billbarsch/myzap\")
![\"GitHub](\"https://img.shields.io/github/forks/billbarsch/myzap\")
![\"GitHub](\"https://img.shields.io/github/languages/top/billbarsch/myzap\")
![\"GitHub](\"https://img.shields.io/github/v/release/billbarsch/myzap\")
![\"GitHub](\"https://img.shields.io/github/release-date/billbarsch/myzap\")
![](\"https://upload.wikimedia.org/wikipedia/commons/thumb/f/f7/WhatsApp_logo.svg/2000px-WhatsApp_logo.svg.png\" "\\"WhatsApp"){kind=logo}
\n\nWe have some COLLABORATORS who provide support, if you need to contact [Everton Nogueira](https://api.whatsapp.com/send?phone=5511912891716&text=Gostaria%20de%20mais%20informa%C3%A7%C3%B5es% 20sobre%20o%20suporte%20da%20API%20MyZAP) or [Jonathan Henrique](https://api.whatsapp.com/send?phone=5531994359434&text=I would like%20de%20mais%20informa%C3%A7%C3%B5es% 20about%20o%20support%20of%20API%20MyZAP)\n\n## #Automatic installation with 1 click; Did you copy? \ud83d\ude0e\n \ud83d\udc49 curl -sSL https://sh.owenbrasil.com/myzap.sh | bash\n\n- Run this command on a fresh Ubuntu 20x server with at least 2GB RAM\n\n## Postman Documentation & Examples:\nThe API documentation is available online [Here](https://documenter.getpostman.com/view/11074732/UVkqrZtZ) . You can also import the Postman collection file into your Postman application alternatively.\n\n## Support Groups\n\n\n ![](\"https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp){kind=icon}
\n\n\n\n \n\n\n\n \n\n\n\n ![\"Telegram\"](\"https://img.shields.io/badge/telegram-online-blue.svg?style=for-the-badge&logo=t1elegram\"){kind=icon}
\n\n\n## Log all changes:\n\n- [Changelog](https://github.com/billbarsch/myzap/blob/myzap2.0/docs/CHANGELOG.md)\n\n## MyZap demo:\n\n\ud83d\udc49 To test myzap running in a production environment for free: Click here \n\n## PHP client\n```composer require jhowbhz/package-apigratis```\n\n\ud83d\udc49 Acessar repositorio\n\n\n## Atividades Recentes [](https://repography.com)\n[](https://github.com/billbarsch/myzap/pulls)\n[](https://github.com/billbarsch/myzap/commits)\n\n\n## Top contributors\n[](https://github.com/billbarsch/myzap/graphs/contributors)", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "jussi-kalliokoski/audiolib.js", "link": "https://github.com/jussi-kalliokoski/audiolib.js", "tags": [], "stars": 668, "description": "audiolib.js is a powerful audio tools library for javascript.", "lang": "JavaScript", "repo_lang": "", "readme": "# audiolib.js\n## Overview\n\naudiolib.js is a powerful toolkit for audio written in JS.\n\nIt ships with most of the common tools such as:\n\n* Reverbs\n* Comb/IIR/Biquad/All-Pass/Low-Pass/Band-Pass/High-Pass filters\n* Delays\n* Oscillators\n* FFT and other analyzing tools\n* Step sequencers\n* Envelope controls\n* Noise generators\n* Samplers\n\nIn addition, it hosts these tools in a comprehensive framework, that makes it simple to write a single effect and provides the higher level abstraction on top of that, making the whole system comfortable for both users and plugin authors.\n\nAs for the higher level abstraction, audiolib.js features a sophisticated automation API, alongside with pre-processing hooks, sample level access and buffer level management.\n\naudiolib.js is bundled with some tools to make an audio developer's life in a browser much easier, such as sink.js for a consistent API between the experimental browser audio APIs. To complement that, audiolib.js also bundles pcmdata.js that is a WAV encoder/decoder, so that you can turn the recordings you make using Sink.js into WAV files that the user can save. Other tools include the AudioWorker API that allows you to create web workers from strings or functions, bundling audiolib.js and its plugins, all ready to use from the worker.\n\n\n## How to get it\n\naudiolib.js is available both in browser and CLI environments.\n\n### Node\n\nTo install via npm:\n\n```\n$ npm install audiolib\n```\n\nPlease note that you'll need [grunt](http://gruntjs.com/) for this to work.\n\n### Browser\n\nFor browser environments, download the latest version [here](https://github.com/jussi-kalliokoski/audiolib.js/downloads), or get the [source code](https://github.com/jussi-kalliokoski/audiolib.js) from GitHub and build it yourself. Don't worry, instructions are included.\n\n## Documentation\n\nDocumentation is available at http://docs.audiolibjs.org/ . Tutorials can be found in the [wiki](https://github.com/jussi-kalliokoski/audiolib.js/wiki)\n\n## Demos\n\n(if you have your own, please fork & add | msg me)\n\n* [JSMad](http://audiocogs.org/codecs/mp3/)\n* [Orbisyn](http://niiden.com/orbisyn/)\n* [Audiocogs codecs](http://audiocogs.org/codecs/)\n\n## Libraries bundled with audiolib.js\n\n* [sink.js](https://github.com/jussi-kalliokoski/sink.js), for output and buffer handling.\n* [PCMData.js](https://github.com/jussi-kalliokoski/pcmdata.js), for WAV codecs. (project deprecated and adopted)\n* [binary.js](https://github.com/jussi-kalliokoski/binary.js), for PCMData.js and general binary data processing. (project deprecated and adopted)\n* [fft.js](https://github.com/jussi-kalliokoski/fft.js), for super fast FT. (project deprecated and adopted)\n\n## Related libraries\n\n* [XAudioJS](https://github.com/grantgalitz/XAudioJS) is an alternative audio sink with built-in resampling and a Flash fallback. More developer-controlled output environment, that might be more sane for example games.\n* [dynamicaudio.js](http://github.com/bfirsh/dynamicaudio.js) is a Flash fallback for Mozilla Audio Data API.\n* [Audiolet](https://github.com/oampo/Audiolet) is a graph-based audio routing framework with a lot of nice stuff.\n* [DSP.js](https://github.com/corbanbrook/dsp.js) is an extensive DSP toolkit originally designed for the Mozilla Audio Data API.\n\n## Plugins\n\nSpecifications for plugin developers can be found in https://github.com/jussi-kalliokoski/audiolib.js/tree/master/specs\n\n## Credits \n\nThis project is maintained by [Jussi Kalliokoski](https://github.com/jussi-kalliokoski), with significant contributions from [David Govea](https://github.com/davidgovea).\n\n## License\n\nLicensed under MIT license.\n\n## Example usage\n\n```javascript\n/* Create an output. */\n\nvar dev = audioLib.Sink(function(sampleBuffer){\n\t// Fill the buffer here.\n}, channelCount, preBufferSize, sampleRate);\n\n/*\n Note that all the arguments are optional,\n so if you want to create a write-only\n device, you can leave the arguments blank.\n Also, it is highly discouraged to set any\n of the arguments if you aren't sure that you\n need them. Use null if you need to skip\n arguments.\n*/\n\n/* Writing buffers: */\ndev.writeBuffer(buffer);\n\n/*\n You can also attach multiple listeners\n to the same Sink instance.\n*/\ndev.on('audioprocess', function(...){});\n\n\n/* Effects */\n\nvar del = audioLib.Delay(sampleRate, delay, feedback);\n\nvar flt = audioLib.IIRFilter(sampleRate, cutoffFreq, resonance);\n\nvar flt = audioLib.LP12Filter(sampleRate, cutoffFreq, resonance);\n\nvar flt = audioLib.Reverb(sampleRate, channelCount, wet, dry, roomSize, damping);\n\nvar dist = audioLib.BiquadFilter(sampleRate, b0, b1, b2, a1, a2);\n\n/* to feed a new input sample */\neffect.pushSample(sample);\n/* to get the output */\nsample = effect.getMix();\n\n/* Synthesis */\n\nvar osc = audioLib.Oscillator(sampleRate, frequency);\n\n/* to generate a new sample */\nosc.generate();\n/* to get the output */\nosc.getMix();\n\n/* Sampler */\n\nvar sampler = audioLib.Sampler(sampleRate, sampleBuffer, defaultPitch);\n\n/* Envelopes */\n\nvar adsr = audioLib.ADSREnvelope(sampleRate, attack, decay, sustain, release);\n\n/* to trigger the gate */\nadsr.triggerGate(isOpen);\n/* to update the value ** Do this on every sample fetch for this to work properly. */\nadsr.generate();\n/* Get the value */\nadsr.value; // 0.0 - 1.0, unless you put something more as sustain\n\nvar stepSeq = new audioLib.StepSequencer(sampleRate, stepLength, stepArray, attack);\n\n/* To start the sequence over */\nstepSeq.triggerGate();\n/* to update the value ** Do this on every sample fetch for this to work properly. */\nstepSeq.generate();\n/* Get the value */\nstepSeq.value; // 0.0 - 1.0\n\n/* Recording */\n\nvar rec = dev.record();\n\n/* To stop */\nrec.stop();\n// To export wav\nvar audioElement = new Audio(\n\t'data:audio/wav;base64,' +\n\tbtoa( rec.toWav() ) // presuming btoa is supported\n);\n\n/* Resampling buffers */\naudioLib.Sampler.resample(buffer, fromSampleRate,\n\tfromFrequency, toSampleRate, toFrequency);\n\n/*\n If you are used to buffer based approach (for example DSP.js)\n and don't need to do any raw manipulation, all the effects\n can be used as buffer based too.\n*/\n\nvar bufFx = audioLib.Delay/* or any effect */.createBufferBased(\n\tchannelCount, /* the parameters needed by the specific effect */);\n\nbufFx.append(buffer);\n\n```\n\n### Audio Workers\n\nYou can also use audiolib.js inside Audio Workers (Firefox 6.0+ only), but this is a whole another story. There are many approaches to that, you can include audiolib.js via an external javascript worker file, but audiolib.js offers an alternative approach to this: inline workers. Inline audio workers include the source code already downloaded, and thus creates a new worker that already contains audiolib.js. Inline Audio Workers also allow you to inject code into workers. Here is some code to get started, also see tests/audioworker.html.\n\n```javascript\n\nvar worker = audioLib.AudioWorker(function(){\n\tdevice = audioLib.Sink(function(buffer, channelCount){\n\t\t/* Do some audio processing, like you weren't in a worker. */\n\t});\n}, true /* enables injections */);\n\n/* Injection */\n\nworker.inject(function(){\n\t/* Execute some code inside the worker. */\n});\n\n/* Close the worker */\n\nworker.terminate();\n\n```\n\nIt's important to remember that even though that code looks like it's running in the same environment as the code it's written in, it's actually not and runs in the context of the worker, meaning you can't cross-reference variables. Also, the injections are sandboxed, so if you need to create a global variable, drop var.\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "pinguinjkeke/vue-local-storage", "link": "https://github.com/pinguinjkeke/vue-local-storage", "tags": ["vue", "vuejs", "vuejs2", "localstorage", "ssr"], "stars": 668, "description": "Vue.js localStorage plugin with types support", "lang": "JavaScript", "repo_lang": "", "readme": "# VueLocalStorage\n[](https://circleci.com/gh/pinguinjkeke/vue-local-storage/tree/master.svg?style=shield)\n[](https://www.npmjs.com/package/vue-localstorage)\n[](https://www.npmjs.com/package/vue-localstorage)\n\nLocalStorage plugin inspired by Vue typed props which take a care of typecasting for Vue.js 1 and 2 with SSR support.\n\n## Install\n\n ``` bash\n npm install vue-localstorage --save\n ```\n or\n ``` bash\n bower install vue-localstorage\n ```\n\n## Usage\n ``` js\n import VueLocalStorage from 'vue-localstorage'\n\n Vue.use(VueLocalStorage)\n // Or you can specify any other name and use it via this.$ls, this.$whatEverYouWant\n Vue.use(VueLocalStorage, {\n name: 'ls',\n bind: true //created computed members from your variable declarations\n })\n\n // Use localStorage from Vue object\n Vue.localStorage.set('someNumber', 123)\n Vue.localStorage.get('someNumber')\n\n // Fallback value if nothing found in localStorage\n Vue.localStorage.get('propertyThatNotExists', 'fallbackValue') // Will return 'fallbackValue' string\n \n // Default type if value isn't registered in localStorage section\n Vue.localStorage.get('property', null, Number)\n\n //register localStorage variables and adds computed variables to local components\n //to be used like regular computeds that are stored in the localstorage\n var vm = new Vue({\n localStorage: {\n someObject: {\n type: Object,\n default: {\n hello: 'world'\n }\n },\n someNumber: {\n type: Number,\n },\n someBoolean: {\n type: Boolean\n },\n stringOne: '',\n stringTwo: {\n type: String,\n default: 'helloworld!'\n },\n stringThree: {\n default: 'hello'\n }\n },\n methods: {\n someMethod () {\n let lsValue = this.$localStorage.get('someObject')\n this.$localStorage.set('someBoolean', true)\n this.$localStorage.remove('stringOne')\n }\n }\n })\n ```\n## License\n[MIT](https://github.com/pinguinjkeke/vue-local-storage/blob/master/LICENSE)\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "mdn/voice-change-o-matic", "link": "https://github.com/mdn/voice-change-o-matic", "tags": [], "stars": 668, "description": "Web Audio API-powered voice changer and visualizer", "lang": "JavaScript", "repo_lang": "", "readme": "# Voice-change-o-matic\n\n> NOTE: The contents of this repository has been moved to [webaudio-examples/voice-change-o-matic](https://github.com/mdn/webaudio-examples/tree/main/voice-change-o-matic)\n\nA Web Audio API-powered voice changer and visualizer.\n", "readme_type": "markdown", "hn_comments": "", "gh_updated_time": "", "gh_accessed_time": "", "hn_accessed_time": ""}, {"name": "wp-shortcake/shortcake", "link": "https://github.com/wp-shortcake/shortcake", "tags": [], "stars": 668, "description": "Shortcake makes using WordPress shortcodes a piece of cake.", "lang": "JavaScript", "repo_lang": "", "readme": "=== Shortcake (Shortcode UI) ===\nContributors: fusionengineering, mattheu, danielbachhuber, zebulonj, goldenapples, jitendraharpalani, sanchothefat, bfintal, davisshaver, garyj, mte90, fredserva, khromov, bronsonquick, dashaluna, mehigh, sc0ttkclark, kraftner, pravdomil\nTags: shortcodes\nRequires at least: 4.5\nTested up to: 5.0.3\nStable tag: 0.7.4\nLicense: GPLv2 or later\nLicense URI: http://www.gnu.org/licenses/gpl-2.0.html\n\nShortcake makes using WordPress shortcodes a piece of cake.\n\n== Description ==\n\nUsed alongside `add_shortcode`, Shortcake supplies a user-friendly interface for adding a shortcode to a post, and viewing and editing it from within the content editor.\n\nOnce you've installed the plugin, you'll need to [register UI for your shortcodes](https://github.com/wp-shortcake/shortcake/wiki/Registering-Shortcode-UI). For inspiration, check out [examples of Shortcake in the wild](https://github.com/wp-shortcake/shortcake/wiki/Shortcode-UI-Examples).\n\nTo report bugs or feature requests, [please use Github issues](https://github.com/wp-shortcake/shortcake/issues).\n\n== Installation ==\n\nShortcake can be installed like any other WordPress plugin.\n\nOnce you've done so, you'll need to [register the UI for your code](https://github.com/wp-shortcake/shortcake/wiki/Registering-Shortcode-UI).\n\nNew in 0.4.0 is the ability to [attach javascript functions to event attribute updates](https://github.com/wp-shortcake/shortcake/wiki/Event-Attribute-Callbacks). Action hooks can be used to dynamically show or hide a field based on the value of another, or to implement custom validation rules.\n\n== Frequently Asked Questions ==\n\n= How do I register UI for arbitrary key/value pairs as shortcode attributes? =\n\nShortcake doesn't support custom key => value pairs as shortcode attributes because it isn't a great user experience.\n\n= After upgrading to Shortcake 0.7.x, some of the shortcode UI fields (post select, user select, etc) don't work as expected. What can I do? =\n\nIn version 0.7.0, we updated to the most recent branch of the Select2 library, which provides the enhanced select fields in these field types. This causes a known conflict with plugins that enqueue older versions of Select2. (Popular plugins with known conflicts include WooCommerce and Advanced Custom Fields Pro, among others.)\n\nIf you find that you're experiencing conflicts with these plugins, you can set a flag to load select2 in a distinct namespace by defining the constant `SELECT2_NOCONFLICT` in your wp-config.php (or anywhere that's defined before the 'init' hook.)\n\n`\ndefine( 'SELECT2_NOCONFLICT', true );\n`\n\n== Running tests ==\n\nWe have test coverage for PHP using PHPunit, and JavaScript using Jasmine.\n\n= Running tests locally =\n\nJasmine tests can be run using `grunt jasmine` and are also run as part of the `grunt scripts` task. To update the core WordPress files used by the Jasmine test suite, run `grunt updateJasmineCoreScripts --abspath=\"/path/to/wordpress-install\"`.\n\n== Screenshots ==\n\n1. Without Shortcake, shortcodes have a minimal UI.\n2. But with Shortcake, TinyMCE will render the shortcode in a TinyMCE view.\n3. And add a user-friendly UI to edit shortcode content and attributes.\n4. Add new shortcodes to your post through \"Add Media\".\n\n== Upgrade Notice ==\n\n= 0.4.0 =\n\nWe've removed the compatibility shim for the `placeholder` attribute argument. You should register a placeholder for your field using the `meta` argument.\n\n= 0.3.0 =\n\nWe've removed the compatibility shim for the magical `content` attribute. If you were using this to support editing inner content, you'll need to change your UI registration to use `inner_content`.\n\n== Changelog ==\n\n= 0.7.4 (January 16, 2019) =\n* Block editor compatibility: prevent templates from being output before the document head, which forced the browser into quirksmode, breaking some CSS styles in the block editor.\n* Bug fix: the above bugfix.\n* Bug fix: Fix a javascript error which would cause the Insert Post Element modal to be blank if any shortcode contains a select field with no visible options and no default set.\n* Bug fix: Fix a bug where the \"Select Files\" button in the media controller became unresponsive after a post element has been inserted.\n* Enhancement: add an optional \"allow clear\" field attribute to be passed to select2 fields (post, user, or term select) so that multi-select fields can be cleared with a single click. (This option defaults to off and should not affect existing fields.)\n\n= 0.7.3 (September 5, 2017) =\n* Security: Use nonce validation in ajax render shortcode callback to protect against CSRF.\n* Bug fix: Make sure that the same js hooks fire on all field types.\n* Bug fix: Fix bugs affecting multiple select fields (values could not be unset once set, and multiple default values couldn't be set).\n* Bug fix: Prevent encoded fields containing two percent characters from breaking.\n* Bug fix: Fix some issues where the media modal state was not reset properly if a shortcode was closed without saving.\n* Bug fix: Support cases where there are multiple WP_Editor instances on a page, and make sure that the shortcode being edited is sent to the correct page.\n* Enhancement: When post_select field is selecting from more than one post type, show the post type alongside the post name for easier selection.\n* Enhancement: Show attachment thumbnails for any attachment type, not just images.\n* Enhancement: Add more helpful error messages if no shortcodes with Shortcake UI are registered.\n* Update Norwegian translation\n\n= 0.7.2 (April 24, 2017) =\n* Bug fix: Fix behavior in WordPress 4.7.4 where editing a shortcode would insert a new shortcode into the editor rather than updating the shortcode being edited.\n* Bug fix: The replacement used to escape percent (%) characters in attributes only replaced the first appearance\n* Bug fix: For select fields with multiple=true, allow multiple options to be selected by default\n* Added i18n for all strings in attachment field template\n* Added Finnish translation\n\n= 0.7.1 (March 16, 2017) =\n* Change shortcode formatting to add a space before the self-closing trailing slash.\n* Fix alignment of attachment previews with long filenames.\n* Bug fix: Set an initial value on select fields (previously, no value would be set for a select field unless the user interacts with the field).\n* Enhancement/fix: Reuse one copy of the media modal and reset its state upon closing, rather than creating duplicate markup each time the modal is accessed.\n* Compatibility: Uses \"full\" version of select2.js 4.0.3 to prevent plugin conflicts with other plugins which expect the full version to be enqueued.\n* Compatibility: Add `SELECT2_NOCONFLICT` flag to load Select2 in a unique namespace to prevent conflicts with other plugins which are loading select2.js version 3.\n* Added Norwegian translation.\n* Multiple coding style fixes.\n\n= 0.7.0 (November 18, 2016) =\n* Adds \"Add post element\" button to media buttons - one click to open the shortcode list, rather than clicking \"Add media\" button and then finding \"insert post element\" in the menu.\n* Added \"Term Select\" field type.\n* Added \"User Select\" field type.\n* Added new hooks that fire on rendering/editing/closing a shortcode, which can be used for field types which require custom javascript initialization or cleanup.\n* Select fields: add full support for multiple select fields.\n* Select fields: support custom ordering of options.\n* Select fields: support grouping option in `![\"Open](\"https://cdn-std.dprcdn.net/files/acc_649651/Q5nVhT\")
\n ![\"Patreon\"](\"https://cdn-std.dprcdn.net/files/acc_649651/plrSCT\")
\n