Datasets:

doanhieung

/

gitsum

like 0

Maven plugin for running and creating Docker images

# docker-maven-plugin [](https://maven-badges.herokuapp.com/maven-central/io.fabric8/docker-maven-plugin/) [](https://circleci.com/gh/fabric8io/docker-maven-plugin/tree/master) [](https://sonarcloud.io/dashboard?id=io.fabric8%3Adocker-maven-plugin) [](https://sonarcloud.io/dashboard?id=io.fabric8%3Adocker-maven-plugin) This is a Maven plugin for building Docker images and managing containers for integration tests. It works with Maven 3.0.5 and Docker 1.6.0 or later. #### Goals | Goal | Description | Default Lifecycle Phase | | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------- | | [`docker:start`](https://fabric8io.github.io/docker-maven-plugin/#docker:start) | Create and start containers | pre-integration-test | | [`docker:stop`](https://fabric8io.github.io/docker-maven-plugin/#docker:stop) | Stop and destroy containers | post-integration-test | | [`docker:build`](https://fabric8io.github.io/docker-maven-plugin/#docker:build) | Build images | install | | [`docker:watch`](https://fabric8io.github.io/docker-maven-plugin/#docker:watch) | Watch for doing rebuilds and restarts | | | [`docker:push`](https://fabric8io.github.io/docker-maven-plugin/#docker:push) | Push images to a registry | deploy | | [`docker:remove`](https://fabric8io.github.io/docker-maven-plugin/#docker:remove) | Remove images from local docker host | post-integration-test | | [`docker:logs`](https://fabric8io.github.io/docker-maven-plugin/#docker:logs) | Show container logs | | | [`docker:source`](https://fabric8io.github.io/docker-maven-plugin/#docker:source) | Attach docker build archive to Maven project | package | | [`docker:save`](https://fabric8io.github.io/docker-maven-plugin/#docker:save) | Save image to a file | | | [`docker:volume-create`](https://fabric8io.github.io/docker-maven-plugin/#docker:volume-create) | Create a volume to share data between containers | pre-integration-test | | [`docker:volume-remove`](https://fabric8io.github.io/docker-maven-plugin/#docker:volume-remove) | Remove a created volume | post-integration-test | | [`docker:copy`](https://fabric8io.github.io/docker-maven-plugin/#docker:copy) | Copy files and directories from a container | post-integration-test | #### Documentation * The **[User Manual](https://fabric8io.github.io/docker-maven-plugin)** [[PDF](https://fabric8io.github.io/docker-maven-plugin/docker-maven-plugin.pdf)] has a detailed reference for all and everything. * The [Introduction](doc/intro.md) is a high level overview of this plugin's features and provides an usage example. provided goals and possible configuration parameters. * [Examples](doc/examples.md) are below `samples/` and contain example setups which you can use as blueprints for your own projects. * [ChangeLog](doc/changelog.md) has the release history of this plugin. * [Contributing](CONTRIBUTING.md) explains how you can contribute to this project. Pull requests are highly appreciated! #### Docker API Support * Docker 1.6 (**v1.18**) is the minimal required version * Docker 1.8.1 (**v1.20**) is required for `docker:watch` * Docker 1.9 (**v1.21**) is required for using custom networks and build args.

:star: Codebase for various tutorials about Java, Spring Boot, AWS, Kotlin, and Testing

# Hands-On Code Examples for Tutorials on [rieckpil.de](https://rieckpil.de/) [](https://github.com/rieckpil/blog-tutorials/actions) If you find an issue or bug within the provided code examples, feel free to open an [issue](https://github.com/rieckpil/blog-tutorials/issues), and I will take a look. ## Cheat Sheets * [Testing Java Applications Cheat Sheet](https://rieckpil.de/testing-java-applications-cheat-sheet/) * [Java EE & Jakarta EE Application Server Cheat Sheet](https://rieckpil.de/cheatsheet-java-jakarta-ee-application-servers/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/application-server-cheatsheet)) * [Spring Web MVC Cheat Sheet](https://rieckpil.de/spring-web-mvc-cheat-sheet/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/)) ## Articles about Testing * [Parallelizing Only Java Unit Tests with JUnit 5 and Maven](https://rieckpil.de/parallelize-only-java-unit-tests-with-junit-5-and-maven/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/maven-junit-paralellize-tests)) * [Test Thymeleaf Controller Endpoints with Spring Boot and MockMvc](https://rieckpil.de/test-thymeleaf-controller-endpoints-with-spring-boot-and-mockmvc/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-thymeleaf-testing)) * [Spring Boot Testing: MockMvc vs. WebTestClient vs. TestRestTemplate](https://rieckpil.de/spring-boot-testing-mockmvc-vs-webtestclient-vs-testresttemplate/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-test-mockmvc-webtestclient-testresttemplate)) * [Amazon SQS Listener Testing with @SqsTest (Spring Cloud AWS)](https://rieckpil.de/amazon-sqs-listener-testing-with-sqstest-spring-cloud-aws/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-cloud-aws-sqs-testing)) * [Spring Boot Test Spring Web MVC HandlerInterceptor](https://rieckpil.de/spring-boot-test-spring-web-mvc-handlerinterceptor/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-web-mvc-testing)) * [LaunchDarkly Java Testing and Local Development Hints](https://rieckpil.de/launchdarkly-java-testing-and-local-development-hints/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/launchdarkly-java-development-testing-hints)) * [What the Heck Is the SpringExtension Used For?](https://rieckpil.de/what-the-heck-is-the-springextension-used-for/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-testing-tips-and-tricks)) * [Maven Setup For Testing Java Applications](https://rieckpil.de/maven-setup-for-testing-java-applications/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/testing-java-applications-with-maven)) * [Creating Deep Stubs With Mockito to Chain Method Stubbing](https://rieckpil.de/creating-deep-stubs-with-mockito-to-chain-method-stubbing/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/mockito-tips-and-tricks)) * [Spring Boot Unit and Integration Testing Overview](https://rieckpil.de/spring-boot-unit-and-integration-testing-overview/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-testing-tips-and-tricks)) * [Initialization Strategies With Testcontainers For Integration Tests](https://rieckpil.de/initialization-strategies-with-testcontainers-for-integration-tests/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/testcontainers-youtube-series)) * [Record Spring Events When Testing Spring Boot Applications](https://rieckpil.de/record-spring-events-when-testing-spring-boot-applications/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-test-spring-events)) * [Testing Spring Boot Applications With REST Assured](https://rieckpil.de/testing-spring-boot-applications-with-rest-assured/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-rest-assured)) * [How to Test Java HTTP Client Usages (e.g OkHttp, Apache HttpClient)](https://rieckpil.de/how-to-test-java-http-client-usages-e-g-okhttp-apache-httpclient/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/test-java-http-clients)) * [Spring Boot Test Slices Overview and Usage](https://rieckpil.de/spring-boot-test-slices-overview-and-usage/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-test-slice-annotations)) * [Guide to Testing Spring Boot applications with MockMvc](https://rieckpil.de/guide-to-testing-spring-boot-applications-with-mockmvc/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/testing-spring-boot-applications-with-mockmvc)) * [MongoDB Testcontainers Setup for @DataMongoTest](https://rieckpil.de/mongodb-testcontainers-setup-for-datamongotest/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-data-mongo-test-testcontainers)) * [Mocking Statics Methods with Mockito (Kotlin & Java)](https://rieckpil.de/mocking-static-methods-with-mockito-java-kotlin/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/mockito-tips-and-tricks)) * [Mock Java Constructors And Their Object Creation With Mockito](https://rieckpil.de/mock-java-constructors-and-their-object-creation-with-mockito/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/mockito-tips-and-tricks)) * [Write Concise Web Tests With Selenide for Java Projects](https://rieckpil.de/write-concise-web-tests-with-selenide-for-java-projects/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/write-concise-web-tests-with-selenide)) * [Test Your Spring MVC Controller with the WebTestClient and MockMvc](https://rieckpil.de/test-your-spring-mvc-controller-with-webtestclient-against-mockmvc/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-mockmvc-with-webtestclient)) * [Test Your Spring Boot JPA Persistence Layer With @DataJpaTest](https://rieckpil.de/test-your-spring-boot-jpa-persistence-layer-with-datajpatest/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-datajpatest)) * [Override Spring Boot Configuration Properties For Tests](https://rieckpil.de/override-spring-boot-configuration-properties-for-tests/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-override-test-properties)) * [Use GreenMail For Spring Mail (JavaMailSender) JUnit 5 Integration Tests](https://rieckpil.de/use-greenmail-for-spring-mail-javamailsender-junit-5-integration-tests/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-test-mail-sending)) * [Write Spring Boot integration tests with Testcontainers (JUnit 4 and 5)](https://rieckpil.de/howto-write-spring-boot-integration-tests-with-a-real-database/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-integration-tests-testcontainers)) * [Reuse containers with Testcontainers for fast integration tests](https://rieckpil.de/reuse-containers-with-testcontainers-for-fast-integration-tests/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/testcontainers-reuse-existing-containers)) * [Test Spring WebClient with MockWebServer from OkHttp](https://rieckpil.de/test-spring-webclient-with-mockwebserver-from-okhttp/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-client-testing-with-mockwebserver)) * [Test Spring applications using AWS with Testcontainers and LocalStack](https://rieckpil.de/test-spring-applications-using-aws-with-testcontainers-and-localstack/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-aws-integration-tests)) * [Write integration tests for your Spring WebSocket endpoints](https://rieckpil.de/write-integration-tests-for-your-spring-websocket-endpoints/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-websocket-integration-tests)) * [Improve build times with Context Caching from Spring Test](https://rieckpil.de/improve-build-times-with-context-caching-from-spring-test/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/)) * [Testing Spring Boot Applications with Kotlin and Testcontainers](https://rieckpil.de/testing-spring-boot-applications-with-kotlin-and-testcontainers/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-kotlin-testcontainers)) * [Write JPA integration tests with Java EE](https://rieckpil.de/howto-jpa-integration-tests-with-java-ee/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/jpa-integration-tests-java-ee)) * [Simple load-testing with Apache Benchmark](https://rieckpil.de/howto-simple-load-testing-with-apache-benchmark/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/load-testing-your-application)) * [Java Benchmarking with JMH (Java Microbenchmark Harness)](https://rieckpil.de/howto-java-benchmarking-with-jmh-java-microbenchmark-harness/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/java-benchmarking-with-jmh)) * [Consumer-Driven Contracts with Spring Cloud Contract](https://rieckpil.de/howto-consumer-driven-contracts-with-spring-cloud-contract/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/consumer-driven-contracts-with-spring-cloud-contract)) * [Jakarta EE integration tests with MicroShed Testing](https://rieckpil.de/jakarta-ee-integration-tests-with-microshed-testing/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/review-microshed-testing)) * [Spring Boot Integration Tests with WireMock and JUnit 5](https://rieckpil.de/spring-boot-integration-tests-with-wiremock-and-junit-5/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-integration-tests-wiremock)) * [Spring WebTestClient for efficient testing of your REST API](https://rieckpil.de/spring-webtestclient-for-efficient-testing-of-your-rest-api/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-test-client)) * [Spring Boot Functional Tests with Selenium and Testcontainers](https://rieckpil.de/spring-boot-functional-tests-with-selenium-and-testcontainers/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-selenium-integration-tests)) * [Testing your Spring RestTemplate with @RestClientTest](https://rieckpil.de/testing-your-spring-resttemplate-with-restclienttest/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/testing-spring-rest-template)) * [Five JUnit 5 features you might not know yet](https://rieckpil.de/five-junit-5-features-you-might-not-know-yet/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/five-unknown-junit-5-features)) * [Testing your JSON serialization with @JsonTest](https://rieckpil.de/testing-your-json-serialization-with-jsontest) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/testing-json-serialization-spring)) ## Articles about Spring Boot * [Lock @Scheduled Tasks With ShedLock And Spring Boot](https://rieckpil.de/lock-scheduled-tasks-with-shedlock-and-spring-boot/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-shedlock)) * [Best Practices Flyway and Hibernate with Spring Boot](https://rieckpil.de/howto-best-practices-for-flyway-and-hibernate-with-spring-boot/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-hibernate-flyway-best-practices)) * [Up- and download files with React and Spring Boot](https://rieckpil.de/howto-up-and-download-files-with-react-and-spring-boot/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-uploading-and-downloading-files-with-react)) * [Expose git information with Spring Boot’s Actuator](https://rieckpil.de/howto-expose-git-information-with-spring-boots-actuator/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/expose-git-information-actuator)) * [Lazy Loading of JPA attributes with Hibernate](https://rieckpil.de/how-to-lazy-loading-of-jpa-attributes-with-hibernate/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/lazy-loading-of-jpa-attributes-with-hibernate)) * [Send E-Mails with SendGrid and Spring Boot](https://rieckpil.de/howto-send-e-mails-with-sendgrid-and-spring-boot/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/send-emails-with-sendgrid-and-spring-boot)) * [Dynamic SQL Querying & Pagination with Querydsl and Spring Data JPA](https://rieckpil.de/howto-dynamic-sql-querying-pagination-with-querydsl-and-spring-data-jpa) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/dynamic-sql-querying-with-pagination)) * [Remote Debug Spring Boot applications (IntelliJ IDEA + Eclipse)](https://rieckpil.de/howto-remote-debug-spring-boot-applications-intellij-idea-eclipse/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/remote-debugging-spring-boot-application)) * [Use Spring’s WebClient for RESTful communication](https://rieckpil.de/howto-use-springs-webclient-for-restful-communication/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-client-demo)) * [Generate random data in Java using Java Faker](https://rieckpil.de/howto-generate-random-data-in-java-using-java-faker/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/random-data-in-java-using-java-faker)) * [Feature Toggles for Spring Boot applications with Togglz](https://rieckpil.de/howto-feature-toggles-for-spring-boot-applications-with-togglz/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-feature-toggles-with-togglz)) * [Spring WebClient OAuth2 Integration for Spring WebFlux](https://rieckpil.de/spring-webclient-oauth2-integration-using-github-as-an-example/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-client-oauth2-reactive-stack)) * [Spring WebClient OAuth2 Integration for Spring Web (Servlet)](https://rieckpil.de/spring-webclient-oauth2-integration-for-spring-web-servlet/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-client-oauth2-servlet-stack)) * [Expose Metrics of Spring WebClient using Spring Boot Actuator](https://rieckpil.de/expose-metrics-of-spring-webclient-using-spring-boot-actuator) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-client-expose-metrics)) * [Spring WebClient exchange vs. retireve a comparison](https://rieckpil.de/spring-webclient-exchange-vs-retrieve-a-comparison/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-client-exchange-retrieve)) * [Customize Spring WebClient with WebClientCustomizer](https://rieckpil.de/customize-spring-webclient-with-webclientcustomizer/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-web-client-customizing)) ## Articles about AWS * [AWS Lambda with Kotlin and Spring Cloud Function](https://rieckpil.de/aws-lambda-with-kotlin-and-spring-cloud-function/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/serverless-java-aws-examples/spring-cloud-function-kotlin-aws)) * [OIDC Logout With AWS Cognito and Spring Security](https://rieckpil.de/oidc-logout-with-aws-cognito-and-spring-security/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-security-aws-cognito-thymeleaf)) * [Java AWS Lambda Container Image Support (Complete Guide)](https://rieckpil.de/java-aws-lambda-container-image-support-complete-guide/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/serverless-java-aws-examples/java-aws-lambda-custom-image)) * [Resolving Spring Boot properties using the AWS Parameter Store (SSM)](https://rieckpil.de/resolving-spring-boot-properties-using-the-aws-parameter-store-ssm/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-aws-ssm-parameter-resolving)) * [Java AWS Lambda with Serverless and Maven - Thumbnail Generator](http://rieckpil.de/aws-lambda-with-serverless-java-and-maven-thumbnail-generator) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/serverless-java-aws-examples/thumbnail-generator)) * [Java AWS Lambda with Spring Cloud Function](https://rieckpil.de/java-aws-lambda-with-spring-cloud-function/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/serverless-java-aws-examples/spring-cloud-function-aws)) * [Thymeleaf OAuth2 Login with Spring Security and AWS Cognito](https://rieckpil.de/thymeleaf-oauth2-login-with-spring-security-and-aws-cognito/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-security-aws-cognito-thymeleaf)) ## Articles about Kotlin * [Create Spring Boot applications with Maven and Kotlin](https://rieckpil.de/create-spring-boot-applications-with-maven-and-kotlin/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-with-kotlin)) * [Write Java EE applications with Kotlin](https://rieckpil.de/howto-write-java-ee-applications-with-kotlin/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/java-ee-with-kotlin)) * [Writing JavaScript code with Kotlin using Gradle](https://rieckpil.de/writing-javascript-code-with-kotlin-using-gradle/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/kotlin-javascript-transpiling-gradle)) ## Articles about Java EE/Jakarta EE/MicroProfile * [Avoid repeating attributes in JPA entities](https://rieckpil.de/howto-avoid-repeating-attributes-in-jpa-entities/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/avoid-repeating-attributes-in-jpa-entities)) * [Deploy a Spring Boot Uber-Jar application within Open Liberty](https://rieckpil.de/howto-run-spring-boot-uber-jar-application-within-open-liberty/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/spring-boot-with-open-liberty/)) * [Simple CRUD table with JSF and PrimeFaces](https://rieckpil.de/howto-simple-crud-table-with-jsf-2-3-and-primefaces/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/simple-crud-table-with-jsf-and-primefaces)) * [Simple JSF 2.3 Login with Java EE 8 Security API](https://rieckpil.de/howto-simple-form-based-authentication-for-jsf-2-3-with-java-ee-8-security-api/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/jsf-simple-login-with-java-ee-security-api)) * [Simple JMS application with the embedded messaging engine in Open Liberty](https://rieckpil.de/howto-simple-jms-application-with-the-embedded-messaging-engine-in-open-liberty/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/embedded-messaging-engine-open-liberty)) * [JAX-RS user-based API rate-limiting with JSR-375](https://rieckpil.de/howto-jax-rs-user-based-rate-limiting-with-jsr-375/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/jax-rs-api-rate-limiting-with-jsr-375)) * [Generate documents from Word templates with Docx4j on Wildfly 14](https://rieckpil.de/howto-generate-documents-from-word-templates-with-docx4j-on-wildfly-14/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/generate-documents-from-word-templates-with-docx4j-on-wildfly14)) * [MicroProfile JWT Authentication with Keycloak and React](https://rieckpil.de/howto-microprofile-jwt-authentication-with-keycloak-and-react/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/microprofile-jwt-keycloak-auth)) * [Generate PDFs (Apache PDFBox) including Charts (XChart) with Java EE](https://rieckpil.de/howto-generate-pdfs-apache-pdfbox-including-charts-xchart-with-java-ee/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/charts-in-pdf-java-ee)) * [Up- and downloading files with Java EE and Web Components](https://rieckpil.de/howto-up-and-download-files-with-java-ee-and-web-components/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/java-ee-uploading-and-downloading-files-with-web-components)) * [RESTEasy (WildFly) file up- and downloading](https://rieckpil.de/howto-resteasy-wildfly-jax-rs-2-1-file-up-and-downloading/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/rest-easy-file-uploading-and-downloading)) * [Messaging with JMS using Payara with embedded OpenMQ broker](https://rieckpil.de/howto-messaging-with-jms-using-payara-with-embedded-openmq-broker/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/messaging-with-jms-using-payara)) * [Nice-looking JSF 2.3 apps with PrimeFaces 7.0](https://rieckpil.de/howto-create-nice-looking-jsf-2-3-applications-with-primefaces-7-0) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/nice-looking-jsf-apps-with-prime-faces-7)) * [Send emails with Java EE using Payara](https://rieckpil.de/howto-send-emails-with-java-ee-using-payara) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/java-ee-sending-mails)) * [Deploy Java EE applications to Kubernetes](https://rieckpil.de/howto-deploy-java-ee-applications-to-kubernetes) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/java-ee-kubernetes-deployment)) * [MicroProfile Rest Client for RESTful communication](https://rieckpil.de/howto-microprofile-rest-client-for-restful-communication/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/microprofile-rest-client-for-restful-communication)) * [Intercept method calls using CDI interceptors](https://rieckpil.de/howto-intercept-method-calls-using-cdi-interceptors/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/intercept-methods-with-cdi-interceptors)) * [Bootstrap your first Jakarta EE 8 application](https://rieckpil.de/howto-bootstrap-your-first-jakarta-ee-8-application/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/bootstrap-jakarta-ee-8-application)) * [Jakarta EE and MicroProfile applications with React and PostgreSQL](https://rieckpil.de/jakarta-ee-and-microprofile-applications-with-react-and-postgresql) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/guide-to-jakarta-ee-with-react-and-postgresql)) * [Create real-time applications with Jakarta EE WebSocket](https://rieckpil.de/create-real-time-applications-with-jakarta-ee-websocket/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/websockets-with-jakarta-ee)) * [Jakarta EE & React file up- and download using Java 11 and TypeScript](https://rieckpil.de/jakarta-ee-react-file-up-and-download-using-java-11-and-typescript) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/jakarta-ee-react-file-handling)) ## Miscellaneous * [Automatic Java Code Migration with OpenRewrite (Mockito Example)](https://rieckpil.de/automatic-java-code-migration-with-openrewrite-mockito-example) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/open-rewrite-example)) * [Simple database documentation with SchemaSpy](https://rieckpil.de/howto-simple-database-documentation-with-schemaspy/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/simple-database-documentation-with-schema-spy)) * [Preview PDF files with React](https://rieckpil.de/howto-pdf-preview-with-react/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/pdf-preview-react)) * [Writing PostgreSQL functions with Java using PL/Java](https://rieckpil.de/howto-writing-postgresql-functions-with-java-using-pl-java/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/running-java-within-postgres)) * [Deploy a React application to Kuberntes](https://dev.to/rieckpil/deploy-a-react-application-to-kubernetes-in-5-easy-steps-516j) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/react-app-kubernetes)) * [Create your own Maven Archetype in 5 simple steps](https://rieckpil.de/create-your-own-maven-archetype-in-5-simple-steps/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/custom-maven-archetype)) * [GitHub Actions for Java - automate your Maven workflows](https://rieckpil.de/github-actions-for-java-automate-your-maven-workflows/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/github-actions-java-maven)) ## WHATIS? Articles * [JavaServer Faces. An introduction to JSF 2.3](https://rieckpil.de/whatis-java-server-faces-an-introduction-to-jsf-2-3/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/hello-world-jsf-2.3)) * [GraalVM - an introduction to the next level JVM](https://rieckpil.de/whatis-graalvm/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/graalvm-intro)) * [MicroProfile Config](https://rieckpil.de/whatis-eclipse-microprofile-config/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-config)) * [MicroProfile Fault Tolerance](https://rieckpil.de/whatis-eclipse-microprofile-fault-tolerance/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-fault-tolerance)) * [MicroProfile Metrics](https://rieckpil.de/whatis-eclipse-microprofile-metrics/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-metrics)) * [MicroProfile JWT Auth](https://rieckpil.de/whatis-eclipse-microprofile-jwt-auth/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-jwt-auth)) * [MicroProfile Rest Client](https://rieckpil.de/whatis-eclipse-microprofile-rest-client/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-rest-client)) * [MicroProfile OpenAPI](https://rieckpil.de/whatis-eclipse-microprofile-openapi/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-open-api)) * [MicroProfile OpenTracing](https://rieckpil.de/whatis-eclipse-microprofile-opentracing/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-open-tracing)) * [MicroProfile Health](https://rieckpil.de/whatis-eclipse-microprofile-health/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/microprofile-health)) * [Contexts and Dependency Injection (CDI)](https://rieckpil.de/whatis-contexts-and-dependency-injection-cdi/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/cdi)) * [Jakarta RESTful Web Services (JAX-RS)](https://rieckpil.de/whatis-jakarta-restful-web-services-jax-rs/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/jax-rs)) * [JSON Binding (JSON-B)](https://rieckpil.de/whatis-json-binding-json-b/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/json-b)) * [JSON Processing (JSON-P)](https://rieckpil.de/whatis-json-processing-json-p/) ([Sources](https://github.com/rieckpil/getting-started-with-eclipse-microprofile/tree/master/json-p)) ## REVIEW Articles * [What’s new in Spring Boot 2.1](https://rieckpil.de/review-whats-new-in-spring-boot-2-1/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/whats-new-in-spring-boot-2.1)) * [What's new in Spring Boot 2.2](https://rieckpil.de/review-whats-new-in-spring-boot-2-2/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/whats-new-in-spring-boot-2.2)) * [What's new in Spring Boot 2.3](https://rieckpil.de/whats-new-in-spring-boot-2-3/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/whats-new-in-spring-boot-2.3)) * [What's new in MicroProfile 3.1](https://rieckpil.de/review-whats-new-in-microprofile-3-1/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/whats-new-in-microprofile-3.1)) * [Improved Java/Jakarta EE productivity with Adam Bien’s WAD (Watch and Deploy)](https://rieckpil.de/review-improved-java-jakarta-ee-productivity-with-adam-biens-wad-watch-and-deploy/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/improved-java-ee-productivity-with-wad)) * [5 Java 9 Features you might not know yet](https://rieckpil.de/review-5-java-9-features-you-might-not-know-yet/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/five-java-9-features)) * [Top 3 Maven Plugins to ensure Quality and Security for your project](https://rieckpil.de/top-3-maven-plugins-to-ensure-quality-and-security-for-your-project/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/maven-plugins-to-ensure-quality)) * [Joyful Open Liberty Developer Experience with Liberty Maven Plugin](https://rieckpil.de/joyful-open-liberty-developer-experience-with-liberty-maven-plugin/) ([Sources](https://github.com/rieckpil/blog-tutorials/tree/master/open-liberty-maven-plugin-review))

Apache Maven Daemon

Java interface to OpenCV, FFmpeg, and more

JavaCV ====== [](https://gitter.im/bytedeco/javacv) [](https://maven-badges.herokuapp.com/maven-central/org.bytedeco/javacv-platform) [](http://bytedeco.org/builds/) [](https://travis-ci.org/bytedeco/javacv) ^{Commercial support:} [](https://xscode.com/bytedeco/javacv) Introduction ------------ JavaCV uses wrappers from the [JavaCPP Presets](https://github.com/bytedeco/javacpp-presets) of commonly used libraries by researchers in the field of computer vision ([OpenCV](http://opencv.org/), [FFmpeg](http://ffmpeg.org/), [libdc1394](http://damien.douxchamps.net/ieee1394/libdc1394/), [FlyCapture](https://www.flir.com/products/flycapture-sdk/), [Spinnaker](https://www.flir.com/products/spinnaker-sdk/), [OpenKinect](http://openkinect.org/), [librealsense](https://github.com/IntelRealSense/librealsense), [CL PS3 Eye Driver](https://codelaboratories.com/downloads/), [videoInput](http://muonics.net/school/spring05/videoInput/), [ARToolKitPlus](https://launchpad.net/artoolkitplus), [flandmark](https://github.com/uricamic/flandmark), [Leptonica](http://www.leptonica.org/), and [Tesseract](https://github.com/tesseract-ocr/tesseract)) and provides utility classes to make their functionality easier to use on the Java platform, including Android. JavaCV also comes with hardware accelerated full-screen image display (`CanvasFrame` and `GLCanvasFrame`), easy-to-use methods to execute code in parallel on multiple cores (`Parallel`), user-friendly geometric and color calibration of cameras and projectors (`GeometricCalibrator`, `ProCamGeometricCalibrator`, `ProCamColorCalibrator`), detection and matching of feature points (`ObjectFinder`), a set of classes that implement direct image alignment of projector-camera systems (mainly `GNImageAligner`, `ProjectiveTransformer`, `ProjectiveColorTransformer`, `ProCamTransformer`, and `ReflectanceInitializer`), a blob analysis package (`Blobs`), as well as miscellaneous functionality in the `JavaCV` class. Some of these classes also have an OpenCL and OpenGL counterpart, their names ending with `CL` or starting with `GL`, i.e.: `JavaCVCL`, `GLCanvasFrame`, etc. To learn how to use the API, since documentation currently lacks, please refer to the [Sample Usage](#sample-usage) section below as well as the [sample programs](https://github.com/bytedeco/javacv/tree/master/samples/), including two for Android (`FacePreview.java` and `RecordActivity.java`), also found in the `samples` directory. You may also find it useful to refer to the source code of [ProCamCalib](https://github.com/bytedeco/procamcalib) and [ProCamTracker](https://github.com/bytedeco/procamtracker) as well as [examples ported from OpenCV2 Cookbook](https://github.com/bytedeco/javacv-examples/) and the associated [wiki pages](https://github.com/bytedeco/javacv-examples/tree/master/OpenCV_Cookbook). Please keep me informed of any updates or fixes you make to the code so that I may integrate them into the next release. Thank you! And feel free to ask questions on [the mailing list](http://groups.google.com/group/javacv) or [the discussion forum](https://github.com/bytedeco/javacv/discussions) if you encounter any problems with the software! I am sure it is far from perfect... Downloads --------- Archives containing JAR files are available as [releases](https://github.com/bytedeco/javacv/releases). The binary archive contains builds for Android, iOS, Linux, Mac OS X, and Windows. The JAR files for specific child modules or platforms can also be obtained individually from the [Maven Central Repository](http://search.maven.org/#search|ga|1|bytedeco). To install manually the JAR files, follow the instructions in the [Manual Installation](#manual-installation) section below. We can also have everything downloaded and installed automatically with: * Maven (inside the `pom.xml` file) ```xml <dependency> <groupId>org.bytedeco</groupId> <artifactId>javacv-platform</artifactId> <version>1.5.8</version> </dependency> ``` * Gradle (inside the `build.gradle` file) ```groovy dependencies { implementation group: 'org.bytedeco', name: 'javacv-platform', version: '1.5.8' } ``` * Leiningen (inside the `project.clj` file) ```clojure :dependencies [ [org.bytedeco/javacv-platform "1.5.8"] ] ``` * sbt (inside the `build.sbt` file) ```scala libraryDependencies += "org.bytedeco" % "javacv-platform" % "1.5.8" ``` This downloads binaries for all platforms, but to get binaries for only one platform we can set the `javacpp.platform` system property (via the `-D` command line option) to something like `android-arm`, `linux-x86_64`, `macosx-x86_64`, `windows-x86_64`, etc. Please refer to the [README.md file of the JavaCPP Presets](https://github.com/bytedeco/javacpp-presets#downloads) for details. Another option available to Gradle users is [Gradle JavaCPP](https://github.com/bytedeco/gradle-javacpp), and similarly for Scala users there is [SBT-JavaCV](https://github.com/bytedeco/sbt-javacv). Required Software ----------------- To use JavaCV, you will first need to download and install the following software: * An implementation of Java SE 7 or newer: * OpenJDK http://openjdk.java.net/install/ or * Oracle JDK http://www.oracle.com/technetwork/java/javase/downloads/ or * IBM JDK http://www.ibm.com/developerworks/java/jdk/ Further, although not always required, some functionality of JavaCV also relies on: * CL Eye Platform SDK (Windows only) http://codelaboratories.com/downloads/ * Android SDK API 21 or newer http://developer.android.com/sdk/ * JOCL and JOGL from JogAmp http://jogamp.org/ Finally, please make sure everything has the same bitness: **32-bit and 64-bit modules do not mix under any circumstances**. Manual Installation ------------------- Simply put all the desired JAR files (`opencv*.jar`, `ffmpeg*.jar`, etc.), in addition to `javacpp.jar` and `javacv.jar`, somewhere in your class path. Here are some more specific instructions for common cases: NetBeans (Java SE 7 or newer): 1. In the Projects window, right-click the Libraries node of your project, and select "Add JAR/Folder...". 2. Locate the JAR files, select them, and click OK. Eclipse (Java SE 7 or newer): 1. Navigate to Project > Properties > Java Build Path > Libraries and click "Add External JARs...". 2. Locate the JAR files, select them, and click OK. Visual Studio Code (Java SE 7 or newer): 1. Navigate to Java Projects > Referenced Libraries, and click `+`. 2. Locate the JAR files, select them, and click OK. IntelliJ IDEA (Android 7.0 or newer): 1. Follow the instructions on this page: http://developer.android.com/training/basics/firstapp/ 2. Copy all the JAR files into the `app/libs` subdirectory. 3. Navigate to File > Project Structure > app > Dependencies, click `+`, and select "2 File dependency". 4. Select all the JAR files from the `libs` subdirectory. After that, the wrapper classes for OpenCV and FFmpeg, for example, can automatically access all of their C/C++ APIs: * [OpenCV documentation](http://docs.opencv.org/master/) * [FFmpeg documentation](http://ffmpeg.org/doxygen/trunk/) Sample Usage ------------ The class definitions are basically ports to Java of the original header files in C/C++, and I deliberately decided to keep as much of the original syntax as possible. For example, here is a method that tries to load an image file, smooth it, and save it back to disk: ```java import org.bytedeco.opencv.opencv_core.*; import org.bytedeco.opencv.opencv_imgproc.*; import static org.bytedeco.opencv.global.opencv_core.*; import static org.bytedeco.opencv.global.opencv_imgproc.*; import static org.bytedeco.opencv.global.opencv_imgcodecs.*; public class Smoother { public static void smooth(String filename) { Mat image = imread(filename); if (image != null) { GaussianBlur(image, image, new Size(3, 3), 0); imwrite(filename, image); } } } ``` JavaCV also comes with helper classes and methods on top of OpenCV and FFmpeg to facilitate their integration to the Java platform. Here is a small demo program demonstrating the most frequently useful parts: ```java import java.io.File; import java.net.URL; import org.bytedeco.javacv.*; import org.bytedeco.javacpp.*; import org.bytedeco.javacpp.indexer.*; import org.bytedeco.opencv.opencv_core.*; import org.bytedeco.opencv.opencv_imgproc.*; import org.bytedeco.opencv.opencv_calib3d.*; import org.bytedeco.opencv.opencv_objdetect.*; import static org.bytedeco.opencv.global.opencv_core.*; import static org.bytedeco.opencv.global.opencv_imgproc.*; import static org.bytedeco.opencv.global.opencv_calib3d.*; import static org.bytedeco.opencv.global.opencv_objdetect.*; public class Demo { public static void main(String[] args) throws Exception { String classifierName = null; if (args.length > 0) { classifierName = args[0]; } else { URL url = new URL("https://raw.github.com/opencv/opencv/master/data/haarcascades/haarcascade_frontalface_alt.xml"); File file = Loader.cacheResource(url); classifierName = file.getAbsolutePath(); } // We can "cast" Pointer objects by instantiating a new object of the desired class. CascadeClassifier classifier = new CascadeClassifier(classifierName); if (classifier == null) { System.err.println("Error loading classifier file \"" + classifierName + "\"."); System.exit(1); } // The available FrameGrabber classes include OpenCVFrameGrabber (opencv_videoio), // DC1394FrameGrabber, FlyCapture2FrameGrabber, OpenKinectFrameGrabber, OpenKinect2FrameGrabber, // RealSenseFrameGrabber, RealSense2FrameGrabber, PS3EyeFrameGrabber, VideoInputFrameGrabber, and FFmpegFrameGrabber. FrameGrabber grabber = FrameGrabber.createDefault(0); grabber.start(); // CanvasFrame, FrameGrabber, and FrameRecorder use Frame objects to communicate image data. // We need a FrameConverter to interface with other APIs (Android, Java 2D, JavaFX, Tesseract, OpenCV, etc). OpenCVFrameConverter.ToMat converter = new OpenCVFrameConverter.ToMat(); // FAQ about IplImage and Mat objects from OpenCV: // - For custom raw processing of data, createBuffer() returns an NIO direct // buffer wrapped around the memory pointed by imageData, and under Android we can // also use that Buffer with Bitmap.copyPixelsFromBuffer() and copyPixelsToBuffer(). // - To get a BufferedImage from an IplImage, or vice versa, we can chain calls to // Java2DFrameConverter and OpenCVFrameConverter, one after the other. // - Java2DFrameConverter also has static copy() methods that we can use to transfer // data more directly between BufferedImage and IplImage or Mat via Frame objects. Mat grabbedImage = converter.convert(grabber.grab()); int height = grabbedImage.rows(); int width = grabbedImage.cols(); // Objects allocated with `new`, clone(), or a create*() factory method are automatically released // by the garbage collector, but may still be explicitly released by calling deallocate(). // You shall NOT call cvReleaseImage(), cvReleaseMemStorage(), etc. on objects allocated this way. Mat grayImage = new Mat(height, width, CV_8UC1); Mat rotatedImage = grabbedImage.clone(); // The OpenCVFrameRecorder class simply uses the VideoWriter of opencv_videoio, // but FFmpegFrameRecorder also exists as a more versatile alternative. FrameRecorder recorder = FrameRecorder.createDefault("output.avi", width, height); recorder.start(); // CanvasFrame is a JFrame containing a Canvas component, which is hardware accelerated. // It can also switch into full-screen mode when called with a screenNumber. // We should also specify the relative monitor/camera response for proper gamma correction. CanvasFrame frame = new CanvasFrame("Some Title", CanvasFrame.getDefaultGamma()/grabber.getGamma()); // Let's create some random 3D rotation... Mat randomR = new Mat(3, 3, CV_64FC1), randomAxis = new Mat(3, 1, CV_64FC1); // We can easily and efficiently access the elements of matrices and images // through an Indexer object with the set of get() and put() methods. DoubleIndexer Ridx = randomR.createIndexer(), axisIdx = randomAxis.createIndexer(); axisIdx.put(0, (Math.random() - 0.5) / 4, (Math.random() - 0.5) / 4, (Math.random() - 0.5) / 4); Rodrigues(randomAxis, randomR); double f = (width + height) / 2.0; Ridx.put(0, 2, Ridx.get(0, 2) * f); Ridx.put(1, 2, Ridx.get(1, 2) * f); Ridx.put(2, 0, Ridx.get(2, 0) / f); Ridx.put(2, 1, Ridx.get(2, 1) / f); System.out.println(Ridx); // We can allocate native arrays using constructors taking an integer as argument. Point hatPoints = new Point(3); while (frame.isVisible() && (grabbedImage = converter.convert(grabber.grab())) != null) { // Let's try to detect some faces! but we need a grayscale image... cvtColor(grabbedImage, grayImage, CV_BGR2GRAY); RectVector faces = new RectVector(); classifier.detectMultiScale(grayImage, faces); long total = faces.size(); for (long i = 0; i < total; i++) { Rect r = faces.get(i); int x = r.x(), y = r.y(), w = r.width(), h = r.height(); rectangle(grabbedImage, new Point(x, y), new Point(x + w, y + h), Scalar.RED, 1, CV_AA, 0); // To access or pass as argument the elements of a native array, call position() before. hatPoints.position(0).x(x - w / 10 ).y(y - h / 10); hatPoints.position(1).x(x + w * 11 / 10).y(y - h / 10); hatPoints.position(2).x(x + w / 2 ).y(y - h / 2 ); fillConvexPoly(grabbedImage, hatPoints.position(0), 3, Scalar.GREEN, CV_AA, 0); } // Let's find some contours! but first some thresholding... threshold(grayImage, grayImage, 64, 255, CV_THRESH_BINARY); // To check if an output argument is null we may call either isNull() or equals(null). MatVector contours = new MatVector(); findContours(grayImage, contours, CV_RETR_LIST, CV_CHAIN_APPROX_SIMPLE); long n = contours.size(); for (long i = 0; i < n; i++) { Mat contour = contours.get(i); Mat points = new Mat(); approxPolyDP(contour, points, arcLength(contour, true) * 0.02, true); drawContours(grabbedImage, new MatVector(points), -1, Scalar.BLUE); } warpPerspective(grabbedImage, rotatedImage, randomR, rotatedImage.size()); Frame rotatedFrame = converter.convert(rotatedImage); frame.showImage(rotatedFrame); recorder.record(rotatedFrame); } frame.dispose(); recorder.stop(); grabber.stop(); } } ``` Furthermore, after creating a `pom.xml` file with the following content: ```xml <project> <modelVersion>4.0.0</modelVersion> <groupId>org.bytedeco.javacv</groupId> <artifactId>demo</artifactId> <version>1.5.8</version> <properties> <maven.compiler.source>1.7</maven.compiler.source> <maven.compiler.target>1.7</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.bytedeco</groupId> <artifactId>javacv-platform</artifactId> <version>1.5.8</version> </dependency> <!-- Additional dependencies required to use CUDA and cuDNN --> <dependency> <groupId>org.bytedeco</groupId> <artifactId>opencv-platform-gpu</artifactId> <version>4.6.0-1.5.8</version> </dependency> <!-- Optional GPL builds with (almost) everything enabled --> <dependency> <groupId>org.bytedeco</groupId> <artifactId>ffmpeg-platform-gpl</artifactId> <version>5.1.2-1.5.8</version> </dependency> </dependencies> <build> <sourceDirectory>.</sourceDirectory> </build> </project> ``` And by placing the source code above in `Demo.java`, or similarly for other classes found in the [`samples`](samples), we can use the following command to have everything first installed automatically and then executed by Maven: ```bash $ mvn compile exec:java -Dexec.mainClass=Demo ``` **Note**: In case of errors, please make sure that the `artifactId` in the `pom.xml` file reads `javacv-platform`, not `javacv` only, for example. The artifact `javacv-platform` adds all the necessary binary dependencies. Build Instructions ------------------ If the binary files available above are not enough for your needs, you might need to rebuild them from the source code. To this end, the project files were created for: * Maven 3.x http://maven.apache.org/download.html * JavaCPP 1.5.8 https://github.com/bytedeco/javacpp * JavaCPP Presets 1.5.8 https://github.com/bytedeco/javacpp-presets Once installed, simply call the usual `mvn install` command for JavaCPP, its Presets, and JavaCV. By default, no other dependencies than a C++ compiler for JavaCPP are required. Please refer to the comments inside the `pom.xml` files for further details. Instead of building the native libraries manually, we can run `mvn install` for JavaCV only and rely on the snapshot artifacts from the CI builds: * http://bytedeco.org/builds/ ---- Project lead: Samuel Audet [samuel.audet `at` gmail.com](mailto:samuel.audet&nbsp;at&nbsp;gmail.com) Developer site: https://github.com/bytedeco/javacv Discussion group: http://groups.google.com/group/javacv

Local and offline-first npm mirror

<img alt="local-npm" width="500px" src="https://cdn.rawgit.com/local-npm/local-npm/8a78d31af0ecfd1d9dfb06ac985a7beacc343f35/assets/logo.svg" /> [](https://travis-ci.org/local-npm/local-npm) [](https://lcov-server.herokuapp.com/coverage/github%2Ecom/local-npm/local-npm) `local-npm` is a Node server that acts as a local npm registry. It serves modules, caches them, and updates them whenever they change. Basically it's a local mirror, but without having to replicate the entire npm registry. This allows your `npm install` commands to (mostly) work offline. Also, they get faster and faster over time, as commonly-installed modules are aggressively cached. <!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 --> - [Introduction](#introduction) - [Usage](#usage) - [Listening for events](#listening-for-events) - [Command line options](#command-line-options) - [Browser UI](#browser-ui) - [Switching with npmrc](#switching-with-npmrc) - [Speed test](#speed-test) - [How it works](#how-it-works) - [Using with Docker](#using-with-docker) <!-- /TOC --> # Introduction `local-npm` acts as a proxy between you and the main npm registry. You run `npm install` commands like normal, but under the hood, all requests are sent through the local server. When you first `npm install` a module, it'll be fetched from the main npm registry. After that, the module and all its dependencies (at that version) are stored in a local database, so you can expect subsequent installs to be much faster. The server will also listen for changes from the remote registry, so you can expect updates to a module's metadata to be replicated within seconds of being published. (I.e. you won't get stuck with old versions.) If you're organizing a conference/meetup/whatever, you can also share this local server with multiple people. So if your teammates are constantly installing the same modules over and over again, this can save a lot of time in the long run. `local-npm` is also a good way to make `npm install` work offline. Assuming new versions of a package haven't been published since you last installed, subsequent `npm install`s will all serve from the cache, without ever hitting a remote server. Addy Osmani has [a nice post](https://addyosmani.com/blog/using-npm-offline/) comparing `local-npm` to other options. # Usage If you're using OS X, take a look at [local-npm-launch-agent](https://github.com/local-npm/local-npm-launch-agent), a one-liner that sets everything up automatically. Otherwise: $ npm install -g local-npm Then $ local-npm to start the server. (Note that it will write files in whatever directory you run it from.) Then set `npm` to point to the local server: $ npm set registry http://127.0.0.1:5080 To switch back, you can do: $ npm set registry https://registry.npmjs.org The same rules as for the [npm Australia mirror](http://www.npmjs.org.au/) apply here. ## Listening for events > to listen to process level events to collecting metrics use the global event emitter to introspect on these - _events can be one of the following_ (info, warn, missed, cached, request) ```javascript require('local-npm')({ port: 5080, pouchPort: 6789, remote: 'https://registry.npmjs.org', remoteSkim: 'https://replicate.npmjs.com', url: 'http://127.0.0.1:5080', directory: './' }); process.on('request', (msg) => { console.log(msg); }) ``` # Command line options ``` Usage: local-npm [options] Options: -h, --help output usage information -V, --version output the version number -p, --port [port] The port to run local-npm on -pp, --pouch-port [port] The port to run the pouch db server on -l, --log-level [level] The level to log information to the console from local-npm -r, --remote [url] The registry to fallback information gathering and tars on -rs, --remote-skim [url] The remote skimdb to sync couchdb information from -u, --url [url] The default access url that local-npm will be hosted on -d, --directory [directory] directory to store data ``` **Protip**: You can replicate from your friend's `local-npm` to your own `local-npm` by simply pointing at it: ``` $ local-npm \ --remote http://<friends_hostname>:5080 \ --remote-skim http://<friends_hostname>:16984/skimdb ``` While your friend does: ``` $ local-npm \ --url http://<friends_hostname>:5080 ``` In this way, you can create a daisy chain of awesome. **Protip 2**: If you want to set up a single `local-npm` for multiple people to use, such as for conferences or workplaces, then just daemonize it (e.g. using [forever](https://www.npmjs.org/package/forever)), and then when you run it, specify the URL that clients will use to access the server, e.g.: ``` $ local-npm \ --url http://192.168.x.x:5080 ``` This will ensure that clients fetch tarballs from `192.168.x.x` instead of `127.0.0.1`. If you want a GUI or don't want to run it from the command-line is an electron app for that! [https://github.com/local-npm/local-npm-daemon](https://github.com/local-npm/local-npm-daemon)  # Browser UI A rudimentary npm-like UI that allows you to search modules and see their descriptions can be found at [http://localhost:5080/_browse](http://localhost:5080/_browse). | main | package | |------|---------| |  |  | If you haven't finished replicating the remote skimdb, then not all the modules will be visible yet. # Switching with npmrc Features like `npm search` are currently unsupported. So to avoid having to remember URLs when switching back and forth, you can use `npmrc` like so (based on the instructions for [the Australian mirror of npm](http://www.npmjs.org.au/)): $ npm install -g npmrc $ npmrc -c local $ npm set registry http://127.0.0.1:5080 then to search: $ npmrc default and to switch back: $ npmrc local Incidentally, though, `local-npm` does allow you to do `npm login` and `npm publish`. These commands will just be proxied to the main npm registry. # Speed test For a speed test of `local-npm` versus regular npm, [see these results](https://github.com/local-npm/test-local-npm-speed#readme). # How it works npm is built on top of CouchDB, so `local-npm` works by replicating the full "skimdb" database to a local [PouchDB Server](https://github.com/pouchdb/pouchdb-server). You can inspect the running database at [http://127.0.0.1:16984/_utils](http://127.0.0.1:16984/_utils). (Don't write to it!) The entire "skimdb" (metadata) is replicated locally, but for the "fullfatdb" (metadata plus tarballs), only what you `npm install` is stored. To start from scratch, just delete whatever directory you started the server in. CouchDB has a changes feed, so `local-npm` just listens to the `skimdb` changes to know when it needs to refresh an outdated module. Changes should replicate within a few seconds of being published. (You can watch this happen in realtime by reading the logs, which is kind of fun! An update comes in whenever someone publishes a module.) Note that new tarballs aren't downloaded until you explicitly `npm install` them, though. So e.g. if you install `v1.0.0` of a package, then `v1.0.1` is published, and your range says `^1.0.0`, then the next `npm install` will fail unless you're online and can fetch the new tarball. # Using with Docker Using local-npm with Docker can help speed up build times during development. The awkward way to use this would be something like: ``` RUN local-npm && \ npm set registry http://... && \ npm set proxy .... && \ npm install some packages etc ... ``` Running services inside of a Docker build command isn't really Docker's business. The friendly scenario works better in this case, i.e. you run local-npm on the host machine: ``` local-npm --url=http://<network host or ip>:5080 ``` And adding the npm registry/proxy commands to your Dockerfile: ``` RUN npm config set proxy http://<network host or ip>:5080 RUN npm config set proxy http://<network host or ip>:5080 RUN npm config set registry http://<network host or ip>:5080 RUN npm config set strict-ssl false RUN npm install project dependencies ... ```

Awesome npm resources and tips

⚡️ Super-powered JavaScript project management

# Bolt > Super-powered JavaScript project management [](https://travis-ci.org/boltpkg/bolt) ### Introduction Are you sharing components, libraries or services between different projects and find it difficult to manage? Juggling lots of Node packages in lots of different repositories? What if there was a better way?  Most JavaScript projects have 1 package per project (repo). So when you have lots of packages, you have to do a lot of work to manage them all: - You need to install every single package one by one. - If you make changes to one package and want to test them in another, you need to manually link them together and run tests separately. - Managing dependencies and keeping everything up to date can be overwhelming, and you can easily fall really far behind. Instead of all that, what if you put all of your packages together?  This is the idea behind "workspaces". #### What are workspaces? A _workspace_ is like any other node package: It's just a directory with its own `package.json`. Workspaces are grouped into a single "project". A _project_ is also just a node package at the root of your repository. This is sometimes referred to as a "monorepo", but we prefer the term "multi-package repo". ``` project ├── package.json ├── workspace-one │ ├── package.json │ └── index.js └── workspace-two ├── package.json └── index.js ``` Put another way, workspaces are just like any other package, except they are nested within a larger project/repo. Each workspace can have its own dependencies with its own code and scripts. Workspaces can also be grouped into sub-directories for further organization. Using Bolt, you can install the dependencies for all of these packages at once (and you can do it really really fast). But here's where it gets really cool: When you specify a dependency from one workspace to another. It will get linked to the actual source. This way, when you go to test your code. All your changes get tested together. > **Note:** This idea is not new, other tools like [Lerna](https://lernajs.io) > have existed for awhile and are used by many projects. Bolt is a fresh take > on the idea. #### What is Bolt? Bolt implements the idea of workspaces on top of [Yarn](https://yarnpkg.com/). In fact, the Bolt CLI is largely a drop-in replacement of the Yarn CLI. You can use it on any project already using Yarn. But Bolt (will soon) do lots of other stuff. Instead of wasting tons of time setting up a whole bunch of build tools for running your tests, or compiling your code, what if your package manager just did all that for you? Then when you want to do something differently, all you need to do is override a script. Well that's what Bolt will do for you (once we get around to implementing it). Long term, many of the features in Bolt will hopefully prove to be useful and other package managers like [Yarn](https://yarnpkg.com/) and [npm](https://www.npmjs.com/) will adopt them. ## Installation First be sure that you have [Node/npm](https://nodejs.org/) and [Yarn](https://yarnpkg.com/docs/install/) installed. Then run the following command: ```sh yarn global add bolt ``` > Thanks to Cam Pedersen ([@ecto](https://github.com/ecto)) for the "bolt" > package name on npm ## Commands > **Note:** Bolt is under active development and some of these commands have > not yet been implemented. | Command | Description | Status | | --------------------------------------- | ------------------------------------------------------------------------- |--------| | `bolt` | (Defaults to `bolt install`) |✅| | `bolt [unknown command]` | (Defaults to `bolt run [unknown command]`) |✅| | `bolt help` | View Bolt's help content |❌| | `bolt help [command]` | View Bolt's help content for a single command |❌| | `bolt init` | Create a new Bolt package in the current directory |✅| | └ `bolt init --yes` | Skip the prompts and use defaults |✅| | `bolt install` | Install all the dependencies for a project |✅| | `bolt add [dependency]` | Add a dependency |✅| | `bolt upgrade [dependency]` | Upgrade a dependency |✅| | `bolt remove [dependency]` | remove a dependency |✅| | `bolt version` | Updates the version of your package(s) |❌| | `bolt publish` | Publish new version(s) of your package(s) to npm |✅| | └ `bolt publish-lock` | Lock your package(s) on the npm registry |✅| | └ `bolt publish-unlock` | Unlock your package(s) on the npm registry |✅| | `bolt run [script]` | Run a script in a package |✅| | `bolt build` | Build your package(s) (Default: Babel) |🖌| | `bolt test` | Test your package(s) (Default: Jest) |🖌| | `bolt format/fmt` | Format the files in your package(s) (Default: Prettier) |🖌| | `bolt lint` | Lint your package(s) (Default: ESLint) |🖌| | `bolt doc` | Generate docs (Default: Documentation.js) |🖌| | `bolt check` | Type check your package(s) (Default: Flow) |🖌| | `bolt bin` | Print the folder where executable files for the package will be installed |✅| | `bolt workspaces/ws` | **Run the following commands across all workspaces:** || | └ `bolt ws run [script]` | Run a script in every package |✅| | └ `bolt ws exec -- [cmd]` | Run a shell cmd in every package |✅| | └ `bolt ws upgrade [dependency]` | Upgrade a dependency from every package that depends on it |✅| | └ `bolt ws remove [dependency]` | Remove a dependency from every package that depends on it |✅| | └ `bolt ws ... --only [name glob]` | Filter workspaces by name |✅| | └ `bolt ws ... --ignore [name glob]` | Filter out workspaces by name |✅| | └ `bolt ws ... --only-fs [file glob]` | Filter workspaces by file path |✅| | └ `bolt ws ... --ignore-fs [file glob]` | Filter out workspaces by file path |✅| | `bolt workspace/w [name]` | **Run the following commands on a single workspace:** || | └ `bolt w [name] run [script]` | Run a script in a single workspace |✅| | └ `bolt w [name] add [dependency]` | Add a dependency to a single workspace |✅| | └ `bolt w [name] upgrade [dependency]` | Upgrade a dependency in a single workspace |✅| | `bolt project/p` | **Run the following commands on your project package:** || | └ `bolt p run [script]` | Run a script on the project package |✅| | └ `bolt p add [dependency]` | Add a dependency to the project package |✅| | └ `bolt p remove [dependency]` | Remove a dependency from the project package |✅| | └ `bolt p upgrade [dependency]` | Upgrade a dependency on the project package |✅| | `bolt generate/g [generator]` | **Create files in your package using a generator:** || | └ `bolt g license [license]` | Create a LICENSE file in your package (Default: MIT) |❌| ## Configuration Bolt config is in the root `package.json`. For examples, for declaring workspaces in sub-directories: ```json { "name": "my-project", "bolt": { "workspaces": [ "utils/*", "apps/*" ] } } ``` ## Passing flags to run commands Depending on your needs you might run a script in one of many ways. ``` bolt script bolt run script bolt p run script bolt w package run script bolt ws --only="my-package" run script bolt ws exec --only="my-package" -- yarn script ``` Similar to later versions of yarn, you can also call a script with extra flags: ``` bolt script --flag1 --flag2 bolt run script --flag1 --flag2 bolt p run script --flag1 --flag2 bolt w my-package run script --flag1 --flag2 bolt ws --only="my-package" run script -- --flag1 --flag2 bolt ws exec --only="my-package" -- yarn script --flag1 --flag2 ``` The only slightly surprising one might be the `ws run` command where you'll notice you need to add in the extra `--` flag to pass in flags. This is to avoid ambiguity in which flags are meant for bolt and which are meant for your script. > Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to its terms.

📦🔐 A lightweight Node.js private proxy registry

[](https://donate.redcrossredcrescent.org/ua/donate/~my-donation?_cv=1) > Verdaccio stands for **peace**, stop the war, we will be yellow / blue 🇺🇦 until that happens.   # Version 6 (Development branch) > Looking for Verdaccio 5 version? Check the branch `5.x` > The plugins for the `v5.x` that are hosted within this organization are located > at the [`verdaccio/monorepo`](https://github.com/verdaccio/monorepo) repository, while for the v6.x > are hosted on this project `./packages/plugins`, keep on mind `v6.x` plugins will eventually would be > incompatible with `v5.x` versions. > Note that contributing guidelines might be different based on the branch. [Verdaccio](https://verdaccio.org/) is a simple, **zero-config-required local private npm registry**. No need for an entire database just to get started! Verdaccio comes out of the box with **its own tiny database**, and the ability to proxy other registries (eg. npmjs.org), caching the downloaded modules along the way. For those looking to extend their storage capabilities, Verdaccio **supports various community-made plugins to hook into services such as Amazon's s3, Google Cloud Storage** or create your own plugin. [](https://www.npmjs.com/package/verdaccio) [](https://www.npmjs.com/package/verdaccio) [](https://verdaccio.org/docs/en/docker.html) [](https://opencollective.com/verdaccio) [](https://stackshare.io/verdaccio) [](http://chat.verdaccio.org/) [](https://github.com/verdaccio/verdaccio/blob/master/LICENSE) [](https://crowdin.com/project/verdaccio) [](https://twitter.com/verdaccio_npm) [](https://github.com/verdaccio/verdaccio/stargazers) [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) ## Install > Latest Node.js v16 required Install with npm: ```bash npm install --location=global verdaccio@6-next ``` With `yarn` ```bash yarn global add verdaccio@6-next ``` With `pnpm` ```bash pnpm i -g verdaccio@6-next ``` or ```bash docker pull verdaccio/verdaccio:nightly-master ``` or with _helm_ [official chart](https://github.com/verdaccio/charts). ```bash helm repo add verdaccio https://charts.verdaccio.org helm repo update helm install verdaccio/verdaccio ``` Furthermore, you can read the [**Debugging Guidelines**](https://github.com/verdaccio/verdaccio/wiki/Debugging-Verdaccio) and the [**Docker Examples**](https://github.com/verdaccio/verdaccio/tree/master/docker-examples) for more advanced development. ## Plugins You can develop your own [plugins](https://verdaccio.org/docs/plugins) with the [verdaccio generator](https://github.com/verdaccio/generator-verdaccio-plugin). Installing [Yeoman](https://yeoman.io/) is required. ``` npm install --location=global yo npm install --location=global generator-verdaccio-plugin ``` Learn more [here](https://verdaccio.org/docs/dev-plugins) how to develop plugins. Share your plugins with the community. ## Donations Verdaccio is run by **volunteers**; nobody is working full-time on it. If you find this project to be useful and would like to support its development, consider do a long support donation - **and your logo will be on this section of the readme.** **[Donate](https://github.com/sponsors/verdaccio)** 💵👍🏻 starting from _$1/month_ or just one single contribution. ## What does Verdaccio do for me? ### Use private packages If you want to use all benefits of npm package system in your company without sending all code to the public, and use your private packages just as easy as public ones. ### Cache npmjs.org registry If you have more than one server you want to install packages on, you might want to use this to decrease latency (presumably "slow" npmjs.org will be connected to only once per package/version) and provide limited failover (if npmjs.org is down, we might still find something useful in the cache) or avoid issues like _[How one developer just broke Node, Babel and thousands of projects in 11 lines of JavaScript](https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/)_, _[Many packages suddenly disappeared](https://github.com/npm/registry-issue-archive/issues/255)_ or _[Registry returns 404 for a package I have installed before](https://github.com/npm/registry-issue-archive/issues/329)_. ### Link multiple registries If you use multiples registries in your organization and need to fetch packages from multiple sources in one single project you might take advance of the uplinks feature with Verdaccio, chaining multiple registries and fetching from one single endpoint. ### Override public packages If you want to use a modified version of some 3rd-party package (for example, you found a bug, but maintainer didn't accept pull request yet), you can publish your version locally under the same name. See in detail [here](https://verdaccio.org/docs/en/best#override-public-packages). ### E2E Testing Verdaccio has proved to be a lightweight registry that can be booted in a couple of seconds, fast enough for any CI. Many open source projects use verdaccio for end to end testing, to mention some examples, **create-react-app**, **mozilla neutrino**, **pnpm**, **storybook**, **babel.js**, **angular-cli** or **docusaurus**. You can read more in [here](https://verdaccio.org/docs/e2e). Furthermore, here few examples how to start: - [e2e-ci-example-gh-actions](https://github.com/juanpicado/e2e-ci-example-gh-actions) - [verdaccio-end-to-end-tests](https://github.com/juanpicado/verdaccio-end-to-end-tests) - [verdaccio-fork](https://github.com/juanpicado/verdaccio-fork) ## Watch our Videos **Node Congress 2022, February 2022, Online Free** <div> <a href="https://portal.gitnation.org/contents/five-ways-of-taking-advantage-of-verdaccio-your-private-and-proxy-nodejs-registry"> <img src="https://cdn.verdaccio.dev/readme/nodejscongress2022.jpg" alt="nodejs" width="200"/> </a> </div> You might want to check out as well our previous talks: - [Using Docker and Verdaccio to make Integration Testing Easy - **Docker All Hands #4 December - 2021**](https://www.youtube.com/watch?v=zRI0skF1f8I) - [**Juan Picado** – Testing the integrity of React components by publishing in a private registry - React Finland - 2021](https://www.youtube.com/watch?v=bRKZbrlQqLY&t=16s&ab_channel=ReactFinland) - [BeerJS Cba Meetup No. 53 May 2021 - **Juan Picado**](https://www.youtube.com/watch?v=6SyjqBmS49Y&ab_channel=BeerJSCba) - [Node.js Dependency Confusion Attacks - April 2021 - **Juan Picado**](https://www.youtube.com/watch?v=qTRADSp3Hpo) - [**OpenJS World 2020** about \*Cover your Projects with a Multi purpose Lightweight Node.js Registry - **Juan Picado**](https://www.youtube.com/watch?v=oVCjDWeehAQ) - [ViennaJS Meetup - Introduction to Verdaccio by **Priscila Olivera** and **Juan Picado**](https://www.youtube.com/watch?v=hDIFKzmoCa) - [Open Source? trivago - Verdaccio (**Ayush** and **Juan Picado**) January 2020](https://www.youtube.com/watch?v=A5CWxJC9xzc) - [GitNation Open Source Stage - How we have built a Node.js Registry with React - **Juan Picado** December 2019](https://www.youtube.com/watch?v=gpjC8Qp9B9A) - [Verdaccio - A lightweight Private Proxy Registry built in Node.js | **Juan Picado** at The Destro Dev Show](https://www.youtube.com/watch?reload=9&v=P_hxy7W-IL4&ab_channel=TheDestroDevShow) ## Get Started Run in your terminal ```bash verdaccio ``` You would need set some npm configuration, this is optional. ```bash npm set registry http://localhost:4873/ ``` For one-off commands or to avoid setting the registry globally: ```bash NPM_CONFIG_REGISTRY=http://localhost:4873 npm i ``` Now you can navigate to [http://localhost:4873/](http://localhost:4873/) where your local packages will be listed and can be searched. > Warning: Verdaccio [does not currently support PM2's cluster mode](https://github.com/verdaccio/verdaccio/issues/1301#issuecomment-489302298), running it with cluster mode may cause unknown behavior. ## Publishing #### 1. create a user and log in ```bash npm adduser --registry http://localhost:4873 ``` > if you use HTTPS, add an appropriate CA information ("null" means get CA list from OS) ```bash npm set ca null ``` #### 2. publish your package ```bash npm publish --registry http://localhost:4873 ``` This will prompt you for user credentials which will be saved on the `verdaccio` server. ## Docker Below are the most commonly needed information, every aspect of Docker and verdaccio is [documented separately](https://www.verdaccio.org/docs/en/docker.html) ``` docker pull verdaccio/verdaccio:nightly-master ``` Available as [tags](https://hub.docker.com/r/verdaccio/verdaccio/tags/). ### Running verdaccio using Docker To run the docker container: ```bash docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio ``` Docker examples are available [in this repository](https://github.com/verdaccio/verdaccio/tree/master/docker-examples). ## Compatibility Verdaccio aims to support all features of a standard npm client that make sense to support in private repository. Unfortunately, it isn't always possible. ### Basic features - Installing packages (npm install, npm upgrade, etc.) - **supported** - Publishing packages (npm publish) - **supported** ### Advanced package control - Unpublishing packages (npm unpublish) - **supported** - Tagging (npm tag) - **supported** - Deprecation (npm deprecate) - **supported** ### User management - Registering new users (npm adduser {newuser}) - **supported** - Change password (npm profile set password) - **supported** - Transferring ownership (npm owner add {user} {pkg}) - not supported, _PR-welcome_ - Token (npm token) - **supported** ### Miscellany - Searching (npm search) - **supported** (cli / browser) - Ping (npm ping) - **supported** - Starring (npm star, npm unstar, npm stars) - **supported** ### Security - npm/yarn audit - **supported** ## Report a vulnerability If you want to report a security vulnerability, please follow the steps which we have defined for you in our [security policy](https://github.com/verdaccio/verdaccio/security/policy). ## Special Thanks Thanks to the following companies to help us to achieve our goals providing free open source licenses. Every company provides enough resources to move this project forward. | Company | Logo | License | | ------------ | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | JetBrains | [](https://www.jetbrains.com/) | JetBrains provides licenses for products for active maintainers, renewable yearly | | Crowdin | [](https://crowdin.com/) | Crowdin provides platform for translations | | BrowserStack | [](https://www.browserstack.com/) | BrowserStack provides plan to run End to End testing for the UI | | Netlify | [](https://www.netlify.com/) | Netlify provides pro plan for website deployment | | Algolia | [](https://algolia.com/) | Algolia provides search services for the website | | Docker | [](https://www.docker.com/community/open-source/application) | Docker offers unlimited pulls and unlimited egress to any and all users | ## Maintainers | [Juan Picado](https://github.com/juanpicado) | [Ayush Sharma](https://github.com/ayusharma) | [Sergio Hg](https://github.com/sergiohgz) | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------- | |  |  |  | | [@jotadeveloper](https://twitter.com/jotadeveloper) | [@ayusharma\_](https://twitter.com/ayusharma_) | [@sergiohgz](https://twitter.com/sergiohgz) | | [Priscila Oliveria](https://github.com/priscilawebdev) | [Daniel Ruf](https://github.com/DanielRuf) | |  |  | | [@priscilawebdev](https://twitter.com/priscilawebdev) | [@DanielRufde](https://twitter.com/DanielRufde) | You can find and chat with then over Discord, click [here](http://chat.verdaccio.org) or follow them at _Twitter_. ## Who is using Verdaccio? - [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#customizing-e2e-registry-configuration) _(+86.2k ⭐️)_ - [Gatsby](https://github.com/gatsbyjs/gatsby) _(+49.2k ⭐️)_ - [Babel.js](https://github.com/babel/babel) _(+38.5k ⭐️)_ - [Docusaurus](https://github.com/facebook/docusaurus) _(+34k ⭐️)_ - [Vue CLI](https://github.com/vuejs/vue-cli) _(+27.4k ⭐️)_ - [Angular CLI](https://github.com/angular/angular-cli) _(+24.3k ⭐️)_ - [Uppy](https://github.com/transloadit/uppy) _(+23.8k ⭐️)_ - [bit](https://github.com/teambit/bit) _(+13k ⭐️)_ - [Aurelia Framework](https://github.com/aurelia/framework) _(+11.6k ⭐️)_ - [pnpm](https://github.com/pnpm/pnpm) _(+10.1k ⭐️)_ - [ethereum/web3.js](https://github.com/ethereum/web3.js) _(+9.8k ⭐️)_ - [NX](https://github.com/nrwl/nx) _(+6.1k ⭐️)_ - [webiny-js](https://github.com/webiny/webiny-js) _(+4.3k ⭐️)_ - [Mozilla Neutrino](https://github.com/neutrinojs/neutrino) _(+3.7k ⭐️)_ - [workshopper how to npm](https://github.com/workshopper/how-to-npm) _(+1k ⭐️)_ - [Amazon SDK v3](https://github.com/aws/aws-sdk-js-v3) - [Amazon Encryption SDK for Javascript](https://github.com/aws/aws-encryption-sdk-javascript) 🤓 Don't be shy, add yourself to this readme. ## Open Collective Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)] [](https://opencollective.com/verdaccio/sponsor/0/website) [](https://opencollective.com/verdaccio/sponsor/1/website) [](https://opencollective.com/verdaccio/sponsor/2/website) [](https://opencollective.com/verdaccio/sponsor/3/website) [](https://opencollective.com/verdaccio/sponsor/4/website) [](https://opencollective.com/verdaccio/sponsor/5/website) [](https://opencollective.com/verdaccio/sponsor/6/website) [](https://opencollective.com/verdaccio/sponsor/7/website) [](https://opencollective.com/verdaccio/sponsor/8/website) [](https://opencollective.com/verdaccio/sponsor/9/website) ## Open Collective Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)] [](https://opencollective.com/verdaccio#backers) ## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. [](../../graphs/contributors) ### FAQ / Contact / Troubleshoot If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for. - [Blog](https://verdaccio.org/blog/) - [Donations](https://github.com/sponsors/verdaccio) - [Reporting an issue](https://github.com/verdaccio/verdaccio/issues/new/choose) - [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss) - [Chat](https://discord.gg/7qWJxBf) - [Logos](https://verdaccio.org/docs/en/logo) - [Docker Examples](https://github.com/verdaccio/verdaccio/tree/master/docker-examples) - [FAQ](https://github.com/verdaccio/verdaccio/discussions/categories/q-a) ### License Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE) The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch) files within the /assets folder) is [Creative Commons licensed](https://creativecommons.org/licenses/by/4.0/).

Curriculum for learning front-end development during #100DaysOfCode.

**Note:** this resource is old! I will be archiving this repository by the end of July 2021 as I feel that many of the recommendations here are outdated for learning front-end web development in 2021. --- <p align="center"> <img alt="#100DaysOfCode Front-End Development" src="https://i.imgur.com/dwYOP0B.jpg" /> </p> **Please support this repo by giving it a star ⭐️ at the top of the page and [follow me](https://github.com/nas5w) for more resources!** Want to learn more about frontend development? Consider: - signing up for my [free newsletter](https://buttondown.email/devtuts?100DoC) where I periodically send out digestible bits of frontend knowledge! - subscribing to my [YouTube channel](https://www.youtube.com/c/devtutsco) where I teach JavaScript, Typescript, and React. --- This is a somewhat opinionated curriculum for learning front-end development during #100DaysOfCode. As it covers a wide range of front-end development topics, it can be thought of as more of a "survey" style course rather than a deep dive into any one area. Ideally, your takeaway from completing this curriculum will be some familiarity with each topic and the ability to easily dive deeper in any area in the future when necessary. This curriculum was influenced significantly by Kamran Ahmed's [Modern Frontend Developer](https://medium.com/tech-tajawal/modern-frontend-developer-in-2018-4c2072fa2b9c) roadmap. Please check it out--it is excellent. **Note**: I know front-end development means a lot of different things to a lot of people! If you're a front-end developer and you think this guide could be improved, please let me know by raising an issue as described in the [Contributing](#contributing) section. Thank you! # Translations Thanks to some incredible contributors, this curriculum has been translated into the following languages! - [Russian русский](/ru) (translation by [@Ibochkarev](https://github.com/Ibochkarev) and [@JonikUl](https://github.com/JonikUl)) - [Chinese 中文](/chinese) (translation by [@simplefeel](https://github.com/simplefeel)) - [Portuguese Português](/portuguese) (translation by [@Zardosh](https://github.com/Zardosh)) - [Polish polski](/polish) (translation by [@mbiesiad](https://github.com/mbiesiad)) - [Malay/Indonesia](/Malay) (translation by [@asyraf-labs](https://github.com/asyraf-labs)) - [Vietnamese Tiếng Việt](/Vietnam) (translation by [@duca7](https://github.com/duca7)) - [Japanese 日本語](/japanese) (translation by [miily8310s](https://github.com/miily8310s)) - [Bangla বাংলা](/bangla) (translation by [mirajus-salehin](https://github.com/mirajus-salehin)) # :calendar: Curriculum The underlying principle of this repository is [timeboxing](https://en.wikipedia.org/wiki/Timeboxing). If you have spent any amount of time in the past trying to learn web development or a similar skill, you have likely experienced going down a rabbit hole on any one particular topic. This repository aims to assign a certain number of days to each technology and encourages you to move to the next once that number of days is up. It is anticipated that everyone is at a different level of proficiency when starting this challenge, and that's okay. Beginner and expert front-end developers alike can benefit from timeboxed practice in each of these areas. The recommended day-by-day activities are as follows: - Days 1-8: [HTML](#html) - Days 9-16: [CSS](#css) - Days 17-24: [JavaScript Basics](#javascript) - Days 25-27: [jQuery](#jquery) - Days 28-33: [Responsive Web Design](#rwd) - Days 34-36: [Accessibility](#accessibility) - Days 37-39: [Git](#git) - Days 40-44: [Node and NPM](#node) - Days 45-50: [Sass](#sass) - Days 51-54: [Bootstrap](#bootstrap) - Day 55: [BEM](#bem) - Days 57-61: [Gulp](#gulp) - Days 62-65: [Webpack](#webpack) - Day 66: [ESLint](#eslint) - Days 68-83: [React](#react) - Days 84-89: [Redux](#redux) - Days 90-94: [Jest](#jest) - Days 95-97: [TypeScript](#typescript) - Days 98-100: [NextJS](#nextjs) # :mag_right: The Details Below you can find a little information about each topic in the curriculum as well as some ideas/guidance on what to do for each. For inspiration on projects to do alongside this curriculum, see the [Project Ideas section](#project-ideas). As part of the timeboxing principle, it's okay if you don't get through all of the items in the "Learning Areas and Ideas" sections. You should instead focus on getting the most you can out of the number of days assigned to each area and then move on. <a name="html"></a>  Hypertext Markup Language (HTML) is the standard markup language for creating web pages and web applications. With Cascading Style Sheets (CSS) and JavaScript, it forms a triad of cornerstone technologies for the World Wide Web. Web browsers receive HTML documents from a web server or from local storage and render the documents into multimedia web pages. HTML describes the structure of a web page semantically and originally included cues for the appearance of the document. (Source: [Wikipedia](https://en.wikipedia.org/wiki/HTML)) ### :bulb: Quick Takeaway HTML is really the foundation of web development. Even in the javascript-based frameworks, you end up writing HTML in one form or another. ### :book: Learning Areas and Ideas - Take the [Basic HTML and HTML5 section](https://learn.freecodecamp.org/) on freeCodeCamp. - HTML page structure - HTML elements - Nesting HTML elements - Semantic markup - Links / multiple pages - Images - Audio/video media - Forms and form elements - Create a multi-page website! (See [Project Ideas](#project-ideas) if you need some inspiration). <a name="css"></a>  Cascading Style Sheets (CSS) is a style sheet language used for describing the presentation of a document written in a markup language like HTML. CSS is a cornerstone technology of the World Wide Web, alongside HTML and JavaScript. CSS is designed to enable the separation of presentation and content, including layout, colors, and fonts. This separation can improve content accessibility, provide more flexibility and control in the specification of presentation characteristics, enable multiple web pages to share formatting by specifying the relevant CSS in a separate .css file, and reduce complexity and repetition in the structural content. (Source: [Wikipedia](https://en.wikipedia.org/wiki/Cascading_Style_Sheets)) ### :bulb: Quick Takeaway CSS is another essential component of web development. While it is mainly used to style and position HTML elements, it has become increasingly capable of more dynamic tasks (e.g., animations) that would once be handled by javascript. ### :book: Learning Areas and Ideas - Take the [Basic CSS, CSS flexbox, and CSS grid sections](https://learn.freecodecamp.org/) on freeCodeCamp. - In-line CSS - `<style>` tags - External CSS with `<link>` - Styling elements - Selectors - Floats, clearing floats - Layouts (grid, flexbox) - Fonts, custom fonts - Style the HTML page(s) you made when learning HTML! <a name="javascript"></a>  JavaScript , often abbreviated as JS, is a high-level, interpreted programming language that conforms to the ECMAScript specification. It is a language that is also characterized as dynamic, weakly typed, prototype-based and multi-paradigm. Alongside HTML and CSS, JavaScript is one of the three core technologies of the World Wide Web. JavaScript enables interactive web pages and thus is an essential part of web applications. The vast majority of websites use it, and all major web browsers have a dedicated JavaScript engine to execute it. (Source: [Wikipedia](https://en.wikipedia.org/wiki/JavaScript)) ### :bulb: Quick Takeaway JavaScript has become increasingly important in the front-end world. While it was once used mainly to make pages dynamic, it is now the foundation of many front-end frameworks. These frameworks handle a lot of the tasks that were formerly handled by the back-end (e.g., routing and displaying different views). ### :book: Learning Areas and Ideas - Take the [Basic JavaScript and ES6 sections](https://learn.freecodecamp.org/) on freeCodeCamp. - Too many language fundamentals to list here! - `<script>` tag and placement - Accessing HTML elements - The event loop, call stack, and event queue - Prototypal Inheritance - Reference vs. value - Add some dynamic elements or logic to your HTML/CSS page(s) developed earlier! <a name="jquery"></a>  jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. With a combination of versatility and extensibility, jQuery has changed the way that millions of people write JavaScript. (Source: [jQuery.com](https://jquery.com/)) ### :bulb: Quick Takeaway After you have spent some time with plain (also called "vanilla") javascript, you may find some tasks a bit cumbersome, especially those related to accessing and manipulating HTML elements. For quite a while, jQuery was the go-to library for making these kinds of tasks easier and consistent across different browsers. Nowadays, jQuery isn't necessarily "mandatory" learning because of advancements in vanilla javascript, CSS, and newer javascript frameworks (we'll look at frameworks later). Still, it would be beneficial to take a little time to learn some jQuery and apply it to a small project. ### :book: Learning Areas and Ideas - Take the [jQuery section](https://learn.freecodecamp.org/) on freeCodeCamp. - Document ready - Selectors - Toggle classes - Animation - Add or move HTML elements - Add jQuery to your site! <a name="rwd"></a>  Responsive web design (RWD) is an approach to web design that makes web pages render well on a variety of devices and window or screen sizes. Recent work also considers the viewer proximity as part of the viewing context as an extension for RWD. Content, design and performance are necessary across all devices to ensure usability and satisfaction. A site designed with RWD adapts the layout to the viewing environment by using fluid, proportion-based grids, flexible images, and CSS3 media queries, an extension of the @media rule. (Source: [Wikipedia](https://en.wikipedia.org/wiki/Responsive_web_design)) ### :bulb: Quick Takeaway Responsive web design is all about making web applications look and function properly on all types of device. A quick-and-dirty example would be that a website should look and function properly both in a desktop web browser and on a mobile phone browser. An understanding of responsive design is crucial for any front-end developer! ### :book: Learning Areas and Ideas - Take the [Responsive Web Design Principles section](https://learn.freecodecamp.org/) on freeCodeCamp. - Media queries, breakpoints - Responsive images - Make your website responsive! - Use Chrome DevTools to view your site on different devices/viewports. <a name="accessibility"></a>  Web accessibility is the inclusive practice of ensuring there are no barriers that prevent interaction with, or access to, websites on the World Wide Web by people with disabilities. When sites are correctly designed, developed and edited, generally all users have equal access to information and functionality. (Source: [Wikipedia](https://en.wikipedia.org/wiki/Web_accessibility)) ### :bulb: Quick Takeaway Accessibility, often written as a11y, is one of the most important topics in front-end web development, yet it seems to often get short shrift. Creating accessible web applications is not only ethically sound, but also makes a lot of business sense considering the additional audience that will be able to view your applications when they are accessible. ### :book: Learning Areas and Ideas - Take the [Applied Accessibility section](https://learn.freecodecamp.org/) on freeCodeCamp. - Read some content on [The A11Y Project](https://a11yproject.com/about) - Review their [checklist](https://a11yproject.com/checklist) - Update your site(s) for accessibility based on this checklist <a name="git"></a>  Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. (Source: [git-scm.com](https://git-scm.com/)) ### :bulb: Quick Takeaway Version/code control is an essential part of any web developer's toolkit. There are a number of different version control systems, but Git is by far the most prevalent at the moment. You can (and should!) use it to track your projects as you learn! ### :book: Learning Areas and Ideas - [Git Tutorial for Beginners (Video)](https://www.youtube.com/watch?v=HVsySz-h9r4) - Install git - Set up a [github](https://github.com) account - Learn the most-used git commands: - init - clone - add - commit - push - pull - merge - rebase - Add your existing projects to github! <a name="node"></a>  Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code outside of a browser. JavaScript is used primarily for client-side scripting, in which scripts written in JavaScript are embedded in a webpage's HTML and run client-side by a JavaScript engine in the user's web browser. Node.js lets developers use JavaScript to write command line tools and for server-side scripting—running scripts server-side to produce dynamic web page content before the page is sent to the user's web browser. Consequently, Node.js represents a "JavaScript everywhere" paradigm, unifying web application development around a single programming language, rather than different languages for server side and client side scripts. (Source: [Wikipedia](https://en.wikipedia.org/wiki/Node.js)) ### :bulb: Quick Takeaway While Node.js is typically known as a back-end solution, it is used quite frequently to support front-end development. It does this in a number of ways, including things like running build tools, testing, and linting (all to be covered soon!). Node Package Manager (npm) is another great feature of Node and can be used to manage dependencies of your project (i.e., code libraries your project might rely on -- jQuery is an example!). ### :book: Learning Areas and Ideas - Research node and how it is different than the browser - Install node (npm comes with it) - Create a simple javascript file and run it with node - Use NPM to manage any dependencies in your existing project(s) (e.g., jQuery!) <a name="sass"></a>  Sass is an extension of CSS that adds power and elegance to the basic language. It allows you to use variables, nested rules, mixins, inline imports, and more, all with a fully CSS-compatible syntax. Sass helps keep large stylesheets well-organized, and get small stylesheets up and running quickly, particularly with the help of the Compass style library. (Source: [sass-lang.com](https://sass-lang.com/documentation/file.SASS_REFERENCE.html)) ### :bulb: Quick Takeaway Sass allows you to write CSS in a more programmatic way. If you've done some CSS, you might have noticed that you end up repeating a lot of information--for example, specifying the same color code. In Sass, you can use things like variables, loops, and nesting to reduce redundancy and increase readability. After writing your code in Sass, you can quickly and easily compile it to regular CSS. ### :book: Learning Areas and Ideas - [Install Sass](https://sass-lang.com/install) globally with npm! - [Sass Crash Course Video](https://www.youtube.com/watch?v=roywYSEPSvc) - Follow the [Learn Sass](https://sass-lang.com/guide) tutorial and/or [freeCodeCamp](https://learn.freecodecamp.org/) Sass tutorial. - Update your existing site to generate your CSS using Sass! <a name="bootstrap"></a>  \* Some alternatives: Foundation, Bulma, Materialize Bootstrap is a free and open-source front-end framework for developing websites and web applications. It contains HTML and CSS-based design templates for typography, forms, buttons, navigation and other interface components, as well as optional JavaScript extensions. (Source: [Wikipedia](<https://en.wikipedia.org/wiki/Bootstrap_(front-end_framework)>)) ### :bulb: Quick Takeaway There are many options for laying out, styling, and making your web application dynamic, but you'll find that starting with a framework helps you tremendously in getting a head start. Bootstrap is one such framework, but it is definitely far from the only option! I recommend getting familiar with one framework like this, but it's far more important to grasp HTML, CSS, and JavaScript fundamentals than it is to get caught up in any one framework. ### :book: Learning Areas and Ideas - Learn what Bootstrap is and why you would want to use it - [Bootstrap 4 Crash Course (Video)](https://www.youtube.com/watch?v=hnCmSXCZEpU) - Complete the Bootstrap section on [freeCodeCamp](https://learn.freecodecamp.org/) - Refactor your site using bootstrap! <a name="bem"></a>  The Block, Element, Modifier methodology (commonly referred to as BEM) is a popular naming convention for classes in HTML and CSS. Developed by the team at Yandex, its goal is to help developers better understand the relationship between the HTML and CSS in a given project. (Source: [css-tricks.com](https://css-tricks.com/bem-101/)) ### :bulb: Quick Takeaway It's important to know naming and organization systems like BEM exist and why they are used. Do some research here, but at a beginner level I wouldn't recommend devoting too much time to the subject. ### :book: Learning Areas and Ideas - Read the [BEM introduction](http://getbem.com/introduction/) - [Why I Use BEM (Video)](https://www.youtube.com/watch?v=SLjHSVwXYq4) - Create a simple webpage using BEM conventions. <a name="gulp"></a>  Gulp is a toolkit for automating painful or time-consuming tasks in your development workflow, so you can stop messing around and build something. (Source: [gulpjs.com](https://gulpjs.com/)) ### :bulb: Quick Takeaway In modern front-end development, you'll often find yourself needing to automate tasks like bundling, moving files, and injecting references into HTML files. Gulp is one tool that can help you do these things! ### :book: Learning Areas and Ideas - Install gulp with npm - Follow the [gulp for beginners tutorial](https://css-tricks.com/gulp-for-beginners/) on CSS-Tricks - In your website, set up gulp to: - Compile Sass for you - Put the generated CSS file in `build` subdirectory - Move your web pages to the build directory - Inject a reference to your generated CSS file into your web pages <a name="webpack"></a>  At its core, webpack is a static module bundler for modern JavaScript applications. When webpack processes your application, it internally builds a dependency graph which maps every module your project needs and generates one or more bundles. (Source: [webpack.js.org](https://webpack.js.org/concepts/)) ### :bulb: Quick Takeaway Imagine that you have a large web development project with a number of different developers working on a lot of different tasks. Rather than all working in the same files, you might want to modularize them as much as possible. Webpack helps enable this by letting your team work modularly and then, come time to build the application, Webpack will stick it all together: HTML, CSS/Sass, JavasScript, images, etc. Webpack isn't the only module bundler, but it seems to be the front-runner at the moment. ### :book: Learning Areas and Ideas - Read [webpack concepts](https://webpack.js.org/concepts/) - [What is Webpack, How does it work? (Video)](https://www.youtube.com/watch?v=GU-2T7k9NfI) - [This webpack tutorial](https://hackernoon.com/a-tale-of-webpack-4-and-how-to-finally-configure-it-in-the-right-way-4e94c8e7e5c1) <a name="eslint"></a>  ESLint is an open source JavaScript linting utility originally created by Nicholas C. Zakas in June 2013. Code linting is a type of static analysis that is frequently used to find problematic patterns or code that doesn’t adhere to certain style guidelines. There are code linters for most programming languages, and compilers sometimes incorporate linting into the compilation process. (Source: [eslint.org](https://eslint.org/docs/about/)) ### :bulb: Quick Takeaway Linting is a fantastic tool for code quality, readability, and consistency. Using a linter will help you catch syntax and formatting mistakes before they go to production. You can run linters manually or include them in your build/deployment process. ### :book: Learning Areas and Ideas - Install eslint using npm - [How to Setup VS Code + Prettier + ESLint (Video)](https://www.youtube.com/watch?v=YIvjKId9m2c) - Lint your JavaScript <a name="react"></a>  \* Some alternatives: Vue, Angular, Ember React (also known as React.js or ReactJS) is a JavaScript library for building user interfaces. It is maintained by Facebook and a community of individual developers and companies. React can be used as a base in the development of single-page or mobile applications. Complex React applications usually require the use of additional libraries for state management, routing, and interaction with an API. (source: [Wikipedia](<https://en.wikipedia.org/wiki/React_(JavaScript_library)>)) ### :bulb: Quick Takeaway Front-end JavaScript frameworks are at the forefront of modern front-end development. One important takeaway here is that React, despite being incredibly popular, is only a library for building user interfaces whereas frameworks like Vue and Angular aim to be more full-featured. For example, if you build an application with in React that needs to route to different views, you'll need to bring in something like `react-router`. ### :book: Learning Areas and Ideas - Take the [React tutorial](https://reactjs.org/tutorial/tutorial.html) - [Learn React with Mosh](https://www.youtube.com/watch?v=Ke90Tje7VS0) - Refactor your website as a React app! - Note: `create-react-app` is a convenient tool to scaffold new React projects. <a name="redux"></a>  Redux is a predictable state container for JavaScript apps. It helps you write applications that behave consistently, run in different environments (client, server, and native), and are easy to test. On top of that, it provides a great developer experience, such as live code editing combined with a time traveling debugger. (Source: [redux.js.org](https://redux.js.org/introduction/getting-started)) ### :bulb: Quick Takeaway As you build bigger and bigger front-end applications, you start realizing that it's hard to maintain application state: things like the if the user is logged in, who the user is, and generally what's going on in the application. Redux is a great library that helps you maintain a single source of state on which your application can base its logic. ### :book: Learning Areas and Ideas - This [Redux video tutorial](https://www.youtube.com/watch?v=93p3LxR9xfM) - This [Redux video series](https://egghead.io/courses/getting-started-with-redux) by Dan Abramov, creator of Redux - Take note of the [Redux three principles](https://redux.js.org/introduction/three-principles) - Single source of truth - State is read-only - Changes are made with pure functions - Add Redux state management to your app! <a name="jest"></a>  Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works with projects using: Babel, TypeScript, Node, React, Angular, Vue and more! (Source: [jestjs.io](https://jestjs.io)) ### :bulb: Quick Takeaway It is very important to set up automated testing for your front-end projects. Setting up automated testing will allow you to make future changes with confidence--if you make changes and your tests still pass, you will be fairly comfortable you didn't break any existing functionality. There are too many testing frameworks to list; Jest is simply one of my favorties. ### :book: Learning Areas and Ideas - Learn [Jest basics](https://jestjs.io/docs/en/getting-started) - If you used `create-react-app`, [Jest is already configured](https://facebook.github.io/create-react-app/docs/running-tests). - Add tests to your application! <a name="typescript"></a>  \* Alternative: Flow TypeScript is an open-source programming language developed and maintained by Microsoft. It is a strict syntactical superset of JavaScript, and adds optional static typing to the language. TypeScript is designed for development of large applications and transcompiles to JavaScript. As TypeScript is a superset of JavaScript, existing JavaScript programs are also valid TypeScript programs. TypeScript may be used to develop JavaScript applications for both client-side and server-side (Node.js) execution. (Source: [Wikipedia](https://en.wikipedia.org/wiki/TypeScript)) ### :bulb: Quick Takeaway JavaScript is dynamically typed. However, it is a common belief that static typing (i.e., specifying variable types, classes, interfaces ahead of time) is both clearer and reduces the likelihood of defects/bugs. Regardless of how you feel on the topic, it's important to at least get a feel for a statically-typed version of JavaScript like TypeScript. Note that TypeScript compiles down to JavaScript so it can be interpreted by browsers (i.e., browsers don't natively interpret TypeScript). ### :book: Learning Areas and Ideas - [Learn TypeScript in 5 minutes](https://medium.freecodecamp.org/learn-typescript-in-5-minutes-13eda868daeb) - [Learn TypeScript in 50 minutes (Video)](https://www.youtube.com/watch?v=WBPrJSw7yQA) - Optionally [create a React app with TypeScript](https://levelup.gitconnected.com/typescript-and-react-using-create-react-app-a-step-by-step-guide-to-setting-up-your-first-app-6deda70843a4) <a name="nextjs"></a>  Next.js is a minimalistic framework for server-rendered React applications. (Source: [Next.js — React Server Side Rendering Done Right](https://hackernoon.com/next-js-react-server-side-rendering-done-right-f9700078a3b6)) ### :bulb: Quick Takeaway Now we're getting advanced! By now you've built a React (or Vue or Angular) application that does quite a bit of work in the browser. For various reasons (e.g., SEO, concerns over client performance), you might actually want your front-end application to be rendered on the server rather than the client. That's where a framework like next.js comes in. ### :book: Learning Areas and Ideas - Next.js [Getting Started](https://nextjs.org/learn/) - [Next.js Crash Course (Video)](https://www.youtube.com/watch?v=IkOVe40Sy0U) - Create a Next.js app or migrate your existing app to Next.js # But What About X? This list is supposed to give you broad exposure to the front-end ecosystem, but it's simply impossible to hit on every single topic, not to mention the myriad tools within each area! If you do think I missed something very important, please see the [Contributing](#contributing) section to see how you can help make this guide better. # Project Ideas As you progress through #100DaysOfCode, you'll want one or multiple projects to which you can apply your new knowledge. In this section, I attempt to provide a few project ideas that you can use. Alternatively, you're encouraged to come up with your own project ideas as those ideas may interest and motivate you more. - Beginner ideas: - Build a portfolio website - Intermediate/Advanced ideas: - Build a tweet analysis app (If you know back-end and API integration already) # Need Help? Generally, I have found the following resources invaluable to learning software development: - Googling the issue - [StackOverflow](http://www.stackoverflow.com) (There's a good chance your question has already been asked and will be a high-ranking result when googling). - [Mozilla MDN Web Docs](https://developer.mozilla.org/en-US/) - [freeCodeCamp](https://www.freecodecamp.org/) - Local software development Meetups! Most are very friendly to all experience levels. If you'd like my input on anything, feel free to [connect with me on Twitter](http://www.twitter.com/nas5w) and I'll do my best to try to offer some assistance. If you think there's an issue with the curriculum or have a recommendation, see the [contributing section](#contributing) below. # Contributing ## Spread the Word If you appreciate the work done here, you can contribute significantly by spreading the word about this repository, including things like: - Starring and forking this repository - Sharing this repository on social media ## Contribute to this Repository This is a work in progress and I very much appreciate any help in maintaining this knowledge base! When contributing to this repository, please first discuss the change you wish to make via issue before making a change. Otherwise, it will be very hard to understand your proposal and could potentially result in you putting in a lot of work to a change that won't get merged. Please note that everyone involved in this project is either trying to learn or trying to help--Please be nice! ## Pull Request Process 1. Create an issue outlining the proposed pull request. 2. Obtain approval from a project owner to make the proposed change. 3. Create the pull request.

Rich is a Python library for rich text and beautiful formatting in the terminal.

[](https://pypi.org/project/rich/) [](https://badge.fury.io/py/rich) [](https://pepy.tech/project/rich) [](https://codecov.io/gh/Textualize/rich) [](https://www.willmcgugan.com/tag/rich/) [](https://twitter.com/willmcgugan)  [English readme](https://github.com/textualize/rich/blob/master/README.md) • [简体中文 readme](https://github.com/textualize/rich/blob/master/README.cn.md) • [正體中文 readme](https://github.com/textualize/rich/blob/master/README.zh-tw.md) • [Lengua española readme](https://github.com/textualize/rich/blob/master/README.es.md) • [Deutsche readme](https://github.com/textualize/rich/blob/master/README.de.md) • [Läs på svenska](https://github.com/textualize/rich/blob/master/README.sv.md) • [日本語 readme](https://github.com/textualize/rich/blob/master/README.ja.md) • [한국어 readme](https://github.com/textualize/rich/blob/master/README.kr.md) • [Français readme](https://github.com/textualize/rich/blob/master/README.fr.md) • [Schwizerdütsch readme](https://github.com/textualize/rich/blob/master/README.de-ch.md) • [हिन्दी readme](https://github.com/textualize/rich/blob/master/README.hi.md) • [Português brasileiro readme](https://github.com/textualize/rich/blob/master/README.pt-br.md) • [Italian readme](https://github.com/textualize/rich/blob/master/README.it.md) • [Русский readme](https://github.com/textualize/rich/blob/master/README.ru.md) • [Indonesian readme](https://github.com/textualize/rich/blob/master/README.id.md) • [فارسی readme](https://github.com/textualize/rich/blob/master/README.fa.md) • [Türkçe readme](https://github.com/textualize/rich/blob/master/README.tr.md) Rich is a Python library for _rich_ text and beautiful formatting in the terminal. The [Rich API](https://rich.readthedocs.io/en/latest/) makes it easy to add color and style to terminal output. Rich can also render pretty tables, progress bars, markdown, syntax highlighted source code, tracebacks, and more — out of the box.  For a video introduction to Rich see [calmcode.io](https://calmcode.io/rich/introduction.html) by [@fishnets88](https://twitter.com/fishnets88). See what [people are saying about Rich](https://www.willmcgugan.com/blog/pages/post/rich-tweets/). ## Compatibility Rich works with Linux, OSX, and Windows. True color / emoji works with new Windows Terminal, classic terminal is limited to 16 colors. Rich requires Python 3.7 or later. Rich works with [Jupyter notebooks](https://jupyter.org/) with no additional configuration required. ## Installing Install with `pip` or your favorite PyPI package manager. ```sh python -m pip install rich ``` Run the following to test Rich output on your terminal: ```sh python -m rich ``` ## Rich Print To effortlessly add rich output to your application, you can import the [rich print](https://rich.readthedocs.io/en/latest/introduction.html#quick-start) method, which has the same signature as the builtin Python function. Try this: ```python from rich import print print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals()) ```  ## Rich REPL Rich can be installed in the Python REPL, so that any data structures will be pretty printed and highlighted. ```python >>> from rich import pretty >>> pretty.install() ```  ## Using the Console For more control over rich terminal content, import and construct a [Console](https://rich.readthedocs.io/en/latest/reference/console.html#rich.console.Console) object. ```python from rich.console import Console console = Console() ``` The Console object has a `print` method which has an intentionally similar interface to the builtin `print` function. Here's an example of use: ```python console.print("Hello", "World!") ``` As you might expect, this will print `"Hello World!"` to the terminal. Note that unlike the builtin `print` function, Rich will word-wrap your text to fit within the terminal width. There are a few ways of adding color and style to your output. You can set a style for the entire output by adding a `style` keyword argument. Here's an example: ```python console.print("Hello", "World!", style="bold red") ``` The output will be something like the following:  That's fine for styling a line of text at a time. For more finely grained styling, Rich renders a special markup which is similar in syntax to [bbcode](https://en.wikipedia.org/wiki/BBCode). Here's an example: ```python console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].") ```  You can use a Console object to generate sophisticated output with minimal effort. See the [Console API](https://rich.readthedocs.io/en/latest/console.html) docs for details. ## Rich Inspect Rich has an [inspect](https://rich.readthedocs.io/en/latest/reference/init.html?highlight=inspect#rich.inspect) function which can produce a report on any Python object, such as class, instance, or builtin. ```python >>> my_list = ["foo", "bar"] >>> from rich import inspect >>> inspect(my_list, methods=True) ```  See the [inspect docs](https://rich.readthedocs.io/en/latest/reference/init.html#rich.inspect) for details. # Rich Library Rich contains a number of builtin _renderables_ you can use to create elegant output in your CLI and help you debug your code. Click the following headings for details: <details> <summary>Log</summary> The Console object has a `log()` method which has a similar interface to `print()`, but also renders a column for the current time and the file and line which made the call. By default Rich will do syntax highlighting for Python structures and for repr strings. If you log a collection (i.e. a dict or a list) Rich will pretty print it so that it fits in the available space. Here's an example of some of these features. ```python from rich.console import Console console = Console() test_data = [ {"jsonrpc": "2.0", "method": "sum", "params": [None, 1, 2, 4, False, True], "id": "1",}, {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]}, {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": "2"}, ] def test_log(): enabled = False context = { "foo": "bar", } movies = ["Deadpool", "Rise of the Skywalker"] console.log("Hello from", console, "!") console.log(test_data, log_locals=True) test_log() ``` The above produces the following output:  Note the `log_locals` argument, which outputs a table containing the local variables where the log method was called. The log method could be used for logging to the terminal for long running applications such as servers, but is also a very nice debugging aid. </details> <details> <summary>Logging Handler</summary> You can also use the builtin [Handler class](https://rich.readthedocs.io/en/latest/logging.html) to format and colorize output from Python's logging module. Here's an example of the output:  </details> <details> <summary>Emoji</summary> To insert an emoji in to console output place the name between two colons. Here's an example: ```python >>> console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:") 😃 🧛 💩 👍 🦝 ``` Please use this feature wisely. </details> <details> <summary>Tables</summary> Rich can render flexible [tables](https://rich.readthedocs.io/en/latest/tables.html) with unicode box characters. There is a large variety of formatting options for borders, styles, cell alignment etc.  The animation above was generated with [table_movie.py](https://github.com/textualize/rich/blob/master/examples/table_movie.py) in the examples directory. Here's a simpler table example: ```python from rich.console import Console from rich.table import Table console = Console() table = Table(show_header=True, header_style="bold magenta") table.add_column("Date", style="dim", width=12) table.add_column("Title") table.add_column("Production Budget", justify="right") table.add_column("Box Office", justify="right") table.add_row( "Dec 20, 2019", "Star Wars: The Rise of Skywalker", "$275,000,000", "$375,126,118" ) table.add_row( "May 25, 2018", "[red]Solo[/red]: A Star Wars Story", "$275,000,000", "$393,151,347", ) table.add_row( "Dec 15, 2017", "Star Wars Ep. VIII: The Last Jedi", "$262,000,000", "[bold]$1,332,539,889[/bold]", ) console.print(table) ``` This produces the following output:  Note that console markup is rendered in the same way as `print()` and `log()`. In fact, anything that is renderable by Rich may be included in the headers / rows (even other tables). The `Table` class is smart enough to resize columns to fit the available width of the terminal, wrapping text as required. Here's the same example, with the terminal made smaller than the table above:  </details> <details> <summary>Progress Bars</summary> Rich can render multiple flicker-free [progress](https://rich.readthedocs.io/en/latest/progress.html) bars to track long-running tasks. For basic usage, wrap any sequence in the `track` function and iterate over the result. Here's an example: ```python from rich.progress import track for step in track(range(100)): do_step(step) ``` It's not much harder to add multiple progress bars. Here's an example taken from the docs:  The columns may be configured to show any details you want. Built-in columns include percentage complete, file size, file speed, and time remaining. Here's another example showing a download in progress:  To try this out yourself, see [examples/downloader.py](https://github.com/textualize/rich/blob/master/examples/downloader.py) which can download multiple URLs simultaneously while displaying progress. </details> <details> <summary>Status</summary> For situations where it is hard to calculate progress, you can use the [status](https://rich.readthedocs.io/en/latest/reference/console.html#rich.console.Console.status) method which will display a 'spinner' animation and message. The animation won't prevent you from using the console as normal. Here's an example: ```python from time import sleep from rich.console import Console console = Console() tasks = [f"task {n}" for n in range(1, 11)] with console.status("[bold green]Working on tasks...") as status: while tasks: task = tasks.pop(0) sleep(1) console.log(f"{task} complete") ``` This generates the following output in the terminal.  The spinner animations were borrowed from [cli-spinners](https://www.npmjs.com/package/cli-spinners). You can select a spinner by specifying the `spinner` parameter. Run the following command to see the available values: ``` python -m rich.spinner ``` The above command generates the following output in the terminal:  </details> <details> <summary>Tree</summary> Rich can render a [tree](https://rich.readthedocs.io/en/latest/tree.html) with guide lines. A tree is ideal for displaying a file structure, or any other hierarchical data. The labels of the tree can be simple text or anything else Rich can render. Run the following for a demonstration: ``` python -m rich.tree ``` This generates the following output:  See the [tree.py](https://github.com/textualize/rich/blob/master/examples/tree.py) example for a script that displays a tree view of any directory, similar to the linux `tree` command. </details> <details> <summary>Columns</summary> Rich can render content in neat [columns](https://rich.readthedocs.io/en/latest/columns.html) with equal or optimal width. Here's a very basic clone of the (MacOS / Linux) `ls` command which displays a directory listing in columns: ```python import os import sys from rich import print from rich.columns import Columns directory = os.listdir(sys.argv[1]) print(Columns(directory)) ``` The following screenshot is the output from the [columns example](https://github.com/textualize/rich/blob/master/examples/columns.py) which displays data pulled from an API in columns:  </details> <details> <summary>Markdown</summary> Rich can render [markdown](https://rich.readthedocs.io/en/latest/markdown.html) and does a reasonable job of translating the formatting to the terminal. To render markdown import the `Markdown` class and construct it with a string containing markdown code. Then print it to the console. Here's an example: ```python from rich.console import Console from rich.markdown import Markdown console = Console() with open("README.md") as readme: markdown = Markdown(readme.read()) console.print(markdown) ``` This will produce output something like the following:  </details> <details> <summary>Syntax Highlighting</summary> Rich uses the [pygments](https://pygments.org/) library to implement [syntax highlighting](https://rich.readthedocs.io/en/latest/syntax.html). Usage is similar to rendering markdown; construct a `Syntax` object and print it to the console. Here's an example: ```python from rich.console import Console from rich.syntax import Syntax my_code = ''' def iter_first_last(values: Iterable[T]) -> Iterable[Tuple[bool, bool, T]]: """Iterate and generate a tuple with a flag for first and last value.""" iter_values = iter(values) try: previous_value = next(iter_values) except StopIteration: return first = True for value in iter_values: yield first, False, previous_value first = False previous_value = value yield first, True, previous_value ''' syntax = Syntax(my_code, "python", theme="monokai", line_numbers=True) console = Console() console.print(syntax) ``` This will produce the following output:  </details> <details> <summary>Tracebacks</summary> Rich can render [beautiful tracebacks](https://rich.readthedocs.io/en/latest/traceback.html) which are easier to read and show more code than standard Python tracebacks. You can set Rich as the default traceback handler so all uncaught exceptions will be rendered by Rich. Here's what it looks like on OSX (similar on Linux):  </details> All Rich renderables make use of the [Console Protocol](https://rich.readthedocs.io/en/latest/protocol.html), which you can also use to implement your own Rich content. # Rich CLI See also [Rich CLI](https://github.com/textualize/rich-cli) for a command line application powered by Rich. Syntax highlight code, render markdown, display CSVs in tables, and more, directly from the command prompt.  # Textual See also Rich's sister project, [Textual](https://github.com/Textualize/textual), which you can use to build sophisticated User Interfaces in the terminal.  # Projects using Rich For some examples of projects using Rich, see the [Rich Gallery](https://www.textualize.io/rich/gallery) on [Textualize.io](https://www.textualize.io). Would you like to add your own project to the gallery? You can! Follow [these instructions](https://www.textualize.io/gallery-instructions). <!-- This is a test, no need to translate -->

✏︎ Curated list about digital typography 🔥

# Awesome Typography [](https://awesome.re) Curated list about digital typography. ## Contents - [Specifications](#specifications) - [OpenType](#opentype) - [JavaScript](#javascript) - [Python](#python) - [C](#c) - [C++](#c-1) - [C#](#c-2) - [Java](#java) - [Ruby](#ruby) - [Go](#go) - [Rust](#rust) - [PHP](#php) - [Perl](#perl) - [Processing](#processing) - [Clojure](#clojure) - [UFO](#ufo) - [Tools with GUI](#tools-with-gui) - [Font Validator](#font-validator) - [Font Testing Websites](#font-testing-websites) - [Miscellaneous](#miscellaneous) - [Fonts](#fonts) - [TrueType](#truetype) - [Books](#books) - [Videos](#videos) ## Specifications - [Microsoft's Documentation](https://docs.microsoft.com/en-us/typography/opentype/spec/) - [Apple's Documentation](https://developer.apple.com/fonts/TrueType-Reference-Manual/) - [The Compact Font Format Specification](https://adobe-type-tools.github.io/font-tech-notes/pdfs/5176.CFF.pdf) - Technical Note #5176. - [the-cff-table](https://github.com/Pomax/the-cff-table) - Markdown conversion of the Adobe Tech notes 5176 and 5177 about CFF. - [Adobe's Documentation](https://www.adobe.com/devnet/font.html) ## OpenType - [OpenType: let's learn how modern fonts actually work](https://pomax.github.io/#gh-weblog-1449777175633) - [The OpenType Cookbook](http://opentypecookbook.com) - Introduction to OpenType features for type designers. [(Source)](https://github.com/typesupply/opentype-feature-intro). - [A bit of font generation](https://pomax.github.io/CFF-glyphlet-fonts/) - Brief excursion into OpenType. ## JavaScript - [OpenType.js](https://github.com/nodebox/opentype.js) - Read and write OpenType fonts. - [opentype-layout](https://github.com/Jam3/opentype-layout) - Experimental word-wrapping and layout for OpenType.js. - [canvas-text-opentypejs-shim](https://github.com/shyiko/canvas-text-opentypejs-shim) - Consistent text rendering for <canvas> (backed by OpenType.js). - [CharacterMap](https://github.com/bluejamesbond/CharacterMap/) - Online Character Map / Glyph / Icon / Font Viewer. - [font](https://www.npmjs.com/package/font) - Parse OTF/TTF file format directory from buffers for metadata. - [fontkit](https://github.com/foliojs/fontkit) - Advanced font engine for Node and the browser. - [Minimal-font-generator](https://github.com/Pomax/Minimal-font-generator) - Font's Hello world. - [simple-cff-builder](https://github.com/Pomax/simple-cff-builder) - Simple CFF builder for testing fonts with different Type2 charstrings. - [ttf2woff2](https://github.com/nfroidure/ttf2woff2/) - Convert TTF files to WOFF2. - [ttf2woff](https://github.com/fontello/ttf2woff) - Convert TTF to WOFF, for Node.js. - [sfnt2woff](https://github.com/laoshu133/sfnt2woff) - Convert TTF or OTF to WOFF, support Node.js and Browsers. - [ttf2eot](https://github.com/fontello/ttf2eot) - Convert TTF to EOT for Node.js. - [cubic2quad](https://github.com/fontello/cubic2quad) - Aproximates cubic bezier curves with quadratic ones. - [SVG font creator](https://github.com/fontello/svg-font-create) - Create SVG font from separate images. - [node-sfnt](https://github.com/be5invis/node-sfnt) - SFNT parser and generator for Node.js. - [node-unicode-data](https://github.com/mathiasbynens/node-unicode-data) - JavaScript-compatible Unicode data generator. - [fontwr](https://github.com/raphaklaus/fontwr) - Font manager for web projects. - [Open Type playground](https://github.com/magalhini/open-type-playground) - Playground for Open Type experiments with CSS. - [ChromaCheck](https://github.com/RoelN/ChromaCheck) - Feature test for color font support in browsers. - [Font Face Observer](https://github.com/bramstein/fontfaceobserver) - Font load events, simple, small and efficient [fontfaceobserver.com](https://fontfaceobserver.com). - [Web Font Loader](https://github.com/typekit/webfontloader) - Web Font Loader gives you added control when using linked fonts via @font-face. - [localFont](https://github.com/jaicab/localFont) - Implement localStorage web font caching in seconds. - [Fontello](https://github.com/fontello/fontello) - This tool lets you combine icon webfonts for your own project. - [GitHub Font Preview](https://github.com/Mottie/GitHub-userscripts/wiki/GitHub-font-preview) - Adds a preview for fonts & glyphs on GitHub with OpenType.js. - [unidata](https://github.com/chbrown/unidata) - Unicode Character Database for JavaScript. - [UCD](https://github.com/ynakajima/ucd) - Unicode Character Database for JavaScript. - [Character Set Inspector](https://github.com/graphicore/charset-inspector) - Unicode Character Database for JavaScript. - [OpenType](https://github.com/bramstein/opentype) - OpenType font parser in JavaScript. - [opentype-geometry](https://github.com/nascherman/opentype-geometry) - Convert Text from OpenType font to three.js 3D. - [Plumin.js](https://github.com/byte-foundry/plumin.js) - Create and manipulate fonts in the browser. - [Typr.js](https://github.com/photopea/Typr.js) - Process fonts in JavaScript. - [fonteditor-core](https://github.com/kekee000/fonteditor-core) - Read, write, transform fonts in JavaScript. - [fontmin](https://github.com/ecomfe/fontmin) - Minify font seamlessly. - [fontfacegen](https://github.com/agentk/fontfacegen) - Browser font-face generator for creating browser usable fonts from TTF's or OTF's. - [NType](https://github.com/kevinzweerink/ntype) - 4D Type Extruder. - [node-emoji](https://github.com/omnidan/node-emoji) - 😏 simple emoji support for Node.js projects. - [custom-fonts-in-emails](https://github.com/ladjs/custom-fonts-in-emails) - Extremely easy way to use custom fonts in emails without having to use art software. - [Google Fonts Infos](https://github.com/thisarmy/fontsinfo) - Extract info out of the Google Fonts archive. - [Hyphenopoly.js](https://github.com/mnater/Hyphenopoly) - JavaScript polyfill for client-side hyphenation. - [Hyphenator.js](https://github.com/mnater/Hyphenator) - JavaScript that implements client-side hyphenation of HTML-Documents. - [Hypher](https://github.com/bramstein/hypher) - Fast and small JavaScript hyphenation engine. - [Typeset.js](https://github.com/davidmerfield/Typeset) - HTML pre-processor for web typography (hanging punctuation, soft hyphen insertion, optical margin outdents, small-caps conversion and punctuation substitution). - [Typeset](https://github.com/bramstein/typeset) - TeX line breaking algorithm in JavaScript. - [otfcc-cubic2quad](https://github.com/caryll/otfcc-cubic2quad) - Losslessly turn CFF OTF to TTF using otfcc. - [caryll / shapeops](https://github.com/caryll/shapeops) - Boolean operations and overlap removal for curves. - [OpenType-SVG Workshop](https://github.com/rocallahan/svg-opentype-workshop) - OpenType-SVG Workshop Web application. - [A-binary-parser-generator](https://github.com/Pomax/A-binary-parser-generator) - This project aims to create a tool that can turn a spec file into a parser skeleton for binary data files such as OpenType fonts, PNG images, etc. - [font-spider](https://github.com/aui/font-spider) - Smart webfont compression and format conversion tool. - [Brotli.js](https://github.com/foliojs/brotli.js) A JavaScript port of the Brotli compression algorithm, as used in WOFF2. - [ideohint](https://github.com/caryll/ideohint) - Optimized hinter for Ideographs. - [subfont](https://github.com/Munter/subfont) - Command line tool to inject Google font subsets used glyphs into your page. - [webfont](https://github.com/itgalaxy/webfont) - Awesome generator of webfont, WOFF2, WOFF, EOT, TTF and SVG. - [grapheme-splitter](https://github.com/orling/grapheme-splitter) - JavaScipt library that breaks strings into their individual user-perceived characters. - [unicode-properties](https://github.com/foliojs/unicode-properties) - Provides fast access to unicode character properties. - [unicode-tr51-emoji](https://github.com/cameronhunter/unicode-tr51-emoji) - Emoji data extracted from Unicode Technical Report #51 v1.0 – v5.0. - [fontblast](https://github.com/eugene1g/font-blast) - Give me an icon-font, and I'll create individual SVG/PNG files for all icons in it. - [fontplop](https://github.com/matthewgonzalez/fontplop) - Fast, Simple, & Free Open Source Webfont Converter. - [svgfont2svgicons](https://github.com/nfroidure/svgfont2svgicons) - Extract SVG icons from an SVG font. - [glyphhanger](https://github.com/filamentgroup/glyphhanger) - Your web font utility belt. It shows what unicode-ranges are used on a web site (optionally for a font-family or for each font-family). It can also subset web fonts. - [Punycode.js](https://github.com/bestiejs/punycode.js) - Robust Punycode converter that fully complies to RFC 3492 and RFC 5891. - [code-point-at](https://github.com/sindresorhus/code-point-at) - ES2015 String#codePointAt() ponyfill. - [Typefont](https://github.com/vasile-peste/Typefont) - First open-source library that detects the font of a text in a image. - [node-fonttools](https://github.com/dfrankland/node-fonttools) - Native bindings to fonttools to decompile and compile fonts. - [font-toolkit](https://github.com/hsiaosiyuan0/fonts) - Font file manipulating in TypeScript. - [variableFont.js](https://github.com/Monotype/variableFont.js) - Handles variable fonts through OpenType.js ## Python - [fontTools](https://github.com/fonttools/fonttools) - Library for manipulating fonts, written in Python. - [fontmake](https://github.com/googlei18n/fontmake) - Compile fonts from sources (UFO, Glyphs) to binary (OpenType, TrueType). - [FontReport](https://github.com/googlei18n/fontreport) - Tool to create PDF files containing glyph images and information about a font. - [fontdiff](https://github.com/googlei18n/fontdiff) - Tool for finding visual differences between two font versions. - [kern-dump](https://github.com/adobe-type-tools/kern-dump) - Scripts for working with and analyzing kerning information (ATypI 2013). - [cu2qu](https://github.com/googlei18n/cu2qu) - Cubic-to-quadratic bezier curve conversion. - [Font Bakery](https://github.com/googlefonts/fontbakery) - Tools to prepare font families for inclusion in github.com/google/fonts. - [glyphNameFormatter](https://github.com/LettError/glyphNameFormatter) - Generate list of glyphnames from unicode names. - [woffTools](https://github.com/typesupply/woffTools) - Library for working with WOFF files. - [pyftfeatfreeze](https://github.com/twardoch/fonttools-utils/tree/master/pyftfeatfreeze) - With pyftfeatfreeze, you can “freeze” some OpenType features into a font. - [RoboFab](https://github.com/robofab-developers/robofab) - Library with objects that deal with data usually associated with fonts and type design. - [pyfontaine](https://github.com/davelab6/pyfontaine) - Python tool to check font files for language/character set support. - [Glyph Nanny](https://github.com/typesupply/glyph-nanny) - Live report about potential drawing issues in your glyph. - [Kernagic](https://github.com/hodefoting/kernagic) - Semi-automatic font spacing tool. - [Huerta Tipográfica Letterspacer](https://github.com/huertatipografica/HTLetterspacer) - HT Letterspacer is a tool for spacing fonts. - [OpenType-SVG Tools](https://github.com/adobe-type-tools/opentype-svg) - Tools and sample files for making OpenType-SVG fonts. - [boxDrawing.py](https://github.com/adobe-type-tools/box-drawing) - Python script to draw all the box drawing characters and block elements based on parameters. - [scfbuild](https://github.com/eosrei/scfbuild/) - Create OpenType-SVG color fonts from a set of SVG source files. - [color-emoji](https://github.com/googlei18n/color-emoji) - Tool to build color fonts using Google color-font format (CBDT/CBLC). - [monospacifier.py](https://github.com/cpitclaudel/monospacifier) - Convert variable-pitch fonts to monospace (useful for unicode and indentation-friendly programming). - [edf825/SVG-OpenType-Utils](https://github.com/edf825/SVG-OpenType-Utils) - SVG in OpenType Utils (!Old: 2013). - [Icon Font to PNG](https://github.com/Pythonity/icon-font-to-png) - Python script (and library) for exporting icons from icon fonts (e.g. Font Awesome, Octicons) as PNG images. - [Compositor](https://github.com/typesupply/compositor) - Basic OpenType GSUB and GPOS layout engine. - [UFO Extractor](https://github.com/typesupply/extractor) - Tools for extracting data from font binaries into UFO objects. - [Noto Tools](https://github.com/googlei18n/nototools) - Noto fonts support tools and scripts. - [compreffor](https://github.com/googlei18n/compreffor) - CFF table subroutinizer for FontTools. - [font-line](https://github.com/source-foundry/font-line) - OpenType vertical metrics reporting and font line spacing adjustment tool. - [Flat](https://xxyxyz.org/flat/) - Library for creating and manipulating digital forms of fine arts. - [PageBot](https://github.com/typenetwork/pagebot) - Scripted page layout program, as application inside Drawbot generating high quality typographic documents that support high quality fonts. ## C - [otfcc](https://github.com/caryll/otfcc) - Parses & writes SFNT structures. - [AFDKO](https://github.com/adobe-type-tools/afdko) - Adobe Font Development Kit for OpenType. See [AFDKO Overview](https://www.adobe.com/devnet/opentype/afdko/topic_overview.html). - [stb_truetype](https://github.com/nothings/stb/) - Parse, decode, and rasterize characters for TrueType fonts. Single header file. - [FreeType](https://www.freetype.org) - Freely available software library to render fonts. - [Raqm](https://github.com/HOST-Oman/libraqm) - Library for complex text layout. - [SheenFigure](https://github.com/mta452/SheenFigure) - Implementation of advanced typographic tables of OpenType specification. - [SheenBidi](https://github.com/mta452/SheenBidi) - SheenBidi is the world's most sophisticated implementation of latest unicode bidirectional algorithm. - [freetype-gl](https://github.com/rougier/freetype-gl) - OpenGL text using one vertex buffer, one texture and FreeType. - [WOFF](https://github.com/samboy/WOFF) - WOFF conversion reference code. ## C++ - [font to svg](https://github.com/donbright/font_to_svg) - Render characters from font files into an SVG path. - [LCDF Typetools](https://github.com/kohler/lcdf-typetools) - Utilities for manipulating OpenType, PostScript Type 1, and Multiple Master fonts. - [HarfBuzz](https://github.com/googlei18n/harfbuzz) - HarfBuzz OpenType text shaping engine. - [FontView](https://github.com/googlei18n/fontview) - Demo app that displays fonts with a free/libre/open-source text rendering stack: FreeType, HarfBuzz and Raqm. - [Text rendering tests](https://github.com/unicode-org/text-rendering-tests) - Test suite for text rendering. - [FTGLES](https://github.com/cdave1/ftgles) - TrueType font rendering library for OpenGL ES on iOS devices (iPad and iPhone). - [TTFPatch](https://github.com/rmuch/ttfpatch) - Mirror of TTFPATCH by Wolfram Esser, modified to support fonts conforming to newer OTF specifications, built for modern versions of Windows. - [stb-truetype-opengl-examples](https://github.com/0xc0dec/demos) - Examples of TrueType font rendering in C++11 using stb_truetype library and OpenGL 3+. - [WOFF2](https://github.com/google/woff2) ## C# - [NRasterizer](https://github.com/vidstige/NRasterizer) - Simple and clean TrueType font renderer written purely in c#. - [Typography](https://github.com/LayoutFarm/Typography) - C# Font Reader (TrueType / OpenType / OpenFont), Glyphs Layout and Rendering. - [SixLabors.Fonts](https://github.com/SixLabors/Fonts) - Font loading and drawing library. - [SharpFont](https://github.com/MikePopoloski/SharpFont) - Pure managed TTF / OTF reader and renderer. ## Java - [sfntly](https://github.com/googlei18n/sfntly) - Library for Using, Editing, and Creating SFNT-based Fonts. - [Emoji-Tools](https://github.com/EmojiTools/Emoji-Tools) - Multiple useful tools to help Android and iOS/OSX developers with creating and modifying Emoji Font files. - [Tehreer-Android](https://github.com/mta452/Tehreer-Android) - Library that gives full control over text related technologies such as bidirectional algorithm, open type shaping engine, text typesetting and text rendering. ## Ruby - [emoji-extractor](https://github.com/tmm1/emoji-extractor) - Extracts high-resolution emoji pngs from Apple Color Emoji.ttf. - [font](https://github.com/alyssais/font) - Command-line font manager. ## Go - [font](https://github.com/ConradIrwin/font) - Parsing OpenType fonts in Golang. - [freetype](https://github.com/golang/freetype) - Freetype font rasterizer in Go. ## Rust - [font-rs](https://github.com/google/font-rs) - The fastest font renderer in the world. - [font-kit](https://github.com/servo/font-kit) - A cross-platform font loading library. - [RustType](https://github.com/redox-os/rusttype) - Pure Rust alternative to libraries like FreeType. - [Pathfinder](https://github.com/pcwalton/pathfinder) - Fast, practical GPU rasterizer for OpenType fonts. - [Font toolbox](https://github.com/bodoni/font) - [Parser for OpenType fonts](https://github.com/bodoni/opentype) - [Parser for PostScript fonts](https://github.com/bodoni/postscript) - [Parser for TrueType fonts](https://github.com/bodoni/truetype) - [freetype-rs](https://github.com/PistonDevelopers/freetype-rs) - Rust bindings for FreeType library. - [freetype-sys](https://github.com/PistonDevelopers/freetype-sys) - Low level bindings for the FreeType font library. - [truetype](https://github.com/PistonDevelopers/truetype) - Library for reading fonts from the TrueType format. ## PHP - [PHP Font Lib](https://github.com/PhenX/php-font-lib) - Library to read, parse, export and make subsets of different types of font files. - [JoliTypo](https://github.com/jolicode/JoliTypo) - Microtypography fixer for the web. - [PHP SmartyPants](https://github.com/michelf/php-smartypants) - SmartyPants is a free web typography prettifyier tool for web writers. It easily translates plain ASCII punctuation characters into "smart" typographic punctuation HTML entities. ## Perl - [Font::TTFMetrics](https://metacpan.org/release/Font-TTFMetrics) - Fast & easy-to-use parser for true-type font (TTF) file. ## Processing - [Fontastic](https://github.com/andreaskoller/Fontastic) - Processing library to create TrueType font files. ## Clojure - [opentype.clj](https://github.com/ivarref/opentype.clj) - A simple API over OpenType.js for Clojure. Runs on the JVM. ## UFO [unifiedfontobject.org](http://unifiedfontobject.org) - [ufo-spec](https://github.com/unified-font-object/ufo-spec) - The official Unified Font Object specification source files. - [ufoLib](https://github.com/unified-font-object/ufoLib) - Low-level UFO reader and writer. - [ufoNormalizer](https://github.com/unified-font-object/ufoNormalizer) - Tool that will normalize the XML and other data inside of a UFO. - [ufo2ft](https://github.com/googlei18n/ufo2ft) - UFO to FontTools. - [ufoJS](https://github.com/graphicore/ufoJS) - JavaScript API for the Unified Font Object. ## Tools with GUI ### Non-Free - [Fontself](https://www.fontself.com) Adobe Illustrator & Photoshop extensions for creating vector and bitmap fonts by Drag&Drop. Make fonts the easy way! - [Robofont](http://doc.robofont.com) - UFO based (Mac only). - [Glyphs](https://glyphsapp.com) - Font editor (Mac only). - [Prototypo](https://github.com/byte-foundry/prototypo) - Web based font generator with a parametric approach. - [FontLab Studio](https://www.fontlab.com/font-editor/fontlab-studio/) - Font editor for font professionals. Version 5 for Mac and Windows. - [DTL OTMaster](https://www.fontmaster.nl) - Highly sophisticated application for reviewing, editing and altering tables and contours of fonts with a snft file structure, as there are CFF and TTF flavored OpenType fonts, TrueType fonts and TrueType Collection fonts. - [010 Editor](http://www.sweetscape.com/010editor/) - Professional text and hex editing with Binary Templates technology. [OpenType template](http://pikensoft.com/programs/OpenTypeTemplate.bt). - [Synalyze It!](https://www.synalysis.net) - Reverse Engineering and Binary File Analysis made easy. [OpenType template](https://www.synalysis.net/Grammars/opentype.grammar). - [TransType 4](https://www.fontlab.com/font-converter/transtype/) - Universal font converter. ### Free - [FontForge](https://github.com/fontforge/fontforge) - Free (libre) font editor for Windows, Mac OS X and GNU+Linux. - [TruFont](https://github.com/trufont/trufont) - UFO3 font editor. À l’ancienne. - [Metapolator](https://github.com/metapolator) - Web-based GUI for creating UFO and Metafont fonts. - [Birdfont](https://github.com/johanmattssonm/birdfont) - Font editor which can generate fonts in TTF, EOT, SVG and BF format. - [Glyphr Studio](https://twitter.com/glyphrstudio) - Free, web-based font editor, focusing on font design hobbyists. - [DTL OTMaster Light](https://www.fontmaster.nl/#light) - In the Light editions of dtl OTMaster only the saving of files is disabled. Checking fonts and exporting OpenType Layout features files, be and ik formats, and Character Layout (.cha) files is possible though. - [fonteditor](https://github.com/ecomfe/fonteditor) - Web-based TTF font editor, live at [fontstore.baidu.com](http://fontstore.baidu.com/static/editor/index-en.html). - [FontArk](https://fontark.net/farkwp/) FontArk is an innovative browser-based font editor, font creator (BETA), featuring the most versatile real-time multiple glyph editing system. - [TTFEdit](https://sourceforge.net/projects/ttfedit/) - TrueType fonts editor. Allows for editing vector-based glyphs. - [OpenType-SVG-Font-Editor](https://github.com/Microsoft/OpenType-SVG-Font-Editor). - [SdfFontDesigner](https://github.com/aiekick/SdfFontDesigner) - A generator of bitmap font, based on ttf & otf, rendered with custom shaders in glsl ## Font Validator - [Font Validator](https://github.com/HinTak/Font-Validator) - Font Validator is a tool for testing fonts prior to release. See [Install post for Mac](http://typedrawers.com/discussion/comment/16090/#Comment_16090). - [OpenType Sanitiser](https://github.com/khaledhosny/ots) - The OpenType Sanitiser (OTS) parses and serialises OpenType files (OTF, TTF) and WOFF and WOFF2 font files, validating them and sanitising them as it goes. - [WOFF Validator](http://validator.fontbureau.com) - Online WOFF Validator. ## Font Testing Websites - [Axis-Praxis](https://www.axis-praxis.org/) - Axis-Praxis is a website for playing with OpenType variable fonts in modern browsers. - [Bulletproof Font Tester](https://bulletproof.italic.space/) - Test your local or remote fonts with the proofing tool developed by a type designer, for type designers. Check out kerning, OpenType features, and language coverage. Explore and animate variation axes in variable fonts. - [Cyreal.org Font Testing Page](http://www.cyreal.org/Font-Testing-Page/) - The Font Testing Page is a tool primarily intended for type designers to 'Drag and Drop' and quickly test their fonts into a browser (active fork of Impallari's testing page). - [Font Gauntlet](https://fontgauntlet.com) - The Dinamo Font Gauntlet is a tool for proofing, generating and animating fonts. - [Wakamai Fondue](https://wakamaifondue.com/) - The tool that answers the question “what can my font do?” - [TypeNetwork TypeTools](https://typetools.typenetwork.com/) - Layout tools for exerimenting with variable fonts in various ways. ## Miscellaneous - [TypeDrawers](http://typedrawers.com) - Discussion forum for professionals and enthusiasts in the fields of typeface design, lettering, and typography. - [Font Squirrel Webfont Generator](https://www.fontsquirrel.com/tools/webfont-generator) - Upload OTF or TTF fonts, receive webfonts. - [The State of Web Type](https://github.com/bramstein/stateofwebtype) - "Can I Use" for typography. - [UseModify](https://usemodify.com) - Open Source typefaces. - [ofont](https://github.com/raphaelbastide/ofont) - Web interface for font collections (used by usemodify.com) - [Git for Type Designers](https://github.com/frankrolf/git-for-type-designers) - [designwithfontforge.com](https://github.com/fontforge/designwithfontforge.com) - Book about how to design new typefaces with FontForge. See [designwithfontforge.com](http://designwithfontforge.com). - [FontTesting Page](https://github.com/impallari/Font-Testing-Page) - Webpage for testing typefaces. - [CSS Utility OpenType](https://github.com/kennethormandy/utility-opentype) - Simple, CSS utility classes for advanced typographic features. See it [here](http://utility-opentype.kennethormandy.com). - [Alfred Special Characters](https://github.com/typefacts/alfred-special-characters) - Typefacts Special Characters Workflow for Alfred 3. - [Typomanie.fr Ressources](http://typomanie.fr/ressources/) - [Drawing good paths Tutorial](https://glyphsapp.com/tutorials/drawing-good-paths) - Badly drawn outlines can cause headache. Your letters may look mangled or not appear at all. You can avoid these difficulties if you keep a few basic rules in mind. - [Deep Into OpenType Features](http://blog.ricardofilipe.com/post/deep-into-opentype-features) - What are OpenType features? - [The A-Z of typographic terms](https://www.fontsmith.com/blog/2016/06/29/the-a-z-of-typographic-terms) - Typography terms in images. - [Emoj](https://github.com/sindresorhus/emoj) - Find relevant emoji from text on the command-line 😮 ✨ 🙌 🐴 💥 🙈. - [Emoji Wrap Monthly Newsletter](http://emojiwrap.com) - Bite-sized summary of what's happening in the world of emoji and Unicode. - [Crypto Puzzles](https://github.com/2d4d/crypto_puzzles) - Functions for encryption and stegonagraphy as puzzles or brain teasers. [Online demo](http://rupp.de/crypto_puzzles/crypto_puzzles_web.py). - [FDBP](http://silnrsi.github.io/FDBP/) - Font Development Best Practice documentation. - [UnicodeChecker](http://earthlingsoft.net/UnicodeChecker/) - Explore and convert Unicode. - [unicodes](https://github.com/jessetane/unicodes) - Browse all of the unicodes. - [Method of Action](http://method.ac) - Method of Action is a collection of tools, games and articles to help you learn design. - [Encodings and character sets for Programmers](http://kunststube.net/encoding/) - What every programmer absolutely, positively needs to know about encodings and character sets to work with text. - [Kernall](https://github.com/n8willis/kernall) - Kerning and letterspacing research. - [Type Facet](https://github.com/charlesmchen/typefacet) - Collection of Python scripts for working with fonts. See [TypeFacet Autokern](http://charlesmchen.github.io/typefacet/topics/autokern/index.html) - [OpenType feature reference](https://github.com/opensource-opentype/features) - Documentation and other info about advanced font features - [Typography Supply](http://typography.supply) An inventory of typographic tools. - [OpenType Feature Bundle](https://github.com/brew/opentype-feature-bundle) - Syntax highlighting and snippets for OpenType feature development in TextMate/Sublime Text. - [Type Tools dotfiles](https://github.com/benkiel/dotfiles) - Setup for type tools. - [AGL & AGLFN](https://github.com/adobe-type-tools/agl-aglfn) - AGL / AGLFN (Adobe Glyph List / For New Fonts) simply provides mappings from glyph names to Unicode scalar values. [See specification](https://github.com/adobe-type-tools/agl-specification). - [The Terrible Secret of OpenType Glyph Substitution](http://ansuz.sooke.bc.ca/entry/131) - [I Can Variable Font](https://github.com/scribbletone/i-can-variable-font) - Tips for making variable fonts. - [You, Me And The Emoji: Character Sets, Encoding And Emoji](https://www.smashingmagazine.com/2016/11/character-sets-encoding-emoji/) - [Emoji Rolodex](https://www.emojicopy.com/#emojicodes) - Resourceful links to emoji-related sites, plug-ins, and apps. - [OpenType_Table_Source](https://github.com/Monotype/OpenType_Table_Source) - Documentation for Monotype's OpenType Layout Source File Format. - [jenskutilek/TypoLabs2016](https://github.com/jenskutilek/TypoLabs2016) - Code examples from Jens Kutilek's TypoLabs workshop. - [W3C - Fonts on the Web](https://www.w3.org/Fonts/) - Fonts on the Web. - [W3C - WebFonts Working Group](https://www.w3.org/Fonts/WG/) - [Twitter Emoji (Twemoji)](https://github.com/twitter/twemoji) - The Twemoji library offers support for +2k emojis, including skin tone and gender modifiers. - [EmojiOne](https://github.com/emojione/emojione) - EmojiOne™ is the open emoji standard. - [No @font-face Syntax will ever be Bulletproof, Nor Should It Be](https://calendar.perfplanet.com/2016/no-font-face-bulletproof-syntax/) - [Typography is impossible](https://medium.engineering/typography-is-impossible-5872b0c7f891) - The practical guide to why laying out type never quite does what you want. - [JavaScript has a Unicode problem](https://mathiasbynens.be/notes/javascript-unicode) - The way JavaScript handles Unicode is… surprising, to say the least. - [homebrew-webfonttools](https://github.com/bramstein/homebrew-webfonttools) - Homebrew formulae for font tools. - [Font Falsehoods](https://github.com/RoelN/Font-Falsehoods) - Falsehoods programmers believe about fonts. - [Letterpress Digest](http://letterpressdigest.com) - The new podcast about letterpress. - [fontspeed](https://www.fontspeed.io) - Newsletter on font loading by @zachleat. - [Font-Awesome-SVG-PNG](https://github.com/encharm/Font-Awesome-SVG-PNG) - Font Awesome split to individual SVG and PNG files of different sizes along with Node.js based generator. ## Fonts - [The Gilbert Font](https://github.com/Fontself/TypeWithPride) - OpenType-SVG font named after Gilbert Baker, the creator of the rainbow flag. - [Nanofont](https://github.com/bramstein/nanofont) - Nano font for testing font format support (TrueType, WOFF, WOFF2). - [FiraSystemFontReplacement](https://github.com/jenskutilek/FiraSystemFontReplacement) - Modified version of the Fira Sans fonts to replace the default system font on Mac OS X 10.10 and 10.11. - [SansBullshitSans Font](https://github.com/RoelN/SansBullshitSans) - Every buzzword will be replaced by a Comic Sans-styled censorship bar. - [Blackout](https://github.com/RoelN/Blackout) - One font to blackout them all. - [Compyx](https://github.com/RoelN/Compyx) - 8-bit Multicolor OpenType font. - [LapisLegit](https://github.com/RoelN/LapisLegit) - OpenType-SVG testfont. - [AIFont](https://github.com/Denly/AIFont) - The fist Chinese font that generated artificial intelligent. - [Noto Fonts](https://github.com/googlei18n/noto-fonts) - Noto’s goal is to provide a beautiful reading experience for all languages. - [Noto Emoji](https://github.com/googlei18n/noto-emoji) - Color and Black-and-White Noto emoji fonts, and tools for working with them. - [EmojiOne COLR/CPAL](https://github.com/mozilla/twemoji-colr) - EmojiOne font in COLR/CPAL layered format. - [EmojiOne OpenType-SVG](https://github.com/eosrei/emojione-color-font) - Color emoji OpenType-SVG font using EmojiOne Unicode 9.0 emoji with diversity and country flags. - [Twitter Color Emoji Font](https://github.com/eosrei/twemoji-color-font) - Color emoji OpenType-SVG font using Twitter Unicode 9.0 emoji with diversity and country flags. - [Bixa Color](https://bixacolor.com) - Building Bixa Color, a color font for the web [pixelambacht.nl/2016/building-bixa-color/](https://pixelambacht.nl/2016/building-bixa-color/). - [fontwr-fonts](https://github.com/raphaklaus/fontwr-fonts) - Fonts repository for fontwr. - [Bungee](https://github.com/djrrb/Bungee/) - Chromatic signage typeface for vertical and horizontal setting. - [Aerial Bold](http://type.aerial-bold.com/tw/) Aerial Bold is the first map and typeface of the earth. - [wavefont](https://github.com/audio-lab/wavefont) Typeface for rendering data: waveforms, spectrums, diagrams, bars etc. - [Adobe Variable Font Prototype](https://github.com/adobe-fonts/adobe-variable-font-prototype) - Variable font example in OpenType-CFF2 & TrueType formats. - [Microsoft open source fonts](https://github.com/Microsoft/fonts) - Central location to share Microsoft's open source fonts. - [Reinebow](https://github.com/xerographer/reinebow-color-font) - OpenType-SVG color font. - [Freizer](https://github.com/xerographer/freizer-color-font) - OpenType-SVG color font. - [Multicoloure](https://github.com/xerographer/multicoloure-font) - OpenType-SVG color font based on Multicolore Vector Typeface. - [null-ttf](https://github.com/grzegorzrolek/null-ttf) - This font is null. It's the smallest possible TrueType binary still valid on OS X and with most of its bytes wiped out. - [Monotype Variable Font Demo](https://github.com/Monotype/Monotype_prototype_variable_fonts) - [CFF opcode test fonts](https://github.com/Pomax/cff-opcode-fonts) - OTF fonts for testing CFF opcode support. - [TestFont](https://github.com/OpenType/TestFont) - Font family for testing OpenType implementations. - [BuffaloGals](https://github.com/TrueTyper/BuffaloGals) - Buffalo Gals is one of the very first “Variable Fonts”, originally made in 1992 for an Apple TrueType GX developer CD. - [Adobe Fonts / Source Emoji](https://github.com/adobe-fonts/source-emoji) - Source Emoji is an emoji font project that began development in order to provide monochrome representative glyphs to the Unicode Consortium for emoji candidates that have been accepted by the UTC (Unicode Technical Committee) but have not yet been fully ratified to become a part of the official standard. - [Hasklig](https://github.com/i-tu/Hasklig) - Code font with monospaced ligatures. - [Firefox OS Emojis](https://github.com/mozilla/fxemoji) - Emoji set from Mozilla available as SVGs and TTF font. - [Iosevka](https://github.com/be5invis/Iosevka) - Slender typeface for code, from code. - [Raleway](https://github.com/theleagueof/raleway) - Elegant sans-serif, designed in a single thin weight. - [Adobe NotDef](https://github.com/adobe-fonts/adobe-notdef) - Maps 1,111,998 Unicode code points to 2,048 .notdef glyphs. - [Adobe Blank](https://github.com/adobe-fonts/adobe-blank) - Maps 1,111,998 Unicode code points to 2,048 non-spacing and non-marking glyphs. - [Adobe Blank 2](https://github.com/adobe-fonts/adobe-blank-2) - Based on Adobe Blank, and differs mainly in that the number of glyphs has been reduced to only two, thanks to the Format 13 'cmap' subtable. - [Width Test](https://github.com/adobe-fonts/width-test) - For testing width-related GSUB features, specifically 'fwid' (Full Widths), 'hwid' (Half Widths), 'twid' (Third Widths), and 'qwid' (Quarter Widths). - [Source Han Sans](https://github.com/adobe-fonts/source-han-sans) - Set of OpenType/CFF Pan-CJK fonts. - [Source Han Serif](https://github.com/adobe-fonts/source-han-serif) - Set of OpenType/CFF Pan-CJK fonts. - [Open Emoji](https://twitter.com/OpenEmoji) - Will provide open and free access to visual communications technology, namely emoji, for the entire universe. - [Overpass](https://github.com/RedHatBrand/Overpass) - Open source font family inspired by Highway Gothic. For more, check [awesome-fonts](https://github.com/brabadu/awesome-fonts)! ## TrueType - [Truetype font software](http://luc.devroye.org/ttsoftware-index.html) - List (Big!) with descriptions [here](http://luc.devroye.org/ttsoftware.html). ## Books - [Fonts & Encodings](http://shop.oreilly.com/product/9780596102425.do) - From Advanced Typography to Unicode and Everything in Between [Google Books Preview](https://books.google.fr/books?id=qrElYgVLDwYC&printsec=frontcover#v=onepage&q&f=false). - [Unicode Explained](http://shop.oreilly.com/product/9780596101213.do) - There are hundreds of different encoding systems for mapping characters to numbers, but Unicode promises a single mapping. [Google Books Preview](https://books.google.fr/books?id=lxndiWaFMvMC&printsec=frontcover#v=onepage&q&f=false). ## Videos - [Talks from TYPO conferences](https://www.typotalks.com/videos/) - [Tales of ⌧! Can You Tell Your Story When Your Character Is Undefined?! by Persa Zula](https://github.com/pzula/tales-of-notdef) ## Contribute ➡️Pull request! (Or open an issue [here](https://github.com/Jolg42/awesome-typography/issues)). ## License [](https://creativecommons.org/publicdomain/zero/1.0/) To the extent possible under law, [Joël Galeran](https://github.com/Jolg42) has waived all copyright and related or neighboring rights to this work.

Project page for "The Fuzzing Book"

<!-- Fuzzingbook README --> <!-- Badges to be shown on project page --> [](https://github.com/uds-se/fuzzingbook/actions/workflows/check-code.yml) &nbsp; [](https://github.com/uds-se/fuzzingbook/actions/workflows/check-notebooks.yml) &nbsp; [](https://github.com/uds-se/fuzzingbook/actions/workflows/check-types.yml) &nbsp; [](https://github.com/uds-se/fuzzingbook/actions/workflows/check-imports.yml) &nbsp; [](https://www.fuzzingbook.org/) [](https://mybinder.org/v2/gh/uds-se/fuzzingbook/master?filepath=docs/notebooks/00_Table_of_Contents.ipynb) &nbsp; [](https://www.python.org/) &nbsp; [](https://www.jupyter.org/) &nbsp; [,_CC_BY--NC--SA_4.0_(Book)-blue.svg)](https://github.com/uds-se/fuzzingbook/blob/master/LICENSE.md) # About this Book __Welcome to "The Fuzzing Book"!__ Software has bugs, and catching bugs can involve lots of effort. This book addresses this problem by _automating_ software testing, specifically by _generating tests automatically_. Recent years have seen the development of novel techniques that lead to dramatic improvements in test generation and software testing. They now are mature enough to be assembled in a book – even with executable code. ```python from bookutils import YouTubeVideo YouTubeVideo("w4u5gCgPlmg") ``` <a href="https://www.youtube-nocookie.com/embed/w4u5gCgPlmg" target="_blank"> <img src="https://www.fuzzingbook.org/html/PICS/youtube.png" width=640> </a> ## A Textbook for Paper, Screen, and Keyboard You can use this book in four ways: * You can __read chapters in your browser__. Check out the list of chapters in the menu above, or start right away with the [introduction to testing](https://www.fuzzingbook.org/html/Intro_Testing.html) or the [introduction to fuzzing](https://www.fuzzingbook.org/html/Fuzzer.html). All code is available for download. * You can __interact with chapters as Jupyter Notebooks__ (beta). This allows you to edit and extend the code, experimenting _live in your browser._ Simply select "Resources → Edit as Notebook" at the top of each chapter. <a href="https://mybinder.org/v2/gh/uds-se/fuzzingbook/master?filepath=docs/notebooks/Fuzzer.ipynb" target=_blank>Try interacting with the introduction to fuzzing.</a> * You can __use the code in your own projects__. You can download the code as Python programs; simply select "Resources → Download Code" for one chapter or "Resources → All Code" for all chapters. These code files can be executed, yielding (hopefully) the same results as the notebooks. Even easier: [Install the fuzzingbook Python package](https://www.fuzzingbook.org/html/Importing.html). * You can __present chapters as slides__. This allows for presenting the material in lectures. Just select "Resources → View slides" at the top of each chapter. <a href="https://www.fuzzingbook.org/slides/Fuzzer.slides.html" target=_blank>Try viewing the slides for the introduction to fuzzing.</a> ## Who this Book is for This work is designed as a _textbook_ for a course in software testing; as _supplementary material_ in a software testing or software engineering course; and as a _resource for software developers_. We cover random fuzzing, mutation-based fuzzing, grammar-based test generation, symbolic testing, and much more, illustrating all techniques with code examples that you can try out yourself. ## News This book is _work in progress._ All chapters planned are out now, but we keep on refining the material with [minor and major releases.](https://www.fuzzingbook.org/html/ReleaseNotes.html) To get notified on updates, <a href="https://twitter.com/FuzzingBook?ref_src=twsrc%5Etfw" data-show-count="false">follow us on Twitter</a>. <a class="twitter-timeline" data-width="500" data-chrome="noheader nofooter noborders transparent" data-link-color="#A93226" data-align="center" href="https://twitter.com/FuzzingBook?ref_src=twsrc%5Etfw" data-dnt="true">News from @FuzzingBook</a> ## About the Authors This book is written by _Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler_. All of us are long-standing experts in software testing and test generation; and we have written or contributed to some of the most important test generators and fuzzers on the planet. As an example, if you are reading this in a Firefox, Chrome, or Edge Web browser, you can do so safely partly because of us, as _the very techniques listed in this book have found more than 2,600 bugs in their JavaScript interpreters so far._ We are happy to share our expertise and making it accessible to the public. ## Frequently Asked Questions ### Troubleshooting #### Why does it take so long to start an interactive notebook? The interactive notebook uses the [mybinder.org](https://mybinder.org) service, which runs notebooks on their own servers. Starting Jupyter through mybinder.org normally takes about 30 seconds, depending on your Internet connection. If, however, you are the first to invoke binder after a book update, binder recreates its environment, which will take a few minutes. Reload the page occasionally. #### The interactive notebook does not work! mybinder.org imposes a [limit of 100 concurrent users for a repository](https://mybinder.readthedocs.io/en/latest/user-guidelines.html). Also, as listed on the [mybinder.org status and reliability page](https://mybinder.readthedocs.io/en/latest/reliability.html), > As mybinder.org is a research pilot project, the main goal for the project is to understand usage patterns and workloads for future project evolution. While we strive for site reliability and availability, we want our users to understand the intent of this service is research and we offer no guarantees of its performance in mission critical uses. There are alternatives to mybinder.org; see below. #### Do I have alternatives to the interactive notebook? If mybinder.org does not work or match your needs, you have a number of alternatives: 1. **Download the Python code** (using the menu at the top) and edit and run it in your favorite environment. This is easy to do and does not require lots of resources. 2. **Download the Jupyter Notebooks** (using the menu at the top) and open them in Jupyter. Here's [how to install jupyter notebook on your machine](https://www.dataquest.io/blog/jupyter-notebook-tutorial/). 3. **Run the notebook locally** in a Docker container. For more information, see [How to use the book with Docker](https://github.com/uds-se/fuzzingbook/blob/master/deploy/README.md). 4. If you want to use the book in a classroom, and depend on your users having access to the interactive notebooks, consider using or deploying a [JupyterHub](http://jupyter.org/hub) or [BinderHub](https://github.com/jupyterhub/binderhub) instance. #### Can I run the code on my Windows machine? We try to keep the code as general as possible, but occasionally, when we interact with the operating system, we assume a Unix-like environment (because that is what Binder provides). To run these examples on your own Windows machine, you can install a Linux VM or a [Docker environment](https://github.com/uds-se/fuzzingbook/blob/master/deploy/README.md). #### Can't you run your own dedicated cloud service? Technically, yes; but this would cost money and effort, which we'd rather spend on the book at this point. If you'd like to host a [JupyterHub](http://jupyter.org/hub) or [BinderHub](https://github.com/jupyterhub/binderhub) instance for the public, please _do so_ and let us know. ### Content #### Can I use your code in my own programs? Yes! See the [installation instructions](https://www.fuzzingbook.org/html/Importing.html) for details. #### Which content has come up? See the [release notes](https://www.fuzzingbook.org/html/ReleaseNotes.html) for details. #### How do I cite your work? Thanks for referring to our work! Once the book is complete, you will be able to cite it in the traditional way. In the meantime, just click on the "cite" button at the bottom of the Web page for each chapter to get a citation entry. #### Can you cite my paper? And possibly write a chapter about it? We're always happy to get suggestions! If we missed an important reference, we will of course add it. If you'd like specific material to be covered, the best way is to _write a notebook_ yourself; see our [Guide for Authors](https://www.fuzzingbook.org/html/Guide_for_Authors.html) for instructions on coding and writing. We can then refer to it or even host it. ### Teaching and Coursework #### Can I use your material in my course? Of course! Just respect the [license](https://github.com/uds-se/fuzzingbook/blob/master/LICENSE.md) (including attribution and share alike). If you want to use the material for commercial purposes, contact us. #### Can I extend or adapt your material? Yes! Again, please see the [license](https://github.com/uds-se/fuzzingbook/blob/master/LICENSE.md) for details. #### How can I run a course based on the book? We have successfully used the material in various courses. * Initially, we used the slides and code and did _live coding_ in lectures to illustrate how a technique works. * Now, the goal of the book is to be completely self-contained; that is, it should work without additional support. Hence, we now give out completed chapters to students in a _flipped classroom_ setting, with the students working on the notebooks at their leisure. We would meet in the classroom to discuss experiences with past notebooks and discuss future notebooks. * We have the students work on exercises from the book or work on larger (fuzzing) projects. We also have students who use the book as a base for their research; indeed, it is very easy to prototype in Python for Python. When running a course, [do not rely on mybinder.org](#Troubleshooting) – it will not provide sufficient resources for a larger group of students. Instead, [install and run your own hub.](#Do-I-have-alternatives-to-the-interactive-notebook?) #### Are there specific subsets I can focus on? We have compiled a number of [tours through the book](https://www.fuzzingbook.org/html/Tours.html) for various audiences. Our [Sitemap](https://www.fuzzingbook.org/html/00_Table_of_Contents.html) lists the dependencies between the individual chapters. #### How can I extend or adapt your slides? Download the Jupyter Notebooks (using the menu at the top) and adapt the notebooks at your leisure (see above), including "Slide Type" settings. Then, 1. Download slides from Jupyter Notebook; or 2. Use the RISE extension ([instructions](http://www.blog.pythonlibrary.org/2018/09/25/creating-presentations-with-jupyter-notebook/)) to present your slides right out of Jupyter notebook. #### Do you provide PDFs of your material? At this point, we do not provide support for PDF versions. We will be producing PDF and print versions after the book is complete. ### Other Issues #### I have a question, comment, or a suggestion. What do I do? You can [tweet to @fuzzingbook on Twitter](https://twitter.com/fuzzingbook), allowing the community of readers to chime in. For bugs that you'd like to get fixed, report an issue on the [development page](https://github.com/uds-se/fuzzingbook/issues). #### I have reported an issue two weeks ago. When will it be addressed? We prioritize issues as follows: 1. Bugs in code published on fuzzingbook.org 2. Bugs in text published on fuzzingbook.org 3. Writing missing chapters 4. Issues in yet unpublished code or text 5. Issues related to development or construction 6. Things marked as "beta" 7. Everything else #### How can I solve problems myself? We're glad you ask that. The [development page](https://github.com/uds-se/fuzzingbook/) has all sources and some supplementary material. Pull requests that fix issues are very welcome. #### How can I contribute? Again, we're glad you're here! We are happy to accept * **Code fixes and improvements.** Please place any code under the MIT license such that we can easily include it. * **Additional text, chapters, and notebooks** on specialized topics. We plan to set up a special folder for third-party contributions. See our [Guide for Authors](https://www.fuzzingbook.org/html/Guide_for_Authors.html) for instructions on coding and writing.

Mutation testing for JavaScript and friends

[](https://dashboard.stryker-mutator.io/reports/github.com/stryker-mutator/stryker-js/master) [](https://github.com/stryker-mutator/stryker-js/actions?query=workflow%3ACI+branch%3Amaster) [](https://www.npmjs.com/package/@stryker-mutator/core) [](https://img.shields.io/node/v/@stryker-mutator/core.svg) [](https://join.slack.com/t/stryker-mutator/shared_invite/enQtOTUyMTYyNTg1NDQ0LTU4ODNmZDlmN2I3MmEyMTVhYjZlYmJkOThlNTY3NTM1M2QxYmM5YTM3ODQxYmJjY2YyYzllM2RkMmM1NjNjZjM)  # StrykerJS *Professor X: For someone who hates mutants... you certainly keep some strange company.* *William Stryker: Oh, they serve their purpose... as long as they can be controlled.* Welcome to StrykerJS's monorepo. This is where all official stryker packages are maintained. If you're new to monorepos: don't be scared. You'll find the packages in the `packages` folder. If you're interested in why we chose a monorepo, please read [babeljs's design document about monorepos](https://github.com/babel/babel/blob/master/doc/design/monorepo.md). We use it for the same reasons as they do. ## Introduction For an introduction to mutation testing and Stryker's features, see [stryker-mutator.io](https://stryker-mutator.io/). ## Getting started Please follow the [quickstart on the website](https://stryker-mutator.io/docs/stryker-js/getting-started/). For small js projects, you can try the following command: ``` npm install --save-dev @stryker-mutator/core # Only for small projects: npx stryker run ``` It will run stryker with default values: * Uses `npm test` as your test command * Searches for files to mutate in the `lib` and `src` directories ## Usage ```sh $ npx stryker <command> [options] [configFile] ``` See [usage on stryker-mutator.io](https://stryker-mutator.io/docs/stryker-js/usage) ## Supported mutators See our website for the [list of currently supported mutators](https://stryker-mutator.io/docs/mutation-testing-elements/supported-mutators). ## Configuration See [configuration on stryker-mutator.io](https://stryker-mutator.io/docs/stryker-js/configuration).

Command line driven CI frontend and development task automation tool.

# tox [](https://pypi.org/project/tox/) [](https://pypi.org/project/tox/) [](https://pepy.tech/project/tox) [](https://tox.readthedocs.io/en/latest/?badge=latest) [](https://github.com/tox-dev/tox/actions/workflows/check.yml) `tox` aims to automate and standardize testing in Python. It is part of a larger vision of easing the packaging, testing and release process of Python software (alongside [pytest](https://docs.pytest.org/en/latest/) and [devpi](https://www.devpi.net)). tox is a generic virtual environment management and test command line tool you can use for: - checking your package builds and installs correctly under different environments (such as different Python implementations, versions or installation dependencies), - running your tests in each of the environments with the test tool of choice, - acting as a frontend to continuous integration servers, greatly reducing boilerplate and merging CI and shell-based testing. Please read our [user guide](https://tox.wiki/en/latest/user_guide.html#basic-example) for an example and more detailed introduction, or watch [this YouTube video](https://www.youtube.com/watch?v=SFqna5ilqig) that presents the problem space and how tox solves it.

A visual overview of useful skills to learn as a web developer

<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><h1 align="center">Web Skills</h1> <p align="center"> Web Skills is a visual overview of useful skills to learn as a web developer. Go to <a href="https://andreasbm.github.io/web-skills" target="_blank" aria-label="Link to Web Skills">https://andreasbm.github.io/web-skills</a> to check out the visual overview or scroll through this readme to get the overview <a href="#-fundamentals" target="_blank" aria-label="Link to list of skills">as a list</a>. If you like the project you are very welcome to <a href="https://github.com/andreasbm/web-skills/stargazers" aria-label="Become stargazer link">become a stargazer 🤩</a> </p> <p align="center"> <a href="http://andreasbm.github.io/web-skills" target="_blank"> <img src="https://raw.githubusercontent.com/andreasbm/web-skills/master/demo.gif" alt="Web Skills Demo" width="800" /> </a> </p> <br /> <details> <summary>📖 Table of Contents</summary> <br /> [](#table-of-contents) ## ➤ Table of Contents * [➤ FAQ](#-faq) * [What is Web Skills?](#what-is-web-skills) * [How did you choose the skills?](#how-did-you-choose-the-skills) * [How can I support you?](#how-can-i-support-you) * [How can I get involved?](#how-can-i-get-involved) * [How can I keep track of what skills I know?](#how-can-i-keep-track-of-what-skills-i-know) * [I am overwhelmed! Help me!](#i-am-overwhelmed-help-me) * [Why haven't you included XYZ Technology?](#why-havent-you-included-xyz-technology) * [What does the "experimental" banner mean?](#what-does-the-experimental-banner-mean) * [How can I get in contact with you?](#how-can-i-get-in-contact-with-you) * [➤ Fundamentals](#-fundamentals) * [HTML](#html) * [Syntax](#syntax) * [Basic Tags](#basic-tags) * [Forms](#forms) * [SEO](#seo) * [Discoverable Content](#discoverable-content) * [Svg](#svg) * [Best Practices](#best-practices) * [CSS](#css) * [Syntax](#syntax-1) * [Selectors](#selectors) * [Specificity](#specificity) * [Pseudo Selectors](#pseudo-selectors) * [Box Model](#box-model) * [Margin Collapsing](#margin-collapsing) * [Colors](#colors) * [Calc](#calc) * [Layout](#layout) * [Flex](#flex) * [Grid](#grid) * [Transforms](#transforms) * [Animations](#animations) * [Responsive Design](#responsive-design) * [Media Queries](#media-queries) * [Relative Units](#relative-units) * [Images](#images) * [CSS Variables](#css-variables) * [Best Practices](#best-practices-1) * [Javascript](#javascript) * [Syntax](#syntax-2) * [Spread](#spread) * [Destructuring](#destructuring) * [DOM](#dom) * [DOM Manipulation](#dom-manipulation) * [Events](#events) * [Objects](#objects) * [Prototype](#prototype) * [Classes](#classes) * [Regex](#regex) * [Template Literals](#template-literals) * [Promises](#promises) * [Callbacks](#callbacks) * [Async/await](#asyncawait) * [Fetch](#fetch) * [Web Animations](#web-animations) * [Modules](#modules) * [Intl](#intl) * [Canvas](#canvas) * [Documentation](#documentation) * [Best Practices](#best-practices-2) * [The Browser](#the-browser) * [Standardization](#standardization) * [W3C](#w3c) * [TC39](#tc39) * [WHATWG](#whatwg) * [Specifications](#specifications) * [Browser Engines](#browser-engines) * [Webkit](#webkit) * [Blink](#blink) * [Gecko](#gecko) * [HTTP](#http) * [The Internet](#the-internet) * [Polyfills](#polyfills) * [Debugging](#debugging) * [Developer console](#developer-console) * [➤ Accessibility](#-accessibility) * [The why](#the-why) * [Screen Readers](#screen-readers) * [Accessibility tree](#accessibility-tree) * [ARIA](#aria) * [Accessible HTML](#accessible-html) * [Alt text](#alt-text) * [Accessible CSS](#accessible-css) * [Accessible forms](#accessible-forms) * [UI States](#ui-states) * [Keyboard Accessibility](#keyboard-accessibility) * [Focus](#focus) * [Accessible Colors](#accessible-colors) * [Laws & Policies](#laws--policies) * [Audits](#audits) * [➤ Web Components](#-web-components) * [Custom Elements](#custom-elements) * [HTML Templates](#html-templates) * [Shadow DOM](#shadow-dom) * [Shadow Parts](#shadow-parts) * [Slots](#slots) * [Best practices](#best-practices) * [Constructible Stylesheets](#constructible-stylesheets) * [Form Participation](#form-participation) * [➤ Progressive Webapps](#-progressive-webapps) * [API's](#apis) * [Storage](#storage) * [Routing](#routing) * [History API](#history-api) * [Service Workers](#service-workers) * [Offline first](#offline-first) * [Push notifications](#push-notifications) * [Web App manifest](#web-app-manifest) * [Add to homescreen](#add-to-homescreen) * [Pointer Events](#pointer-events) * [Loading Performance](#loading-performance) * [App shell](#app-shell) * [Render-Blocking Resources](#render-blocking-resources) * [Compression](#compression) * [Performance metrics](#performance-metrics) * [Largest Contentful Paint](#largest-contentful-paint) * [Total Blocking Time](#total-blocking-time) * [Time to Interactive](#time-to-interactive) * [Lazy Loading](#lazy-loading) * [Dynamic Import](#dynamic-import) * [Offscreen images](#offscreen-images) * [Critical Request Chains](#critical-request-chains) * [Tree shaking](#tree-shaking) * [Codesplitting](#codesplitting) * [PRPL Pattern](#prpl-pattern) * [Resource Prioritization](#resource-prioritization) * [Caching](#caching) * [Rendering Performance](#rendering-performance) * [Rendering](#rendering) * [Event loop](#event-loop) * [Microtask](#microtask) * [Stack](#stack) * [Heap](#heap) * [RAIL Model](#rail-model) * [requestAnimationFrame](#requestanimationframe) * [requestIdleCallback](#requestidlecallback) * [Critical Rendering Path](#critical-rendering-path) * [The Pixel Pipeline](#the-pixel-pipeline) * [Style calculations](#style-calculations) * [Transforms](#transforms-1) * [Paint areas](#paint-areas) * [Layout Trashing](#layout-trashing) * [Layers](#layers) * [Debounce](#debounce) * [CSS Containment](#css-containment) * [Web Workers](#web-workers) * [Security](#security) * [HTTPS](#https) * [Browser Sandbox](#browser-sandbox) * [OWASP](#owasp) * [Cross-Site Scripting](#cross-site-scripting) * [Clickjacking](#clickjacking) * [Content Security Policy](#content-security-policy) * [Audits](#audits-1) * [Performance budgets](#performance-budgets) * [Lighthouse](#lighthouse) * [Chrome DevTools](#chrome-devtools) * [➤ Build tools](#-build-tools) * [Package Managers](#package-managers) * [NPM](#npm) * [Yarn](#yarn) * [Module Bundlers](#module-bundlers) * [Rollup](#rollup) * [Webpack](#webpack) * [Parcel](#parcel) * [Snowpack](#snowpack) * [Linters and formatters](#linters-and-formatters) * [Prettier](#prettier) * [ESLint](#eslint) * [Task Runners](#task-runners) * [NPM Scripts](#npm-scripts) * [Transpilers](#transpilers) * [Babel](#babel) * [Typescript](#typescript) * [CSS Pre-processors](#css-pre-processors) * [SASS](#sass) * [PostCSS](#postcss) * [Node.js](#nodejs) * [➤ Frameworks & Libraries](#-frameworks--libraries) * [lit-element](#lit-element) * [Vue](#vue) * [React](#react) * [Angular](#angular) * [Svelte](#svelte) * [Stencil](#stencil) * [➤ Testing](#-testing) * [Testing Methodologies](#testing-methodologies) * [Unit Testing](#unit-testing) * [Integration Testing](#integration-testing) * [System Testing](#system-testing) * [Acceptance Testing](#acceptance-testing) * [Smoke Testing](#smoke-testing) * [Performance Testing](#performance-testing) * [Usability Testing](#usability-testing) * [White Box Testing](#white-box-testing) * [Black Box Testing](#black-box-testing) * [Automated Testing](#automated-testing) * [Manual Testing](#manual-testing) * [Continuous integration](#continuous-integration) * [A/B Testing](#ab-testing) * [Test Runners](#test-runners) * [Karma](#karma) * [Mocha](#mocha) * [Jasmine](#jasmine) * [Cypress](#cypress) * [Ava](#ava) * [Best Practices](#best-practices-3) * [➤ Architecture & paradigms](#-architecture--paradigms) * [Paradigms](#paradigms) * [Programming Paradigms](#programming-paradigms) * [Object Oriented Programming](#object-oriented-programming) * [S.O.L.I.D](#solid) * [Functional programming](#functional-programming) * [Recursion](#recursion) * [Higher-Order Functions](#higher-order-functions) * [Currying](#currying) * [Monads](#monads) * [Architecture](#architecture) * [Design Patterns](#design-patterns) * [Singleton](#singleton) * [Observer](#observer) * [Prototype](#prototype-1) * [Bridge](#bridge) * [Proxy](#proxy) * [Chain of responsibility](#chain-of-responsibility) * [Constructor](#constructor) * [CSS Methodologies](#css-methodologies) * [BEM](#bem) * [SMACSS](#smacss) * [OOCSS](#oocss) * [➤ Team Collaboration](#-team-collaboration) * [Version Control](#version-control) * [Git](#git) * [Github](#github) * [Bitbucket](#bitbucket) * [Management](#management) * [Agile Development](#agile-development) * [Scrum](#scrum) * [Kanban](#kanban) * [Waterfall Development](#waterfall-development) * [Test Driven Development](#test-driven-development) * [➤ Design & UX](#-design--ux) * [Color Theory](#color-theory) * [Color Wheel](#color-wheel) * [Typography](#typography) * [Font Size](#font-size) * [Line Spacing](#line-spacing) * [C.R.A.P](#crap) * [Contrast](#contrast) * [Repetition](#repetition) * [Alignment](#alignment) * [Proximity](#proximity) * [Consistency](#consistency) * [Spacing](#spacing) * [Error Handling](#error-handling) * [Loading](#loading) * [The Golden Ratio](#the-golden-ratio) * [Mobile First](#mobile-first) * [Hit Targets](#hit-targets) * [Design Systems](#design-systems) * [Material Design](#material-design) * [Fluent Design](#fluent-design) * [Accessibility](#accessibility) * [Best Practices](#best-practices-4) * [➤ The Modern Web](#-the-modern-web) * [Streams](#streams) * [Media Streams](#media-streams) * [Media Recorder](#media-recorder) * [Web RTC](#web-rtc) * [Screen Capture](#screen-capture) * [Generators](#generators) * [Speech Synthesis](#speech-synthesis) * [Web Sockets](#web-sockets) * [Geolocation](#geolocation) * [Device orientation & motion](#device-orientation--motion) * [Fullscreen](#fullscreen) * [Variable Fonts](#variable-fonts) * [HTTP/2](#http2) * [Payment Request API](#payment-request-api) * [Web Audio](#web-audio) * [Observers](#observers) * [Mutation Observer](#mutation-observer) * [Intersection Observer](#intersection-observer) * [Resize Observer](#resize-observer) * [Performance Observer](#performance-observer) * [Scrollsnapping](#scrollsnapping) * [Web Assembly](#web-assembly) * [Beacon](#beacon) * [Clipboard](#clipboard) * [Share](#share) * [Performance API](#performance-api) * [Gamepad API](#gamepad-api) * [Speech Recognition](#speech-recognition) * [Interaction Media Queries](#interaction-media-queries) * [Browser Extensions](#browser-extensions) * [Pointer Lock API](#pointer-lock-api) * [Picture In Picture](#picture-in-picture) * [Proxies](#proxies) * [Houdini](#houdini) * [Project Fugu](#project-fugu) * [Web Authentication API](#web-authentication-api) * [Credentials Manager API](#credentials-manager-api) * [Native File System](#native-file-system) * [Shape Detection](#shape-detection) * [Web Bluetooth](#web-bluetooth) * [Web USB](#web-usb) * [Web XR](#web-xr) * [Presentation](#presentation) * [Network Information API](#network-information-api) * [➤ Algorithms & Data structures](#-algorithms--data-structures) * [Data structures](#data-structures) * [Arrays](#arrays) * [Queues & Stacks](#queues--stacks) * [Trees](#trees) * [Binary Indexed Tree](#binary-indexed-tree) * [Heap](#heap-1) * [Red-black Tree](#red-black-tree) * [Trie](#trie) * [K-D Tree](#k-d-tree) * [Hash Tables](#hash-tables) * [Linked Lists](#linked-lists) * [Graphs](#graphs) * [Analysis](#analysis) * [Time complexity](#time-complexity) * [Cost model](#cost-model) * [Order of Growth](#order-of-growth) * [Big O notation](#big-o-notation) * [Space Complexity](#space-complexity) * [Algorithms](#algorithms) * [Sorting](#sorting) * [Insertion Sort](#insertion-sort) * [Quicksort](#quicksort) * [Mergesort](#mergesort) * [Heapsort](#heapsort) * [Searching](#searching) * [Binary Search](#binary-search) * [Breadth First Search](#breadth-first-search) * [Depth First Search](#depth-first-search) * [Dijkstra's Algorithm](#dijkstras-algorithm) * [String Search](#string-search) * [Hashing](#hashing) * [➤ Databases & Servers](#-databases--servers) * [Databases](#databases) * [Relational Databases](#relational-databases) * [SQL](#sql) * [MySQL](#mysql) * [PostgreSQL](#postgresql) * [Non-relational Databases](#non-relational-databases) * [Redis](#redis) * [MongoDB](#mongodb) * [Data Modelling](#data-modelling) * [ER Diagram](#er-diagram) * [Keys](#keys) * [Indexing](#indexing) * [Data Integrity](#data-integrity) * [Normalization](#normalization) * [Functional Dependencies](#functional-dependencies) * [Normal Forms](#normal-forms) * [Transactions](#transactions) * [ACID](#acid) * [Serializability](#serializability) * [Locks](#locks) * [Deadlocks](#deadlocks) * [Precedence graph](#precedence-graph) * [Servers](#servers) * [Architectural Models](#architectural-models) * [Client-Server](#client-server) * [Proxy Server](#proxy-server) * [Peer-To-Peer](#peer-to-peer) * [Middleware](#middleware) * [Request-Reply Protocol](#request-reply-protocol) * [UDP](#udp) * [TCP](#tcp) * [REST API](#rest-api) * [CRUD](#crud) * [Express](#express) * [GraphQL](#graphql) * [GNU/Linux](#gnulinux) * [Docker](#docker) * [SSH](#ssh) * [➤ Contributors](#-contributors) * [➤ License](#-license) </details> [](#faq) ## ➤ FAQ ### What is Web Skills? Web Skills is a visual overview of useful skills to learn as a web developer. It is useful for people who just started learning about web development and for people who have been in the field for years and want to learn new things. As a beginner, I would encourage you not to see this website as the definitive list of what you need to know but as an example of what you can learn and where you can start. The skills are arranged in chronological order based on what learning path I recommend you to take but feel free to jump around freely. ### How did you choose the skills? The skills are derived from a combination of 10 years of experience, a bachelor in software engineering and what I personally find to be the most useful to know on a day-to-day basis. Therefore, you'll notice that it's missing a lot of things. For example, I am not a PHP developer - because of this, PHP is not included. If you were a PHP developer, this overview would probably look a lot different. ### How can I support you? I am spending my spare time building Web Skills for free because I want to help people get into web development. My motivation comes from people finding Web Skills useful, so if you like the project feel free to support me in any way you like! For example, you are more than welcome to become a [stargazer](https://github.com/andreasbm/web-skills/stargazers), share Web Skills with your friends and followers or create blog articles linking to Web Skills. If you want to, it will absolutely make my day if you [support me with a cup of coffee](https://www.buymeacoffee.com/AndreasMehlsen)! <3 ### How can I get involved? You are welcome to get involved in any way you like. If you want to, you can go to the [issues page](https://github.com/andreasbm/web-skills/issues) and help me fix the spelling, fix issues or suggest some new features. Any involvement is highly appreciated! ### How can I keep track of what skills I know? If you scroll to the bottom of the page, you will find a button that says "Sign in with Google". If you click this button and sign in, you will be able to mark skills as completed. ### I am overwhelmed! Help me! I totally understand if you are a bit overwhelmed by the amount of skills on the page – but I can assure you that this overview includes much, much more than most people will ever need to know. My main goal is to provide a visual overview of web development and make people hungry for learning more. One of the things I absolute love about being a developer is learning new skills. I think it is amazing to be in a field where you can do what you do for a lifetime and still learn something new! People cannot be an expert in every skill on this page so try to find what excites you the most and become really good at that. ### Why haven't you included XYZ Technology? The skills are based on what I personally find to be the most useful on a day-to-day basis. If you think something really important is missing, you can always suggest it on the [issues page](https://github.com/andreasbm/web-skills/issues). ### What does the "experimental" banner mean? When a skill is described as experimental, it means that the technology is immature and currently in the process of being added to the Web platform (or considered for addition). Think carefully before you start using experimental technology in any kind of production project. The definition used in Web Skills is based on the excellent definition used on [MDN](https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Conventions_definitions#Experimental). You are very welcome to open an issue if you see a skill you believe should be marked as "experimental" or have the banner removed. ### How can I get in contact with you? Reach out to me on Twitter at [@AndreasMehlsen](https://twitter.com/AndreasMehlsen) or take a look at [my website](https://andreasbm.github.io) if you want to learn more about what other projects I'm working on. [](#fundamentals) ## ➤ Fundamentals ### HTML ### Syntax Learn the basics of HTML and get comfortable with it's syntax and main concepts. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTML Basics](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/HTML_basics) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Introduction to HTML](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.codecademy.com" alt="Logo" /> Codecademy - Learn HTML](https://www.codecademy.com/learn/learn-html) #### Basic Tags Get familiar with the basic HTML tags * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTML elements reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Element) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - Basic HTML tags](https://www.tutorialspoint.com/html/html_basic_tags.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.elated.com" alt="Logo" /> Elated - First 10 HTML tags](https://www.elated.com/first-10-html-tags/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - HTML tags](https://www.w3schools.com/tags/ref_byfunc.asp) ### Forms Learn how to design efficient forms, validating them effectively and keeping the user informed along the way. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTML forms](https://developer.mozilla.org/en-US/docs/Learn/HTML/Forms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Web - Forms](https://developers.google.com/web/fundamentals/design-and-ux/input/forms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - Forms](https://www.w3schools.com/html/html_forms.asp) ### SEO Learn how to make your content search-friendly. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Discoverable](https://web.dev/discoverable) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Search - Get Started](https://developers.google.com/search/docs/guides/get-started) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Search - SEO basics](https://developers.google.com/search/docs/guides/javascript-seo-basics) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - SEO audits](https://web.dev/lighthouse-seo) #### Discoverable Content Learn how to structure your HTML in a way that provides a rich experience when sharing it online. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Web - Social Discovery](https://developers.google.com/web/fundamentals/discovery/social-discovery) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Search - Search Features](https://developers.google.com/search/docs/guides/search-features) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Search - Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Easily discoverable](https://web.dev/discoverable) ### Svg Learn how to work with SVG files to make graphics look crisp across all screen resolutions. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Adding vector graphics to the Web](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Adding_vector_graphics_to_the_Web) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsvgontheweb.com" alt="Logo" /> SVG on the web](https://svgontheweb.com/) ### Best Practices Learn the best practices of writing HTML. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTML guidelines](https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/HTML) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - HTML Coding Conventions](https://www.w3schools.com/html/html5_syntax.asp) ### CSS ### Syntax Learn the basics of CSS and get comfortable with it's syntax and main concepts. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS Basics](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/CSS_basics) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - CSS Tutorial](https://www.w3schools.com/css/default.asp) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Supercharged - CSS Selectors](https://www.youtube.com/watch?v=IKho_xDKaLw) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS first steps](https://developer.mozilla.org/en-US/docs/Learn/CSS/First_steps) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS building blocks](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS values and units](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS Syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Syntax) ### Selectors Learn about CSS selectors and how to effeciently target DOM elements. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS selectors](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - All selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Child and Sibling Selectors](https://css-tricks.com/child-and-sibling-selectors/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - All Selectors](https://css-tricks.com/almanac/selectors/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - CSS Combinators](https://www.w3schools.com/css/css_combinators.asp) #### Specificity Learn what specificity means and how to use it when writing CSS. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Specificity](https://developer.mozilla.org/en-US/docs/Web/CSS/Specificity) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Cascade and inheritance](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Cascade_and_inheritance) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - CSS Specificity](https://dev.to/emmawedekind/css-specificity-1kca) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fspecificity.keegan.st" alt="Logo" /> Specificity Calculator](https://specificity.keegan.st/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - CSS Specificity](https://www.w3schools.com/css/css_specificity.asp) #### Pseudo Selectors Learn how to use pseudo selectors. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Pseudo-classes](https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-classes) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Meet the Pseudo Class Selectors](https://css-tricks.com/pseudo-class-selectors/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbitsofco.de" alt="Logo" /> When do the :hover, :focus, and :active pseudo-classes apply?](https://bitsofco.de/when-do-the-hover-focus-and-active-pseudo-classes-apply/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - CSS Pseudo-elements](https://www.w3schools.com/css/css_pseudo_elements.asp) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - CSS Pseudo-classes](https://www.w3schools.com/css/css_pseudo_classes.asp) ### Box Model Learn what the CSS box model means. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Introduction to the CSS basic box model](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - The box model](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/The_box_model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Inheriting box-sizing](https://css-tricks.com/inheriting-box-sizing-probably-slightly-better-best-practice/) #### Margin Collapsing Learn about margin collapsing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Mastering margin collapsing](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Box_Model/Mastering_margin_collapsing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Margin Collapse in CSS: What, Why, and How](https://medium.com/@joseph0crick/margin-collapse-in-css-what-why-and-how-328c10e37ca0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - What You Should Know About Collapsing Margins](https://css-tricks.com/what-you-should-know-about-collapsing-margins/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbitsofco.de" alt="Logo" /> What's the Deal with Collapsible Margins?](https://bitsofco.de/collapsible-margins/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjonathan-harrell.com" alt="Logo" /> What’s the Deal with Margin Collapse?](https://jonathan-harrell.com/whats-the-deal-with-margin-collapse/) ### Colors Learn the different ways you can define colors in CSS. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Color](https://developer.mozilla.org/en-US/docs/Web/CSS/color) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - <color>](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - CSS Colors](https://www.w3schools.com/css/css_colors.asp) ### Calc Learn how to use the CSS calc function. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Calc](https://developer.mozilla.org/en-US/docs/Web/CSS/calc) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - A Couple of Use Cases for Calc()](https://css-tricks.com/a-couple-of-use-cases-for-calc/) ### Layout Learn the different layout types for web. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Chrome Dev - Basic Layout](https://developers.google.com/training/certification/mobile-web-specialist/study-guide/basic-layout) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - CSS Website Layout](https://www.w3schools.com/css/css_website_layout.asp) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Document and website structure](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Document_and_website_structure) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS layout](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout) #### Flex Learn how to create layouts using flexbox. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Flexbox](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Flexbox) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> A Complete Guide to Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflexboxfroggy.com" alt="Logo" /> Flexbox Froggy](https://flexboxfroggy.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fflexboxdefense.com" alt="Logo" /> Flexbox Defense](http://flexboxdefense.com) #### Grid Learn how to create layouts using CSS Grid. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Grids](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Grids) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> A Complete Guide to CSS Grid](https://css-tricks.com/snippets/css/complete-guide-grid/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS Grid](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcssgridgarden.com" alt="Logo" /> CSS Grid Garden](https://cssgridgarden.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Supercharged - CSS Grids](https://www.youtube.com/watch?v=AqwPrR7hklE) ### Transforms Learn the different ways to transform elements through CSS. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Transform](https://css-tricks.com/almanac/properties/t/transform/) #### Animations Learn how to animate elements through CSS using keyframes. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using CSS animations](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Animations/Using_CSS_animations) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Animation](https://css-tricks.com/almanac/properties/a/animation/) ### Responsive Design Learn how to make your website responsive so it works across different screen sizes. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Responsive design](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Responsive_Design) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.udacity.com" alt="Logo" /> Responsive Web Design Fundamentals by Google](https://www.udacity.com/course/responsive-web-design-fundamentals--ud893) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Dev - Responsive Design](https://developers.google.com/web/fundamentals/design-and-ux/responsive) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Dev - UX Patterns](https://developers.google.com/web/fundamentals/design-and-ux/responsive/patterns) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Dev - Responsive Content](https://developers.google.com/web/fundamentals/design-and-ux/responsive/content) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodelabs.developers.google.com" alt="Logo" /> Codelabs - Responsive Design](https://codelabs.developers.google.com/codelabs/pwa-responsive-design/index.html?index=..%2F..dev-pwa-training#0) #### Media Queries Learn how use media queries to build responsive layout. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - CSS Media Queries & Using Available Space](https://css-tricks.com/css-media-queries/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using media queries](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_media_queries) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using Media Queries for Accessibility](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_Media_Queries_for_Accessibility) #### Relative Units Learn how to use relative units for properties such as font sizes and spacing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Sizing items in CSS](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Sizing_items_in_CSS) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS values and units](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fthecssworkshop.com" alt="Logo" /> The CSS Workshop - Relative Units](https://thecssworkshop.com/lessons/relative-units) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Fun with Viewport Units](https://css-tricks.com/fun-viewport-units/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - 15 CSS Relative units](https://dev.to/bytegasm/15-css-relative-units-how-many-do-you-know-em-rem-ex-cap-ch-ic-6m) #### Images Learn how to make images responsive, always showing the best possible version for the screen size. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Responsive Images](https://developers.google.com/web/fundamentals/design-and-ux/responsive/images) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Responsive Images](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images) ### CSS Variables Learn how to define and use CSS variables. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - CSS Variables: Why Should You Care?](https://developers.google.com/web/updates/2016/02/css-variables-why-should-you-care) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - CSS Quickies: CSS Variables](https://dev.to/lampewebdev/css-quickies-css-variables-or-how-you-create-a-white-dark-theme-easily-1i0i) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> CSS Variables explained with 5 examples](https://codeburst.io/css-variables-explained-with-5-examples-84adaffaa5bd) ### Best Practices Learn the best practices of writing CSS. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS guidelines](https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/CSS) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Organizing your CSS](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Organizing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fspeckyboy.com" alt="Logo" /> Speckyboy - Good and bad CSS practices](https://speckyboy.com/good-bad-css-practices/) ### Javascript ### Syntax Learn the basics of Javascript and get comfortable with it's syntax and main concepts. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Javascript First Steps](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/First_steps) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Javascript Basics](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Javascript Building Blocks](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks) #### Spread Learn how the spread syntax can help you when working with arrays. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Spread syntax](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - An introduction to Spread syntax](https://www.freecodecamp.org/news/an-introduction-to-spread-syntax-in-javascript-fba39595922c/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fv8.dev" alt="Logo" /> Object rest and spread properties](https://v8.dev/features/object-rest-spread) #### Destructuring Learn how destructuring can help you when working with objects. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhacks.mozilla.org" alt="Logo" /> MDN - ES6 In Depth: Destructuring](https://hacks.mozilla.org/2015/05/es6-in-depth-destructuring/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Destructuring assignment](https://javascript.info/destructuring-assignment) ### DOM Learn how the HTML is represented as objects that comprise the structure and content of a document. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - DOM Introduction](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - What's the DOM](https://www.freecodecamp.org/news/whats-the-document-object-model-and-why-you-should-know-how-to-use-it-1a2d0bc5429d/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flearn.co" alt="Logo" /> Introduction to the DOM](https://learn.co/lessons/introduction-to-the-dom) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhtmldom.dev" alt="Logo" /> htmldom.dev](https://htmldom.dev/) #### DOM Manipulation Learn how to query HTML elements through Javascript and manipulate them. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Locating DOM elements using selectors](https://developer.mozilla.org/en-US/docs/Web/API/Document_object_model/Locating_DOM_elements_using_selectors) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Supercharged - querySelector](https://www.youtube.com/watch?v=s0vg_H9hBuU) ### Events Learn how to dispatch and listen for events. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Introduction to events](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Events) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Creating and triggering events](https://developer.mozilla.org/en-US/docs/Web/Guide/Events/Creating_and_triggering_events) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Event Bubbling and Event Capturing in JavaScript](https://medium.com/@vsvaibhav2016/event-bubbling-and-event-capturing-in-javascript-6ff38bec30e) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - A simplified explanation of event propagation](https://www.freecodecamp.org/news/a-simplified-explanation-of-event-propagation-in-javascript-f9de7961a06e/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> JavaScript Events Explained](https://flaviocopes.com/javascript-events/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - addEventListener()](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - removeEventListener(](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.quirksmode.org" alt="Logo" /> Event order](https://www.quirksmode.org/js/events_order.html) ### Objects Learn how to create and use objects. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Introducing JavaScript objects](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Working with objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Working_with_Objects) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Objects](https://javascript.info/object) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - this](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - The JavaScript this Keyword](https://www.w3schools.com/js/js_this.asp) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - bind()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - new operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - new.target](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/new.target) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fscotch.io" alt="Logo" /> Data Structures: Objects and Arrays](https://scotch.io/courses/10-need-to-know-javascript-concepts/data-structures-objects-and-arrays) #### Prototype Learn how to extend objects and functions through its prototype. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> The prototype chain](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Inheritance_and_the_prototype_chain) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Prototypes in JavaScript](https://medium.com/better-programming/prototypes-in-javascript-5bba2990e04b) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - JavaScript Visualized: Prototypal Inheritance](https://dev.to/lydiahallie/javascript-visualized-prototypal-inheritance-47co) ##### Classes Learn how to define and use classes. Get somewhat comfortable with some of the object oriented concepts such as inheritence and encapsulation. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Classes](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Medium - ES6 Classes](https://medium.com/@luke_smaki/javascript-es6-classes-8a34b0a6720a) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Inheritance](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Inheritance) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Object Oriented Programming](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Object-oriented_JS) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - super](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/super) ### Regex Learn how to use regex to extract information from strings. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Regular Expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Regular expressions](https://javascript.info/regular-expressions) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) ### Template Literals Learn how template literals and tagged templates and help you manipulate strings. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhacks.mozilla.org" alt="Logo" /> MDN - ES6 In Depth: Template strings](https://hacks.mozilla.org/2015/05/es6-in-depth-template-strings-2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Getting Literal With ES6 Template Strings](https://developers.google.com/web/updates/2015/01/ES6-Template-Strings) ### Promises Learn how to use promises and what asynchronous code means. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - JavaScript Promises: an Introduction](https://developers.google.com/web/fundamentals/primers/promises) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Master the JavaScript Interview: What is a Promise?](https://medium.com/javascript-scene/master-the-javascript-interview-what-is-a-promise-27fc71e77261) #### Callbacks Learn how to use callbacks and why they are not always a good idea. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Callback function](https://developer.mozilla.org/en-US/docs/Glossary/Callback_function) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> JavaScript: What the heck is a Callback?](https://codeburst.io/javascript-what-the-heck-is-a-callback-aba4da2deced) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Callbacks](https://javascript.info/callbacks) #### Async/await Learn how to use the async and await keywords to make it easier to write asynchronous code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - async function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Async functions](https://developers.google.com/web/fundamentals/primers/async-functions) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Async/await](https://javascript.info/async-await) #### Fetch Learn how to use the fetch API to fetch data. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Introduction to fetch](https://developers.google.com/web/updates/2015/03/introduction-to-fetch) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Networking](https://developers.google.com/training/certification/mobile-web-specialist/study-guide/networking) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - Fetch practical guide](https://www.freecodecamp.org/news/a-practical-es6-guide-on-how-to-perform-http-requests-using-the-fetch-api-594c3d91a547/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Falligator.io" alt="Logo" /> Alligator - Fetch API](https://alligator.io/js/fetch-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Supercharged - Fetch](https://www.youtube.com/watch?v=GiI77ya60yk) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodelabs.developers.google.com" alt="Logo" /> Codelabs - Fetch ](https://codelabs.developers.google.com/codelabs/pwa-fetch/index.html?index=..%2F..dev-pwa-training#0) ### Web Animations Learn how to use web animations to animate elements in the DOM. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Animations](https://developers.google.com/web/fundamentals/design-and-ux/animations) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using The Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - CSS Animations vs Web Animations API](https://css-tricks.com/css-animations-vs-web-animations-api/) ### Modules Learn how to modularize your code into ES6 modules using the export and import keywords. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Export](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fv8.dev" alt="Logo" /> V8 - Modules](https://v8.dev/features/modules) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - A Practical guide to ES6 modules](https://www.freecodecamp.org/news/how-to-use-es6-modules-and-why-theyre-important-a9b20b480773/) ### Intl Learn how to localize your website using the Intl API. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Date Time Format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.bitsrc.io" alt="Logo" /> New Intl APIs in JavaScript](https://blog.bitsrc.io/new-intl-apis-in-javascript-c50dc89d2cf3) ### Canvas Learn how to paint graphics onto a canvas. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Canvas tutorial](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Tutorial) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Manipulating Pixels Using Canvas](https://css-tricks.com/manipulating-pixels-using-canvas/) ### Documentation Learn how to create good documentation and why it is important. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjsdoc.app" alt="Logo" /> Getting Started with JSDoc](https://jsdoc.app/about-getting-started.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.writethedocs.org" alt="Logo" /> A beginner’s guide to writing documentation](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> Write Good Documentation](https://hackernoon.com/write-good-documentation-6caffb9082b4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> The power of jsDoc](https://dev.to/gmartigny/the-power-of-jsdoc-272d) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Document your Javascript code with JSDoc](https://dev.to/paulasantamaria/document-your-javascript-code-with-jsdoc-2fbf) ### Best Practices Learn the best practices of writing Javascript. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - JavaScript guidelines](https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/JavaScript) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Airbnb - JavaScript Style Guide](https://github.com/airbnb/javascript) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Principles of Writing Consistent, Idiomatic JavaScript](https://github.com/rwaldron/idiomatic.js/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> 5 JavaScript Style Guides](https://codeburst.io/5-javascript-style-guides-including-airbnb-github-google-88cbc6b2b7aa) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> JavaScript Style Guide and Coding Conventions](https://www.w3schools.com/js/js_conventions.asp) ### The Browser ### Standardization Learn why web standards are important and how new specifications are standardised. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Web Standards](https://en.wikipedia.org/wiki/Web_standards) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.elcom.com.au" alt="Logo" /> What Are Web Standards?](https://www.elcom.com.au/resources/blog/web-standards) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frobertnyman.com" alt="Logo" /> A Comprehensive Explanation of Web Standards](https://robertnyman.com/2007/05/21/what-are-web-standards-a-comprehensive-explanation-of-what-is-comprised-in-the-term/) #### W3C Learn what W3C are doing and how they are moving the web forward. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - About](https://www.w3.org/standards/about.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Standards](https://www.w3.org/standards/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwebdiy.org" alt="Logo" /> W3C - Process](http://webdiy.org/w3c/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> Web Standards Guide](https://www.smashingmagazine.com/2019/01/web-standards-guide/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Groups](https://www.w3.org/community/groups/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> The W3C At Twenty-Five](https://www.smashingmagazine.com/2019/10/happy-birthday-w3c/) #### TC39 Learn what TC39 are doing and how they are moving the web forward. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2F2ality.com" alt="Logo" /> The TC39 process for ECMAScript features](https://2ality.com/2015/11/tc39-process.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - TC39](https://github.com/tc39) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.ecma-international.org" alt="Logo" /> Ecma International - Programme of work](https://www.ecma-international.org/memento/tc39.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Ecma International](https://en.wikipedia.org/wiki/Ecma_International) #### WHATWG Learn what WHATWG are doing and how they are moving the web forward. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwg.org" alt="Logo" /> WHATWG - FAQ](https://whatwg.org/faq) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fspec.whatwg.org" alt="Logo" /> WHATWG - Standards](https://spec.whatwg.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - WHATWG](https://developer.mozilla.org/en-US/docs/Glossary/WHATWG) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdzone.com" alt="Logo" /> W3C vs. WHATWG HTML5 Specs](https://dzone.com/articles/w3c-vs-whatwg-html5-specs) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhtml.spec.whatwg.org" alt="Logo" /> WHATWG - HTML](https://html.spec.whatwg.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - WHATWG](https://en.wikipedia.org/wiki/WHATWG) #### Specifications Learn how to read specifications developed by the standards committees. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ftimothygu.me" alt="Logo" /> How to Read the ECMAScript Specification](https://timothygu.me/es-howto/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Falistapart.com" alt="Logo" /> How to Read W3C Specs](https://alistapart.com/article/readspec/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.chenhuijing.com" alt="Logo" /> Learning CSS by reading specs](https://www.chenhuijing.com/blog/learning-css-by-reading-specifications/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> Understanding the CSS Specifications](https://www.w3.org/Style/CSS/read.en.html) ### Browser Engines Learn what a browser engine is and get an overview of the browser landscape and market share. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Medium - Browser Engines](https://medium.com/@jonbiro/browser-engines-chromium-v8-blink-gecko-webkit-98d6b0490968) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Comparison](https://en.wikipedia.org/wiki/Comparison_of_browser_engines) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - How Browsers Work](https://www.html5rocks.com/en/tutorials/internals/howbrowserswork/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ftextslashplain.com" alt="Logo" /> Demystifying Browsers](https://textslashplain.com/2020/02/09/demystifying-browsers/) #### Webkit Learn about the Webkit browser engine. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebkit.org" alt="Logo" /> Webkit](https://webkit.org/) #### Blink Learn about the Blink browser engine. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Blink](https://en.wikipedia.org/wiki/Blink_(browser_engine)) #### Gecko Learn about the Gecko browser engine. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Gecko](https://en.wikipedia.org/wiki/Gecko_(software)) ### HTTP Learn how data is distributed through the HTTP protocol. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTTP Glossary](https://developer.mozilla.org/en-US/docs/Glossary/HTTP) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - An overview of HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Hypertext Transfer Protocol](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) ### The Internet Learn the basics of how the internet works. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - How does the Internet work?](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/How_does_the_Internet_work) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - How the Internet Works in 5 Minutes](https://www.youtube.com/watch?v=7_LPdttKXPc) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.explainthatstuff.com" alt="Logo" /> Explain That Stuff - Internet](https://www.explainthatstuff.com/internet.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.stanford.edu" alt="Logo" /> Stanford - How Does the Internet Work?](https://web.stanford.edu/class/msande91si/www-spr04/readings/week1/InternetWhitepaper.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.hubspot.com" alt="Logo" /> How the Internet Works](https://blog.hubspot.com/marketing/how-the-internet-works) ### Polyfills Learn how it is possible to use polyfills to increase the browser support for your website. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Polyfill](https://developer.mozilla.org/en-US/docs/Glossary/Polyfill) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Introduction To Polyfills & Their Usage](https://medium.com/beginners-guide-to-mobile-web-development/introduction-to-polyfills-their-usage-9cd6db4b1923) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Polyfills and the evolution of the Web](https://www.w3.org/2001/tag/doc/polyfills/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fcaniuse.com" alt="Logo" /> Can I use](http://caniuse.com/) ### Debugging Learn about the basics concepts of debugging. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Inspect and Edit Pages and Styles](https://developers.google.com/web/tools/chrome-devtools/inspect-styles/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Cross browser testing](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Cross_browser_testing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> 5 things to remember for better debugging of your code](https://medium.com/dev-bits/5-things-to-remember-for-better-debugging-of-your-code-94b9bc3fb3df) #### Developer console Learn how to use the developer console to debug your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Console](https://developer.mozilla.org/en-US/docs/Web/API/Console) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Console API Reference](https://developers.google.com/web/tools/chrome-devtools/console/api) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Get Started with Chrome DevTools](https://developers.google.com/web/tools/chrome-devtools/javascript) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Console Utilities API Reference](https://developers.google.com/web/tools/chrome-devtools/console/utilities) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Debugging CSS](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Debugging_CSS) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Debugging HTML](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Debugging_HTML) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Debugging in Chrome](https://javascript.info/debugging-chrome) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fraygun.com" alt="Logo" /> 14 JavaScript debugging tips](https://raygun.com/javascript-debugging-tips) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> The definitive guide to debugging JavaScript](https://flaviocopes.com/javascript-debugging/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Chrome DevTools 101](https://www.youtube.com/watch?v=H0XScE08hy8) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Chrome Devs - Quickly monitor events](https://developers.google.com/web/updates/2015/05/quickly-monitor-events-from-the-console-panel) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - 14 Must Know Chrome Dev Tools Tricks](https://www.youtube.com/watch?v=xkzDaKwinA8) [](#accessibility) ## ➤ Accessibility ### The why Learn what accessibility is and why it is important. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Accessibility Fundamentals](https://developers.google.com/web/fundamentals/accessibility/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> A11ycasts with Rob Dodson](https://www.youtube.com/playlist?list=PLNYkxOF6rcICWx0C9LVWWVqvHlYJyqw7g) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fudacity.github.io" alt="Logo" /> Udacity - Chromevox Lite](http://udacity.github.io/ud891/lesson3-semantics-built-in/02-chromevox-lite/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Dev.to - Why Accessibility Matters](https://dev.to/lhoffmanwg1/why-accessibility-matters-39nl) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.abilitynet.org.uk" alt="Logo" /> Abilitynet - Why Accessibility Matters](https://www.abilitynet.org.uk/why-accessibility-matters) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.udacity.com" alt="Logo" /> Udacity - Web Accessibility](https://www.udacity.com/course/web-accessibility--ud891) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Headings, Landmarks, and Tabs](https://www.youtube.com/watch?v=HE2R86EZPMA) ### Screen Readers Learn about assistive technology such as screen readers that reads sections of the page aloud based on the current focus. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11yproject.com" alt="Logo" /> The A11Y Project - Screen Reader Myths](https://a11yproject.com/posts/people-who-use-screen-readers-dont-use-javascript/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11yproject.com" alt="Logo" /> The A11Y Project - NVDA Screen Reader](https://a11yproject.com/posts/getting-started-with-nvda/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11yproject.com" alt="Logo" /> The A11Y Project - OS X Voiceover](https://a11yproject.com/posts/getting-started-with-voiceover/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Screen Reader Survey](https://webaim.org/projects/screenreadersurvey7/) ### Accessibility tree Learn about the accessibility tree and how assistive technology uses it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The Accessibility Tree](https://developers.google.com/web/fundamentals/accessibility/semantics-builtin/the-accessibility-tree) #### ARIA Learn how to use ARIA descriptions an labels to help assistive technology understanding your website. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - ARIA Labels](https://developers.google.com/web/fundamentals/accessibility/semantics-aria/aria-labels-and-relationships) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Hiding and updating content](https://developers.google.com/web/fundamentals/accessibility/semantics-aria/hiding-and-updating-content) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11yproject.com" alt="Logo" /> The A11Y Project - ARIA States](https://a11yproject.com/posts/ARIA-states/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11yproject.com" alt="Logo" /> The A11Y Project - ARIA Properties](https://a11yproject.com/posts/ARIA-properties/) #### Accessible HTML Learn how to write HTML in such as way that assistive technology better understands it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Introduction to Semantics](https://developers.google.com/web/fundamentals/accessibility/semantics-builtin/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Accessibility HTML](https://developer.mozilla.org/en-US/docs/Learn/Accessibility/HTML) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Skip navigation](https://webaim.org/techniques/skipnav/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> w3c - Headings](https://www.w3.org/WAI/tutorials/page-structure/headings/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fguide.freecodecamp.org" alt="Logo" /> Freecodecamp - Semantic Elements](https://guide.freecodecamp.org/html/html5-semantic-elements/) ##### Alt text Learn how to use the alt attribute to provide a useful text alternative to this image. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Text Alternatives for Images](https://developers.google.com/web/fundamentals/accessibility/semantics-builtin/text-alternatives-for-images) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Accessible Images](https://webaim.org/techniques/images/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Alternative text](https://webaim.org/techniques/alttext/) #### Accessible CSS Learn how to write CSS in such as way that assistive technology better understands it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - CSS](https://webaim.org/techniques/css/) ### Accessible forms Learn how to build accessible forms that makes it usable to as many people as possible. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Forms](https://webaim.org/techniques/forms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fitnext.io" alt="Logo" /> Itnext - Form Accessibility Gudie](https://itnext.io/form-accessibility-a-practical-guide-4062b7e2dd14) ### UI States Learn how to make the state of each UI element clear. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Accessible Styles](https://developers.google.com/web/fundamentals/accessibility/accessible-styles) ### Keyboard Accessibility Learn how to make it easy for keyboard users to navigate your site. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Keyboard](https://webaim.org/techniques/keyboard/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> Smashing Magazine - Web with just a keyboard](https://www.smashingmagazine.com/2018/07/web-with-just-a-keyboard/) #### Focus Learn how to create a sensible tab order and how to make it easy for the users to locate the currently focused element. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Control focus with tabindex](https://web.dev/control-focus-with-tabindex/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Focus](https://developers.google.com/web/fundamentals/accessibility/focus/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Dom Order Matters](https://developers.google.com/web/fundamentals/accessibility/focus/dom-order-matters) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Using Tabindex](https://developers.google.com/web/fundamentals/accessibility/focus/using-tabindex) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Track Focus](https://developers.google.com/web/tools/chrome-devtools/accessibility/focus) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - :focus-visible](https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - :focus-within](https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-within) ### Accessible Colors Learn how to select colors in such a way that users, including those with visual disabilities, can perceive the content on the page. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Contrast and Color](https://webaim.org/articles/contrast/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11yproject.com" alt="Logo" /> The A11Y Project - Check contrast](https://a11yproject.com/posts/check-contrast-with-mobile-device/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11yproject.com" alt="Logo" /> The A11Y Project - What is color contrast?](https://a11yproject.com/posts/what-is-color-contrast/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstripe.com" alt="Logo" /> Designing accessible color systems](https://stripe.com/en-dk/blog/accessible-color-systems) ### Laws & Policies Learn about the governmental policies related to web accessibility. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Laws & Policies](https://www.w3.org/WAI/policies/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Laws around the world](https://webaim.org/articles/laws/world/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Section 508](https://webaim.org/standards/508/checklist) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - WCAG 2 Checklist](https://webaim.org/standards/wcag/checklist) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fa11y.dev" alt="Logo" /> A11Y.dev - Lawsuits](https://a11y.dev/470-digital-accessibility-cases-were-filed-in-q3-2018/) #### Audits Learn how to conduct an accessibility review to improve the overall experience of using your site. Remember, good accessibility equals good UX! * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Accessibility audits](https://web.dev/lighthouse-accessibility) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - How to review](https://developers.google.com/web/fundamentals/accessibility/how-to-review) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebaim.org" alt="Logo" /> Webaim - Accessibility Tools](https://webaim.org/articles/tools/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Accessibility Reference](https://developers.google.com/web/tools/chrome-devtools/accessibility/reference) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwave.webaim.org" alt="Logo" /> Webaim - Wave](http://wave.webaim.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fchrome.google.com" alt="Logo" /> Google Chrome - NoCoffee Extension](https://chrome.google.com/webstore/detail/nocoffee/jjeeggmbnhckmgdhmgdckeigabjfbddl) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.digitala11y.com" alt="Logo" /> Digital A11Y - Accessibility Plugins](https://www.digitala11y.com/accessibility-plug-ins-ie-chrome-firefox-browsers/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Accessibility for teams](https://developers.google.com/web/fundamentals/accessibility/a11y-for-teams) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.wuhcag.com" alt="Logo" /> WCAG 2.0 checklists](https://www.wuhcag.com/wcag-checklist/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> How to Meet WCAG (Quick Reference)](https://www.w3.org/WAI/WCAG21/quickref/) [](#web-components) ## ➤ Web Components ### Custom Elements Learn how to create new HTML tags with Custom Elements. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Custom Elements](https://developers.google.com/web/fundamentals/web-components/customelements) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using Custom Elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Creating a Custom Element from Scratch](https://css-tricks.com/creating-a-custom-element-from-scratch/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> Javascript.info - Custom Elements](https://javascript.info/custom-elements) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - An introduction to Custom Elements](https://dev.to/jamesrweb/an-introduction-to-custom-elements-5327) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fitnext.io" alt="Logo" /> itnext - Introduction to Web Components](https://itnext.io/introduction-to-web-components-part-i-custom-elements-4de6713cef9d) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Web Components](https://web.dev/web-components-io-2019/) ### HTML Templates Learn how to use HTML templates to create flexible templates that can then be used to populate the Shadow DOM. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using Templates & Slots](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_templates_and_slots) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> Javascript.info - Template Element](https://javascript.info/template-element) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - The Content Template element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/template) ### Shadow DOM Learn how to encapsulate your CSS using Shadow DOM. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Shadow DOM](https://developers.google.com/web/fundamentals/web-components/shadowdom) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Shadow Tree](https://developer.mozilla.org/en-US/docs/Glossary/Shadow_tree) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Encapsulating Style and Structure](https://css-tricks.com/encapsulating-style-and-structure-with-shadow-dom/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fitnext.io" alt="Logo" /> itnext - Introduction to Web Components](https://itnext.io/introduction-to-web-components-part-ii-shadow-dom-8d1d8e126332) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmeowni.ca" alt="Logo" /> Monica - Shadow DOM: fast and encapsulated styles](https://meowni.ca/posts/shadow-dom/) #### Shadow Parts Learn how to style the inside of a shadow tree from outside of that Shadow Tree by using Shadow Parts. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Fergald - CSS Shadow ::part and ::theme](https://github.com/fergald/docs/blob/master/explainers/css-shadow-parts-1.md) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - ::part](https://developer.mozilla.org/en-US/docs/Web/CSS/::part) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - CSS Shadow Parts](https://www.w3.org/TR/css-shadow-parts-1/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmeowni.ca" alt="Logo" /> Monica - ::part and ::theme, an explainer](https://meowni.ca/posts/part-theme-explainer/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - CSS Shadow Parts](https://www.youtube.com/watch?v=yVrvOueeb3s) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.chromestatus.com" alt="Logo" /> Chrome Status - ::part and ::theme](https://www.chromestatus.com/features/5763933658939392) #### Slots Learn how to compose Custom Elements by using slots. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Falligator.io" alt="Logo" /> Alligator.io - Composing Custom Elements](https://alligator.io/web-components/composing-slots-named-slots/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> Javascript.info - Slots Composition](https://javascript.info/slots-composition) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTML <slot> element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/slot) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcomponent.kitchen" alt="Logo" /> Component.kitchen - A history of the HTML slot element](https://component.kitchen/blog/posts/a-history-of-the-html-slot-element) ### Best practices Get familiar with best practices when it comes to building Web Components. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Custom Element Best Practices](https://developers.google.com/web/fundamentals/web-components/best-practices) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.webcomponents.org" alt="Logo" /> Webcomponents.org - Web Components Best Practices](https://www.webcomponents.org/community/articles/web-components-best-practices) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> mateusortiz - Web Components the Right Way](https://github.com/mateusortiz/webcomponents-the-right-way) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Making Web Components for Different Contexts](https://dev.to/equinusocio/making-web-components-for-different-contexts-25ed) ### Constructible Stylesheets Learn how the Constructible Stylesheets proposal enables reusable styles when using shadow dom. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Constructable Stylesheets](https://developers.google.com/web/updates/2019/02/constructable-stylesheets) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwicg.github.io" alt="Logo" /> W3C - Constructable Stylesheet Objects](https://wicg.github.io/construct-stylesheets/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Why Would Anyone Use Constructible Stylesheets](https://dev.to/westbrook/why-would-anyone-use-constructible-stylesheets-anyways-19ng) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Benjamin Farrel - Adopt a Design System](https://medium.com/swlh/adopt-a-design-system-inside-your-web-components-with-constructable-stylesheets-dd24649261e) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> WICG - Constructable Stylesheet Objects](https://github.com/WICG/construct-stylesheets/blob/gh-pages/explainer.md) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.chromestatus.com" alt="Logo" /> Chrome Status - Constructible Stylesheets](https://www.chromestatus.com/feature/5394843094220800) ### Form Participation Learn how the Form Participation API proposal enables elements, other than built-in form control elements, to participate in form submission and validation. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.google.com" alt="Logo" /> Form Participation API Explained](https://docs.google.com/document/d/1JO8puctCSpW-ZYGU8lF-h4FWRIDQNDVexzHoOQ2iQmY/edit) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.chromestatus.com" alt="Logo" /> Chrome Status - Form-associated custom elements](https://www.chromestatus.com/features/4708990554472448) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> web-platform-tests - Form Participation](https://github.com/web-platform-tests/wpt/tree/master/custom-elements/form-associated) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Form-associated custom elements](https://developers.google.com/web/updates/2019/09/nic77#form-associated_custom_elements) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - More capable form controls](https://web.dev/more-capable-form-controls/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhtml.spec.whatwg.org" alt="Logo" /> W3C - Creating a form-associated custom element](https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements-face-example) [](#progressive-webapps) ## ➤ Progressive Webapps ### API's ### Storage Learn how to store data for your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Storage](https://developer.mozilla.org/en-US/docs/Web/API/Storage_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - View And Edit Local Storage](https://developers.google.com/web/tools/chrome-devtools/storage/localstorage) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Client-side storage](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Client-side_storage) ### Routing Learn what routing means in single page applications. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.pshrmn.com" alt="Logo" /> How Single-Page Applications Work](https://blog.pshrmn.com/how-single-page-applications-work/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstaticapps.org" alt="Logo" /> Static Apps - Routing URLs in Static Web Apps](https://staticapps.org/articles/routing-urls-in-static-apps/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fpennyforyourcode.com" alt="Logo" /> Routing With Single Page Applications or Client Side Routing](https://pennyforyourcode.com/tldr-routing-with-single-page-applications-or-client-side-routing-327626cdc5dd) #### History API Learn how to use the history API to add single page applicaiton routing to your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Working with the History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API/Working_with_the_History_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Single-page application routing in vanilla JavaScript](https://medium.com/@george.norberg/history-api-getting-started-36bfc82ddefc) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Using the HTML5 History API](https://css-tricks.com/using-the-html5-history-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> The History API](https://flaviocopes.com/history-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - History API: Scroll Restoration](https://developers.google.com/web/updates/2015/09/history-api-scroll-restoration) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - The Document Base URL element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base) ### Service Workers Learn how to register a service worker to provide a rich native-like experience. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Service Workers: an Introduction](https://developers.google.com/web/fundamentals/primers/service-workers) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The Service Worker Lifecycle](https://developers.google.com/web/fundamentals/primers/service-workers/lifecycle) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Service Worker Registration](https://developers.google.com/web/fundamentals/primers/service-workers/registration) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Service Worker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - High-performance service worker loading](https://developers.google.com/web/fundamentals/primers/service-workers/high-performance-loading) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodelabs.developers.google.com" alt="Logo" /> Codelabs - Scripting the service worker](https://codelabs.developers.google.com/codelabs/pwa-scripting-the-service-worker/index.html?index=..%2F..dev-pwa-training#0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodelabs.developers.google.com" alt="Logo" /> Codelabs - Caching files with the service worker](https://codelabs.developers.google.com/codelabs/pwa-caching-service-worker/index.html?index=..%2F..dev-pwa-training#0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Codelabs - Adding a Service Worker](https://developers.google.com/web/fundamentals/codelabs/offline) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Debugging Service Workers](https://developers.google.com/web/fundamentals/codelabs/debugging-service-workers) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjakearchibald.com" alt="Logo" /> Caching best practices](https://jakearchibald.com/2016/caching-best-practices/) #### Offline first Learn how to make your web app working offline with an offline first approach. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The Offline Cookbook](https://developers.google.com/web/fundamentals/instant-and-offline/offline-cookbook) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.udacity.com" alt="Logo" /> Udacity - Offline Web Applications](https://www.udacity.com/course/offline-web-applications--ud899) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fofflinefirst.org" alt="Logo" /> Offline First](http://offlinefirst.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Offline UX Considerations](https://developers.google.com/web/fundamentals/instant-and-offline/offline-ux) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Offline Storage for Progressive Web Apps](https://developers.google.com/web/fundamentals/instant-and-offline/web-storage/offline-for-pwa) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodelabs.developers.google.com" alt="Logo" /> Codelabs - Offline quickstart](https://codelabs.developers.google.com/codelabs/pwa-offline-quickstart/index.html?index=..%2F..dev-pwa-training#0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodelabs.developers.google.com" alt="Logo" /> Codelabs - Adding a Service Worker and Offline into your Web App](https://codelabs.developers.google.com/codelabs/offline/index.html?index=..%2F..%2Findex#0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Supercharged - Offline Links](https://www.youtube.com/watch?v=7fnpsF9tMXc) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Online and offline events](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/Online_and_offline_events) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Making PWAs work offline](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Offline_Service_workers) #### Push notifications Learn how to add push notifications to your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Adding Push Notifications to a Web App](https://developers.google.com/web/fundamentals/codelabs/push-notifications/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - How to make PWAs re-engageable](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Re-engageable_Notifications_Push) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Notifications API](https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API) ### Web App manifest Learn how to tell the browser about your web app and how it should behave when 'installed' by creating a web app manifest. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Web App Manifest](https://developers.google.com/web/fundamentals/web-app-manifest/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Add a web app manifest](https://web.dev/add-manifest/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Web App Manifest](https://www.w3.org/TR/appmanifest/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - How to make PWAs installable](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Installable_PWAs) ### Add to homescreen Learn how to make your web app installable. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Installable](https://web.dev/installable) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - App Install Banners](https://developers.google.com/web/fundamentals/app-install-banners/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Add to Home screen](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Add_to_home_screen) ### Pointer Events Learn how to handle inputs from pointing devices such as a mouse, pen/stylus or touch. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Pointer Events](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Add Touch to Your Site](https://developers.google.com/web/fundamentals/design-and-ux/input/touch) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Pointing the Way Forward](https://developers.google.com/web/updates/2016/10/pointer-events) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Touch Action Options](https://developers.google.com/web/updates/2016/10/touch-action) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Pointer Events](https://www.w3.org/TR/pointerevents/) ### Loading Performance ### App shell Learn how to use an app shell to provide an instant and reliable experience to users on repeat visits * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The App Shell Model](https://developers.google.com/web/fundamentals/architecture/app-shell) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Architecture of an app](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/App_structure) ### Render-Blocking Resources Learn about render-blocking resources and why they are bad for the user-experience. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Render-blocking resources](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Loading#Render-blocking_resources) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Render-Blocking Resources](https://developers.google.com/web/tools/lighthouse/audits/blocking-resources) ### Compression Learn how to minimize the overall download size by optimizing and compressing resources. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Optimizing Encoding and Transfer Size](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/optimize-encoding-and-transfer) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Replace Animated GIFs with Video](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/replace-animated-gifs-with-video/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsquoosh.app" alt="Logo" /> Squoosh](https://squoosh.app/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Text Content](https://developers.google.com/web/fundamentals/performance/get-started/textcontent-3) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Optimize Images](https://developers.google.com/web/tools/lighthouse/audits/optimize-images) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Reduce JavaScript execution time](https://web.dev/bootup-time/) ### Performance metrics Learn why it is important to measure performance and which metrics you should prioritize. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - User-centric Performance Metrics](https://developers.google.com/web/fundamentals/performance/user-centric-performance-metrics) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.udacity.com" alt="Logo" /> Udacity - Website Performance Optimization](https://www.udacity.com/course/website-performance-optimization--ud884) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.udacity.com" alt="Logo" /> Udacity - Browser Rendering Optimization](https://www.udacity.com/course/browser-rendering-optimization--ud860) #### Largest Contentful Paint Learn about Largest Contentful Paint and how it impacts the overall performance. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Largest Contentful Paint](https://web.dev/lcp/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Lighthouse Largest Contentful Paint](https://web.dev/lighthouse-largest-contentful-paint) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Medium - New Performance Metric: What is Largest Contentful Paint?](https://medium.com/speedrank-app/new-performance-metric-what-is-largest-contentful-paint-dc784a497dd5) #### Total Blocking Time Learn about Total Blocking Time and how it impacts the overall performance. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - First CPU Idle](https://web.dev/first-cpu-idle) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> Google Devs - Total Blocking Time](https://web.dev/tbt) #### Time to Interactive Learn about Time to Interactive and how it impacts the overall performance. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Total Blocking Time](https://web.dev/lighthouse-total-blocking-time/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Time to Interactive](https://developers.google.com/web/tools/lighthouse/audits/time-to-interactive) ### Lazy Loading Learn how to use lazy loading to lower the initial page payload and load time. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Lazy Loading Images and Video](https://developers.google.com/web/fundamentals/performance/lazy-loading-guidance/images-and-video) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faddyosmani.com" alt="Logo" /> Addy Osmani - Lazy Loading Images](https://addyosmani.com/blog/lazy-loading/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Native lazy-loading for the web](https://web.dev/native-lazy-loading/) #### Dynamic Import Learn how to use dynamic import to lazy load javascript. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fv8.dev" alt="Logo" /> V8 - Dynamic import()](https://v8.dev/features/dynamic-import) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> JavaScript dynamic import() & export](https://medium.com/@WebReflection/javascript-dynamic-import-export-b0e8775a59d4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Dynamic Import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#Dynamic_Imports) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> TC39 - proposal-dynamic-import](https://github.com/tc39/proposal-dynamic-import) #### Offscreen images Learn why offscreen images increase the load time and how to avoid them by lazy loading images. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Defer offscreen images](https://web.dev/offscreen-images/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Properly Size Images](https://developers.google.com/web/tools/lighthouse/audits/oversized-images) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Native lazy-loading for the web](https://web.dev/native-lazy-loading) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faddyosmani.com" alt="Logo" /> Addy Osmani - Native image lazy-loading for the web!](https://addyosmani.com/blog/lazy-loading/) ### Critical Request Chains Learn about the critical request chains and how to find them in your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Critical Request Chains](https://developers.google.com/web/tools/lighthouse/audits/critical-request-chains) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Minimize critical requests depth](https://web.dev/critical-request-chains) ### Tree shaking Learn how to use tree shaking to eliminate dead code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Reduce JavaScript Payloads](https://developers.google.com/web/fundamentals/performance/optimizing-javascript/tree-shaking) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.keycdn.com" alt="Logo" /> How to Clean Up Your JavaScript](https://www.keycdn.com/blog/tree-shaking) ### Codesplitting Learn about codesplitting an how dividing your code into multiple chunks makes your web app faster. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Reduce JavaScript Payloads](https://developers.google.com/web/fundamentals/performance/optimizing-javascript/code-splitting) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.creativebloq.com" alt="Logo" /> All you need to know about JavaScript code splitting](https://www.creativebloq.com/how-to/all-you-need-to-know-about-javascript-code-splitting) ### PRPL Pattern Learn how to use the PRPL pattern to make web apps more performant. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The PRPL Pattern](https://developers.google.com/web/fundamentals/performance/prpl-pattern/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - JavaScript Start-up Optimization](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/javascript-startup-optimization) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbuilding.calibreapp.com" alt="Logo" /> Ben Schwarz - Real world performance](https://building.calibreapp.com/beyond-the-bubble-real-world-performance-9c991dcd5342?gi=76804aa8f46e) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> The Cost of Javascript](https://medium.com/@addyosmani/the-cost-of-javascript-in-2018-7d8950fbb5d4) ### Resource Prioritization Learn about resource prioritization and how to inform the browser about the importance of a resource. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Resource Prioritization](https://developers.google.com/web/fundamentals/performance/resource-prioritization) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.igvita.com" alt="Logo" /> Eliminating Roundtrips with Preconnect](https://www.igvita.com/2015/08/17/eliminating-roundtrips-with-preconnect/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Addy Osmani - Preload, Prefetch And Priorities in Chrome](https://medium.com/reloading/preload-prefetch-and-priorities-in-chrome-776165961bbf) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Preconnect to required origins](https://web.dev/uses-rel-preconnect/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2F3perf.com" alt="Logo" /> Preload, prefetch and other <link> tags](https://3perf.com/blog/link-rels/) ### Caching Learn about caching and how it can be uses to make web apps load faster. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - HTTP Caching](https://developers.google.com/web/fundamentals/performance/get-started/httpcaching-6) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - HTTP caching](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching) ### Rendering Performance ### Rendering Learn about rendering, how a page is rendered and why it is important to keep your web app interactive and smooth running. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Constructing the Object Model](https://developers.google.com/web/fundamentals/performance/critical-rendering-path/constructing-the-object-model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Rendering Performance](https://developers.google.com/web/fundamentals/performance/rendering) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Render-tree Construction](https://developers.google.com/web/fundamentals/performance/critical-rendering-path/render-tree-construction) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Render Blocking CSS](https://developers.google.com/web/fundamentals/performance/critical-rendering-path/render-blocking-css) ### Event loop Learn about the event loop and how Javascript simulate like it’s running our commands in a multi-thread environment. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fyoutu.be" alt="Logo" /> Youtube - Jake Archibald: In The Loop](https://youtu.be/cCOL7MC4Pl0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Understanding JavaScript](https://medium.com/@muratcatal/understanding-javascript-heap-stack-event-loops-and-callback-queue-6fdec3cfe32e) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> JavaScript Event Loop Explained](https://medium.com/front-end-weekly/javascript-event-loop-explained-4cd26af121d4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - What the heck is the event loop anyway?](https://www.youtube.com/watch?v=8aGhZQkoFbQ) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> The JavaScript Event Loop](https://flaviocopes.com/javascript-event-loop/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - JavaScript Visualized: Event Loop](https://dev.to/lydiahallie/javascript-visualized-event-loop-3dif) #### Microtask Learn about microtasks and the microtask queue. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjakearchibald.com" alt="Logo" /> Tasks, microtasks, queues and schedules](https://jakearchibald.com/2015/tasks-microtasks-queues-and-schedules/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using microtasks in JavaScript](https://developer.mozilla.org/en-US/docs/Web/API/HTML_DOM_API/Microtask_guide) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Microtasks and macrotasks](https://javascript.info/event-loop) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Microtasks](https://javascript.info/microtask-queue) #### Stack Learn about the stack and how to investigate the staack trace when debugging. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.scalyr.com" alt="Logo" /> Javascript Stack Trade - Using it to debug](https://www.scalyr.com/blog/javascript-stack-trace-understanding-it-and-using-it-to-debug/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - console.trace()](https://developer.mozilla.org/en-US/docs/Web/API/Console/trace) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fv8.dev" alt="Logo" /> V8 - Stack trace API](https://v8.dev/docs/stack-trace-api) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Confused about Stack and Heap?](https://medium.com/fhinkel/confused-about-stack-and-heap-2cf3e6adb771) #### Heap Learn about the heap and how to investigate the heap snapshots when debugging. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Memory Problems](https://developers.google.com/web/tools/chrome-devtools/memory-problems/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Memory Terminology](https://developers.google.com/web/tools/chrome-devtools/memory-problems/memory-101) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - How to Record Heap Snapshots](https://developers.google.com/web/tools/chrome-devtools/memory-problems/heap-snapshots) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Confused about Stack and Heap?](https://medium.com/fhinkel/confused-about-stack-and-heap-2cf3e6adb771) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - How to Use the Allocation Profiler Tool](https://developers.google.com/web/tools/chrome-devtools/memory-problems/allocation-profiler) ### RAIL Model Learn how to use the RAIL model to ensure a good user experience. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - RAIL](https://developers.google.com/web/fundamentals/performance/rail) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Why Performance Matters](https://developers.google.com/web/fundamentals/performance/why-performance-matters/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Get Started With Analyzing](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Animations and Performance](https://developers.google.com/web/fundamentals/design-and-ux/animations/animations-and-performance) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - CSS Versus JavaScript Animations](https://developers.google.com/web/fundamentals/design-and-ux/animations/css-vs-javascript) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Choosing the Right Easing](https://developers.google.com/web/fundamentals/design-and-ux/animations/choosing-the-right-easing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Animating Modal Views](https://developers.google.com/web/fundamentals/design-and-ux/animations/animating-modal-views) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS and JavaScript animation performance](https://developer.mozilla.org/en-US/docs/Web/Performance/CSS_JavaScript_animation_performance) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Performance fundamentals](https://developer.mozilla.org/en-US/docs/Web/Performance/Fundamentals) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Fast By Default](https://www.youtube.com/watch?v=_srJ7eHS3IM) #### requestAnimationFrame Learn how to use the requestAnimationFrame API to create butter-smooth animations. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Optimize JavaScript Execution](https://developers.google.com/web/fundamentals/performance/rendering/optimize-javascript-execution) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - requestAnimationFrame()](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame) #### requestIdleCallback Learn how to use the requestIdleCallback to defer heavy tasks. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Background Tasks API](https://developer.mozilla.org/en-US/docs/Web/API/Background_Tasks_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Dev - requestIdleCallback](https://developers.google.com/web/updates/2015/08/using-requestidlecallback?hl=en) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - requestIdleCallback()](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) ### Critical Rendering Path Learn about the critical rendering path and how to identify it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Critical Rendering Path](https://developers.google.com/web/fundamentals/performance/critical-rendering-path/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Critical Rendering Path](https://developer.mozilla.org/en-US/docs/Web/Performance/Critical_rendering_path) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Understanding the critical rendering path](https://medium.com/@luisvieira_gmr/understanding-the-critical-rendering-path-rendering-pages-in-1-second-735c6e45b47a) ### The Pixel Pipeline Learn about the five key points in the pixels-to-screen pipeline. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The pixel pipeline](https://developers.google.com/web/fundamentals/performance/rendering#the_pixel_pipeline) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faerotwist.com" alt="Logo" /> Pixels are expensive](https://aerotwist.com/blog/pixels-are-expensive/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Google Devs - The Applied Science of Runtime Performance](https://www.youtube.com/watch?v=RCFQu0hK6bU) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcsstriggers.com" alt="Logo" /> CSS Triggers](https://csstriggers.com/) #### Style calculations Learn how to optimize your CSS to avoid heavy style calculations. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Style Calculations](https://developers.google.com/web/fundamentals/performance/rendering/reduce-the-scope-and-complexity-of-style-calculations) #### Transforms Learn about transforms and how it is possible to avoid both layout and paint. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Use transform and opacity for animations](https://developers.google.com/web/fundamentals/performance/rendering/stick-to-compositor-only-properties-and-manage-layer-count#use_transform_and_opacity_changes_for_animations) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Achieving 60 FPS Animations with CSS3](https://medium.com/outsystems-experts/how-to-achieve-60-fps-animations-with-css3-db7b98610108) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - High Performance Animations](https://www.html5rocks.com/en/tutorials/speed/high-performance-animations/) #### Paint areas Learn about paint areas and how it is possible to reduce them. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Paint Areas](https://developers.google.com/web/fundamentals/performance/rendering/simplify-paint-complexity-and-reduce-paint-areas) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Browser painting](https://css-tricks.com/browser-painting-and-considerations-for-web-performance/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - Avoiding Unnecessary Paints](https://www.html5rocks.com/en/tutorials/speed/unnecessary-paints/) #### Layout Trashing Learn about layout trashing and how to avoid it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Layout Thrashing](https://developers.google.com/web/fundamentals/performance/rendering/avoid-large-complex-layouts-and-layout-thrashing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.idrsolutions.com" alt="Logo" /> Beware JavaScript Layout Thrashing!](https://blog.idrsolutions.com/2014/08/beware-javascript-layout-thrashing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevhints.io" alt="Logo" /> Layout thrashing cheatsheet](https://devhints.io/layout-thrashing) #### Layers Learn about layers and how to promote an element to another layer. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Manage Layer Count](https://developers.google.com/web/fundamentals/performance/rendering/stick-to-compositor-only-properties-and-manage-layer-count) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - Accelerated Rendering in Chrome](https://www.html5rocks.com/en/tutorials/speed/layers/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdassur.ma" alt="Logo" /> Layers and how to force them](https://dassur.ma/things/forcing-layers/) #### Debounce Learn how to debounce computationally expensive code to avoid blocking the UI. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Debounce Your Input Handlers](https://developers.google.com/web/fundamentals/performance/rendering/debounce-your-input-handlers) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> What is Debouncing?](https://medium.com/@jamischarles/what-is-debouncing-2505c0648ff1) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flevelup.gitconnected.com" alt="Logo" /> Level Up - Debounce in JavaScript](https://levelup.gitconnected.com/debounce-in-javascript-improve-your-applications-performance-5b01855e086) ### CSS Containment Learn how to use CSS containment to improve the performance of your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - CSS Containment](https://developers.google.com/web/updates/2016/06/css-containment) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - CSS Containment Module](https://www.w3.org/TR/css-contain-1/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblogs.igalia.com" alt="Logo" /> An introduction to CSS Containment](https://blogs.igalia.com/mrego/2019/01/11/an-introduction-to-css-containment/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Contain](https://developer.mozilla.org/en-US/docs/Web/CSS/contain) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - CSS containment](https://css-tricks.com/css-containment/) ### Web Workers Learn how to use web workers to run a script operation in a background thread separate from the main execution thread. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Web Workers API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - The Basics of Web Workers](https://www.html5rocks.com/en/tutorials/workers/basics/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdassur.ma" alt="Logo" /> When should you be using Web Workers?](https://dassur.ma/things/when-workers/) ### Security ### HTTPS Learn about HTTPS and why a website should always be protected with HTTPS. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Why HTTPS Matters](https://developers.google.com/web/fundamentals/security/encrypt-in-transit/why-https) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Enabling HTTPS on Your Servers](https://developers.google.com/web/fundamentals/security/encrypt-in-transit/enable-https) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Mixed Content](https://developers.google.com/web/fundamentals/security/prevent-mixed-content/what-is-mixed-content) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Stories from the field](https://www.youtube.com/watch?v=GoXgl9r0Kjk) ### Browser Sandbox Learn about the sandbox security mechanism and how it restricts the execution environment. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Browser sandbox](https://web.dev/browser-sandbox/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Sandbox (computer security)](https://en.wikipedia.org/wiki/Sandbox_(computer_security)) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.howtogeek.com" alt="Logo" /> Howtogeek - Sandboxes Explained](https://www.howtogeek.com/169139/sandboxes-explained-how-theyre-already-protecting-you-and-how-to-sandbox-any-program/) ### OWASP Learn about the OWASP organization and how they help with web application security. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - OWASP](https://en.wikipedia.org/wiki/OWASP) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.owasp.org" alt="Logo" /> OWASP - About](https://www.owasp.org/index.php/About_The_Open_Web_Application_Security_Project) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.owasp.org" alt="Logo" /> OWASP - OWASP Top 10](https://www.owasp.org/images/7/72/OWASP_Top_10-2017_%28en%29.pdf.pdf) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcheatsheetseries.owasp.org" alt="Logo" /> OWASP - Cheatsheets](https://cheatsheetseries.owasp.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - OWASP](https://www.youtube.com/user/OWASPGLOBAL) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.sucuri.net" alt="Logo" /> OWASP Top 10 Security Risks](https://blog.sucuri.net/2018/10/owasp-top-10-security-risks-part-i.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Web application security](https://en.wikipedia.org/wiki/Web_application_security) #### Cross-Site Scripting Learn about cross-site scripting and how it is possible mitigate these kind of attacks. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Cross-site scripting](https://developer.mozilla.org/en-US/docs/Glossary/Cross-site_scripting) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.owasp.org" alt="Logo" /> OWASP - Cross-site Scripting (XSS)](https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcheatsheetseries.owasp.org" alt="Logo" /> OWASP - XSS Cheatsheet](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fexcess-xss.com" alt="Logo" /> Excess XSS](https://excess-xss.com/) #### Clickjacking Learn about clickjacking and how it is possible to mitigate these kind of attacks. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.owasp.org" alt="Logo" /> OWASP - Clickjacking](https://www.owasp.org/index.php/Clickjacking) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Clickjacking](https://en.wikipedia.org/wiki/Clickjacking) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Same-origin policy](https://web.dev/same-origin-policy/#how-to-prevent-clickjacking) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcheatsheetseries.owasp.org" alt="Logo" /> OWASP - Clickjacking Cheatsheet](https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html) ### Content Security Policy Learn about content security policy and how it can help to detect and mitigate certain types of attacks. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - CSP](https://developers.google.com/web/fundamentals/security/csp) ### Audits ### Performance budgets Learn about performance budgets and how you can create one for your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Performance Budgets](https://web.dev/performance-budgets-101) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Performance Budget](https://developers.google.com/web/tools/lighthouse/audits/budgets) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faddyosmani.com" alt="Logo" /> Addy Osmani - Start Performance Budgeting](https://addyosmani.com/blog/performance-budgets/) ### Lighthouse Learn about lighthouse and how it can be used to audit your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Lighthouse](https://developers.google.com/web/tools/lighthouse/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Staying off the Rocks](https://www.youtube.com/watch?v=NoRYn6gOtVo) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Measure](https://web.dev/measure) ### Chrome DevTools Learn about the Chrome DevTools and how it can be used to audit your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Chrome DevTools](https://developers.google.com/web/tools/chrome-devtools) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Inspect animations](https://developers.google.com/web/tools/chrome-devtools/inspect-styles/animations) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcalibreapp.com" alt="Logo" /> Investigate animation performance with DevTools](https://calibreapp.com/blog/investigate-animation-performance-with-devtools/) [](#build-tools) ## ➤ Build tools ### Package Managers Learn about package managers and how they make managing dependencies easier. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - How JavaScript package managers work](https://www.freecodecamp.org/news/javascript-package-managers-101-9afd926add0a/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.javascriptstuff.com" alt="Logo" /> Guide to JavaScript frontend package managers](https://www.javascriptstuff.com/javascript-frontend-package-managers/) #### NPM Learn about NPM and how it can be used to manage dependencies. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.npmjs.com" alt="Logo" /> npmjs - About npm](https://docs.npmjs.com/about-npm/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.npmjs.com" alt="Logo" /> npmjs - Getting started](https://docs.npmjs.com/getting-started/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Introduction to npm and basic npm commands](https://medium.com/beginners-guide-to-mobile-web-development/introduction-to-npm-and-basic-npm-commands-18aa16f69f6b) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fnodesource.com" alt="Logo" /> An Absolute Beginner's Guide to Using npm](https://nodesource.com/blog/an-absolute-beginners-guide-to-using-npm/) #### Yarn Learn about Yarn and how it can be used to manage dependencies. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fyarnpkg.com" alt="Logo" /> Yarnpkg - Getting Started](https://yarnpkg.com/en/docs/getting-started) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fengineering.fb.com" alt="Logo" /> Facebook Engineering - Yarn](https://engineering.fb.com/web/yarn-a-new-package-manager-for-javascript/) ### Module Bundlers Learn about module bundler and how they can help bundling your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - What is a module bundler?](https://dev.to/tanhauhau/what-is-module-bundler-and-how-does-it-work-3gp2) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - Let’s learn how module bundlers work](https://www.freecodecamp.org/news/lets-learn-how-module-bundlers-work-and-then-write-one-ourselves-b2e3fe6c88ae/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> JavaScript Bundlers, a Comparison](https://medium.com/@ajmeyghani/javascript-bundlers-a-comparison-e63f01f2a364) #### Rollup Learn how you can use Rollup to bundle your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frollupjs.org" alt="Logo" /> Rollup - Introduction](https://rollupjs.org/guide/en/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flengstorf.com" alt="Logo" /> How to Bundle JavaScript With Rollup](https://lengstorf.com/learn-rollup-js/) #### Webpack Learn how you can use Webpack to bundle your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebpack.js.org" alt="Logo" /> Webpack - Getting Started](https://webpack.js.org/guides/getting-started/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fauth0.com" alt="Logo" /> Webpack: A Gentle Introduction to the Module Bundler](https://auth0.com/blog/webpack-a-gentle-introduction/) #### Parcel Learn how you can use Parcel to bundle your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fparceljs.org" alt="Logo" /> Parcel - Getting Started](https://parceljs.org/getting_started.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> Parcel, a simpler webpack](https://flaviocopes.com/parcel/) #### Snowpack Learn how Snowpack can replace the traditional app bundler during development. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.snowpack.dev" alt="Logo" /> Snowpack](https://www.snowpack.dev/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.snowpack.dev" alt="Logo" /> Snowpack - Quickstart](https://www.snowpack.dev/#quickstart) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Snowpack](https://github.com/pikapkg/snowpack) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.pika.dev" alt="Logo" /> Pika - About](https://www.pika.dev/about/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.pika.dev" alt="Logo" /> A Future Without Webpack](https://www.pika.dev/blog/pika-web-a-future-without-webpack/) ### Linters and formatters Learn how you can improve your code quality with linters and formatters. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.gistia.com" alt="Logo" /> Improve Your JavaScript Code Quality With Linters](https://www.gistia.com/javascript-linters-formatter-prettier-eslint/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Why you should always use a Linter](https://medium.com/dailyjs/why-you-should-always-use-a-linter-and-or-pretty-formatter-bb5471115a76) #### Prettier Learn how you can use Prettier to format your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fprettier.io" alt="Logo" /> Prettier - What is Prettier?](https://prettier.io/docs/en/index.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.bitsrc.io" alt="Logo" /> Let the computer do the formatting](https://blog.bitsrc.io/let-the-computer-do-the-formatting-ddb799e8a068) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fprettier.io" alt="Logo" /> Prettier - Playground](https://prettier.io/playground/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fprettier.io" alt="Logo" /> Prettier - Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html) #### ESLint Learn how you can use ESLint to lint your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Feslint.org" alt="Logo" /> Eslint - Getting Started](https://eslint.org/docs/user-guide/getting-started) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Streamline Code Reviews with ESLint + Prettier](https://medium.com/javascript-scene/streamline-code-reviews-with-eslint-prettier-6fb817a6b51d) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.futurehosting.com" alt="Logo" /> Prettier vs ESLint: What’s The Difference?](https://www.futurehosting.com/blog/prettier-vs-eslint-whats-the-difference/) ### Task Runners Learn about task runners and how you can automate code execution. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dbswebsite.com" alt="Logo" /> The Advantages of Using Task Runners](https://www.dbswebsite.com/blog/the-advantages-of-using-task-runners/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> Being Productive With Task Runners](https://www.smashingmagazine.com/2016/06/harness-machines-productive-task-runners/) #### NPM Scripts Learn about NPM scripts and how you can run your own. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Why npm Scripts?](https://css-tricks.com/why-npm-scripts/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmichael-kuehnel.de" alt="Logo" /> Helpers and tips for npm run scripts](https://michael-kuehnel.de/tooling/2018/03/22/helpers-and-tips-for-npm-run-scripts.html) ### Transpilers Learn what transpilers are and why we need them. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fscotch.io" alt="Logo" /> Scotch - Javascript Transpilers](https://scotch.io/tutorials/javascript-transpilers-what-they-are-why-we-need-them) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fthenewstack.io" alt="Logo" /> What JavaScript Programmers Need to Know about Transpilers](https://thenewstack.io/javascript-transpilers-need-know/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Source-to-source compiler](https://en.wikipedia.org/wiki/Source-to-source_compiler) #### Babel Learn about Babel and how you can use it to transpile your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Complete Babel 7 Guide for Beginners](https://medium.com/@onlykiosk/complete-babel-7-guide-for-beginners-in-2019-7dd78214c464) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbabeljs.io" alt="Logo" /> Babel - What is Babel?](https://babeljs.io/docs/en/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbabeljs.io" alt="Logo" /> Babel - Usage Guide](https://babeljs.io/docs/en/usage) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sitepoint.com" alt="Logo" /> A Beginner’s Guide to Babel](https://www.sitepoint.com/babel-beginners-guide/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> Moving to ES6 — Babel and Transpilers](https://hackernoon.com/moving-to-es6-babel-and-transpilers-337921c025b1) #### Typescript Learn how to use Typescript and how it can help making your code typesafe. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.typescriptlang.org" alt="Logo" /> Typescript - Documentation](http://www.typescriptlang.org/docs/home.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Typescript: Why should one use i?](https://medium.com/tech-tajawal/typescript-why-should-one-use-it-a539faa92010) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Why TypeScript is the best way to write Front-end in 2019](https://medium.com/@jtomaszewski/why-typescript-is-the-best-way-to-write-front-end-in-2019-feb855f9b164) ### CSS Pre-processors Learn about CSS pre-processors and why we need them. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS preprocessor](https://developer.mozilla.org/en-US/docs/Glossary/CSS_preprocessor) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Advantages of Using a Preprocessor](https://medium.com/swlh/advantages-of-using-a-preprocessor-sass-in-css-eb7310179944) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Deconfusing Pre- and Post-processing](https://medium.com/@ddprrt/deconfusing-pre-and-post-processing-d68e3bd078a3) #### SASS Learn about SASS and how you can use it to simplify your styles. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsass-lang.com" alt="Logo" /> SASS - Guide](https://sass-lang.com/guide) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fraygun.com" alt="Logo" /> 10 Reasons to Use a CSS Preprocessor in 2018](https://raygun.com/blog/10-reasons-css-preprocessor/) #### PostCSS Learn about PostCSS and how you can use its ecosystem of plugins to extend your CSS build pipeline. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fpostcss.org" alt="Logo" /> PostCSS](https://postcss.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sitepoint.com" alt="Logo" /> What is PostCSS?](https://www.sitepoint.com/an-introduction-to-postcss/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> Introduction to PostCSS](https://flaviocopes.com/postcss/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.logrocket.com" alt="Logo" /> Getting started with PostCSS in 2019](https://blog.logrocket.com/getting-started-with-postcss-in-2019-484262a4d725/) ### Node.js Learn how to use Node.js. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fnodejs.org" alt="Logo" /> Node.js](https://nodejs.org) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fnodejs.dev" alt="Logo" /> Introduction to Node.js](https://nodejs.dev/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fnodejs.org" alt="Logo" /> Node.js - Guides](https://nodejs.org/en/docs/guides/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3schools.com" alt="Logo" /> W3Schools - Node.js tutorial](https://www.w3schools.com/nodejs/) [](#frameworks--libraries) ## ➤ Frameworks & Libraries ### lit-element Learn how to use lit-element for creating fast, lightweight web components. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flit-element.polymer-project.org" alt="Logo" /> lit-element](https://lit-element.polymer-project.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Lightning-fast templates](https://developers.google.com/web/updates/2019/02/lit-element-and-lit-html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvaadin.com" alt="Logo" /> Vaadin - Creating a LitElement project](https://vaadin.com/tutorials/lit-element/starting-a-lit-element-project) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Web Components: from zero to hero, part three](https://dev.to/thepassle/web-components-from-zero-to-hero-part-three-3c5h) ### Vue Learn about Vue and how you can use it for building web apps. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvuejs.org" alt="Logo" /> Vue](https://vuejs.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcli.vuejs.org" alt="Logo" /> Vue - CLI](https://cli.vuejs.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.taniarascia.com" alt="Logo" /> Getting Started with Vue](https://www.taniarascia.com/getting-started-with-vue/) ### React Learn about React and how you can use it for building web apps. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Freactjs.org" alt="Logo" /> React](https://reactjs.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - React](https://web.dev/react) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.taniarascia.com" alt="Logo" /> Getting Started with React](https://www.taniarascia.com/getting-started-with-react/) ### Angular Learn about Angular and how you can use it for building web apps. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fangular.io" alt="Logo" /> Angular](https://angular.io/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Angular](https://web.dev/angular) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcli.angular.io" alt="Logo" /> Angular - CLI](https://cli.angular.io/) ### Svelte Learn about Svelte and how it can convert your component into highly efficient imperative code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsvelte.dev" alt="Logo" /> Svelte](https://svelte.dev/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Svelte FAQ](https://github.com/sveltejs/svelte/wiki/FAQ) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsvelte.dev" alt="Logo" /> Svelte - Rethinking reactivity](https://svelte.dev/blog/svelte-3-rethinking-reactivity) ### Stencil Learn how Stencil can be used for generating small, fast web components. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstenciljs.com" alt="Logo" /> Stencil](https://stenciljs.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Falligator.io" alt="Logo" /> Alligator - Getting Started With Stencil](https://alligator.io/stencil/getting-started/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> How to Build Reusable Web Components Using Stenciljs](https://codeburst.io/how-to-build-web-components-using-stenciljs-afacc5451c2d) [](#testing) ## ➤ Testing ### Testing Methodologies Learn about various software testing methodologies and why it is important to test your code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Software testing](https://en.wikipedia.org/wiki/Software_testing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsmartbear.com" alt="Logo" /> Software Testing Methodologies](https://smartbear.com/learn/automated-testing/software-testing-methodologies/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.inflectra.com" alt="Logo" /> Learn The Methods & Tools](https://www.inflectra.com/ideas/topic/testing-methodologies.aspx) #### Unit Testing Learn about unit testing and how it can be used to test individual units of code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> Unit Testing Tutorial](https://www.guru99.com/unit-testing-guide.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Unit testing](https://en.wikipedia.org/wiki/Unit_testing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> What is Unit Testing?](https://www.tutorialspoint.com/software_testing_dictionary/unit_testing.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> The Arrange, Act and Assert (AAA) Pattern](https://medium.com/@pjbgf/title-testing-code-ocd-and-the-aaa-pattern-df453975ab80) #### Integration Testing Learn about integration testing and how it can be used to test modules as a group. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> Integration Testing Tutorial](https://www.guru99.com/integration-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> What is Integration Testing?](https://www.tutorialspoint.com/software_testing_dictionary/integration_testing.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> Integration Testing](http://softwaretestingfundamentals.com/integration-testing/) #### System Testing Learn about system testing and how it can be used to test the fully integrated software product. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> System Testing Tutorial](https://www.guru99.com/system-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> What is System Testing?](https://www.tutorialspoint.com/software_testing_dictionary/system_testing.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> System Testing](http://softwaretestingfundamentals.com/system-testing/) #### Acceptance Testing Learn about acceptance testing and how it can be used to test the software for acceptability * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> What is User Acceptance Testing?](https://www.guru99.com/user-acceptance-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> Acceptance Testing](http://softwaretestingfundamentals.com/acceptance-testing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> What is Acceptance Testing?](https://www.tutorialspoint.com/software_testing_dictionary/acceptance_testing.htm) #### Smoke Testing Learn about smoke testing and how it can be used to ensure that critical functionalities of the program are working fine. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> Sanity Testing Vs Smoke Testing](https://www.guru99.com/smoke-sanity-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> Smoke Testing](http://softwaretestingfundamentals.com/smoke-testing/) #### Performance Testing Learn about performance testing and how it can be used to determine the responsiveness and stability of a program. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> Performance Testing Tutorial](https://www.guru99.com/performance-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> Performance Testing](http://softwaretestingfundamentals.com/performance-testing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Software performance testing](https://en.wikipedia.org/wiki/Software_performance_testing) #### Usability Testing Learn about usability testing and how it can be used to determine if the system is easily usable for the end-user. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> What is Usability Testing?](https://www.guru99.com/usability-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> Usability Testing](http://softwaretestingfundamentals.com/usability-testing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Usability testing](https://en.wikipedia.org/wiki/Usability_testing) #### White Box Testing Learn about white box testing and how it can be used to test the software's internal structure, design, and coding. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> What is White Box Testing?](https://www.guru99.com/white-box-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> White Box Testing](http://softwaretestingfundamentals.com/white-box-testing/) #### Black Box Testing Learn about black box testing and how a test can be carried out without looking at the internal code. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> What is Black Box Testing?](https://www.guru99.com/black-box-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsoftwaretestingfundamentals.com" alt="Logo" /> Black Box Testing](http://softwaretestingfundamentals.com/black-box-testing/) #### Automated Testing Learn about automated testing and when it should be applied. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsmartbear.com" alt="Logo" /> What is Automated Testing?](https://smartbear.com/learn/automated-testing/what-is-automated-testing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> Automated Testing Tutorial](https://www.guru99.com/automation-testing.html) #### Manual Testing Learn about manual testing and when it should be applied. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> Manual Testing Tutorial](https://www.guru99.com/manual-testing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Manual Testing](https://en.wikipedia.org/wiki/Manual_testing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> What is Manual Testing?](https://www.tutorialspoint.com/software_testing_dictionary/manual_testing.htm) ### Continuous integration Learn about continuous integration and it can enable iterative software development. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Continuous Integration Explained](https://dev.to/markoa/continuous-integration-explained-59f9) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Continuous Integration Tutorial](https://www.tutorialspoint.com/continuous_integration/index.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) ### A/B Testing Learn about A/B testing and how it can be used to optimize your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - A/B testing: introduction](https://dev.to/ice_lenor/ab-testing-introduction-3jpd) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - When Not To A/B Test](https://dev.to/ice_lenor/when-not-to-ab-test-4cc7) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.optimizely.com" alt="Logo" /> A/B Testing](https://www.optimizely.com/optimization-glossary/ab-testing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - A/B testing](https://en.wikipedia.org/wiki/A/B_testing) ### Test Runners Learn about test runners and how they can help running tests. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Famzotti.github.io" alt="Logo" /> Classifications of Testing Software](https://amzotti.github.io/testing/2015/03/16/what-is-the-difference-between-a-test-runner-testing-framework-assertion-library-and-a-testing-plugin/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.udacity.com" alt="Logo" /> Udacity - Javascript Testing](https://www.udacity.com/course/javascript-testing--ud549) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> JavaScript Unit Testing Frameworks](https://www.guru99.com/javascript-unit-testing-frameworks.html) #### Karma Learn about the Karma test runner. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fkarma-runner.github.io" alt="Logo" /> Karma](https://karma-runner.github.io/latest/index.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Getting started with Karma and Mocha](https://medium.com/@jazcodes/getting-started-with-karma-and-mocha-for-automated-browser-tests-5ebb6cd02edf) #### Mocha Learn about the Mocha testing framework. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmochajs.org" alt="Logo" /> Mocha](https://mochajs.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.logrocket.com" alt="Logo" /> A quick and complete guide to Mocha testing](https://blog.logrocket.com/a-quick-and-complete-guide-to-mocha-testing-d0e0ea09f09d/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> How to test JavaScript with Mocha](https://codeburst.io/how-to-test-javascript-with-mocha-the-basics-80132324752e) #### Jasmine Learn about the Jasmine testing frameworks. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjasmine.github.io" alt="Logo" /> Jasmine](https://jasmine.github.io/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> How to set up a testing environment with Jasmine and karma](https://medium.com/bb-tutorials-and-thoughts/javascript-how-to-set-up-a-testing-environment-with-jasmine-and-karma-58591dd39734) #### Cypress Learn how to use Cypress for end-to-end-testing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.cypress.io" alt="Logo" /> Cypress](https://www.cypress.io/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebdevstudios.com" alt="Logo" /> End-to-End Testing with Cypress](https://webdevstudios.com/2018/11/13/end-to-end-testing-with-cypress-io/) #### Ava Learn about the Ava test runner. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Ava](https://github.com/avajs/ava) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fpusher.com" alt="Logo" /> A Fresh Take On JavaScript Testing](https://pusher.com/sessions/meetup/the-js-roundabout/ava-test-runner-a-fresh-take-on-javascript-testing-and-growing-an-open-source-project) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - How you can test your Node.js applications](https://www.freecodecamp.org/news/testing-your-nodejs-applications-with-ava-js-99e806a226a7/) ### Best Practices Learn about the best practices when it comes to testing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Javascript Testing Best Practices](https://github.com/goldbergyoni/javascript-testing-best-practices) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.quora.com" alt="Logo" /> What are the best practices in software Testing?](https://www.quora.com/What-are-the-best-practices-in-software-Testing) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.qasymphony.com" alt="Logo" /> 7 Software Testing Best Practices](https://www.qasymphony.com/blog/7-software-testing-best-practices/) [](#architecture--paradigms) ## ➤ Architecture & paradigms ### Paradigms ### Programming Paradigms Learn how programming languages can be categoried into different paraigmes based on their features. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Programming paradigm](https://en.wikipedia.org/wiki/Programming_paradigm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Introduction of Programming Paradigms](https://www.geeksforgeeks.org/introduction-of-programming-paradigms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> What Are JavaScript Programming Paradigms?](https://medium.com/javascript-in-plain-english/what-are-javascript-programming-paradigms-3ef0f576dfdb) ### Object Oriented Programming Learn about object oriented programming and how objects can make your code easier to read and debug. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Object-oriented JavaScript](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Object-oriented_JS) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - An introduction to Object-Oriented Programming](https://www.freecodecamp.org/news/an-introduction-to-object-oriented-programming-in-javascript-8900124e316a/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Introduction to Object Oriented Programming in JavaScript](https://www.geeksforgeeks.org/introduction-object-oriented-programming-javascript/) #### S.O.L.I.D Learn about the SOLID design pricinples that can make your code more understandable, flexible and maintainable. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - SOLID](https://en.wikipedia.org/wiki/SOLID) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fscotch.io" alt="Logo" /> S.O.L.I.D: The First 5 Principles of Object Oriented Design](https://scotch.io/bar-talk/s-o-l-i-d-the-first-five-principles-of-object-oriented-design) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> S.O.L.I.D The first 5 principles of Object Oriented Design with JavaScript](https://medium.com/@cramirez92/s-o-l-i-d-the-first-5-priciples-of-object-oriented-design-with-javascript-790f6ac9b9fa) ### Functional programming Learn about functional programming and how it can make your code easier to read and debug. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fopensource.com" alt="Logo" /> An introduction to functional programming in JavaScript](https://opensource.com/article/17/6/functional-javascript) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> Functional Programming in JavaScript](https://codeburst.io/functional-programming-in-javascript-e57e7e28c0e5) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fitnext.io" alt="Logo" /> The power of functional programming in Javascript](https://itnext.io/the-power-of-functional-programming-in-javascript-cc9797a42b60) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> An introduction to Functional Programming](https://flaviocopes.com/javascript-functional-programming/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Basic Functional Programming Patterns in JavaScript](https://dev.to/nestedsoftware/basic-functional-programming-patterns-in-javascript-49p2) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Functional-ish JavaScript](https://medium.com/@bluepnume/functional-ish-javascript-205c05d0ed08) #### Recursion Learn about recursion and when it can be used to make your code more readable. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> Learn and Understand Recursion in JavaScript](https://codeburst.io/learn-and-understand-recursion-in-javascript-b588218e87ea) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Understanding Recursion in JavaScript](https://medium.com/@zfrisch/understanding-recursion-in-javascript-992e96449e03) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - Recursion in JavaScript](https://www.freecodecamp.org/news/recursion-in-javascript-1608032c7a1f/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Recursion and stack](https://javascript.info/recursion) #### Higher-Order Functions Learn about higher-order functions and when it can be used to make your code more readable. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sitepoint.com" alt="Logo" /> Higher-Order Functions](https://www.sitepoint.com/higher-order-functions-javascript/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - A quick intro to Higher-Order Functions](https://www.freecodecamp.org/news/a-quick-intro-to-higher-order-functions-in-javascript-1a014f89c6b/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Higher-Order function](https://en.wikipedia.org/wiki/Higher-order_function) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.bitsrc.io" alt="Logo" /> Understanding Higher-Order Functions in JavaScript](https://blog.bitsrc.io/understanding-higher-order-functions-in-javascript-75461803bad) #### Currying Learn about currying and when it can be used to make your code more readable. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - All you need to know about currying](https://dev.to/bettercodingacademy/functional-programming-all-you-need-to-know-about-currying-5k7) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgideonpyzer.dev" alt="Logo" /> JavaScript: Currying and Partial Application](https://gideonpyzer.dev/blog/2017/01/14/javascript-currying-and-partial-application/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Curry and Function Composition](https://medium.com/javascript-scene/curry-and-function-composition-2c208d774983) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Currying](https://en.wikipedia.org/wiki/Currying) #### Monads Learn about monads and when it can be used to make your code more readable. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Monad, FunFunFunction](https://www.youtube.com/watch?v=9QveBbn7t_c) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Functors, FunFunFunction ](https://www.youtube.com/watch?v=YLIH8TKbAh4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Functional JavaScript - Functors, Monads, and Promises](https://dev.to/joelnet/functional-javascript---functors-monads-and-promises-1pol) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Monad](https://en.wikipedia.org/wiki/Monad_(functional_programming)) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> JavaScript Monads Made Simple](https://medium.com/javascript-scene/javascript-monads-made-simple-7856be57bfe8) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Implementing JavaScript Functors and Monads](https://medium.com/front-end-weekly/implementing-javascript-functors-and-monads-a87b6a4b4d9a) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Array.prototype.flatMap()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flatMap) ### Architecture ### Design Patterns Learn how commonly occurring problems can be solved using design patterns. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Software design pattern](https://en.wikipedia.org/wiki/Software_design_pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> The 7 Most Important Software Design Patterns](https://medium.com/educative/the-7-most-important-software-design-patterns-d60e546afb0e) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Software Design Patterns](https://www.geeksforgeeks.org/software-design-patterns/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoring.guru" alt="Logo" /> Design Patterns](https://refactoring.guru/design-patterns) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dofactory.com" alt="Logo" /> JavaScript Design Patterns](https://www.dofactory.com/javascript/design-patterns) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Design Patterns in TypeScript](https://github.com/torokmark/design_patterns_in_typescript) #### Singleton Learn about the singleton design pattern and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoring.guru" alt="Logo" /> Singleton Pattern](https://refactoring.guru/design-patterns/singleton) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dofactory.com" alt="Logo" /> Singleton Example](https://www.dofactory.com/javascript/singleton-design-pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Singleton Pattern](https://en.wikipedia.org/wiki/Singleton_pattern) #### Observer Learn about the observer design pattern and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoring.guru" alt="Logo" /> Observer Pattern](https://refactoring.guru/design-patterns/observer) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dofactory.com" alt="Logo" /> Observer Example](https://www.dofactory.com/javascript/observer-design-pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Observer Pattern](https://en.wikipedia.org/wiki/Observer_pattern) #### Prototype Learn about the prototype design pattern and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoring.guru" alt="Logo" /> Prototype Pattern](https://refactoring.guru/design-patterns/prototype) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dofactory.com" alt="Logo" /> Prototype Example](https://www.dofactory.com/javascript/prototype-design-pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Prototype pattern](https://en.wikipedia.org/wiki/Prototype_pattern) #### Bridge Learn about the bridge design pattern and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoring.guru" alt="Logo" /> Bridge Pattern](https://refactoring.guru/design-patterns/bridge) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dofactory.com" alt="Logo" /> Bridge Example](https://www.dofactory.com/javascript/bridge-design-pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Bridge pattern](https://en.wikipedia.org/wiki/Bridge_pattern) #### Proxy Learn about the proxy design pattern and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoring.guru" alt="Logo" /> Proxy Pattern](https://refactoring.guru/design-patterns/proxy) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dofactory.com" alt="Logo" /> Proxy Example](https://www.dofactory.com/javascript/proxy-design-pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Proxy pattern](https://en.wikipedia.org/wiki/Proxy_pattern) #### Chain of responsibility Learn about the chain of responsibility design pattern and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoring.guru" alt="Logo" /> Chain of Responsibility Pattern](https://refactoring.guru/design-patterns/chain-of-responsibility) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.dofactory.com" alt="Logo" /> Chain of Responsibility Example](https://www.dofactory.com/javascript/chain-of-responsibility-design-pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Chain of responsibility](https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern) #### Constructor Learn about the constructor design pattern and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.oreilly.com" alt="Logo" /> The Constructor Pattern](https://www.oreilly.com/library/view/learning-javascript-design/9781449334840/ch09s01.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Fundamental Object Design Patterns in JavaScript](https://medium.com/@severinperez/javascript-weekly-fundamental-object-design-patterns-31453f68427f) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstackoverflow.com" alt="Logo" /> Difference between Constructor pattern and Prototype pattern](https://stackoverflow.com/questions/35057827/difference-between-constructor-pattern-and-prototype-pattern) ### CSS Methodologies Learn how CSS can be structured using CSS methodologies. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.webfx.com" alt="Logo" /> A Look at Some CSS Methodologies](https://www.webfx.com/blog/web-design/css-methodologies/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.creativebloq.com" alt="Logo" /> A web designer's guide to CSS methodologies](https://www.creativebloq.com/features/a-web-designers-guide-to-css-methodologies) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.hongkiat.com" alt="Logo" /> Understanding CSS Writing Methodologies](https://www.hongkiat.com/blog/css-writing-methodologies/) #### BEM Learn about the BEM methodology and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fgetbem.com" alt="Logo" /> Get BEM](http://getbem.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - BEM 101](https://css-tricks.com/bem-101/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> What is BEM? And Why you should use it in your project.](https://medium.com/@dannyhuang_75970/what-is-bem-and-why-you-should-use-it-in-your-project-ab37c6d10b79) #### SMACSS Learn about the SMACSS methodology and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fsmacss.com" alt="Logo" /> SMACSS](http://smacss.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sitepoint.com" alt="Logo" /> BEM vs SMACSS](https://www.sitepoint.com/bem-smacss-advice-from-developers/) #### OOCSS Learn about the OOCSS methodology and when it should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> OOCSS](https://github.com/stubbornella/oocss/wiki) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> An Introduction To Object Oriented CSS](https://www.smashingmagazine.com/2011/12/an-introduction-to-object-oriented-css-oocss/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.keycdn.com" alt="Logo" /> The Future of Writing CSS](https://www.keycdn.com/blog/oocss) [](#team-collaboration) ## ➤ Team Collaboration ### Version Control ### Git Learn about git and how it is used for version control. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flearngitbranching.js.org" alt="Logo" /> Learn Git Branching](https://learngitbranching.js.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fguides.github.com" alt="Logo" /> Git Handbook](https://guides.github.com/introduction/git-handbook/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.github.com" alt="Logo" /> Github Cheatsheet](https://github.github.com/training-kit/downloads/github-git-cheat-sheet/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fgit-school.github.io" alt="Logo" /> Visualizing Git](http://git-school.github.io/visualizing-git/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.codecademy.com" alt="Logo" /> Codecademy - Learn Gitthis](https://www.codecademy.com/learn/learn-git) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgit-hint.netlify.com" alt="Logo" /> Git Hint](https://git-hint.netlify.com/) #### Github Learn how to use Github. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fguides.github.com" alt="Logo" /> What is GitHub?](https://guides.github.com/activities/hello-world/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flab.github.com" alt="Logo" /> GitHub Learning Lab](https://lab.github.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Github](https://en.wikipedia.org/wiki/Github) #### Bitbucket Learn how to use Bitbucket. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Bitbucket](https://en.wikipedia.org/wiki/Bitbucket) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fconfluence.atlassian.com" alt="Logo" /> Tutorial: Learn Bitbucket with Git](https://confluence.atlassian.com/bitbucket/tutorial-learn-bitbucket-with-git-759857287.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tecmint.com" alt="Logo" /> Getting Started with Bitbucket for Version Control](https://www.tecmint.com/bitbucket-for-version-control/) ### Management ### Agile Development Learn about agile development and when to use it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Agile software development](https://en.wikipedia.org/wiki/Agile_software_development) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.infoworld.com" alt="Logo" /> What is agile methodology?](https://www.infoworld.com/article/3237508/what-is-agile-methodology-modern-software-development-explained.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.visual-paradigm.com" alt="Logo" /> What is Agile Software Development?](https://www.visual-paradigm.com/scrum/what-is-agile-software-development/) #### Scrum Learn about scrum and when to use it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.knowledgehut.com" alt="Logo" /> Scrum Tutorial](https://www.knowledgehut.com/tutorials/scrum-tutorial) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Scrum - Overview](https://www.tutorialspoint.com/scrum/scrum_overview.htm) #### Kanban Learn about kanban and when to use it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Kanban Tutorial](https://www.tutorialspoint.com/kanban/kanban_introduction.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.atlassian.com" alt="Logo" /> What is kanban?](https://www.atlassian.com/agile/kanban) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.scrumhub.com" alt="Logo" /> Kanban Fundamentals](https://www.scrumhub.com/kanban-fundamentals/) ### Waterfall Development Learn about waterfall development and when to use it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Waterfall Model](https://www.tutorialspoint.com/sdlc/sdlc_waterfall_model.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.seguetech.com" alt="Logo" /> Waterfall vs. Agile](https://www.seguetech.com/waterfall-vs-agile-methodology/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fairbrake.io" alt="Logo" /> Waterfall Model: What and when](https://airbrake.io/blog/sdlc/waterfall-model) ### Test Driven Development Learn about test driven development and when to use it. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Test-driven development](https://en.wikipedia.org/wiki/Test-driven_development) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.codecademy.com" alt="Logo" /> Red, Green, Refactor](https://www.codecademy.com/articles/tdd-red-green-refactor) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - Test Driven Development](https://www.freecodecamp.org/news/test-driven-development-what-it-is-and-what-it-is-not-41fa6bca02a2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> TDD Changed My Life](https://medium.com/javascript-scene/tdd-changed-my-life-5af0ce099f80) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Test-driven development in JavaScript](https://dev.to/tomekbuszewski/test-driven-development-in-javascript-olg) [](#design--ux) ## ➤ Design & UX ### Color Theory Learn about color theory and how you can make your own color schemes. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> All you need to know about colors in UI Design](https://uxdesign.cc/all-you-need-to-know-about-colors-in-ui-design-theory-practice-235179712522) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.toptal.com" alt="Logo" /> The Role of Color in UX](https://www.toptal.com/designers/ux/color-in-ux) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.muz.li" alt="Logo" /> 10 Questions of Color Theory](https://medium.muz.li/10-questions-of-color-theory-that-will-make-you-a-better-ux-designer-b5244c1341a6) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Color Theory](https://en.wikipedia.org/wiki/Color_theory) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> The Meaning of Color](https://www.smashingmagazine.com/2010/01/color-theory-for-designers-part-1-the-meaning-of-color/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvisme.co" alt="Logo" /> 50 Gorgeous Color Schemes](https://visme.co/blog/website-color-schemes/) #### Color Wheel Learn how to use the color wheel when making a color scheme. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxplanet.org" alt="Logo" /> Color Theory: Brief Guide For Designers](https://uxplanet.org/color-theory-brief-guide-for-designers-76e11c57eaa) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.canva.com" alt="Logo" /> Color theory and the color wheel](https://www.canva.com/colors/color-wheel/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2F99designs.dk" alt="Logo" /> The fundamentals of understanding color theory](https://99designs.dk/blog/tips/the-7-step-guide-to-understanding-color-theory/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcolor.adobe.com" alt="Logo" /> Adobe - Color wheel](https://color.adobe.com/) ### Typography Learn about typography and how to describe fonts. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmaterial.io" alt="Logo" /> Google - Understanding typography](https://material.io/design/typography/understanding-typography.html#type-classification) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.howtogeek.com" alt="Logo" /> How to Understand Typography](https://www.howtogeek.com/howto/30065/how-to-understand-typography-like-a-professional-designer/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Typography Elements Everyone Needs to Understand](https://medium.com/gravitdesigner/typography-elements-everyone-needs-to-understand-5fdea82f470d) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - 10 rules to help you rule type](https://www.youtube.com/watch?v=QrNi9FmdlxY) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.canva.com" alt="Logo" /> Font Design](https://www.canva.com/learn/font-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.hubspot.com" alt="Logo" /> Typography Tutorial for Beginners](https://blog.hubspot.com/marketing/typography-terms-introduction) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.jotform.com" alt="Logo" /> A Crash Course in Typography](https://www.jotform.com/blog/a-crash-course-in-typography-the-basics-of-type/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.fonts.com" alt="Logo" /> Type Classifications](https://www.fonts.com/content/learning/fontology/level-1/type-anatomy/type-classifications) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ffonts.google.com" alt="Logo" /> Google Fonts](https://fonts.google.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> 7 web typography rules](https://uxdesign.cc/7-web-typography-rules-27de68c60f6) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.muz.li" alt="Logo" /> 15 Best Practices To Excellent UI](https://medium.muz.li/typography-in-mobile-design-15-best-practices-to-excellent-ui-5eaf18280ad) #### Font Size Learn about font sizes and how to choose the right one. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ftype-scale.com" alt="Logo" /> Type scale](https://type-scale.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.cardinalpath.com" alt="Logo" /> The importance of font size](https://www.cardinalpath.com/the-importance-of-font-size/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.liveseysolar.com" alt="Logo" /> Website font size: Size does matter](https://www.liveseysolar.com/website-font-size-size-does-matter/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - font-size](https://css-tricks.com/almanac/properties/f/font-size/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Fluid Typography](https://css-tricks.com/snippets/css/fluid-typography/) #### Line Spacing Learn about line spacing and how to choose the right one. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.justinmind.com" alt="Logo" /> Best UX practices for line spacing](https://www.justinmind.com/blog/best-ux-practices-for-line-spacing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fpracticaltypography.com" alt="Logo" /> Line spacing](https://practicaltypography.com/line-spacing.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.invisionapp.com" alt="Logo" /> Why you should go big with line spacing](https://www.invisionapp.com/inside-design/line-spacing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - line-height](https://css-tricks.com/almanac/properties/l/line-height/) ### C.R.A.P Learn how the C.R.A.P. design principles can help you point out the qualities (or flaws) in a design. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvwo.com" alt="Logo" /> Build Better User Experience](https://vwo.com/blog/crap-design-principles/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.instructables.com" alt="Logo" /> CRAP Principles](https://www.instructables.com/id/CRAP-principles/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.amazon.com" alt="Logo" /> The Non-Designer's Design Book](https://www.amazon.com/Non-Designers-Design-Book-4th/dp/0133966151) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - The Non-Designers Design Book](https://www.youtube.com/watch?v=NZ3ryLUR8CI) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcreativemarket.com" alt="Logo" /> How CRAP Will Make You a Better Designer](https://creativemarket.com/blog/how-crap-will-make-you-a-better-designer) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.presentationzen.com" alt="Logo" /> The Big Four: Contrast, Repetition, Alignment, Proximity](https://www.presentationzen.com/chapter6_spread.pdf) #### Contrast Learn how the principles of contrast can help you when designing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.canva.com" alt="Logo" /> Designing with contrast: 20 tips from a designer](https://www.canva.com/learn/contrasting-colors/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Contrast Design principle of Graphic Design](https://www.youtube.com/watch?v=r0SAPEw0ru4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.designcontest.com" alt="Logo" /> Contrast In Design](https://www.designcontest.com/blog/contrast-in-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.webdesignerdepot.com" alt="Logo" /> Fully understanding contrast in design](https://www.webdesignerdepot.com/2010/09/fully-understanding-contrast-in-design/) #### Repetition Learn how the principles of repetition can help you when designing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Repetition Design principle of Graphic Design](https://www.youtube.com/watch?v=u55BW6WBqVU) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2F254-online.com" alt="Logo" /> Repetition Principle of Design](https://254-online.com/repetition-principle-of-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.interaction-design.org" alt="Logo" /> Repetition, Pattern, and Rhythm](https://www.interaction-design.org/literature/article/repetition-pattern-and-rhythm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.johnlovett.com" alt="Logo" /> Repetition, principles of design](https://www.johnlovett.com/repetition) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.edgee.net" alt="Logo" /> How to Use Repetition Effectively](https://www.edgee.net/the-principles-of-graphic-design-how-to-use-repetition-effectively/) #### Alignment Learn how the principles of alignment can help you when designing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Alignment Design principle of Graphic Design](https://www.youtube.com/watch?v=2kokQi9vb6E) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2F254-online.com" alt="Logo" /> Alignment Principle Of Design](https://254-online.com/alignment-principle-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.designmantic.com" alt="Logo" /> The Art Of Alignment In Graphic Design](https://www.designmantic.com/blog/art-of-alignment-graphic-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxengineer.com" alt="Logo" /> Introduction to Alignment](https://uxengineer.com/principles-of-design/alignment/) #### Proximity Learn how the principles of proximity can help you when designing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Proximity Design principle of Graphic Design](https://www.youtube.com/watch?v=xUdqSiI_G8Y) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.edgee.net" alt="Logo" /> How to Use Proximity Effectively](https://www.edgee.net/the-principles-of-graphic-design-how-to-use-proximity-effectively/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2F254-online.com" alt="Logo" /> Proximity Principle Of Design](https://254-online.com/proximity-principle-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxplanet.org" alt="Logo" /> Gestalt Theory for UX Design: Principle of Proximity](https://uxplanet.org/gestalt-theory-for-ux-design-principle-of-proximity-e56b136d52d1) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sitepoint.com" alt="Logo" /> Principles of Design: Proximity](https://www.sitepoint.com/principles-of-design-proximity/) ### Consistency Learn why consistency is one of the most important building-blocks in a design. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> Design principle: Consistency](https://uxdesign.cc/design-principle-consistency-6b0cf7e7339f) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.prototypr.io" alt="Logo" /> Consistency, A Key Design Principle](https://blog.prototypr.io/consistency-a-key-design-principle-5d125469da8e) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.interaction-design.org" alt="Logo" /> Consistency: MORE than what you think](https://www.interaction-design.org/literature/article/consistency-more-than-what-you-think) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.interaction-design.org" alt="Logo" /> Principle of Consistency in User Interface Design](https://www.interaction-design.org/literature/article/principle-of-consistency-and-standards-in-user-interface-design) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.invisionapp.com" alt="Logo" /> The value of consistent design](https://www.invisionapp.com/inside-design/consistent-design/) ### Spacing Learn how to use space in your design. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Space in Design Systems](https://medium.com/eightshapes-llc/space-in-design-systems-188bcbae0d62) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvisme.co" alt="Logo" /> How to use spacing margin and spacing in design](https://visme.co/blog/how-to-properly-use-margins-and-spacing-in-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvanseodesign.com" alt="Logo" /> How To Use Space In Design](https://vanseodesign.com/web-design/design-space/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.prototypr.io" alt="Logo" /> Importance of White Space in Design](https://blog.prototypr.io/importance-of-white-space-in-design-5a40c0e65bfd) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ftubikstudio.com" alt="Logo" /> Negative Space in Design](https://tubikstudio.com/negative-space-in-design-tips-and-best-practices-2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.shutterstock.com" alt="Logo" /> How to Change Line Spacing in InDesign](https://www.shutterstock.com/support/article/how-to-change-line-spacing-in-indesign) ### Error Handling Learn how to improve the user experience by handling errors in an intuitive way. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Design an Error Handling System before you structure your App](https://medium.com/lattice-product-development/design-an-error-handling-system-before-you-structure-your-app-or-software-project-part-i-efe6a1674628) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuimovement.com" alt="Logo" /> UI Error Handling](https://uimovement.com/tag/error-handling/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> Creating Error Messages](https://uxdesign.cc/creating-error-messages-best-practice-in-ux-design-cda3be0f5e16) ### Loading Learn how a loading state can improve the user experience. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> Everything you need to know about skeleton screens](https://uxdesign.cc/what-you-should-know-about-skeleton-screens-a820c45a571a) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> Engaging users with progressive loading in skeleton screen](https://uxdesign.cc/engaging-users-with-progressive-loading-in-skeleton-screen-335a4e287a55) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmarinaaisa.com" alt="Logo" /> Design and code responsive Skeleton Screens](https://marinaaisa.com/blog/design-and-code-skeletons-screens/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sitepoint.com" alt="Logo" /> How to Speed Up Your UX with Skeleton Screens](https://www.sitepoint.com/how-to-speed-up-your-ux-with-skeleton-screens/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.viget.com" alt="Logo" /> A Bone to Pick with Skeleton Screens](https://www.viget.com/articles/a-bone-to-pick-with-skeleton-screens/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> When to use loaders & empty states](https://uxdesign.cc/when-to-use-loaders-empty-states-ebd23cecc7d6) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.uisources.com" alt="Logo" /> Empty/Loading State](https://www.uisources.com/pattern/empty-loading-state) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxmovement.com" alt="Logo" /> When You Need to Show a Button’s Loading State](https://uxmovement.com/buttons/when-you-need-to-show-a-buttons-loading-state/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.iamsuleiman.com" alt="Logo" /> Stop Using Loading Spinner](https://blog.iamsuleiman.com/stop-using-loading-spinner-theres-something-better/) ### The Golden Ratio Learn how the golden ratio can help you when choose measurements for your design. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdesignshack.net" alt="Logo" /> The Golden Ratio in Design](https://designshack.net/articles/layouts/golden-ratio-in-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.invisionapp.com" alt="Logo" /> A guide to the Golden Ratio for designers](https://www.invisionapp.com/inside-design/golden-ratio-designers/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.canva.com" alt="Logo" /> What is the golden ratio](https://www.canva.com/learn/what-is-the-golden-ratio/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.creativebloq.com" alt="Logo" /> The Golden Ratio: A designer's guide](https://www.creativebloq.com/design/designers-guide-golden-ratio-12121546) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.prototypr.io" alt="Logo" /> Golden Ratio: What It Is And Why Should You Use It In Design](https://blog.prototypr.io/golden-ratio-what-it-is-and-why-should-you-use-it-in-design-7c3f43bcf98) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgrtcalculator.com" alt="Logo" /> Golden Ratio Typography (GRT) Calculator](https://grtcalculator.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.companyfolders.com" alt="Logo" /> How to Use the Golden Ratio](https://www.companyfolders.com/blog/golden-ratio-design-examples) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwpamelia.com" alt="Logo" /> Golden Ratio in Design](https://wpamelia.com/golden-ratio/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.format.com" alt="Logo" /> How To Use The Golden Ratio In Design](https://www.format.com/magazine/resources/design/golden-ratio-in-design) ### Mobile First Learn about designing for mobile first and why it is important. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.justinmind.com" alt="Logo" /> Complete guide to mobile first design](https://www.justinmind.com/blog/complete-guide-to-mobile-first-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> What is Mobile First Design?](https://medium.com/@Vincentxia77/what-is-mobile-first-design-why-its-important-how-to-make-it-7d3cf2e29d00) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.uxpin.com" alt="Logo" /> A Hands-On Guide to Mobile-First Responsive Design](https://www.uxpin.com/studio/blog/a-hands-on-guide-to-mobile-first-design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdesignshack.net" alt="Logo" /> Mobile First Design](https://designshack.net/articles/mobile/mobilefirst/) #### Hit Targets Learn about hit targets can why they should not be neglected. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> Finger-Friendly Design](https://www.smashingmagazine.com/2012/02/finger-friendly-design-ideal-mobile-touchscreen-target-sizes/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Size matters! Accessibility and Touch Targets](https://medium.com/@zacdicko/size-matters-accessibility-and-touch-targets-56e942adc0cc) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxmovement.com" alt="Logo" /> Optimal Size and Spacing for Mobile Buttons](https://uxmovement.com/mobile/optimal-size-and-spacing-for-mobile-buttons/) ### Design Systems Learn what design systems are and get familiar with some. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.invisionapp.com" alt="Logo" /> A guide to design systems](https://www.invisionapp.com/inside-design/guide-to-design-systems/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> What the heck is a design system?](https://uxdesign.cc/what-the-heck-is-a-design-system-c89a8ea73b0d) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> Everything you need to know about Design Systems](https://uxdesign.cc/everything-you-need-to-know-about-design-systems-54b109851969) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.muz.li" alt="Logo" /> What is a Design System?](https://medium.muz.li/what-is-a-design-system-1e43d19e7696) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> What's a Design System](https://dev.to/graphqleditor/what-s-design-system-and-why-you-need-one-31fh) #### Material Design Learn about material design and get familiar with the core principles. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmaterial.io" alt="Logo" /> Google - Material Design](https://material.io/design/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmaterial.io" alt="Logo" /> Google - Material Components](https://material.io/components/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmaterial.io" alt="Logo" /> Google - Material Develop](https://material.io/develop/web/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmaterial.io" alt="Logo" /> Google - Material Tutorial](https://material.io/collections/developer-tutorials/#web) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Material Design](https://en.wikipedia.org/wiki/Material_Design) #### Fluent Design Learn about fluent design and get familiar with the core principles. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.microsoft.com" alt="Logo" /> Microsoft - Fluent Design System](https://www.microsoft.com/design/fluent/#/web) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.microsoft.com" alt="Logo" /> Microsoft - Fluent UI Toolkit](https://www.microsoft.com/design/fluent/toolkits/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Fluent Design System](https://en.wikipedia.org/wiki/Fluent_Design_System) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Fluent: Design Behind the Design](https://medium.com/microsoft-design/fluent-design-behind-the-design-973028062fcc) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Iconic Icons: Designing the World of Windows](https://medium.com/microsoft-design/iconic-icons-designing-the-world-of-windows-5e70e25e5416) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Evolving the Microsoft Fluent Design System](https://medium.com/microsoft-design/evolving-the-microsoft-fluent-design-system-9b37fb890c82) ### Accessibility Learn how and why it is important to design for accessibility. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> Designing For Accessibility And Inclusion](https://www.smashingmagazine.com/2018/04/designing-accessibility-inclusion/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fuxdesign.cc" alt="Logo" /> Designing for accessibility is not that hard](https://uxdesign.cc/designing-for-accessibility-is-not-that-hard-c04cc4779d94) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ftheblog.adobe.com" alt="Logo" /> Designing Accessible Experiences at Scale](https://theblog.adobe.com/accessibility-design-at-scale/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmaterial.io" alt="Logo" /> Material Design - Accessibility](https://material.io/design/usability/accessibility.html#) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Designing for Web Accessibility](https://www.w3.org/WAI/tips/designing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faccessibility.blog.gov.uk" alt="Logo" /> Accessibility in government](https://accessibility.blog.gov.uk/2016/09/02/dos-and-donts-on-designing-for-accessibility/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Visual Presentation](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-visual-presentation.html) ### Best Practices Learn about some of the best practices when designing. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.quicksprout.com" alt="Logo" /> 13 Website Design Best Practices For 2019](https://www.quicksprout.com/website-design-best-practices/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Design Best Practices](https://medium.com/thinking-design/design-best-practices/home) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frefactoringui.com" alt="Logo" /> Refactoring UI](https://refactoringui.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Refactoring UI | CSS Day 2019](https://www.youtube.com/watch?v=7Z9rrryIOC4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.3pillarglobal.com" alt="Logo" /> Dieter Ram' 10 principles for good design](https://www.3pillarglobal.com/insights/dieter-rams-10-principles-good-design) [](#the-modern-web) ## ➤ The Modern Web ### Streams Learn about streams and how they can help you effeciently transporting data. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Streams](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Streams API concepts](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API/Concepts) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeanhume.com" alt="Logo" /> Experimenting with the Streams API](https://deanhume.com/experimenting-with-the-streams-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstreams.spec.whatwg.org" alt="Logo" /> WHATWG - Streams](https://streams.spec.whatwg.org/) #### Media Streams Learn about media streams and how it is possible to get a stream to device specific hardware such as the camera or microphone. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Media Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Media_Streams_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Image Capture API](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream_Image_Capture_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - mediaDevices.getUserMedia()](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fw3c.github.io" alt="Logo" /> W3C - Media Capture and Streams](https://w3c.github.io/mediacapture-main/#dom-mediastream) #### Media Recorder Learn how to use the media recorder API to record media streams. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - MediaStream Recording API](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream_Recording_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faddpipe.com" alt="Logo" /> Media Recorder API Demo](https://addpipe.com/media-recorder-api-demo/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> WTC - MediaStream Recording](https://www.w3.org/TR/mediastream-recording/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Recording Media](https://whatwebcando.today/recording.html) #### Web RTC Learn how to use Web RTC for establishing real-time communication. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebrtc.org" alt="Logo" /> WebRTC - Getting Started](https://webrtc.org/start/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebrtc.github.io" alt="Logo" /> WebRTC samples](https://webrtc.github.io/samples/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - WebRTC](https://en.wikipedia.org/wiki/WebRTC) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - WebRTC](https://whatwebcando.today/realtime.html) #### Screen Capture Learn how to use the Screen Capture API for recording the screen. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Screen Capture API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Capture_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Intro to Screen Capture API](https://dev.to/al_khovansky/intro-to-screen-capture-api-scanning-qr-codes-bgi) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Screen Capture](https://www.w3.org/TR/screen-capture/) #### Generators Learn how to use generator functions to define iterative algorithms by writing functions whose execution is not continuous. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Iterators and generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.jeremyfairbank.com" alt="Logo" /> Functional JavaScript - Streams](https://blog.jeremyfairbank.com/javascript/functional-javascript-streams-2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> Understanding Generators with Examples](https://codeburst.io/understanding-generators-in-es6-javascript-with-examples-6728834016d5) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - function*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - yield*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/yield*) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - JavaScript Visualized: Generators and Iterators](https://dev.to/lydiahallie/javascript-visualized-generators-and-iterators-e36) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Generators](https://javascript.info/generators) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Medium - A Simple Guide to Understanding Javascript Generators](https://medium.com/dailyjs/a-simple-guide-to-understanding-javascript-es6-generators-d1c350551950) ### Speech Synthesis Learn how the speech synthesis API can help you converting text to speech. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Web apps that talk](https://developers.google.com/web/updates/2014/01/Web-apps-that-talk-Introduction-to-the-Speech-Synthesis-API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - window.speechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/Window/speechSynthesis) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - SpeechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fw3c.github.io" alt="Logo" /> W3C - Web Speech API](https://w3c.github.io/speech-api) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fflaviocopes.com" alt="Logo" /> The Speech Synthesis API](https://flaviocopes.com/speech-synthesis-api/) ### Web Sockets Learn about web sockets and how you can push data to your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Websockets API](https://developer.mozilla.org/en-US/docs/Web/API/Websockets_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> What are Web Sockets?](https://medium.com/@dominik.t/what-are-web-sockets-what-about-rest-apis-b9c15fd72aac) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - Introducing WebSockets](https://www.html5rocks.com/en/tutorials/websockets/basics/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhtml.spec.whatwg.org" alt="Logo" /> WHATWG - Web sockets](https://html.spec.whatwg.org/multipage/web-sockets.html) ### Geolocation Learn how to ask the user for permission to the location. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Falligator.io" alt="Logo" /> Alligrator - Using the Geolocation API](https://alligator.io/js/geolocation-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Maps Platform - Displaying User Position on Maps](https://developers.google.com/maps/documentation/javascript/geolocation) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Geolocation](https://whatwebcando.today/geolocation.html) ### Device orientation & motion Learn how to measure the orientation and motion of the device. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Detecting device orientation](https://developer.mozilla.org/en-US/docs/Web/API/Detecting_device_orientation) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - DeviceOrientation Event Specification](https://www.w3.org/TR/orientation-event/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - Introduction](https://www.html5rocks.com/en/tutorials/device/orientation/index.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Device Position](https://whatwebcando.today/device-position.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Generic Sensor API](https://www.w3.org/TR/generic-sensor/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Sensor APIs](https://developer.mozilla.org/en-US/docs/Web/API/Sensor_APIs) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Sensors For The Web](https://developers.google.com/web/updates/2017/09/sensors-for-the-web) ### Fullscreen Learn how to use the fullscreen API to give the user a more immersive experience when needed. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Fullscreen API](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Let Your Content Do the Talking](https://developers.google.com/web/updates/2011/10/Let-Your-Content-Do-the-Talking-Fullscreen-API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdavidwalsh.name" alt="Logo" /> David Walsh - Fullscreen API](https://davidwalsh.name/fullscreen) ### Variable Fonts Learn how to use variable fonts and how it is possible to customize fonts without the need for loading more. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fv-fonts.com" alt="Logo" /> v-fonts](https://v-fonts.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Variable fonts guide](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Introduction to variable fonts](https://developers.google.com/web/fundamentals/design-and-ux/typography/variable-fonts) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Supercharged - Variable Fonts](https://www.youtube.com/watch?v=B42rUMdcB7c) ### HTTP/2 Learn about the faster and more convenient HTTP/2 protocol. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Introduction to HTTP/2](https://developers.google.com/web/fundamentals/performance/http2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - HTTP/2](https://en.wikipedia.org/wiki/HTTP/2) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> HTTP/2: the difference between HTTP/1.1](https://medium.com/@factoryhr/http-2-the-difference-between-http-1-1-benefits-and-how-to-use-it-38094fa0e95b) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhttp2.github.io" alt="Logo" /> HTTP/2 - FAQ](https://http2.github.io/faq/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.lucidchart.com" alt="Logo" /> Why turning on HTTP/2 was a mistake](https://www.lucidchart.com/techblog/2019/04/10/why-turning-on-http2-was-a-mistake/) ### Payment Request API Learn about the payment request API and how it can help monetize your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Payment Request API](https://developer.mozilla.org/en-US/docs/Web/API/Payment_Request_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Codelabs - Payment Request API](https://developers.google.com/web/fundamentals/codelabs/payment-request-api) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Payments](https://whatwebcando.today/payments.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Payment Request API](https://www.w3.org/TR/payment-request/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Introduction to the Payment Request API](https://developers.google.com/web/ilt/pwa/introduction-to-the-payment-request-api) ### Web Audio Learn how to use the Web Audio API to add audio to your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using the Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Web Audio API](https://www.w3.org/TR/webaudio/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.html5rocks.com" alt="Logo" /> HTML5 Rocks - Getting Started with Web Audio API](https://www.html5rocks.com/en/tutorials/webaudio/intro/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> All You Need to Know About the Web Audio API](https://medium.com/better-programming/all-you-need-to-know-about-the-web-audio-api-3df170559378) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Falligator.io" alt="Logo" /> Alligator - Your First Steps with the Web Audio API](https://alligator.io/js/first-steps-web-audio-api/) ### Observers Learn about the observer pattern and get comfortable concepts such as subjects and observers. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fchromatichq.com" alt="Logo" /> Javascript Observers and You](https://chromatichq.com/blog/javascript-observers-and-you) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebdevstudios.com" alt="Logo" /> How to Use the Observable Pattern in JavaScript](https://webdevstudios.com/2019/02/19/observable-pattern-in-javascript/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Publish–subscribe pattern](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> The Observer Pattern with Vanilla JavaScript](https://medium.com/@patrickackerman/the-observer-pattern-with-vanilla-javascript-8f85ea05eaa8) #### Mutation Observer Learn how to use the Mutation Observer API to get informed about changes to the DOM. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - MutationObserver](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Listening to the DOM changes with MutationObserver](https://medium.com/@abbeal/listening-to-the-dom-changes-with-mutationobserver-b53a068a58d2) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdavidwalsh.name" alt="Logo" /> David Walsh - MutationObserver API](https://davidwalsh.name/mutationobserver-api) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Mutation observer](https://javascript.info/mutation-observer) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdom.spec.whatwg.org" alt="Logo" /> WHATWG - Mutation observers](https://dom.spec.whatwg.org/#mutation-observers) #### Intersection Observer Learn how to use the Intersection Observer API can help you detect when an element is visible on the screen. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Intersection Observer](https://www.w3.org/TR/intersection-observer/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Trust is Good, Observation is Better](https://developers.google.com/web/updates/2019/02/intersectionobserver-v2) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - An Explanation of Intersection Observers](https://css-tricks.com/an-explanation-of-how-the-intersection-observer-watches/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Understanding the Intersection Observer API in JavaScript](https://medium.com/better-programming/understanding-intersection-observer-api-in-javascript-bb1bf04b8081) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - A Few Functional Uses for Intersection Observer](https://css-tricks.com/a-few-functional-uses-for-intersection-observer-to-know-when-an-element-is-in-view/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> google Devs - An event for CSS position:sticky](https://developers.google.com/web/updates/2017/09/sticky-headers) #### Resize Observer Learn how to use the Resize Observer API to get informed when the element resizes. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Resize Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Resize_Observer_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - It’s Like document.onresize for Elements](https://developers.google.com/web/updates/2016/10/resizeobserver) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Falligator.io" alt="Logo" /> Alligator - A Look at the Resize Observer JavaScript API](https://alligator.io/js/resize-observer/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdavidwalsh.name" alt="Logo" /> David Walsh - Resize Observer](https://davidwalsh.name/resize-observer) #### Performance Observer Learn how the Performance Observer API can help you get information about the performance of your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Long Tasks API](https://developer.mozilla.org/en-US/docs/Web/API/Long_Tasks_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - PerformanceObserver](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceObserver) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Efficient Access to Performance Data](https://developers.google.com/web/updates/2016/06/performance-observer) ### Scrollsnapping Learn about the Scrollsnapping API and how it can help you provide an intuitive experience when scrolling. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Practical CSS Scroll Snapping](https://css-tricks.com/practical-css-scroll-snapping/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Introducing CSS Scroll Snap Points](https://css-tricks.com/introducing-css-scroll-snap-points/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Well-Controlled Scrolling with CSS Scroll Snap](https://developers.google.com/web/updates/2018/07/css-scroll-snap) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - CSS Scroll Snap](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Scroll_Snap) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebkit.org" alt="Logo" /> The scroll-snap-* Properties](https://webkit.org/demos/scroll-snap/index.html) ### Web Assembly Learn about Web Assembly and how it opens up the playing field for new types of web apps. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - WebAssembly Concepts](https://developer.mozilla.org/en-US/docs/WebAssembly/Concepts) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - WebAssembly](https://developer.mozilla.org/en-US/docs/WebAssembly) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Why the heck is everyone talking about WebAssembly?](https://dev.to/captainsafia/why-the-heck-is-everyone-talking-about-webassembly-455a) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Introduction to Web Assembly](https://medium.com/beginners-guide-to-mobile-web-development/introduction-to-web-assembly-6cb6466a3478) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodelabs.developers.google.com" alt="Logo" /> Google Codelabs - An Introduction to Web Assembly](https://codelabs.developers.google.com/codelabs/web-assembly-intro/index.html#0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> How We Used WebAssembly To Speed Up Our Web App By 20X](https://www.smashingmagazine.com/2019/04/webassembly-speed-web-app/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - WebAssembly](https://developers.google.com/web/updates/2019/02/hotpath-with-wasm) ### Beacon Learn how the Beacon API can help you send data to endpoints before the user closes the page. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - sendBeacon](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using the Beacon API](https://developer.mozilla.org/en-US/docs/Web/API/Beacon_API/Using_the_Beacon_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smashingmagazine.com" alt="Logo" /> Logging Activity With The Web Beacon API](https://www.smashingmagazine.com/2018/07/logging-activity-web-beacon-api/) ### Clipboard Learn about the Clipboard API and how it can help you copy and paste data. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Clipboard](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/clipboard) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Clipboard (Copy & Paste)](https://whatwebcando.today/clipboard.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Image Support for the Async Clipboard API](https://developers.google.com/web/updates/2019/07/image-support-for-async-clipboard) ### Share Learn how the Web Share API can help users sharing your web app. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Share](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Introducing the Web Share API](https://developers.google.com/web/updates/2016/09/navigator-share) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Registering as a Share Target](https://developers.google.com/web/updates/2018/12/web-share-target) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - How to Use the Web Share API](https://css-tricks.com/how-to-use-the-web-share-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.arnellebalane.com" alt="Logo" /> The Web Share API](https://blog.arnellebalane.com/the-web-share-api-2cbb3e6cf007) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - How to implement the Web Share API with a fallback](https://dev.to/daviddalbusco/how-to-implement-the-web-share-api-with-a-fallback-b3) ### Performance API Learn about the Performance API and how it can help you monitor the performance of the device. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Performance](https://developer.mozilla.org/en-US/docs/Web/API/Performance) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - performance.measure()](https://developer.mozilla.org/en-US/docs/Web/API/Performance/measure) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - Breaking Down the Performance API](https://css-tricks.com/breaking-performance-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Assessing Loading Performance](https://developers.google.com/web/fundamentals/performance/navigation-and-resource-timing/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Performance Specifications](https://developer.mozilla.org/en-US/docs/Web/API/Performance_API#Specifications) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Performance Timeline](https://developer.mozilla.org/en-US/docs/Web/API/Performance_Timeline) ### Gamepad API Learn how the Gamepad API can help you integrate with various controllers such as an x-box or playstation controller * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using the Gamepad API](https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API/Using_the_Gamepad_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Gamepad API](https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fluser.github.io" alt="Logo" /> luser - Gamepad Test](http://luser.github.io/gamepadtest/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Implementing controls using the Gamepad API](https://developer.mozilla.org/en-US/docs/Games/Techniques/Controls_Gamepad_API) ### Speech Recognition Learn how to use the Speech Recognition API to analyze speech. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Using the Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API/Using_the_Web_Speech_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdavidwalsh.name" alt="Logo" /> David Walsh - JavaScript Speech Recognition](https://davidwalsh.name/speech-recognition) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - SpeechRecognition](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - web-speech-api](https://github.com/mdn/web-speech-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Speech Recognition](https://whatwebcando.today/speech-recognition.html) ### Interaction Media Queries Learn how to use Interaction Media Queries to optimize the user experience for the specific type of device. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Introducing CSS Interaction Media Queries](https://medium.com/@rossbulat/introducing-css-interaction-media-queries-38eea48f4221) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Media features](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Using_media_queries#Media_features) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> Touch Devices Should Not Be Judged By Their Size](https://css-tricks.com/touch-devices-not-judged-size/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.opera.com" alt="Logo" /> Interaction Media Features and their potential](https://dev.opera.com/articles/media-features/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Interaction Media Features](https://www.w3.org/TR/mediaqueries-4/#mf-interaction) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Pointing Device Adaptation](https://whatwebcando.today/pointer-adaptation.html) ### Browser Extensions Learn how to build browser extensions to enhance the functionality of your browser. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Browser Extensions](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.chrome.com" alt="Logo" /> Chrome - What are extensions?](https://developer.chrome.com/extensions) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.chrome.com" alt="Logo" /> Chrome - Getting Started with Extensions](https://developer.chrome.com/extensions/getstarted) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Google Chrome Extensions](https://www.youtube.com/view_play_list?p=CA101D6A85FE9D4B) ### Pointer Lock API Learn how to use the Pointer Lock API to get the raw mouse movement and lock the target of mouse events to a single element. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Pointer Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Pointer Lock](https://www.w3.org/TR/pointerlock/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdzone.com" alt="Logo" /> Use the Pointer Lock API to Restrict Mouse Movement](https://dzone.com/articles/html5-use-pointer-lock-api) ### Picture In Picture Learn how to use the Picture-In-Picture API to watch videos in a floating window (always on top of other windows). * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Watch video using Picture-in-Picture](https://developers.google.com/web/updates/2018/10/watch-video-using-picture-in-picture) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgooglechrome.github.io" alt="Logo" /> Picture-in-Picture Sample](https://googlechrome.github.io/samples/picture-in-picture/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-tricks.com" alt="Logo" /> CSS Tricks - An Introduction to Picture-in-Picture](https://css-tricks.com/an-introduction-to-the-picture-in-picture-web-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Implement Picture-in-Picture on the Web](https://dev.to/ananyaneogi/implement-picture-in-picture-on-the-web-17g8) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Medium - How to use “picture in picture 📺” in JavaScript.](https://medium.com/@ashifa454/how-to-use-picture-in-picture-in-javascript-d315296c5800) ### Proxies Learn how to use proxies to intercept certain operations and implement custom behaviors. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Meta programming](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Meta_programming) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.bitsrc.io" alt="Logo" /> A practical guide to Javascript Proxy](https://blog.bitsrc.io/a-practical-guide-to-es6-proxy-229079c3c2f0?gi=92cd1f951006) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> Introducing Javascript ES6 Proxies](https://hackernoon.com/introducing-javascript-es6-proxies-1327419ab413) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Medium - How to use JavaScript Proxies for Fun and Profit](https://medium.com/dailyjs/how-to-use-javascript-proxies-for-fun-and-profit-365579d4a9f8) ### Houdini Learn about the Houdini project and get excited about the future of CSS. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Houdini, Demystifying CSS](https://developers.google.com/web/updates/2016/05/houdini) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - Smarter custom properties](https://web.dev/css-props-and-vals/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcss-houdini.rocks" alt="Logo" /> CSS Houdini Experiments](https://css-houdini.rocks/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fhoudini.glitch.me" alt="Logo" /> Interactive Introduction to CSS Houdini](http://houdini.glitch.me/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> W3C - CSS Houdini Wiki](https://github.com/w3c/css-houdini-drafts/wiki) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Houdini's Animation Worklet](https://developers.google.com/web/updates/2018/10/animation-worklet) ### Project Fugu Learn about Project Fugu project and get excited about the future of the Web. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.chromium.org" alt="Logo" /> Our commitment to a more capable web](https://blog.chromium.org/2018/11/our-commitment-to-more-capable-web.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.chromium.org" alt="Logo" /> Web Capabilities (Fugu)](https://www.chromium.org/teams/web-capabilities-fugu) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbugs.chromium.org" alt="Logo" /> Chromium Bugs - Fugu](https://bugs.chromium.org/p/chromium/issues/list?q=proj-fugu) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Unlocking new capabilities for the web](https://developers.google.com/web/updates/capabilities) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Unlocking New Capabilities for the Web](https://www.youtube.com/watch?v=GSiUzuB-PoI) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fchromium.googlesource.com" alt="Logo" /> Controlling Access to Powerful Web Platform Features](https://chromium.googlesource.com/chromium/src/+/f384207e04ad27f58287e972907f17ad66acc115/docs/security/permissions-for-powerful-web-platform-features.md) ### Web Authentication API Learn how to use the Web Authentication API to provide a strong authentication with public key cryptography. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Web Authentication API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.w3.org" alt="Logo" /> W3C - Web Authentication: An API for accessing Public Key Credentials](https://www.w3.org/TR/webauthn-2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Enabling Strong Authentication with WebAuthn](https://developers.google.com/web/updates/2018/05/webauthn) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fauth0.com" alt="Logo" /> Introduction to Web Authentication: The New W3C Spec](https://auth0.com/blog/introduction-to-web-authentication/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.microsoft.com" alt="Logo" /> Microsoft - Web Authentication and Windows Hello](https://docs.microsoft.com/en-us/microsoft-edge/dev-guide/windows-integration/web-authentication) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fduo.com" alt="Logo" /> Web Authentication: What It Is and What It Means for Passwords](https://duo.com/blog/web-authentication-what-it-is-and-what-it-means-for-passwords) #### Credentials Manager API Learn about the Credentials Manager API proposal and how it can help authenticating users. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Credential Management API](https://developer.mozilla.org/en-US/docs/Web/API/Credential_Management_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The Credential Management API](https://developers.google.com/web/fundamentals/security/credential-management) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Sign in Users](https://developers.google.com/web/fundamentals/security/credential-management/retrieve-credentials) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Save Credentials from Forms](https://developers.google.com/web/fundamentals/security/credential-management/save-forms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Credentials](https://whatwebcando.today/credentials.html) ### Native File System Learn how the Native File System API proposal enables interacting with files on the user's local device. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - The Native File System API](https://developers.google.com/web/updates/2019/08/native-file-system) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Native File System](https://github.com/WICG/native-file-system/blob/master/EXPLAINER.md) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwicg.github.io" alt="Logo" /> W3C - Native File System](https://wicg.github.io/native-file-system/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.google.com" alt="Logo" /> Native File System Web API - Chromium Security Model](https://docs.google.com/document/d/1NJFd-EWdUlQ7wVzjqcgXewqC5nzv_qII4OvlDtK6SE8/edit#heading=h.7nki9mck5t64) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.chromestatus.com" alt="Logo" /> Chromestatus - Native File System](https://www.chromestatus.com/feature/6284708426022912) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fw3c.github.io" alt="Logo" /> W3C - File API](https://w3c.github.io/FileAPI/) ### Shape Detection Learn how the Shape Detection API proposal can be use to detect shapes such as faces or barcodes in pictures. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwicg.github.io" alt="Logo" /> W3C - Accelerated Shape Detection in Images](https://wicg.github.io/shape-detection-api/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fweb.dev" alt="Logo" /> web.dev - A Picture is Worth a Thousand Words](https://web.dev/shape-detection/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Shape Detection API Specification](https://github.com/WICG/shape-detection-api) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.arnellebalane.com" alt="Logo" /> Introduction to the Shape Detection API](https://blog.arnellebalane.com/introduction-to-the-shape-detection-api-e07425396861) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fpaul.kinlan.me" alt="Logo" /> Face detection using Shape Detection API](https://paul.kinlan.me/face-detection/) ### Web Bluetooth Learn how the Web Bluetooth API proposal can be used to connect with nearby devices. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Web Bluetooth API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Interact with Bluetooth devices](https://developers.google.com/web/updates/2015/07/interact-with-ble-devices-on-the-web) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Bluetooth](https://whatwebcando.today/bluetooth.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwebbluetoothcg.github.io" alt="Logo" /> W3C - Web Bluetooth](https://webbluetoothcg.github.io/web-bluetooth/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgooglechrome.github.io" alt="Logo" /> Web Bluetooth Samples](https://googlechrome.github.io/samples/web-bluetooth/) ### Web USB Learn the Web USB API proposal can be used to connect with hardware through a cable. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - USB](https://developer.mozilla.org/en-US/docs/Web/API/USB) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> WICG - Web USB](https://github.com/WICG/webusb) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Access USB Devices on the Web](https://developers.google.com/web/updates/2016/03/access-usb-devices-on-the-web) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Web USB](https://whatwebcando.today/usb.html) ### Web XR Learn how to use Web XR API proposal for virtual- and augmented reality experiences. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - WebXR Device API](https://developer.mozilla.org/en-US/docs/Web/API/WebXR_Device_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Welcome to the immersive web](https://developers.google.com/web/updates/2018/05/welcome-to-immersive) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhacks.mozilla.org" alt="Logo" /> New API to Bring Augmented Reality to the Web](https://hacks.mozilla.org/2018/09/webxr/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fimmersive-web.github.io" alt="Logo" /> W3C - WebXR Device API](https://immersive-web.github.io/webxr/) ### Presentation Learn how the Presentation API proposal enables your web app to use the presentation display mode in the browser or at an external display device. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Presentation API](https://developer.mozilla.org/en-US/docs/Web/API/Presentation_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Presentation Features](https://whatwebcando.today/presentation.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Present web pages to secondary attached displays](https://developers.google.com/web/updates/2018/04/present-web-pages-to-secondary-attached-displays) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fw3c.github.io" alt="Logo" /> W3C - Presentation API](https://w3c.github.io/presentation-api) ### Network Information API Learn how the Network Information API proposal can give you information about the state of the network. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Network Information API](https://developer.mozilla.org/en-US/docs/Web/API/Network_Information_API) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faddyosmani.com" alt="Logo" /> Addy Osmani - Adaptive Serving](https://addyosmani.com/blog/adaptive-serving/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwicg.github.io" alt="Logo" /> W3C - Network Information API](https://wicg.github.io/netinfo/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgooglechrome.github.io" alt="Logo" /> Network Information API Sample](https://googlechrome.github.io/samples/network-information/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatwebcando.today" alt="Logo" /> What Web Can Do Today - Network Type & Speed](https://whatwebcando.today/network-type-speed.html) [](#algorithms--data-structures) ## ➤ Algorithms & Data structures ### Data structures ### Arrays Learn how and when arrays should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fjavascript.info" alt="Logo" /> javascript.info - Arrays](https://javascript.info/array) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - Arrays, A Visual Introduction for Beginners](https://www.freecodecamp.org/news/data-structures-101-arrays-a-visual-introduction-for-beginners-7f013bcc355a/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Array data structure](https://en.wikipedia.org/wiki/Array_data_structure) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdeveloper.mozilla.org" alt="Logo" /> MDN - Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) ### Queues & Stacks Learn how and when queues and stacks should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.cs.cmu.edu" alt="Logo" /> Stacks and Queues](https://www.cs.cmu.edu/~adamchik/15-121/lectures/Stacks%20and%20Queues/Stacks%20and%20Queues.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Difference between Stack and Queue Data Structures](https://www.geeksforgeeks.org/difference-between-stack-and-queue-data-structures/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Data Structures: Stacks & Queues](https://medium.com/@hitherejoe/data-structures-stacks-queues-a3b3591c8cb0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Stacks vs. Queues In JavaScript](https://dev.to/emmawedekind/stacks-vs-queues-in-javascript-4d1o) ### Trees Learn how and when trees should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Tree (data structure)](https://en.wikipedia.org/wiki/Tree_(data_structure)) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - Everything you need to know about tree data structure](https://www.freecodecamp.org/news/all-you-need-to-know-about-tree-data-structures-bceacb85490c/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Data Structure and Algorithms - Tree](https://www.tutorialspoint.com/data_structures_algorithms/tree_data_structure.htm) #### Binary Indexed Tree Learn how and when binary indexed trees should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Fenwick tree](https://en.wikipedia.org/wiki/Fenwick_tree) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcs.stackexchange.com" alt="Logo" /> What is the intuition behind a binary indexed tree?](https://cs.stackexchange.com/questions/10538/bit-what-is-the-intuition-behind-a-binary-indexed-tree-and-how-was-it-thought-a) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Binary Indexed Tree or Fenwick Tree](https://www.geeksforgeeks.org/binary-indexed-tree-or-fenwick-tree-2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Fenwick Tree / Binary Indexed Tree](https://github.com/trekhleb/javascript-algorithms/tree/master/src/data-structures/tree/fenwick-tree) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Binary Indexed Tree](https://www.youtube.com/watch?v=CWDQJGaN1gY&index=18&t=0s&list=PLLXdhg_r2hKA7DPDsunoDZ-Z769jWn4R8) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - fast-binary-indexed-tree-js](https://github.com/microsoft/fast-binary-indexed-tree-js) #### Heap Learn how and when heaps should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Heap (data structure)](https://en.wikipedia.org/wiki/Heap_(data_structure)) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - Heap Data Structure](https://www.tutorialspoint.com/data_structures_algorithms/heap_data_structure.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Learning to Love Heaps](https://medium.com/basecs/learning-to-love-heaps-cef2b273a238) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Freactgo.com" alt="Logo" /> How to implement Heap Data structure in JavaScript](https://reactgo.com/javascript-heap-datastructure/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Data Structures: Heaps](https://www.youtube.com/watch?v=t0Cq6tVNRBA&list=PLLXdhg_r2hKA7DPDsunoDZ-Z769jWn4R8&index=5) #### Red-black Tree Learn how and when red-black trees should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Red–black tree](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Painting Nodes Black With Red-Black Trees](https://dev.to/vaidehijoshi/painting-nodes-black-with-red-black-trees) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Red-Black Tree](https://www.geeksforgeeks.org/red-black-tree-set-1-introduction-2/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Red Black Trees in JavaScript](https://medium.com/@julianknodt/red-black-trees-in-javascript-c20eec1d5d1c) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Red–Black Tree](https://github.com/trekhleb/javascript-algorithms/tree/master/src/data-structures/tree/red-black-tree) #### Trie Learn how and when tries should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Trie](https://en.wikipedia.org/wiki/Trie) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Trie (Insert and Search)](https://www.geeksforgeeks.org/trie-insert-and-search/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Trying to Understand Tries](https://medium.com/basecs/trying-to-understand-tries-3ec6bede0014) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.interviewcake.com" alt="Logo" /> Trie, Datastructure](https://www.interviewcake.com/concept/java/trie) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Data Structures: Tries](https://www.youtube.com/watch?v=zIjfhVPRZCg&list=PLLXdhg_r2hKA7DPDsunoDZ-Z769jWn4R8&index=7) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> Practical Data Structures: Tries](https://hackernoon.com/practical-data-structures-for-frontend-applications-when-to-use-tries-5428a565eba4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.cs.usfca.edu" alt="Logo" /> Trie, visualization](https://www.cs.usfca.edu/~galles/visualization/Trie.html) #### K-D Tree Learn how and when K-D trees should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - k-d tree](https://en.wikipedia.org/wiki/K-d_tree) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - k-d Tree JavaScript Library](https://github.com/ubilabs/kd-tree-javascript) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.cs.cmu.edu" alt="Logo" /> kd-Trees](https://www.cs.cmu.edu/~ckingsf/bioinfo-lectures/kdtrees.pdf) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - KD Tree Algorithm](https://www.youtube.com/watch?v=TLxWtXEbtFE) ### Hash Tables Learn how and when hash tables should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Hash table](https://en.wikipedia.org/wiki/Hash_table) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fyourbasic.org" alt="Logo" /> Hash tables explained](https://yourbasic.org/algorithms/hash-tables-explained/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.hackerearth.com" alt="Logo" /> Basics of Hash Tables](https://www.hackerearth.com/practice/data-structures/hash-tables/basics-of-hash-tables/tutorial/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Javascript Hash Table](https://medium.com/@yanganif/javascript-hash-table-8878afceecbc) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> Objects and Hash Tables in Javascript](https://codeburst.io/objects-and-hash-tables-in-javascript-a472ad1940d9) ### Linked Lists Learn how and when linked lists should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Linked list](https://en.wikipedia.org/wiki/Linked_list) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> Introduction to Linked Lists](https://www.studytonight.com/data-structures/introduction-to-linked-list) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> Linked Lists in JavaScript](https://codeburst.io/linked-lists-in-javascript-es6-code-part-1-6dd349c3dcc3) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> The Little Guide of Linked List in JavaScript](https://hackernoon.com/the-little-guide-of-linked-list-in-javascript-9daf89b63b54) ### Graphs Learn how and when graphs should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Graph theory](https://en.wikipedia.org/wiki/Graph_theory) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Implementation of Graph in JavaScript](https://www.geeksforgeeks.org/implementation-graph-javascript/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frunestone.academy" alt="Logo" /> Graphs and Graph Algorithms](https://runestone.academy/runestone/books/published/pythonds/Graphs/Objectives.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> The Javascript Developer’s Guide to Graphs](https://hackernoon.com/the-javascript-developers-guide-to-graphs-and-detecting-cycles-in-them-96f4f619d563) ### Analysis ### Time complexity Learn about time complexity and how it can be used to analyze an algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Time complexity](https://en.wikipedia.org/wiki/Time_complexity) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> Time Complexity of Algorithms](https://www.studytonight.com/data-structures/time-complexity-of-algorithms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - An Introduction to Time Complexity](https://www.freecodecamp.org/news/time-complexity-of-algorithms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fadrianmejia.com" alt="Logo" /> 8 time complexities that every programmer should know](https://adrianmejia.com/most-popular-algorithms-time-complexity-every-programmer-should-know-free-online-tutorial-course/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.jenniferbland.com" alt="Logo" /> Time Complexity Analysis in JavaScript](https://www.jenniferbland.com/time-complexity-analysis-in-javascript/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> An intro to Algorithms](https://codeburst.io/algorithms-i-searching-and-sorting-algorithms-56497dbaef20) #### Cost model Learn how to setup a cost model for an algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Analysis of algorithms](https://en.wikipedia.org/wiki/Analysis_of_algorithms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Faofa.cs.princeton.edu" alt="Logo" /> Analysis of Algorithms](https://aofa.cs.princeton.edu/10analysis/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fv8.dev" alt="Logo" /> The cost of JavaScript in 2019](https://v8.dev/blog/cost-of-javascript-2019) #### Order of Growth Learn how to make an order-of-growth classification to classify the cost model. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.quora.com" alt="Logo" /> Quora - What is the meaning of 'order of growth'](https://www.quora.com/What-is-the-meaning-of-order-of-growth-in-algorithm-analysis-and-how-can-we-find-the-order-of-growth-of-given-algorithm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.ccs.neu.edu" alt="Logo" /> Orders of Growth](http://www.ccs.neu.edu/home/jaa/CS7800.12F/Information/Handouts/order.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.coursera.org" alt="Logo" /> Coursera - Order-of-Growth Classifications](https://www.coursera.org/lecture/algorithms-part1/order-of-growth-classifications-Xk03a) #### Big O notation Learn how to use Big O notation to classify the time complexity of an algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Big O notation](https://en.wikipedia.org/wiki/Big_O_notation) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Time Complexity/Big O Notation](https://medium.com/javascript-scene/time-complexity-big-o-notation-1a4310c3ee4b) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Big O Notation in JavaScript](https://medium.com/cesars-tech-insights/big-o-notation-javascript-25c79f50b19b) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Big O in JS: The basic that you need to know](https://medium.com/front-end-weekly/big-o-in-js-the-basic-that-you-need-to-know-a5abb45570fa) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Big O in JavaScript](https://medium.com/@gmedina229/big-o-in-javascript-36ff67766051) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - What is Big O Notation, and Why is it Useful?](https://dev.to/mattdmccarley/what-is-big-o-notation-and-why-is-it-useful-2b7l) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Big-O Notation Useful guide](https://dev.to/yashwanthambati/big-o-notation-complete-guide-226h) ### Space Complexity Learn about space complexity and how it can be used to analyze an algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> Space Complexity of Algorithms](https://www.studytonight.com/data-structures/space-complexity-of-algorithms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Fix Memory Problems](https://developers.google.com/web/tools/chrome-devtools/memory-problems) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - Memory Terminology](https://developers.google.com/web/tools/chrome-devtools/memory-problems/memory-101) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdevelopers.google.com" alt="Logo" /> Google Devs - How to Record Heap Snapshots](https://developers.google.com/web/tools/chrome-devtools/memory-problems/heap-snapshots) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Debugging Memory Leaks in JavaScript](https://medium.com/@sarahelson81/debugging-memory-leaks-in-javascript-ed6d0fa84b40) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Space complexity](https://en.wikipedia.org/wiki/Space_complexity) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fexploreshaifali.github.io" alt="Logo" /> Space Complexity](http://exploreshaifali.github.io/2014/02/13/Space-Complexity/) ### Algorithms ### Sorting Learn about the most important sorting algorithms and figure out what challenges there are involved with implementing one. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.bitsrc.io" alt="Logo" /> A Guide To Sorting Algorithms in JavaScript](https://blog.bitsrc.io/a-guide-to-sorting-algorithms-in-javascript-5b32da4eae1e) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Sorting Algorithms with Javascript](https://dev.to/wangonya/sorting-algorithms-with-javascript-part-1-4aca) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> Introduction to Sorting](https://www.studytonight.com/data-structures/introduction-to-sorting) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Implementing Sorting Algorithms in JavaScript](https://medium.com/@rwillt/implementing-sorting-algorithms-in-javascript-b08504cdf4a9) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fnotlaura.com" alt="Logo" /> Algorithms – Sorting Algorithms in JavaScript](https://notlaura.com/day-6-algorithms-sorting-algorithms-in-javascript/) #### Insertion Sort Learn about the insertion sort algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Insertion sort](https://en.wikipedia.org/wiki/Insertion_sort) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Insertion Sort](https://www.geeksforgeeks.org/insertion-sort/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.interviewbit.com" alt="Logo" /> Insertion Sort Algorithm](https://www.interviewbit.com/tutorial/insertion-sort-algorithm/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Insertion Sorting for Beginners in JS](https://dev.to/ryan_dunton/insertion-sorting-for-beginners-in-js------fkg) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Algorithms: Insertion Sort in JavaScript](https://medium.com/dailyjs/insertion-sort-in-javascript-9c077844717a) #### Quicksort Learn about the quicksort algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Quicksort](https://en.wikipedia.org/wiki/Quicksort) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> A Quick Explanation of Quick Sort](https://medium.com/karuna-sehgal/a-quick-explanation-of-quick-sort-7d8e2563629b) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> QuickSort](https://www.geeksforgeeks.org/quick-sort/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Implementing Quicksort in JavaScript](https://medium.com/@Charles_Stover/implementing-quicksort-in-javascript-8044a8e2bf39) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhumanwhocodes.com" alt="Logo" /> Computer science in JavaScript: Quicksort](https://humanwhocodes.com/blog/2012/11/27/computer-science-in-javascript-quicksort/) #### Mergesort Learn about the mergesort algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Merge sort](https://en.wikipedia.org/wiki/Merge_sort) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Merge Sort Algorithm in JavaScript](https://medium.com/javascript-in-plain-english/javascript-merge-sort-3205891ac060) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> A Simplified Explanation of Merge Sort](https://medium.com/karuna-sehgal/a-simplified-explanation-of-merge-sort-77089fe03bb2) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.khanacademy.org" alt="Logo" /> Overview of merge sort](https://www.khanacademy.org/computing/computer-science/algorithms/merge-sort/a/overview-of-merge-sort) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> Freecodecamp - The Merge Sort Algorithm Explained](https://www.freecodecamp.org/forum/t/the-merge-sort-algorithm-explained/16104) #### Heapsort Learn about the heapsort algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Heapsort](https://en.wikipedia.org/wiki/Heapsort) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Heapify All The Things With Heap Sort](https://medium.com/basecs/heapify-all-the-things-with-heap-sort-55ee1c93af82) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> Heap Sort Algorithm](https://www.studytonight.com/data-structures/heap-sort) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.interviewcake.com" alt="Logo" /> Heapsort Algorithm](https://www.interviewcake.com/concept/java/heapsort) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbrilliant.org" alt="Logo" /> Heap Sort](https://brilliant.org/wiki/heap-sort/) ### Searching Learn about the most important searching algorithms and figure out what challenges there are involved with implementing one. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Search algorithm](https://en.wikipedia.org/wiki/Search_algorithm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Search Algorithms with ES6](https://github.com/Crizstian/data-structure-and-algorithms-with-ES6/tree/master/13-chapter-Searching-Algorithms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> Introduction to Searching Algorithms](https://www.studytonight.com/data-structures/search-algorithms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Implement linear and binary search algorithms with Javascript](https://medium.com/employbl/implement-linear-and-binary-search-algorithms-with-javascript-2149997588f0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.scriptonitejs.com" alt="Logo" /> Searching Algorithms In Javascript](https://www.scriptonitejs.com/javascript-searching-algorithms/) #### Binary Search Learn about the binary search algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Binary search algorithm](https://en.wikipedia.org/wiki/Binary_search_algorithm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Freactgo.com" alt="Logo" /> How to implement a Binary search algorithm](https://reactgo.com/binary-search-algorithm-javascript/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.interviewbit.com" alt="Logo" /> Binary Search](https://www.interviewbit.com/courses/programming/topics/binary-search/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> What Is Binary Search, A Detailed Step-By-Step](https://medium.com/@jeffrey.allen.lewis/javascript-algorithms-explained-binary-search-25064b896470) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> Programming with JS: Binary Search](https://hackernoon.com/programming-with-js-binary-search-aaf86cef9cb3) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Binary Search In JavaScript](https://www.geeksforgeeks.org/binary-search-in-javascript/) #### Breadth First Search Learn about the breadth first search algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Breadth-first search](https://en.wikipedia.org/wiki/Breadth-first_search) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Breaking Down Breadth-First Search](https://medium.com/basecs/breaking-down-breadth-first-search-cebe696709d9) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Breadth First Search in JavaScript](https://medium.com/dailyjs/breadth-first-search-in-javascript-e655cd824fa4) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Breadth-First Search (BFS)](https://github.com/trekhleb/javascript-algorithms/tree/master/src/algorithms/graph/breadth-first-search) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flevelup.gitconnected.com" alt="Logo" /> The Magician’s Guide to Algorithms](https://levelup.gitconnected.com/the-magicians-guide-to-algorithms-part-4-the-breadth-first-search-b800aec8ccf8) #### Depth First Search Learn about the depth first search algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Depth-first search](https://en.wikipedia.org/wiki/Depth-first_search) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fedgy.app" alt="Logo" /> Depth First Search Algorithm](https://edgy.app/depth-first-search-algorithm-what-it-is-and-how-it-works) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Depth first and breadth first search on trees](https://medium.com/employbl/depth-first-and-breadth-first-search-on-trees-in-javascript-58dcd6ff8de1) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Breadth-first vs Depth-first Tree Traversal](https://medium.com/@kenny.hom27/breadth-first-vs-depth-first-tree-traversal-in-javascript-48df2ebfc6d1) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - Depth-First Search (DFS)](https://github.com/trekhleb/javascript-algorithms/tree/master/src/algorithms/graph/depth-first-search) #### Dijkstra's Algorithm Learn about dijkstra's algorithm. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Dijkstra's algorithm](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcourses.cs.washington.edu" alt="Logo" /> Dijkstra’s algorithm](https://courses.cs.washington.edu/courses/cse373/16su/lectures/lecture15.pdf) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhackernoon.com" alt="Logo" /> How to implement Dijkstra’s Algorithm](https://hackernoon.com/how-to-implement-dijkstras-algorithm-in-javascript-abdfd1702d04) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> A Walkthrough of Dijkstra’s Algorithm](https://medium.com/@adriennetjohnson/a-walkthrough-of-dijkstras-algorithm-in-javascript-e94b74192026) #### String Search Learn about various algorithms for searching in strings. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - String-searching algorithm](https://en.wikipedia.org/wiki/String-searching_algorithm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fongspxm.github.io" alt="Logo" /> Boyer Moore String Search](https://ongspxm.github.io/blog/2017/05/boyer-moore-search/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Boyer–Moore string-search algorithm](https://en.wikipedia.org/wiki/Boyer%E2%80%93Moore_string-search_algorithm) ### Hashing Learn about hashing algorithms. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Hash function](https://en.wikipedia.org/wiki/Hash_function) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcomputer.howstuffworks.com" alt="Logo" /> How Encryption Works](https://computer.howstuffworks.com/encryption5.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Cryptography for JavaScript: Hash Function](https://medium.com/@promentol/cryptography-for-javascript-node-js-developers-part-1-hash-function-86d119c7304) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgist.github.com" alt="Logo" /> Github - hash.js](https://gist.github.com/iperelivskiy/4110988) [](#databases--servers) ## ➤ Databases & Servers ### Databases ### Relational Databases Learn about relational databases and how to use them. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Relational database](https://en.wikipedia.org/wiki/Relational_database) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchdatamanagement.techtarget.com" alt="Logo" /> Relational database](https://searchdatamanagement.techtarget.com/definition/relational-database) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Everything you need to know about (Relational) Databases](https://dev.to/lmolivera/everything-you-need-to-know-about-relational-databases-3ejl) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcomputer.howstuffworks.com" alt="Logo" /> What are relational databases?](https://computer.howstuffworks.com/question599.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.codecademy.com" alt="Logo" /> What is a Relational Database Management System?](https://www.codecademy.com/articles/what-is-rdbms-sql) #### SQL Learn how to write SQL statements to communicate with a database. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.codecademy.com" alt="Logo" /> Learn SQL](https://www.codecademy.com/learn/learn-sql) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - SQL](https://en.wikipedia.org/wiki/SQL) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Flearntocodewith.me" alt="Logo" /> A beginners guide to SQL](https://learntocodewith.me/posts/sql-guide/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> The Last SQL Guide for Data Analysis You’ll Ever Need](https://medium.com/better-programming/the-last-sql-guide-for-data-analysis-youll-ever-need-17ae10fa4a6f) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialrepublic.com" alt="Logo" /> SQL Tutorial](https://www.tutorialrepublic.com/sql-tutorial/) #### MySQL Learn about the open-source relational database management system called MySQL. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.mysql.com" alt="Logo" /> MySQL](https://www.mysql.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - MySQL](https://en.wikipedia.org/wiki/MySQL) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - MySQL Tutorial](https://www.tutorialspoint.com/mysql/index.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchoracle.techtarget.com" alt="Logo" /> MySQL Definition](https://searchoracle.techtarget.com/definition/MySQL) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.mysqltutorial.org" alt="Logo" /> Getting Started with MySQL](http://www.mysqltutorial.org/getting-started-with-mysql/) #### PostgreSQL Learn about the open-source relational database management system called PostgreSQL. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.postgresql.org" alt="Logo" /> PostgreSQL](https://www.postgresql.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - PostgreSQL](https://en.wikipedia.org/wiki/PostgreSQL) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.postgresqltutorial.com" alt="Logo" /> PostgreSQL Tutorial](http://www.postgresqltutorial.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fpostgresguide.com" alt="Logo" /> Postgres Guide](http://postgresguide.com/) ### Non-relational Databases Learn about non-relational databases and how to use them. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.mongodb.com" alt="Logo" /> What Is A Non Relational Database](https://www.mongodb.com/scale/what-is-a-non-relational-database) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - NoSQL](https://en.wikipedia.org/wiki/NoSQL) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Relational SQL vs. Non-Relational NoSQL Databases](https://dev.to/trevoirwilliams/relational-sql-vs-non-relational-nosql-databases-hi5) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.microsoft.com" alt="Logo" /> Non-relational data and NoSQL](https://docs.microsoft.com/en-us/azure/architecture/data-guide/big-data/non-relational-data) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.techopedia.com" alt="Logo" /> Non-Relational Database](https://www.techopedia.com/definition/25218/non-relational-database) #### Redis Learn about the open-source non-relational database management system called Redis. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fredis.io" alt="Logo" /> Redis](https://redis.io/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Ftry.redis.io" alt="Logo" /> Try Redis](http://try.redis.io/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Redis](https://en.wikipedia.org/wiki/Redis) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fredis.io" alt="Logo" /> An introduction to Redis data types and abstractions](https://redis.io/topics/data-types-intro) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fredis.io" alt="Logo" /> Redis - Documentation](https://redis.io/documentation) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcodeburst.io" alt="Logo" /> Redis: What and Why?](https://codeburst.io/redis-what-and-why-d52b6829813) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - Redis Tutorial](https://www.tutorialspoint.com/redis/index.htm) #### MongoDB Learn about the open-source non-relational database management system called MongoDB. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.mongodb.com" alt="Logo" /> MongoDB](https://www.mongodb.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.mongodb.com" alt="Logo" /> MongoDB - Documentation](https://docs.mongodb.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Funiversity.mongodb.com" alt="Logo" /> MongoDB - University](https://university.mongodb.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - MongoDB Tutorial](https://www.tutorialspoint.com/mongodb/index.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - MongoDB In 30 Minutes](https://www.youtube.com/watch?v=pWbMrx5rVBE) ### Data Modelling Learn how data modelling can help your database design. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fopentextbc.ca" alt="Logo" /> Chapter 5 Data Modelling](https://opentextbc.ca/dbdesign01/chapter/chapter-5-data-modelling/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Database Model](https://en.wikipedia.org/wiki/Database_model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Database Modelling](https://en.wikipedia.org/wiki/Data_modeling) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> What is Data Modelling?](https://www.guru99.com/data-modelling-conceptual-logical.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchdatamanagement.techtarget.com" alt="Logo" /> Data Modeling Definition](https://searchdatamanagement.techtarget.com/definition/data-modeling) #### ER Diagram Learn how to model your data using ER diagrams. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - DBMS, Data Models](https://www.tutorialspoint.com/dbms/dbms_data_models.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.smartdraw.com" alt="Logo" /> Entity Relationship Diagram](https://www.smartdraw.com/entity-relationship-diagram/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Entity Relationship Diagram Tutorial](https://www.youtube.com/watch?v=QpdhBUYk7Kk) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Entity–relationship model](https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbeginnersbook.com" alt="Logo" /> Entity Relationship Diagram](https://beginnersbook.com/2015/04/e-r-model-in-dbms/) #### Keys Learn how to figure out what types of keys to use and where to use them. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> Introduction to Database Keys](https://www.studytonight.com/dbms/database-key.php) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.csestack.org" alt="Logo" /> 7 Different Types of Database Keys](https://www.csestack.org/different-types-database-keys-example/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdatabasemanagement.fandom.com" alt="Logo" /> Database Management: Keys](https://databasemanagement.fandom.com/wiki/Relational_Database:_Keys) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialcup.com" alt="Logo" /> Database Keys](https://www.tutorialcup.com/dbms/keys.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Database Keys](https://www.youtube.com/watch?v=yMYH0zP1m8U) ### Indexing Learn how to use indexing to speed up your database. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Indexing in Databases](https://www.geeksforgeeks.org/indexing-in-databases-set-1/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Database index](https://en.wikipedia.org/wiki/Database_index) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.essentialsql.com" alt="Logo" /> Database Indexes Explained](https://www.essentialsql.com/what-is-a-database-index/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> Indexing in Databases with EXAMPLES](https://www.guru99.com/indexing-in-database.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fchartio.com" alt="Logo" /> What Does Indexing Do?](https://chartio.com/learn/databases/how-does-indexing-work/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.freecodecamp.org" alt="Logo" /> An in-depth look at Database Indexing](https://www.freecodecamp.org/news/database-indexing-at-a-glance-bb50809d48bd/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Indexing your database data — the easy way](https://medium.com/faun/explained-indexing-your-database-data-the-easy-way-3c7127ed36a) ### Data Integrity Learn how to assure the accuracy and consistency of data. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Data Integrity](https://en.wikipedia.org/wiki/Data_integrity) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.talend.com" alt="Logo" /> What is Data Integrity and Why Is It Important?](https://www.talend.com/resources/what-is-data-integrity/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdigitalguardian.com" alt="Logo" /> hat is Data Integrity?](https://digitalguardian.com/blog/what-data-integrity-data-protection-101) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdatabase.guide" alt="Logo" /> What is Data Integrity?](https://database.guide/what-is-data-integrity/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialcup.com" alt="Logo" /> Data Integrity](https://www.tutorialcup.com/dbms/integrity.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Database Design, Data Integrity](https://www.youtube.com/watch?v=1D_h-yFtQVo) ### Normalization Learn how data normalization can help you decrease data redundancy and improve data integrity in your database. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Database normalization](https://en.wikipedia.org/wiki/Database_normalization) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.essentialsql.com" alt="Logo" /> Database Normalization (Explained in Simple English)](https://www.essentialsql.com/get-ready-to-learn-sql-database-normalization-explained-in-simple-english/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> What is Normalization?](https://www.guru99.com/database-normalization.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Normal Forms in DBMS](https://www.geeksforgeeks.org/normal-forms-in-dbms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchsqlserver.techtarget.com" alt="Logo" /> Database normalization](https://searchsqlserver.techtarget.com/definition/normalization) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ftowardsdatascience.com" alt="Logo" /> Database Normalization Explained](https://towardsdatascience.com/database-normalization-explained-53e60a494495) #### Functional Dependencies Learn how to find functional dependencies to improve your database design. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.lifewire.com" alt="Logo" /> Full Functional Dependency in Database Normalization](https://www.lifewire.com/full-functional-dependency-1019753) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstackoverflow.com" alt="Logo" /> Stackoverflow - Functional dependency and normalization](https://stackoverflow.com/questions/4199444/functional-dependency-and-normalization) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - DBMS, Normalization](https://www.tutorialspoint.com/dbms/database_normalization.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.ict.griffith.edu.au" alt="Logo" /> Functional Dependencies and Normalization](http://www.ict.griffith.edu.au/~jw/normalization/assets/Functional%20Dependencies%20and%20Normalization.pdf) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> DBMS Functional Dependency](https://www.guru99.com/dbms-functional-dependency.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Armstrong's axioms](https://en.wikipedia.org/wiki/Armstrong%27s_axioms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.includehelp.com" alt="Logo" /> Armstrong's Axioms in Functional Dependency](https://www.includehelp.com/dbms/armstrongs-axioms-in-functional-dependency.aspx) #### Normal Forms Learn how normal forms can help you normalize your database. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Normal forms](https://en.wikipedia.org/wiki/Database_normalization#Normal_forms) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbeginnersbook.com" alt="Logo" /> 1NF, 2NF, 3NF and BCNF in Database](https://beginnersbook.com/2015/05/normalization-in-dbms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fopentextbc.ca" alt="Logo" /> Chapter 12 Normalization](https://opentextbc.ca/dbdesign01/chapter/chapter-12-normalization/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Boyce–Codd normal form](https://en.wikipedia.org/wiki/Boyce%E2%80%93Codd_normal_form) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Boyce-Codd Normal Form (BCNF)](https://www.geeksforgeeks.org/boyce-codd-normal-form-bcnf/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Third normal form](https://en.wikipedia.org/wiki/Third_normal_form) ### Transactions Learn how transactions can group a set of database tasks into a single execution unit. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Database transaction](https://en.wikipedia.org/wiki/Database_transaction) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstackoverflow.com" alt="Logo" /> Stackoverflow - What is a database transaction?](https://stackoverflow.com/questions/974596/what-is-a-database-transaction) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - DBMS, Transaction](https://www.tutorialspoint.com/dbms/dbms_transaction.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fdb4beginners.com" alt="Logo" /> Why do you need to know transactions?](http://db4beginners.com/blog/relationaldb-transaction/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> SQL Transactions](https://www.geeksforgeeks.org/sql-transactions/) #### ACID Learn about the ACID properties of transactions. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvladmihalcea.com" alt="Logo" /> A beginner’s guide to ACID](https://vladmihalcea.com/a-beginners-guide-to-acid-and-database-transactions/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.guru99.com" alt="Logo" /> DBMS Transaction Management: ACID Properties](https://www.guru99.com/dbms-transaction-management.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> ACID Properties in DBMS](https://www.geeksforgeeks.org/acid-properties-in-dbms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - ACID](https://en.wikipedia.org/wiki/ACID) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.ibm.com" alt="Logo" /> ACID properties of transactions](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.4.0/product-overview/acid.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fblog.yugabyte.com" alt="Logo" /> A Primer on ACID Transactions](https://blog.yugabyte.com/a-primer-on-acid-transactions/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fstackoverflow.com" alt="Logo" /> Stackoverflow - How do ACID and database transactions work?](https://stackoverflow.com/questions/3740280/how-do-acid-and-database-transactions-work) #### Serializability Learn how to determine whether a schedule is serializable and leaves the database in a consistent state. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Serializability](https://en.wikipedia.org/wiki/Serializability) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialcup.com" alt="Logo" /> Transaction Serializability in DBMS](https://www.tutorialcup.com/dbms/transaction-serializability.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fbeginnersbook.com" alt="Logo" /> DBMS Serializability](https://beginnersbook.com/2018/12/dbms-serializability/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> View Serializability in DBMS Transactions](https://www.geeksforgeeks.org/view-serializability-in-dbms-transactions/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Conflict Serializability in DBMS](https://www.geeksforgeeks.org/conflict-serializability-in-dbms/) #### Locks Learn about locks and when they should be used. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Record locking](https://en.wikipedia.org/wiki/Record_locking) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.methodsandtools.com" alt="Logo" /> Database Locking: What, why and how?](http://www.methodsandtools.com/archive/archive.php?id=83) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fvladmihalcea.com" alt="Logo" /> A beginner’s guide to locking and lost updates](https://vladmihalcea.com/a-beginners-guide-to-database-locking-and-the-lost-update-phenomena/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.microsoft.com" alt="Logo" /> Monitoring SQL Database Locks](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/monitor-database-locks) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Implementation of Locking in DBMS](https://www.geeksforgeeks.org/implementation-of-locking-in-dbms/) ##### Deadlocks Learn about deadlocks and why they should be avoided. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Deadlock in DBMS](https://www.geeksforgeeks.org/deadlock-in-dbms/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Deadlock](https://en.wikipedia.org/wiki/Deadlock) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.studytonight.com" alt="Logo" /> What is a Deadlock?](https://www.studytonight.com/operating-system/deadlocks) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.oracle.com" alt="Logo" /> Oracle - Deadlocks](https://docs.oracle.com/javadb/10.8.3.0/devguide/cdevconcepts28436.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatis.techtarget.com" alt="Logo" /> Deadlock Definition](https://whatis.techtarget.com/definition/deadlock) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.javatpoint.com" alt="Logo" /> Introduction to Deadlock](https://www.javatpoint.com/os-deadlocks-introduction) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> dev.to - Understanding SQL Server Deadlocks](https://dev.to/integerman/understanding-sql-server-deadlocks-2ej6) #### Precedence graph Learn how to create a precedence graph to test for conflict serializability of a schedule. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Precedence graph](https://en.wikipedia.org/wiki/Precedence_graph) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - How to draw a precedence graph](https://www.youtube.com/watch?v=U3SHusK80q0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fashutoshtripathi.com" alt="Logo" /> Precedence Graph to check Conflict Serializable Schedule](https://ashutoshtripathi.com/2017/04/15/how-to-check-conflict-serializability-using-precedence-graph-algorithm/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.exploredatabase.com" alt="Logo" /> Testing for conflict serializablity](http://www.exploredatabase.com/2017/11/testing-for-conflict-serializablity-using-precedence-graph.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.includehelp.com" alt="Logo" /> Precedence Graph, DBMS](https://www.includehelp.com/dbms/precedence-graph.aspx) ### Servers ### Architectural Models Learn about the fundamental architectural server models. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.techopedia.com" alt="Logo" /> Server Architecture](https://www.techopedia.com/definition/30262/server-architecture) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Architectural model](https://www.youtube.com/watch?v=SKtR7NVxYFA) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sciencedirect.com" alt="Logo" /> Architectural Model](https://www.sciencedirect.com/topics/computer-science/architectural-model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww2.imm.dtu.dk" alt="Logo" /> Distributed Systems: Models and Design](http://www2.imm.dtu.dk/courses/02220/2018/L3/Models.pdf) #### Client-Server Learn about the client-server model. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Client-server model](https://en.wikipedia.org/wiki/Client%E2%80%93server_model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fcio-wiki.org" alt="Logo" /> Client Server Architecture](https://cio-wiki.org/wiki/Client_Server_Architecture) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ffreefeast.info" alt="Logo" /> Understanding What Client Server Architecture Is All About](https://freefeast.info/general-it-articles/client-server-architecture/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsimple.wikipedia.org" alt="Logo" /> Wikipedia - Client-server](https://simple.wikipedia.org/wiki/Client-server) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchnetworking.techtarget.com" alt="Logo" /> Client-server model (client-server architecture)](https://searchnetworking.techtarget.com/definition/client-server) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.techopedia.com" alt="Logo" /> Client-Server Model](https://www.techopedia.com/definition/18321/client-server-model) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.sciencedirect.com" alt="Logo" /> Learn more about Client-Server Model](https://www.sciencedirect.com/topics/computer-science/client-server-model) #### Proxy Server Learn about the proxy-server model. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Proxy Server](https://en.wikipedia.org/wiki/Proxy_server) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - What is a Proxy Server?](https://www.youtube.com/watch?v=5cPIukqXe5w) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.varonis.com" alt="Logo" /> What is a Proxy Server and How Does it Work?](https://www.varonis.com/blog/what-is-a-proxy-server/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwhatis.techtarget.com" alt="Logo" /> Proxy Server Definition](https://whatis.techtarget.com/definition/proxy-server) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.itpro.co.uk" alt="Logo" /> What is a proxy server?](https://www.itpro.co.uk/server-storage/30246/what-is-a-proxy-server) #### Peer-To-Peer Learn about the peer-to-peer model. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Peer-to-peer](https://en.wikipedia.org/wiki/Peer-to-peer) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - What is a Peer to Peer Network? ](https://www.youtube.com/watch?v=ie-qRQIQT4I) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.computerworld.com" alt="Logo" /> What's a Peer-to-Peer (P2P) Network?](https://www.computerworld.com/article/2588287/networking-peer-to-peer-network.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchnetworking.techtarget.com" alt="Logo" /> Peer-to-peer (P2P)](https://searchnetworking.techtarget.com/definition/peer-to-peer) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdev.to" alt="Logo" /> Make a P2P connection in 10 minutes](https://dev.to/carloslfu/make-a-p2p-connection-in-10-minutes-4b32) ### Middleware Learn about middleware. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Middleware](https://en.wikipedia.org/wiki/Middleware) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchapparchitecture.techtarget.com" alt="Logo" /> Middleware Definition](https://searchapparchitecture.techtarget.com/definition/middleware) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.quora.com" alt="Logo" /> Quora - Why is Middleware important?](https://www.quora.com/Why-is-Middleware-important) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.redhat.com" alt="Logo" /> What is middleware?](https://www.redhat.com/en/topics/middleware/what-is-middleware) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.talend.com" alt="Logo" /> What is Middleware? Technology’s Go-to Middleman](https://www.talend.com/resources/what-is-middleware/) ### Request-Reply Protocol Learn how computers communicate with eachother using the request-reply protocol. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Request Response](https://en.wikipedia.org/wiki/Request%E2%80%93response) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Event-Driven Architecture](https://www.youtube.com/watch?v=3bxAm3XIFmk) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsolace.com" alt="Logo" /> Request/Reply](https://solace.com/samples/solace-samples-jms/request-reply/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=http%3A%2F%2Fwww.informit.com" alt="Logo" /> Enterprise Integration - Request-Reply](http://www.informit.com/articles/article.aspx?p=1398616&seqNum=4) #### UDP Learn about the UDP transport layer protocol. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchnetworking.techtarget.com" alt="Logo" /> UDP (User Datagram Protocol)](https://searchnetworking.techtarget.com/definition/UDP-User-Datagram-Protocol) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - User Datagram Protocol](https://en.wikipedia.org/wiki/User_Datagram_Protocol) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.techopedia.com" alt="Logo" /> User Datagram Protocol (UDP)](https://www.techopedia.com/definition/13460/user-datagram-protocol-udp) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Explained! UDP and TCP](https://www.youtube.com/watch?v=1LYqtkgtSPU) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> User Datagram Protocol](https://www.geeksforgeeks.org/user-datagram-protocol-udp/) #### TCP Learn about the TCP transport layer protocol. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchnetworking.techtarget.com" alt="Logo" /> TCP (Transmission Control Protocol)](https://searchnetworking.techtarget.com/definition/TCP) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Transmission Control Protocol](https://en.wikipedia.org/wiki/Transmission_Control_Protocol) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchnetworking.techtarget.com" alt="Logo" /> TCP/IP (Transmission Control Protocol/Internet Protocol)](https://searchnetworking.techtarget.com/definition/TCP-IP) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> Services and Segment structure in TCP](https://www.geeksforgeeks.org/services-and-segment-structure-in-tcp/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> TCP and UDP in Transport Layer](https://www.geeksforgeeks.org/tcp-and-udp-in-transport-layer/) ### REST API Learn how an API can be designed to be RESTful. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipeia - Representational state transfer](https://en.wikipedia.org/wiki/Representational_state_transfer) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.restapitutorial.com" alt="Logo" /> Learn REST: A RESTful Tutorial](https://www.restapitutorial.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - REST API concepts and examples](https://www.youtube.com/watch?v=7YcW25PHnAA) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Frestfulapi.net" alt="Logo" /> REST API Tutorial](https://restfulapi.net/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.mulesoft.com" alt="Logo" /> What is a REST API?](https://www.mulesoft.com/resources/api/what-is-rest-api-design) #### CRUD Learn about the CRUD operations. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Create, read, update and delete](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.codecademy.com" alt="Logo" /> Codecademy - What is CRUD?](https://www.codecademy.com/articles/what-is-crud) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.bmc.com" alt="Logo" /> What is the Difference between REST and CRUD?](https://www.bmc.com/blogs/rest-vs-crud-whats-the-difference/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Introduction to CRUD Operations](https://www.youtube.com/watch?v=Lyi8SoVdkhM) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Ftyk.io" alt="Logo" /> REST was NEVER about CRUD](https://tyk.io/rest-never-crud/) ### Express Learn about the Node.js web application framework called Express. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fexpressjs.com" alt="Logo" /> Express](https://expressjs.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.tutorialspoint.com" alt="Logo" /> Tutorialspoint - Express Framework](https://www.tutorialspoint.com/nodejs/nodejs_express_framework.htm) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Express.js & Node.js Course for Beginners](https://www.youtube.com/watch?v=G8uL0lFFoN0) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fmedium.com" alt="Logo" /> Understanding Node.js & Express.js fundamentals](https://medium.com/@LindaVivah/the-beginners-guide-understanding-node-js-express-js-fundamentals-e15493462be1) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Express.js](https://en.wikipedia.org/wiki/Express.js) ### GraphQL Learn how to use the GraphQL query language. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgraphql.org" alt="Logo" /> GraphQL](https://graphql.org/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.youtube.com" alt="Logo" /> Youtube - Introduction to GraphQL](https://www.youtube.com/watch?v=Y0lDGjwRYKw) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fgithub.com" alt="Logo" /> Github - GraphQL Specification](https://github.com/graphql/graphql-spec) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.howtographql.com" alt="Logo" /> The Fullstack Tutorial for GraphQL](https://www.howtographql.com/) ### GNU/Linux Learn about the GNU/Linux operating system * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.gnu.org" alt="Logo" /> Linux and the GNU System](https://www.gnu.org/gnu/linux-and-gnu.en.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - GNU/Linux naming controversy](https://en.wikipedia.org/wiki/GNU/Linux_naming_controversy) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.debian.org" alt="Logo" /> What is GNU/Linux?](https://www.debian.org/releases/stable/amd64/ch01s02.en.html) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchdatacenter.techtarget.com" alt="Logo" /> GNU Linux](https://searchdatacenter.techtarget.com/definition/GNU-Linux) ### Docker Learn how to use Docker. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.docker.com" alt="Logo" /> Docker](https://www.docker.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Docker (software)](https://en.wikipedia.org/wiki/Docker_(software)) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocker-curriculum.com" alt="Logo" /> Docker for beginners](https://docker-curriculum.com/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fopensource.com" alt="Logo" /> What is Docker?](https://opensource.com/resources/what-docker) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fdocs.docker.com" alt="Logo" /> Get Started, Part 1: Orientation and setup](https://docs.docker.com/get-started/) ### SSH Learn how to use SSH and learn how to connect to a device using an SSH client. * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fen.wikipedia.org" alt="Logo" /> Wikipedia - Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fsearchsecurity.techtarget.com" alt="Logo" /> Secure Shell (SSH)](https://searchsecurity.techtarget.com/definition/Secure-Shell) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fwww.geeksforgeeks.org" alt="Logo" /> SSH command in Linux with Examples](https://www.geeksforgeeks.org/ssh-command-in-linux-with-examples/) * [ ] [<img style="margin-bottom: 0;" src="https://plus.google.com/_/favicon?domain_url=https%3A%2F%2Fhelp.ubnt.com" alt="Logo" /> How to Establish a Connection Using SSH](https://help.ubnt.com/hc/en-us/articles/218850057-Intro-to-Networking-How-to-Establish-a-Connection-Using-SSH) [](#contributors) ## ➤ Contributors | [<img alt="Andreas Mehlsen" src="https://avatars1.githubusercontent.com/u/6267397?s=460&v=4" width="100">](https://twitter.com/andreasmehlsen) | [<img alt="You?" src="https://joeschmoe.io/api/v1/random" width="100">](https://github.com/andreasbm/readme/blob/master/CONTRIBUTING.md) | |:--------------------------------------------------:|:--------------------------------------------------:| | [Andreas Mehlsen](https://twitter.com/andreasmehlsen) | [You?](https://github.com/andreasbm/readme/blob/master/CONTRIBUTING.md) | | 🔥 | | [](#license) ## ➤ License Licensed under [MIT](https://opensource.org/licenses/MIT).

Laravel Dusk provides simple end-to-end testing and browser automation.

<p align="center"><img src="/art/logo.svg" alt="Logo Laravel Dusk"></p> <p align="center"> <a href="https://github.com/laravel/dusk/actions"><img src="https://github.com/laravel/dusk/workflows/tests/badge.svg" alt="Build Status"></a> <a href="https://packagist.org/packages/laravel/dusk"><img src="https://img.shields.io/packagist/dt/laravel/dusk" alt="Total Downloads"></a> <a href="https://packagist.org/packages/laravel/dusk"><img src="https://img.shields.io/packagist/v/laravel/dusk" alt="Latest Stable Version"></a> <a href="https://packagist.org/packages/laravel/dusk"><img src="https://img.shields.io/packagist/l/laravel/dusk" alt="License"></a> </p> ## Introduction Laravel Dusk provides an expressive, easy-to-use browser automation and testing API. By default, Dusk does not require you to install JDK or Selenium on your machine. Instead, Dusk uses a standalone Chromedriver. However, you are free to utilize any other Selenium driver you wish. ## Official Documentation Documentation for Dusk can be found on the [Laravel website](https://laravel.com/docs/dusk). ## Contributing Thank you for considering contributing to Dusk! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). ## Code of Conduct In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). ## Security Vulnerabilities Please review [our security policy](https://github.com/laravel/dusk/security/policy) on how to report security vulnerabilities. ## License Laravel Dusk is open-sourced software licensed under the [MIT license](LICENSE.md).

:books: The starting point of your career as a Software Quality Assurance Engineer | Quality Automation Engineer :books:

👁 Visual Regression Testing for Storybook

packages/loki/README.md

Test Kitchen is an integration tool for developing and testing infrastructure code and software on isolated target platforms

# Test Kitchen [](http://badge.fury.io/rb/test-kitchen) [](https://dev.azure.com/test-kitchen/test-kitchen/_build/latest?definitionId=6&branchName=main) | | | | ----------- | --------------------------------------------------------------------------------| | Website | [https://kitchen.ci/][website] | | Source Code | [https://kitchen.ci/docs/getting-started/introduction/][guide] | | Slack | [#test-kitchen][slack] channel on Chef Community Slack | **Test Kitchen is an integration tool for developing and testing infrastructure code and software on isolated target platforms.** ## Getting Started Guide To learn how to install and setup Test Kitchen for developing infrastructure code, check out the [Getting Started Guide][guide]. If you want to get going super fast, then try the Quick Start next... ## Quick Start Test Kitchen is a RubyGem and can be installed with: ```shell gem install test-kitchen ``` If you use Bundler, you can add `gem "test-kitchen"` to your Gemfile and make sure to run `bundle install`. Next add support to your library, Chef cookbook, or empty project with `kitchen init`: ```shell kitchen init ``` A `kitchen.yml` file will be created in your project base directory. This file describes your testing configuration; what you want to test and on which target platforms. Each of these suite and platform combinations are called instances. By default your instances will be converged with Chef Solo and run in Vagrant virtual machines. Get a listing of your instances with: ```shell kitchen list ``` Run Chef Infra Client on an instance, in this case `default-ubuntu-2004`, with: ```shell kitchen converge default-ubuntu-2004 ``` Destroy all instances with: ```shell kitchen destroy ``` You can clone a Chef Infra cookbook project that contains Test Kitchen support and run through all the instances in serial by running: ```shell kitchen test ``` ## Usage There is help included with the `kitchen help` subcommand which will list all subcommands and their usage: ```shell kitchen help test ``` More verbose logging for test-kitchen can be specified when running test-kitchen from the command line using: ```shell kitchen test -l debug ``` For the provisioner (e.g. chef-solo or chef-infra) add a `log_level` item to the provisioner section of the `.kitchen.yml` For more information on setting `log_level` see the [configuration documentation](https://kitchen.ci/docs/reference/configuration/). ## Documentation Documentation is being added on the Test Kitchen [website][website]. Please read and contribute to improve them! ## Versioning Test Kitchen aims to adhere to [Semantic Versioning 2.0.0][semver]. ## Community and Ecosystem If you would like to see a few of the plugins or ecosystem helpers, please look at [ECOSYSTEM.md][ecosystem]. ## Development * Source hosted at [GitHub][repo] * Report issues/questions/feature requests on [GitHub Issues][issues] Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example: 1. Fork the repo 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Added some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request ## Authors Created by [Fletcher Nichol][fnichol] (<[email protected]>). Maintained by Chef Software and a growing community of [contributors][contributors]. ## License Apache License, Version 2.0 (see [LICENSE][license]) [contributors]: https://github.com/test-kitchen/test-kitchen/graphs/contributors [ecosystem]: https://github.com/test-kitchen/test-kitchen/blob/main/ECOSYSTEM.md [fnichol]: https://github.com/fnichol [guide]: https://kitchen.ci/docs/getting-started/introduction/ [issues]: https://github.com/test-kitchen/test-kitchen/issues [license]: https://github.com/test-kitchen/test-kitchen/blob/main/LICENSE [repo]: https://github.com/test-kitchen/test-kitchen [semver]: https://semver.org/ [slack]: https://chefcommunity.slack.com/messages/testkitchen/details/ [website]: https://kitchen.ci/

Chaos Monkey for Spring Boot

[](https://www.apache.org/licenses/LICENSE-2.0.txt) [](https://github.com/codecentric/chaos-monkey-spring-boot/actions?query=workflow%3A%22Chaos+Monkey+Build%22) [](https://codecov.io/gh/codecentric/chaos-monkey-spring-boot) [](https://maven-badges.herokuapp.com/maven-central/de.codecentric/chaos-monkey-spring-boot/) [](CODE_OF_CONDUCT.adoc) [](https://gitpod.io/#https://github.com/codecentric/chaos-monkey-spring-boot) [](https://open.vscode.dev/microsoft/vscode) # Chaos Monkey for Spring Boot ### inspired by Chaos Engineering at Netflix <p align="center"> <img src="docs/images/sb-chaos-monkey-logo.png"> </p> This project provides a Chaos Monkey for Spring Boot applications and will try to attack your running Spring Boot App. >Everything from getting started to advanced usage is explained in the [Documentation for Chaos Monkey for Spring Boot](https://codecentric.github.io/chaos-monkey-spring-boot/latest/) ## Introduction If you're not familiar with the principles of chaos engineering yet, check out this blog post and enter the world of chaos engineering. <a href="https://blog.codecentric.de/en/2018/07/chaos-engineering/" target="_blank"><img src="https://pbs.twimg.com/media/DhaRNO7XUAAi00i.jpg" alt="Chaos Engineering – withstanding turbulent conditions in production" width="260" height="155" border="10" /></a><br> Get familiar with the Chaos Monkey for Spring Boot in the following video, <a href="https://goo.gl/r2Tmig" target="_blank">available on YouTube</a>: <a href="https://goo.gl/r2Tmig" target="_blank"><img src="https://i.ytimg.com/vi/7sQiIR9qCdA/maxresdefault.jpg" alt="Chaos Monkey for Spring Boot" width="260" height="155" border="10" /></a><br> ## What is the goal of Chaos Monkey? Inspired by [PRINCIPLES OF CHAOS ENGINEERING](https://principlesofchaos.org/), with a focus on [Spring Boot](https://projects.spring.io/spring-boot/), Chaos Monkey wants to test applications better and especially during operation. After writing many unit and integration tests, a code coverage from 70% to 80%, this unpleasant feeling remains, how our baby behaves in production? Many questions remain unanswered: - Will our fallbacks work? - How does the application behave with network latency? - What if one of our services breaks down? - Service Discovery works, but is our Client-Side-Load-Balancing also working? As you can see, there are many more questions and open topics you have to deal with. That was the start of Chaos Monkey for Spring Boot. ### How does it work? If Spring Boot Chaos Monkey is on your classpath and activated with profile name `chaos-monkey`, it will automatically hook into your application. Now you can activate [watchers](https://codecentric.github.io/chaos-monkey-spring-boot/latest/#watchers), which look for classes to [assault](https://codecentric.github.io/chaos-monkey-spring-boot/latest/#assaults). There are also [runtime assaults](https://codecentric.github.io/chaos-monkey-spring-boot/latest/#runtime-assaults), which attack your whole application. <p align="center"> <img class="imgborder s1" width="90%" src="docs/images/sb-chaos-monkey-architecture.png"> </p> ## Be social and communicative! If you start to implement Chaos Engineering at your company, then you must be a very social and communicative person. Why? Because you will get to know many of your colleagues personally in a very short time when your chaos experiments strike. ### Check your resilience Are your services already resilient and can handle failures? Don´t start a chaos experiment if not! ### Implement active application monitoring Check your monitoring and check if you can see the overall state of your system. There are many great tools out there to get a pleasant feeling about your entire system. ### Define steady states Define a metric to check a steady state of your service and of course your entire system. Start small with a service that is not critical. ### Do not start in production Of course, you can start in production, but keep in mind... > The best place on earth is...production!<br> > *Josh Long* ...so let's keep production as the best place on earth and look for our first experiences on another stage. If all goes well, and you're confident, run it in production. ## Documentation [Documentation](https://codecentric.github.io/chaos-monkey-spring-boot/latest/) ## Help We are using GitHub issues to track bugs, improvements and new features (for more information see [Contributions](#contributions)). If you have a general question on how to use Chaos Monkey for Spring Boot, please ask on Stack Overflow using the tag [`#spring-boot-chaos-monkey`](https://stackoverflow.com/questions/tagged/spring-boot-chaos-monkey). ## Contributions Chaos Monkey is open source and welcomes contributions from everyone. The [contribution guideline](https://github.com/codecentric/chaos-monkey-spring-boot/blob/main/CONTRIBUTING.adoc) is where you should begin in order to best understand how to contribute to this project. ## Releases [Releases](https://github.com/codecentric/chaos-monkey-spring-boot/releases)

PHP Architecture Tester - Easy to use architectural testing tool for PHP :heavy_check_mark:

<p align="center"> <img width="500px" src="https://raw.githubusercontent.com/carlosas/phpat/master/.github/logo.png" alt="PHP Architecture Tester"> </p> <h2 align="center">Easy to use architecture testing tool for PHP</h2> <p align="center"> <a> <img src="https://img.shields.io/packagist/v/phpat/phpat?label=last%20version&style=for-the-badge" alt="Version"> </a> <a> <img src="https://img.shields.io/packagist/php-v/phpat/phpat?style=for-the-badge" alt="PHP Version"> </a> <a> <img src="https://img.shields.io/badge/phpstan-%5E1.3-blue?style=for-the-badge" alt="PHPStan Version"> </a> <a> <img src="https://img.shields.io/badge/contributions-welcome-green.svg?style=for-the-badge" alt="Contributions welcome"> </a> </p> <hr /> ℹ️ **PHPat** has been transformed into a [PHPStan](https://phpstan.org/) extension. Read the [UPGRADE notes](doc/UPGRADE-0.10.md). <br /> The standalone version (v0.9) will remain available and will receive critical bugfixes if required. <h2></h2> ### Introduction 📜 **PHP Architecture Tester** is a static analysis tool designed to verify architectural requirements. It provides a natural language abstraction that enables you to define your own architectural rules and and assess their compliance in your code. Check out the section [WHAT TO TEST](doc/WHAT_TO_TEST.md) to see some examples of typical use cases. <h2></h2> ### Installation 💽 Require **PHPat** with [Composer](https://getcomposer.org/): ```bash composer require --dev phpat/phpat ``` If you also install [phpstan/extension-installer](https://github.com/phpstan/extension-installer) then you're all set! <details> <summary>Manual installation</summary> If you don't want to use `phpstan/extension-installer`, enable the extension in your PHPStan configuration: ```neon # phpstan.neon includes: - vendor/phpat/phpat/extension.neon ``` </details> <h2></h2> ### Configuration 🔧 You will need to register your test classes in your PHPStan configuration: ```neon # phpstan.neon services: - class: Tests\Architecture\MyFirstTest tags: - phpat.test - class: Tests\Architecture\MySecondTest tags: - phpat.test ``` ⚠️ Your architecture tests folder should be included in the PHPStan analysed paths. See [PHPat's own PHPat configuration](ci/phpstan-phpat.neon) as an example. You can configure some PHPat options as follows: ```neon # phpstan.neon parameters: phpat: ignore_doc_comments: true ``` <details><summary>Complete list of options</summary> <br /> | Name | Description | Default | |-------------------------------------------|-------------------------------------------------------|:------------:| | `ignore_doc_comments` | Ignore relations on Doc Comments | *false* | </details> <h2></h2> ### Test definition 📓 There are different [Selectors](doc/SELECTORS.md) available to select the classes involved in a rule, and a wide set of [Assertions](doc/ASSERTIONS.md). Here's an example test with a rule: ```php <?php use PHPat\Selector\Selector; use PHPat\Test\Builder\Rule; use PHPat\Test\PHPat; use App\Domain\SuperForbiddenClass; class MyFirstTest { public function test_domain_does_not_depend_on_other_layers(): Rule { return PHPat::rule() ->classes(Selector::namespace('App\Domain')) ->shouldNotDependOn() ->classes( Selector::namespace('App\Application'), Selector::namespace('App\Infrastructure'), Selector::classname(SuperForbiddenClass::class), Selector::classname('/^SomeVendor\\\.*\\\ForbiddenSubfolder\\\.*/', true) ); } } ``` <h2></h2> ### Usage 🚀 Run **PHPStan** as usual: ```bash php vendor/bin/phpstan analyse -c phpstan.neon ``` <h2></h2> > **Warning**<br /> > The launch of early-stage releases (0.x.x) could break the API according to [Semantic Versioning 2.0](https://semver.org/). > We are using *minor* for breaking changes until the release of the stable `1.0.0` version. **PHP Architecture Tester** is open source, contributions are welcome. Please have a look to the [Contribution docs](.github/CONTRIBUTING.md). <br /> **Sponsors** (free license) <a href="https://jb.gg/OpenSourceSupport"> <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo" width="100"/> </a> <a href="https://www.blackfire.io"> <img src="https://avatars.githubusercontent.com/u/8961067?s=100" alt="BlackFire Logo" width="100"/> </a>

A toolkit with common assertions and mocks that plays nicely with the standard library

Testify - Thou Shalt Write Tests ================================ ℹ️ We are working on testify v2 and would love to hear what you'd like to see in it, have your say here: https://cutt.ly/testify [](https://travis-ci.org/stretchr/testify) [](https://goreportcard.com/report/github.com/stretchr/testify) [](https://pkg.go.dev/github.com/stretchr/testify) Go code (golang) set of packages that provide many tools for testifying that your code will behave as you intend. Features include: * [Easy assertions](#assert-package) * [Mocking](#mock-package) * [Testing suite interfaces and functions](#suite-package) Get started: * Install testify with [one line of code](#installation), or [update it with another](#staying-up-to-date) * For an introduction to writing test code in Go, see http://golang.org/doc/code.html#Testing * Check out the API Documentation http://godoc.org/github.com/stretchr/testify * To make your testing life easier, check out our other project, [gorc](http://github.com/stretchr/gorc) * A little about [Test-Driven Development (TDD)](http://en.wikipedia.org/wiki/Test-driven_development) [`assert`](http://godoc.org/github.com/stretchr/testify/assert "API documentation") package ------------------------------------------------------------------------------------------- The `assert` package provides some helpful methods that allow you to write better test code in Go. * Prints friendly, easy to read failure descriptions * Allows for very readable code * Optionally annotate each assertion with a message See it in action: ```go package yours import ( "testing" "github.com/stretchr/testify/assert" ) func TestSomething(t *testing.T) { // assert equality assert.Equal(t, 123, 123, "they should be equal") // assert inequality assert.NotEqual(t, 123, 456, "they should not be equal") // assert for nil (good for errors) assert.Nil(t, object) // assert for not nil (good when you expect something) if assert.NotNil(t, object) { // now we know that object isn't nil, we are safe to make // further assertions without causing any errors assert.Equal(t, "Something", object.Value) } } ``` * Every assert func takes the `testing.T` object as the first argument. This is how it writes the errors out through the normal `go test` capabilities. * Every assert func returns a bool indicating whether the assertion was successful or not, this is useful for if you want to go on making further assertions under certain conditions. if you assert many times, use the below: ```go package yours import ( "testing" "github.com/stretchr/testify/assert" ) func TestSomething(t *testing.T) { assert := assert.New(t) // assert equality assert.Equal(123, 123, "they should be equal") // assert inequality assert.NotEqual(123, 456, "they should not be equal") // assert for nil (good for errors) assert.Nil(object) // assert for not nil (good when you expect something) if assert.NotNil(object) { // now we know that object isn't nil, we are safe to make // further assertions without causing any errors assert.Equal("Something", object.Value) } } ``` [`require`](http://godoc.org/github.com/stretchr/testify/require "API documentation") package --------------------------------------------------------------------------------------------- The `require` package provides same global functions as the `assert` package, but instead of returning a boolean result they terminate current test. See [t.FailNow](http://golang.org/pkg/testing/#T.FailNow) for details. [`mock`](http://godoc.org/github.com/stretchr/testify/mock "API documentation") package ---------------------------------------------------------------------------------------- The `mock` package provides a mechanism for easily writing mock objects that can be used in place of real objects when writing test code. An example test function that tests a piece of code that relies on an external object `testObj`, can setup expectations (testify) and assert that they indeed happened: ```go package yours import ( "testing" "github.com/stretchr/testify/mock" ) /* Test objects */ // MyMockedObject is a mocked object that implements an interface // that describes an object that the code I am testing relies on. type MyMockedObject struct{ mock.Mock } // DoSomething is a method on MyMockedObject that implements some interface // and just records the activity, and returns what the Mock object tells it to. // // In the real object, this method would do something useful, but since this // is a mocked object - we're just going to stub it out. // // NOTE: This method is not being tested here, code that uses this object is. func (m *MyMockedObject) DoSomething(number int) (bool, error) { args := m.Called(number) return args.Bool(0), args.Error(1) } /* Actual test functions */ // TestSomething is an example of how to use our test object to // make assertions about some target code we are testing. func TestSomething(t *testing.T) { // create an instance of our test object testObj := new(MyMockedObject) // setup expectations testObj.On("DoSomething", 123).Return(true, nil) // call the code we are testing targetFuncThatDoesSomethingWithObj(testObj) // assert that the expectations were met testObj.AssertExpectations(t) } // TestSomethingWithPlaceholder is a second example of how to use our test object to // make assertions about some target code we are testing. // This time using a placeholder. Placeholders might be used when the // data being passed in is normally dynamically generated and cannot be // predicted beforehand (eg. containing hashes that are time sensitive) func TestSomethingWithPlaceholder(t *testing.T) { // create an instance of our test object testObj := new(MyMockedObject) // setup expectations with a placeholder in the argument list testObj.On("DoSomething", mock.Anything).Return(true, nil) // call the code we are testing targetFuncThatDoesSomethingWithObj(testObj) // assert that the expectations were met testObj.AssertExpectations(t) } // TestSomethingElse2 is a third example that shows how you can use // the Unset method to cleanup handlers and then add new ones. func TestSomethingElse2(t *testing.T) { // create an instance of our test object testObj := new(MyMockedObject) // setup expectations with a placeholder in the argument list mockCall := testObj.On("DoSomething", mock.Anything).Return(true, nil) // call the code we are testing targetFuncThatDoesSomethingWithObj(testObj) // assert that the expectations were met testObj.AssertExpectations(t) // remove the handler now so we can add another one that takes precedence mockCall.Unset() // return false now instead of true testObj.On("DoSomething", mock.Anything).Return(false, nil) testObj.AssertExpectations(t) } ``` For more information on how to write mock code, check out the [API documentation for the `mock` package](http://godoc.org/github.com/stretchr/testify/mock). You can use the [mockery tool](http://github.com/vektra/mockery) to autogenerate the mock code against an interface as well, making using mocks much quicker. [`suite`](http://godoc.org/github.com/stretchr/testify/suite "API documentation") package ----------------------------------------------------------------------------------------- The `suite` package provides functionality that you might be used to from more common object oriented languages. With it, you can build a testing suite as a struct, build setup/teardown methods and testing methods on your struct, and run them with 'go test' as per normal. An example suite is shown below: ```go // Basic imports import ( "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/suite" ) // Define the suite, and absorb the built-in basic suite // functionality from testify - including a T() method which // returns the current testing context type ExampleTestSuite struct { suite.Suite VariableThatShouldStartAtFive int } // Make sure that VariableThatShouldStartAtFive is set to five // before each test func (suite *ExampleTestSuite) SetupTest() { suite.VariableThatShouldStartAtFive = 5 } // All methods that begin with "Test" are run as tests within a // suite. func (suite *ExampleTestSuite) TestExample() { assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive) } // In order for 'go test' to run this suite, we need to create // a normal test function and pass our suite to suite.Run func TestExampleTestSuite(t *testing.T) { suite.Run(t, new(ExampleTestSuite)) } ``` For a more complete example, using all of the functionality provided by the suite package, look at our [example testing suite](https://github.com/stretchr/testify/blob/master/suite/suite_test.go) For more information on writing suites, check out the [API documentation for the `suite` package](http://godoc.org/github.com/stretchr/testify/suite). `Suite` object has assertion methods: ```go // Basic imports import ( "testing" "github.com/stretchr/testify/suite" ) // Define the suite, and absorb the built-in basic suite // functionality from testify - including assertion methods. type ExampleTestSuite struct { suite.Suite VariableThatShouldStartAtFive int } // Make sure that VariableThatShouldStartAtFive is set to five // before each test func (suite *ExampleTestSuite) SetupTest() { suite.VariableThatShouldStartAtFive = 5 } // All methods that begin with "Test" are run as tests within a // suite. func (suite *ExampleTestSuite) TestExample() { suite.Equal(suite.VariableThatShouldStartAtFive, 5) } // In order for 'go test' to run this suite, we need to create // a normal test function and pass our suite to suite.Run func TestExampleTestSuite(t *testing.T) { suite.Run(t, new(ExampleTestSuite)) } ``` ------ Installation ============ To install Testify, use `go get`: go get github.com/stretchr/testify This will then make the following packages available to you: github.com/stretchr/testify/assert github.com/stretchr/testify/require github.com/stretchr/testify/mock github.com/stretchr/testify/suite github.com/stretchr/testify/http (deprecated) Import the `testify/assert` package into your code using this template: ```go package yours import ( "testing" "github.com/stretchr/testify/assert" ) func TestSomething(t *testing.T) { assert.True(t, true, "True is true!") } ``` ------ Staying up to date ================== To update Testify to the latest version, use `go get -u github.com/stretchr/testify`. ------ Supported go versions ================== We currently support the most recent major Go versions from 1.13 onward. ------ Contributing ============ Please feel free to submit issues, fork the repository and send pull requests! When submitting an issue, we ask that you please include a complete test function that demonstrates the issue. Extra credit for those using Testify to write the test code that demonstrates it. Code generation is used. Look for `CODE GENERATED AUTOMATICALLY` at the top of some files. Run `go generate ./...` to update generated files. We also chat on the [Gophers Slack](https://gophers.slack.com) group in the `#testify` and `#testify-dev` channels. ------ License ======= This project is licensed under the terms of the MIT license.

iOS touch synthesis library

<p align="center"><img src="https://user-images.githubusercontent.com/585835/116218212-273b4880-a6ff-11eb-93ec-7c28d821f620.png" alt="" width="80" height="80"></p> <h1 align="center">Hammer</h1> <p align="center">If you can't touch this, it's Hammer time!</p> <p align="center"><img src="https://user-images.githubusercontent.com/585835/116217617-ab410080-a6fe-11eb-9de1-3d42f7dd6037.gif" alt="Demo"></p> <details open="open"> <summary>Table of Contents</summary> <ol> <li><a href="#introduction">Introduction</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#setup">Setup</a></li> <li><a href="#usage">Usage</a><ul> <li><a href="#simulating-fingers">Simulating Fingers</a></li> <li><a href="#simulating-stylus">Simulating Stylus</a></li> <li><a href="#simulating-keyboard">Simulating Keyboard</a></li> <li><a href="#finding-a-subview">Finding a Subview</a></li> <li><a href="#waiting">Waiting</a></li> </ul></li> <li><a href="#troubleshooting">Troubleshooting</a></li> <li><a href="#license">License</a></li> </ol> </details> ## Introduction Hammer is a touch, stylus and keyboard synthesis library for emulating user interaction events. It enables better ways of triggering UI actions in unit tests, replicating a real world environment as much as possible. ⚠️ IMPORTANT: This library makes extensive use of private APIs and should never be included in a production app. ## Installation #### Requirements Hammer requires Swift 5.3 and iOS 11.0 or later. #### With [SwiftPM](https://swift.org/package-manager) ```swift .package(url: "https://github.com/lyft/Hammer.git", from: "0.13.0") ``` #### With [CocoaPods](https://cocoapods.org/) ```ruby pod 'HammerTests', '~> 0.13.1' ``` ## Setup Hammer unit tests need to run in a host application to be able to generate touches. To configure this select your project in the sidebar, select your test target, and choose a host application in the general tab. The host application can be your main application or an empty wrapper like [TestHost](./TestHost). SwiftPM does not currently support creating applications. To use Hammer with SwiftPM frameworks you need to create an xcodeproj and setup a host application. ## Usage Hammer allows you to simulate fingers, stylus and keyboard events. It also provides various convenience methods to simulate higher level user interactions. To be able to send events to a view you must first create an `EventGenerator`: ```swift // Initialize for an existing UIWindow, ensure that the window is key and visible. let eventGenerator = EventGenerator(window: myWindow) // Initialize for a UIView, automatically wrapping it in a temporary window. let eventGenerator = EventGenerator(view: myView) // Initialize for a UIViewController, automatically wrapping it in a temporary window. let eventGenerator = EventGenerator(viewController: myViewController) ``` When simulating finger or stylus touches, there are multiple ways of specifying a touch location: 1. Default: If you don't specify a location it will use the center of the screen. 2. Point: A CGPoint in screen coordinates. 3. View: A reference to a UIView or UIViewController, the location will be the center of the visible part of the view. 4. Identifier: An accessibility identifier string of a view, the location will be the center of the visible part of the view. By default, Hammer will display simulated touches over the view. You can change this behavior for your event generator. ```swift eventGenerator.showTouches = false ``` ### Simulating Fingers Fingers are the most common method of user interaction on iOS. Hammer supports handling multiple fingers on the screen simultaneously, up to the limit on the device. You can specify the specific finger index you would like to use, if unspecified it will choose the most appropriate one automatically. Primitive events are the basic building blocks of user interactions, they can be combined together to create full gestures. Some methods will allow you to specify a duration and will interpolate the changes during that time. ```swift try eventGenerator.fingerDown(at: CGPoint(x: 10, y: 10)) try eventGenerator.fingerMove(to: CGPoint(x: 20, y: 10), duration: 0.5) try eventGenerator.fingerUp() ``` For convenience, Hammer provides many higher level gestures. If you don't specify a location it will automatically default to the center of the view. ```swift try eventGenerator.fingerTap() try eventGenerator.fingerDoubleTap() try eventGenerator.fingerLongPress() try eventGenerator.twoFingerTap() ``` Many advanced gestures are also available. ```swift try eventGenerator.fingerDrag(from: CGPoint(x: 10, y: 10), to: CGPoint(x: 20, y: 10), duration: 0.5) try eventGenerator.fingerPinch(fromDistance: 100, toDistance: 50, duration: 0.5) try eventGenerator.fingerRotate(angle: .pi, duration: 0.5) ``` ### Simulating Stylus Stylus is available when running on an iPad. It allows for additional properties like pressure, altitude and azimuth to be specified. Similar to fingers, primitive events are the basic building blocks of stylus interactions. ```swift try eventGenerator.stylusDown(at: CGPoint(x: 10, y: 10), azimuth: 0, altitude: 0, pressure: 0.5) try eventGenerator.stylusMove(to: CGPoint(x: 20, y: 10), duration: 0.5) try eventGenerator.stylusUp() ``` Hammer also provides many higher level gestures for Stylus. If you don't specify a location it will automatically default to the center of the view. ```swift try eventGenerator.stylusTap() try eventGenerator.stylusDoubleTap() try eventGenerator.stylusLongPress() ``` ### Simulating Keyboard Keyboard methods take an explicit `KeyboardKey` object or a `Character`. Characters will be mapped to their closest keyboard key, you must wrap them with a shift key modifier if needed. This means that specifying a lowercase "a" character is equivalent to specifying an uppercase "A", this is also true for keys with symbols. ```swift // Explicit `KeyboardKey` try eventGenerator.keyDown(.letterA) try eventGenerator.keyUp(.letterA) // Automatic `Character` mapping try eventGenerator.keyDown("a") try eventGenerator.keyUp("a") // Convenience key down and up events try eventGenerator.keyPress(.letterA) try eventGenerator.keyPress("a") ``` To type characters or longer strings and get automatic shift wrapping you can use the `keyType()` methods. ```swift try eventGenerator.keyType("This will type the string as specified, including symbols!") ``` ### Finding a subview When running on a full screen app or testing navigation, specifying a CGPoint in screen coordinates can be difficult. For this, Hammer provides convenience methods to find views in the hierarchy by their accessibility identifier. ```swift let myButton = try eventGenerator.viewWithIdentifier("my_button", ofType: UIButton.self) try eventGenerator.fingerTap(at: myButton) ``` This method will throw an error if the view was not found in the hierarchy. If you're testing navigation or screen changes and you need to wait until the view appears, you can add a timeout. This will wait until the hierarchy has updated and return the view. ```swift let myButton = try eventGenerator.viewWithIdentifier("my_button", ofType: UIButton.self, timeout: 1) try eventGenerator.fingerTap(at: myButton) ``` You can also pass accessibility identifiers directly to the event methods. ```swift try eventGenerator.fingerDown(at: "my_draggable_object") try eventGenerator.fingerMove(to: "drop_target", duration: 0.5) try eventGenerator.fingerUp() ``` ### Waiting You will often need to wait for the simulator to finish displaying something on the screen or for an animation to end. Hammer provides multiple methods to wait until a view is visible on screen or if a control is hittable ```swift try eventGenerator.waitUntilVisible("my_label", timeout: 1) try eventGenerator.waitUntilHittable("my_button", timeout: 1) ``` ## Troubleshooting - The app or window is not ready for interaction Make sure you are running your unit tests in a host application ([setup instructions](#setup)). To interact with a view, it must be visible on the screen and the application must have finished presenting. You can test this by adding a delay to your testing and verifying that your view is appearing on screen. - View is not in hirarchy / Unable to find view Make sure the view you specified is in the same hierarchy as the view that was used to create the `EventGenerator`. If you used an accessibility identifier, check that it was spelled correctly. - View is not visible This means that the view is in the hierarchy but is not currently visible on screen, so it's not possible to generate touches for it. Make sure that the view is within visible bounds, not covered by other views, not hidden, and with alpha greater than 0.01. - View is not hittable This means that the view is in the hierarchy and visible on screen but is not currently able to receive touches. Make sure that the view reponds to hit test in its center coordinate and user interaction is enabled. ## License Hammer is released under the Apache License. See [LICENSE](./LICENSE)

Angular testing library for mocking components, directives, pipes, services and facilitating TestBed setup

[<img src="https://img.shields.io/gitter/room/help-me-mom/ng-mocks" alt="chat on gitter" width="90" height="20" />](https://gitter.im/ng-mocks/community) [<img src="https://img.shields.io/npm/v/ng-mocks" alt="npm version" width="88" height="20" />](https://www.npmjs.com/package/ng-mocks) [<img src="https://img.shields.io/circleci/build/github/help-me-mom/ng-mocks/master" alt="build status" width="88" height="20" />](https://app.circleci.com/pipelines/github/help-me-mom/ng-mocks?branch=master) [<img src="https://img.shields.io/coveralls/github/help-me-mom/ng-mocks/master" alt="coverage status" width="104" height="20" />](https://coveralls.io/github/help-me-mom/ng-mocks?branch=master) # Mock components, services and more out of annoying dependencies for simplification of Angular testing `ng-mocks` facilitates **Angular testing** and helps to: - **mock Components**, Directives, Pipes, Modules, Services and Tokens - reduce boilerplate in tests - access declarations via simple interface The current version of the library **has been tested** and **can be used** with: | Angular | ng-mocks | Jasmine | Jest | Ivy | | ------: | :------: | :-----: | :--: | :-: | | 15 | latest | yes | yes | yes | | 14 | latest | yes | yes | yes | | 13 | latest | yes | yes | yes | | 12 | latest | yes | yes | yes | | 11 | latest | yes | yes | yes | | 10 | latest | yes | yes | yes | | 9 | latest | yes | yes | yes | | 8 | latest | yes | yes | | | 7 | latest | yes | yes | | | 6 | latest | yes | yes | | | 5 | latest | yes | yes | | ## Important links - **[Documentation with examples of Angular testing](https://ng-mocks.sudo.eu)** - [CHANGELOG](https://github.com/help-me-mom/ng-mocks/blob/master/CHANGELOG.md) - [GitHub repo](https://github.com/help-me-mom/ng-mocks) - [NPM package](https://www.npmjs.com/package/ng-mocks) * Live [example on StackBlitz](https://stackblitz.com/github/help-me-mom/ng-mocks-sandbox?file=src/test.spec.ts) * Live [example on CodeSandbox](https://codesandbox.io/s/github/help-me-mom/ng-mocks-sandbox?file=/src/test.spec.ts) - [chat on gitter](https://gitter.im/ng-mocks/community) - **[ask a question on Stackoverflow](https://stackoverflow.com/questions/ask?tags=ng-mocks%20angular%20testing%20mocking)** - [report an issue on GitHub](https://github.com/help-me-mom/ng-mocks/issues) ## Very short introduction Global configuration for mocks in `src/test.ts`. In case of jest, `src/setup-jest.ts` / `src/test-setup.ts` should be used. ```ts title="src/test.ts" // All methods in mock declarations and providers // will be automatically spied on their creation. // https://ng-mocks.sudo.eu/extra/auto-spy ngMocks.autoSpy('jasmine'); // or jest // ngMocks.defaultMock helps to customize mocks // globally. Therefore, we can avoid copy-pasting // among tests. // https://ng-mocks.sudo.eu/api/ngMocks/defaultMock ngMocks.defaultMock(AuthService, () => ({ isLoggedIn$: EMPTY, currentUser$: EMPTY, })); ``` An example of a spec for a profile edit component. ```ts title="src/profile.component.spec.ts" // Let's imagine that there is a ProfileComponent // and it has 3 text fields: email, firstName, // lastName, and a user can edit them. // In the following test suite, we would like to // cover behavior of the component. describe('profile:builder', () => { // Helps to reset customizations after each test. MockInstance.scope(); // Let's configure TestBed via MockBuilder. // The code below says to mock everything in // ProfileModule except ProfileComponent and // ReactiveFormsModule. beforeEach(() => { // The result of MockBuilder should be returned. // https://ng-mocks.sudo.eu/api/MockBuilder return MockBuilder( ProfileComponent, ProfileModule, ).keep(ReactiveFormsModule); // // or old fashion way // return TestBed.configureTestingModule({ // imports: [ // MockModule(SharedModule), // mock // ReactiveFormsModule, // real // ], // declarations: [ // ProfileComponent, // real // MockPipe(CurrencyPipe), // mock // MockDirective(HoverDirective), // mock // ], // providers: [ // MockProvider(AuthService), // mock // ], // }).compileComponents(); }); // A test to ensure that ProfileComponent // can be created. it('should be created', () => { // MockRender is an advanced version of // TestBed.createComponent. // It respects all lifecycle hooks, // onPush change detection, and creates a // wrapper component with a template like // <app-root ...allInputs></profile> // and renders it. // It also respects all lifecycle hooks. // https://ng-mocks.sudo.eu/api/MockRender const fixture = MockRender(ProfileComponent); expect( fixture.point.componentInstance, ).toEqual(assertion.any(ProfileComponent)); }); // A test to ensure that the component listens // on ctrl+s hotkey. it('saves on ctrl+s hot key', () => { // A fake profile. const profile = { email: '[email protected]', firstName: 'testFirst2', lastName: 'testLast2', }; // A spy to track save calls. // MockInstance helps to configure mock // providers, declarations and modules // before their initialization and usage. // https://ng-mocks.sudo.eu/api/MockInstance const spySave = MockInstance( StorageService, 'save', jasmine.createSpy(), // or jest.fn() ); // Renders <profile [profile]="params.profile"> // </profile>. // https://ng-mocks.sudo.eu/api/MockRender const { point } = MockRender( ProfileComponent, { profile }, // bindings ); // Let's change the value of the form control // for email addresses with a random value. // ngMocks.change finds a related control // value accessor and updates it properly. // https://ng-mocks.sudo.eu/api/ngMocks/change ngMocks.change( '[name=email]', // css selector '[email protected]', // an email address ); // Let's ensure that nothing has been called. expect(spySave).not.toHaveBeenCalled(); // Let's assume that there is a host listener // for a keyboard combination of ctrl+s, // and we want to trigger it. // ngMocks.trigger helps to emit events via // simple interface. // https://ng-mocks.sudo.eu/api/ngMocks/trigger ngMocks.trigger(point, 'keyup.control.s'); // The spy should be called with the user // and the random email address. expect(spySave).toHaveBeenCalledWith({ email: '[email protected]', firstName: profile.firstName, lastName: profile.lastName, }); }); }); ``` Profit. ## Extra If you like `ng-mocks`, please support it: - [with a star on GitHub](https://github.com/help-me-mom/ng-mocks) - [with a tweet](https://twitter.com/intent/tweet?text=Check%20ng-mocks%20package%20%23angular%20%23testing%20%23mocking&url=https%3A%2F%2Fgithub.com%2Fike18t%2Fng-mocks) Thank you! P.S. Feel free to [contact us](https://ng-mocks.sudo.eu/need-help) if you need help.

The leading open source test management system with over 1 million downloads!

Quick and Easy server testing/validation

# Goss - Quick and Easy server validation [](https://travis-ci.org/goss-org/goss) [](https://github.com/goss-org/goss/releases) ** [](https://medium.com/@aelsabbahy) ## Goss in 45 seconds <a href="https://asciinema.org/a/4suhr8p42qcn6r7crfzt6cc3e?autoplay=1" target="_blank"><img src="https://cloud.githubusercontent.com/assets/6783261/17330426/ce7ad066-5894-11e6-84ea-29fd4207af58.gif" alt="asciicast"></a> **Note:** For an even faster way of doing this, see: [autoadd](https://github.com/goss-org/goss/blob/master/docs/manual.md#autoadd-aa---auto-add-all-matching-resources-to-test-suite) **Note:** For testing docker containers see the [dgoss](https://github.com/goss-org/goss/tree/master/extras/dgoss) wrapper. Also, user submitted wrapper scripts for Kubernetes [kgoss](https://github.com/goss-org/goss/tree/master/extras/kgoss) and Docker Compose [dcgoss](https://github.com/goss-org/goss/tree/master/extras/dcgoss). **Note:** For some Docker/Kubernetes healthcheck, health endpoint, and container ordering examples, see my blog post [here][kubernetes-simplified-health-checks]. ## Introduction ### What is Goss? Goss is a YAML based [serverspec](http://serverspec.org/) alternative tool for validating a server’s configuration. It eases the process of writing tests by allowing the user to generate tests from the current system state. Once the test suite is written they can be executed, waited-on, or served as a health endpoint. ### Why use Goss? * Goss is EASY! - [Goss in 45 seconds](#goss-in-45-seconds) * Goss is FAST! - small-medium test suites are near instantaneous, see [benchmarks](https://github.com/goss-org/goss/wiki/Benchmarks) * Goss is SMALL! - <10MB single self-contained binary ## Installation **Note:** For macOS and Windows, see: [platform-feature-parity]. This will install goss and [dgoss](https://github.com/goss-org/goss/tree/master/extras/dgoss). **Note:** Using `curl | sh` is not recommended for production systems, use manual installation below. ```bash # Install latest version to /usr/local/bin curl -fsSL https://goss.rocks/install | sh # Install v0.3.16 version to ~/bin curl -fsSL https://goss.rocks/install | GOSS_VER=v0.3.16 GOSS_DST=~/bin sh ``` ### Manual installation #### Latest ```bash curl -L https://github.com/goss-org/goss/releases/latest/download/goss-linux-amd64 -o /usr/local/bin/goss chmod +rx /usr/local/bin/goss curl -L https://github.com/goss-org/goss/releases/latest/download/dgoss -o /usr/local/bin/dgoss # Alternatively, using the latest master # curl -L https://raw.githubusercontent.com/goss-org/goss/master/extras/dgoss/dgoss -o /usr/local/bin/dgoss chmod +rx /usr/local/bin/dgoss ``` #### Specific Version ```bash # See https://github.com/goss-org/goss/releases for release versions VERSION=v0.3.10 curl -L "https://github.com/goss-org/goss/releases/download/${VERSION}/goss-linux-amd64" -o /usr/local/bin/goss chmod +rx /usr/local/bin/goss # (optional) dgoss docker wrapper (use 'master' for latest version) VERSION=v0.3.10 curl -L "https://github.com/goss-org/goss/releases/download/${VERSION}/dgoss" -o /usr/local/bin/dgoss chmod +rx /usr/local/bin/dgoss ``` ### Build it yourself ```bash make build ``` ## Full Documentation Documentation is available here: [manual](https://github.com/goss-org/goss/blob/master/docs/manual.md) ## Quick start ### Writing a simple sshd test An initial set of tests can be derived from the system state by using the [add](https://github.com/goss-org/goss/blob/master/docs/manual.md#add-a---add-system-resource-to-test-suite) or [autoadd](https://github.com/goss-org/goss/blob/master/docs/manual.md#autoadd-aa---auto-add-all-matching-resources-to-test-suite) commands. Let's write a simple sshd test using autoadd. ```txt # Running it as root will allow it to also detect ports $ sudo goss autoadd sshd ``` Generated `goss.yaml`: ```yaml $ cat goss.yaml port: tcp:22: listening: true ip: - 0.0.0.0 tcp6:22: listening: true ip: - '::' service: sshd: enabled: true running: true user: sshd: exists: true uid: 74 gid: 74 groups: - sshd home: /var/empty/sshd shell: /sbin/nologin group: sshd: exists: true gid: 74 process: sshd: running: true ``` Now that we have a test suite, we can: * Run it once ```txt goss validate ............... Total Duration: 0.021s # <- yeah, it's that fast.. Count: 15, Failed: 0 ``` * Edit it to use [templates](https://github.com/goss-org/goss/blob/master/docs/manual.md#templates), and run with a vars file ```txt goss --vars vars.yaml validate ``` * keep running it until the system enters a valid state or we timeout ```txt goss validate --retry-timeout 30s --sleep 1s ``` * serve the tests as a health endpoint ```txt goss serve & curl localhost:8080/healthz # JSON endpoint goss serve --format json & curl localhost:8080/healthz # rspecish response via content negotiation goss serve --format json & curl -H "Accept: application/vnd.goss-rspecish" localhost:8080/healthz ``` ### Manually editing Goss files Goss files can be manually edited to improve readability and expressiveness of tests. A [Json draft 7 schema](https://github.com/json-schema-org/json-schema-spec/blob/draft-07/schema.json) available in [docs/goss-json-schema.yaml](./docs/goss-json-schema.yaml) makes it easier to edit simple goss.yaml files in IDEs, providing usual coding assistance such as inline documentation, completion and static analysis. See [PR 793](https://github.com/goss-org/goss/pull/793) for screenshots. For example, to configure the Json schema in JetBrains intellij IDEA, follow [documented instructions](https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom), with arguments such as `schema url=https://raw.githubusercontent.com/goss-org/goss/master/docs/goss-json-schema.yaml`, `schema version=Json schema version 7`, `file path pattern=*/goss.yaml` In addition, Goss files can also be further manually edited (without yet full json support) to use: * [Patterns](https://github.com/goss-org/goss/blob/master/docs/manual.md#patterns) * [Advanced Matchers](https://github.com/goss-org/goss/blob/master/docs/manual.md#advanced-matchers) * [Templates](https://github.com/goss-org/goss/blob/master/docs/manual.md#templates) * `title` and `meta` (arbitrary data) attributes are persisted when adding other resources with `goss add` Some examples: ```yaml user: sshd: title: UID must be between 50-100, GID doesn't matter. home is flexible meta: desc: Ensure sshd is enabled and running since it's needed for system management sev: 5 exists: true uid: # Validate that UID is between 50 and 100 and: gt: 50 lt: 100 home: # Home can be any of the following or: - /var/empty/sshd - /var/run/sshd package: kernel: installed: true versions: # Must have 3 kernels and none of them can be 4.4.0 and: - have-len: 3 - not: contain-element: 4.4.0 # Loaded from --vars YAML/JSON file {{.Vars.package}}: installed: true {{if eq .Env.OS "centos"}} # This test is only when $OS environment variable is set to "centos" libselinux: installed: true {{end}} ``` Goss.yaml files with templates can still be validated through the Json schema after being rendered using the `goss render` command. See example below ```bash cd docs goss --vars ./vars.yaml render > rendered_goss.yaml # proceed with json schema validation of rendered_goss.yaml in your favorite IDE # or in one of the Json schema validator listed in https://json-schema.org/implementations.html # The following example is for a Linux AMD64 host curl -LO https://github.com/neilpa/yajsv/releases/download/v1.4.1/yajsv.linux.amd64 chmod a+x yajsv.linux.amd64 sudo mv yajsv.linux.amd64 /usr/sbin/yajsv yajsv -s goss-json-schema.yaml rendered_goss.yaml rendered_goss.yaml: fail: process.chrome: skip is required rendered_goss.yaml: fail: service.sshd: skip is required 1 of 1 failed validation rendered_goss.yaml: fail: process.chrome: skip is required rendered_goss.yaml: fail: service.sshd: skip is required ``` Full list of available Json schema validators can be found in https://json-schema.org/implementations.html#validator-command%20line ## Supported resources * package - add new package * file - add new file * addr - add new remote address:port - ex: google.com:80 * port - add new listening [protocol]:port - ex: 80 or udp:123 * service - add new service * user - add new user * group - add new group * command - add new command * dns - add new dns * process - add new process name * kernel-param - add new kernel-param * mount - add new mount * interface - add new network interface * http - add new network http url with proxy support * goss - add new goss file, it will be imported from this one * matching - test for matches in supplied content ## Supported output formats * rspecish - **(default)** Similar to rspec output * documentation - Verbose test results * json - JSON, detailed test result * tap - TAP style * junit - JUnit style * nagios - Nagios/Sensu compatible output /w exit code 2 for failures. * prometheus - Prometheus compatible output. * silent - No output. Avoids exposing system information (e.g. when serving tests as a healthcheck endpoint). ## Community Contributions * [goss-ansible](https://github.com/indusbox/goss-ansible) - Ansible module for Goss. * [degoss](https://github.com/naftulikay/ansible-role-degoss) - Ansible role for installing, running, and removing Goss in a single go. * [kitchen-goss](https://github.com/ahelal/kitchen-goss) - A test-kitchen verifier plugin for Goss. * [goss-fpm-files](https://github.com/deanwilson/unixdaemon-fpm-cookery-recipes) - Might be useful for building goss system packages. * [molecule](https://github.com/metacloud/molecule) - Automated testing for Ansible roles, with native Goss support. * [packer-provisioner-goss](https://github.com/YaleUniversity/packer-provisioner-goss) - A packer plugin to run Goss as a provision step. * [gossboss](https://github.com/mdb/gossboss) - Collect and view aggregated Goss test results from multiple remote Goss servers. ## Limitations `goss` works well on Linux, but support on Windows & macOS is alpha. See [platform-feature-parity]. The following tests have limitations. Package: * rpm * deb * Alpine apk * pacman Service: * systemd * sysV init * OpenRC init * Upstart [kubernetes-simplified-health-checks]: https://medium.com/@aelsabbahy/docker-1-12-kubernetes-simplified-health-checks-and-container-ordering-with-goss-fa8debbe676c [platform-feature-parity]: docs/platform-feature-parity.md

Test Redux Saga with an easy plan.

# Redux Saga Test Plan [](https://www.npmjs.com/package/redux-saga-test-plan) [](https://travis-ci.org/jfairbank/redux-saga-test-plan) [](https://codecov.io/gh/jfairbank/redux-saga-test-plan) #### Test Redux Saga with an easy plan. Redux Saga Test Plan makes testing sagas a breeze. Whether you need to test exact effects and their ordering or just test your saga `put`'s a specific action at some point, Redux Saga Test Plan has you covered. Redux Saga Test Plan aims to embrace both integration testing and unit testing approaches to make testing your sagas easy. ## Table of Contents * [Integration Testing](#integration-testing) * [Simple Example](#simple-example) * [Mocking with Providers](#mocking-with-providers) * [Example with Reducer](#example-with-reducer) * [Unit Testing](#unit-testing) * [Extending inspect options](#extending-inspect-options) * [Install](#install) ## Documentation * [Introduction](http://redux-saga-test-plan.jeremyfairbank.com/) * [Getting Started](http://redux-saga-test-plan.jeremyfairbank.com/getting-started.html) * [Integration Testing](http://redux-saga-test-plan.jeremyfairbank.com/integration-testing/) * [Unit Testing](http://redux-saga-test-plan.jeremyfairbank.com/unit-testing/) ## Integration Testing **Requires global `Promise` to be available** One downside to unit testing sagas is that it couples your test to your implementation. Simple reordering of yielded effects in your saga could break your tests even if the functionality stays the same. If you're not concerned with the order or exact effects your saga yields, then you can take an integrative approach, testing the behavior of your saga when run by Redux Saga. Then, you can simply test that a particular effect was yielded during the saga run. For this, use the `expectSaga` test function. ### Simple Example Import the `expectSaga` function and pass in your saga function as an argument. Any additional arguments to `expectSaga` will become arguments to the saga function. The return value is a chainable API with assertions for the different effect creators available in Redux Saga. In the example below, we test that the `userSaga` successfully `put`s a `RECEIVE_USER` action with the `fakeUser` as the payload. We call `expectSaga` with the `userSaga` and supply an `api` object as an argument to `userSaga`. We assert the expected `put` effect via the `put` assertion method. Then, we call the `dispatch` method with a `REQUEST_USER` action that contains the user id payload. The `dispatch` method will supply actions to `take` effects. Finally, we start the test by calling the `run` method which returns a `Promise`. Tests with `expectSaga` will always run asynchronously, so the returned `Promise` resolves when the saga finishes or when `expectSaga` forces a timeout. If you're using a test runner like Jest, you can return the `Promise` inside your Jest test so Jest knows when the test is complete. ```js import { call, put, take } from 'redux-saga/effects'; import { expectSaga } from 'redux-saga-test-plan'; function* userSaga(api) { const action = yield take('REQUEST_USER'); const user = yield call(api.fetchUser, action.payload); yield put({ type: 'RECEIVE_USER', payload: user }); } it('just works!', () => { const api = { fetchUser: id => ({ id, name: 'Tucker' }), }; return expectSaga(userSaga, api) // Assert that the `put` will eventually happen. .put({ type: 'RECEIVE_USER', payload: { id: 42, name: 'Tucker' }, }) // Dispatch any actions that the saga will `take`. .dispatch({ type: 'REQUEST_USER', payload: 42 }) // Start the test. Returns a Promise. .run(); }); ``` ### Mocking with Providers `expectSaga` runs your saga with Redux Saga, so it will try to resolve effects just like Redux Saga would in your application. This is great for integration testing, but sometimes it can be laborious to bootstrap your entire application for tests or mock things like server APIs. In those cases, you can use _providers_ which are perfect for mocking values directly with `expectSaga`. Providers are similar to middleware that allow you to intercept effects before they reach Redux Saga. You can choose to return a mock value instead of allowing Redux Saga to handle the effect, or you can pass on the effect to other providers or eventually Redux Saga. `expectSaga` has two flavors of providers, _static providers_ and _dynamic providers_. Static providers are easier to compose and reuse, but dynamic providers give you more flexibility with non-deterministic effects. Here is one example below using static providers. There are more examples of providers [in the docs](http://redux-saga-test-plan.jeremyfairbank.com/integration-testing/mocking/). ```js import { call, put, take } from 'redux-saga/effects'; import { expectSaga } from 'redux-saga-test-plan'; import * as matchers from 'redux-saga-test-plan/matchers'; import { throwError } from 'redux-saga-test-plan/providers'; import api from 'my-api'; function* userSaga(api) { try { const action = yield take('REQUEST_USER'); const user = yield call(api.fetchUser, action.payload); const pet = yield call(api.fetchPet, user.petId); yield put({ type: 'RECEIVE_USER', payload: { user, pet }, }); } catch (e) { yield put({ type: 'FAIL_USER', error: e }); } } it('fetches the user', () => { const fakeUser = { name: 'Jeremy', petId: 20 }; const fakeDog = { name: 'Tucker' }; return expectSaga(userSaga, api) .provide([ [call(api.fetchUser, 42), fakeUser], [matchers.call.fn(api.fetchPet), fakeDog], ]) .put({ type: 'RECEIVE_USER', payload: { user: fakeUser, pet: fakeDog }, }) .dispatch({ type: 'REQUEST_USER', payload: 42 }) .run(); }); it('handles errors', () => { const error = new Error('error'); return expectSaga(userSaga, api) .provide([ [matchers.call.fn(api.fetchUser), throwError(error)] ]) .put({ type: 'FAIL_USER', error }) .dispatch({ type: 'REQUEST_USER', payload: 42 }) .run(); }); ``` Notice we pass in an array of tuple pairs (or array pairs) that contain a matcher and a fake value. You can use the effect creators from Redux Saga or matchers from the `redux-saga-test-plan/matchers` module to match effects. The bonus of using Redux Saga Test Plan's matchers is that they offer special partial matchers like `call.fn` which matches by the function without worrying about the specific `args` contained in the actual `call` effect. Notice in the second test that we can also simulate errors with the `throwError` function from the `redux-saga-test-plan/providers` module. This is perfect for simulating server problems. ### Example with Reducer One good use case for integration testing is testing your reducer too. You can hook up your reducer to your test by calling the `withReducer` method with your reducer function. ```js import { put } from 'redux-saga/effects'; import { expectSaga } from 'redux-saga-test-plan'; const initialDog = { name: 'Tucker', age: 11, }; function reducer(state = initialDog, action) { if (action.type === 'HAVE_BIRTHDAY') { return { ...state, age: state.age + 1, }; } return state; } function* saga() { yield put({ type: 'HAVE_BIRTHDAY' }); } it('handles reducers and store state', () => { return expectSaga(saga) .withReducer(reducer) .hasFinalState({ name: 'Tucker', age: 12, // <-- age changes in store state }) .run(); }); ``` ## Unit Testing If you want to ensure that your saga yields specific types of effects in a particular order, then you can use the `testSaga` function. Here's a simple example: ```js import { testSaga } from 'redux-saga-test-plan'; function identity(value) { return value; } function* mainSaga(x, y) { const action = yield take('HELLO'); yield put({ type: 'ADD', payload: x + y }); yield call(identity, action); } const action = { type: 'TEST' }; it('works with unit tests', () => { testSaga(mainSaga, 40, 2) // advance saga with `next()` .next() // assert that the saga yields `take` with `'HELLO'` as type .take('HELLO') // pass back in a value to a saga after it yields .next(action) // assert that the saga yields `put` with the expected action .put({ type: 'ADD', payload: 42 }) .next() // assert that the saga yields a `call` to `identity` with // the `action` argument .call(identity, action) .next() // assert that the saga is finished .isDone(); }); ``` ## Extending inspect options To see large effect objects while Expected & Actual result comparison you'll need to extend inspect options. Example: ```js import util from 'util'; import testSaga from 'redux-saga-test-plan'; import { testableSaga } from '../sagas'; describe('Some sagas to test', () => { util.inspect.defaultOptions.depth = null; it('testableSaga', () => { testSaga(testableSaga) .next() .put({ /* large object here */ }) .next() .isDone(); }); }); ``` ## Install ``` yarn add redux-saga-test-plan --dev ``` ``` npm install --save-dev redux-saga-test-plan ```

Learn Go with test-driven development

# Learn Go with Tests <p align="center"> <img src="red-green-blue-gophers-smaller.png" /> </p> [Art by Denise](https://twitter.com/deniseyu21) [](https://goreportcard.com/report/github.com/quii/learn-go-with-tests) ## Formats - [Gitbook](https://quii.gitbook.io/learn-go-with-tests) - [EPUB or PDF](https://github.com/quii/learn-go-with-tests/releases) ## Translations - [中文](https://studygolang.gitbook.io/learn-go-with-tests) - [Português](https://larien.gitbook.io/aprenda-go-com-testes/) - [日本語](https://andmorefine.gitbook.io/learn-go-with-tests/) - [한국어](https://miryang.gitbook.io/learn-go-with-tests/) - [Türkçe](https://halilkocaoz.gitbook.io/go-programlama-dilini-ogren/) ## Support me I am proud to offer this resource for free, but if you wish to give some appreciation: - [Tweet me @quii](https://twitter.com/quii) - <a rel="me" href="https://mastodon.cloud/@quii">Mastodon</a> - [Buy me a coffee :coffee:](https://www.buymeacoffee.com/quii) - [Sponsor me on GitHub](https://github.com/sponsors/quii) ## Why * Explore the Go language by writing tests * **Get a grounding with TDD**. Go is a good language for learning TDD because it is a simple language to learn and testing is built-in * Be confident that you'll be able to start writing robust, well-tested systems in Go * [Watch a video, or read about why unit testing and TDD is important](why.md) ## Table of contents ### Go fundamentals 1. [Install Go](install-go.md) - Set up environment for productivity. 2. [Hello, world](hello-world.md) - Declaring variables, constants, if/else statements, switch, write your first go program and write your first test. Sub-test syntax and closures. 3. [Integers](integers.md) - Further Explore function declaration syntax and learn new ways to improve the documentation of your code. 4. [Iteration](iteration.md) - Learn about `for` and benchmarking. 5. [Arrays and slices](arrays-and-slices.md) - Learn about arrays, slices, `len`, varargs, `range` and test coverage. 6. [Structs, methods & interfaces](structs-methods-and-interfaces.md) - Learn about `struct`, methods, `interface` and table driven tests. 7. [Pointers & errors](pointers-and-errors.md) - Learn about pointers and errors. 8. [Maps](maps.md) - Learn about storing values in the map data structure. 9. [Dependency Injection](dependency-injection.md) - Learn about dependency injection, how it relates to using interfaces and a primer on io. 10. [Mocking](mocking.md) - Take some existing untested code and use DI with mocking to test it. 11. [Concurrency](concurrency.md) - Learn how to write concurrent code to make your software faster. 12. [Select](select.md) - Learn how to synchronise asynchronous processes elegantly. 13. [Reflection](reflection.md) - Learn about reflection 14. [Sync](sync.md) - Learn some functionality from the sync package including `WaitGroup` and `Mutex` 15. [Context](context.md) - Use the context package to manage and cancel long-running processes 16. [Intro to property based tests](roman-numerals.md) - Practice some TDD with the Roman Numerals kata and get a brief intro to property based tests 17. [Maths](math.md) - Use the `math` package to draw an SVG clock 18. [Reading files](reading-files.md) - Read files and process them 19. [Templating](html-templates.md) - Use Go's html/template package to render html from data, and also learn about approval testing 20. [Generics](generics.md) - Learn how to write functions that take generic arguments and make your own generic data-structure 21. [Revisiting arrays and slices with generics](revisiting-arrays-and-slices-with-generics.md) - Generics are very useful when working with collections. Learn how to write your own `Reduce` function and tidy up some common patterns. ### Build an application Now that you have hopefully digested the _Go Fundamentals_ section you have a solid grounding of a majority of Go's language features and how to do TDD. This next section will involve building an application. Each chapter will iterate on the previous one, expanding the application's functionality as our product owner dictates. New concepts will be introduced to help facilitate writing great code but most of the new material will be learning what can be accomplished from Go's standard library. By the end of this, you should have a strong grasp as to how to iteratively write an application in Go, backed by tests. * [HTTP server](http-server.md) - We will create an application which listens to HTTP requests and responds to them. * [JSON, routing and embedding](json.md) - We will make our endpoints return JSON and explore how to do routing. * [IO and sorting](io.md) - We will persist and read our data from disk and we'll cover sorting data. * [Command line & project structure](command-line.md) - Support multiple applications from one code base and read input from command line. * [Time](time.md) - using the `time` package to schedule activities. * [WebSockets](websockets.md) - learn how to write and test a server that uses WebSockets. ### Testing fundamentals Covering other subjects around testing. * [Introduction to acceptance tests](intro-to-acceptance-tests.md) - Learn how to write acceptance tests for your code, with a real-world example for gracefully shutting down a HTTP server * [Scaling acceptance tests](scaling-acceptance-tests.md) - Learn techniques to manage the complexity of writing acceptance tests for non-trivial systems. ### Questions and answers I often run in to questions on the internets like > How do I test my amazing function that does x, y and z If you have such a question raise it as an issue on github and I'll try and find time to write a short chapter to tackle the issue. I feel like content like this is valuable as it is tackling people's _real_ questions around testing. * [OS exec](os-exec.md) - An example of how we can reach out to the OS to execute commands to fetch data and keep our business logic testable/ * [Error types](error-types.md) - Example of creating your own error types to improve your tests and make your code easier to work with. * [Context-aware Reader](context-aware-reader.md) - Learn how to TDD augmenting `io.Reader` with cancellation. Based on [Context-aware io.Reader for Go](https://pace.dev/blog/2020/02/03/context-aware-ioreader-for-golang-by-mat-ryer) * [Revisiting HTTP Handlers](http-handlers-revisited.md) - Testing HTTP handlers seems to be the bane of many a developer's existence. This chapter explores the issues around designing handlers correctly. ### Meta / Discussion * [Why](why.md) - Watch a video, or read about why unit testing and TDD is important * [Anti-patterns](anti-patterns.md) - A short chapter on TDD and unit testing anti-patterns ## Contributing * _This project is work in progress_ If you would like to contribute, please do get in touch. * Read [contributing.md](https://github.com/quii/learn-go-with-tests/tree/842f4f24d1f1c20ba3bb23cbc376c7ca6f7ca79a/contributing.md) for guidelines * Any ideas? Create an issue ## Background I have some experience introducing Go to development teams and have tried different approaches as to how to grow a team from some people curious about Go into highly effective writers of Go systems. ### What didn't work #### Read _the_ book An approach we tried was to take [the blue book](https://www.amazon.co.uk/Programming-Language-Addison-Wesley-Professional-Computing/dp/0134190440) and every week discuss the next chapter along with the exercises. I love this book but it requires a high level of commitment. The book is very detailed in explaining concepts, which is obviously great but it means that the progress is slow and steady - this is not for everyone. I found that whilst a small number of people would read chapter X and do the exercises, many people didn't. #### Solve some problems Katas are fun but they are usually limited in their scope for learning a language; you're unlikely to use goroutines to solve a kata. Another problem is when you have varying levels of enthusiasm. Some people just learn way more of the language than others and when demonstrating what they have done end up confusing people with features the others are not familiar with. This ends up making the learning feel quite _unstructured_ and _ad hoc_. ### What did work By far the most effective way was by slowly introducing the fundamentals of the language by reading through [go by example](https://gobyexample.com/), exploring them with examples and discussing them as a group. This was a more interactive approach than "read chapter x for homework". Over time the team gained a solid foundation of the _grammar_ of the language so we could then start to build systems. This to me seems analogous to practicing scales when trying to learn guitar. It doesn't matter how artistic you think you are, you are unlikely to write good music without understanding the fundamentals and practicing the mechanics. ### What works for me When _I_ learn a new programming language I usually start by messing around in a REPL but eventually, I need more structure. What I like to do is explore concepts and then solidify the ideas with tests. Tests verify the code I write is correct and documents the feature I have learned. Taking my experience of learning with a group and my own personal way I am going to try and create something that hopefully proves useful to other teams. Learning the fundamentals by writing small tests so that you can then take your existing software design skills and ship some great systems. ## Who this is for * People who are interested in picking up Go. * People who already know some Go, but want to explore testing with TDD. ## What you'll need * A computer! * [Installed Go](https://golang.org/) * A text editor * Some experience with programming. Understanding of concepts like `if`, variables, functions etc. * Comfortable with using the terminal ## Feedback * Add issues/submit PRs [here](https://github.com/quii/learn-go-with-tests) or [tweet me @quii](https://twitter.com/quii) [MIT license](LICENSE.md) [Logo is by egonelbre](https://github.com/egonelbre) What a star!

Datafaker is a large-scale test data and flow test data generation tool. Datafaker fakes data and inserts to varied data sources. 测试数据生成工具

Datafaker - Tool for faking data ========= [](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://starchart.cc/gangly/datafaker) English | [中文](doc/zh_CN/README.md) ## 1. Introduction Datafaker is a large-scale test data and flow test data generation tool. It is compatible with python2.7 and python3.4+. Welcome to download and use. The github address is: https://github.com/gangly/datafaker Document sync updates on github ## 2. Background In the software development testing process, test data is often needed. These scenarios include: - Backend development. After creating a new table, you need to construct database test data and generate interface data for use by the front end. - Database performance test. Generates a lot of test data to test database performance - Stream data test. For kafka streaming data, it is necessary to continuously generate test data to write to kafka. After research, there is currently no open source test data generation tool for generating data with similar structure in mysql table. The common method is to manually create several pieces of data into the database. The disadvantage of this method is - Wasting work hours. Needs to construct different data for fields of different data types of the table - Small amount of data. If you need to construct a lot of data, you can't do it manually. - Not accurate enough. For example, you need to construct a mailbox (satisfying a certain format), a phone number (determined number of digits), an ip address (fixed format), age (cannot be negative, have a size range), and so on. These test data have certain restrictions or rules, and the manual construction may not meet the data range or some format requirements, resulting in the backend program error. - Multi-table association. The amount of data created manually is small, and the primary key in multiple tables may not be associated with, or associated with no data. - Dynamic random write. For example, for streaming data, you need to write kafka randomly every few seconds. Or dynamically insert mysql randomly, manual operation is relatively cumbersome, and it is not good to count the number of data written. In response to these current pain points, datafaker came into being. Datafaker is a multi-data source test data construction tool that can simulate most common data types and easily solve the above pain points. Datafaker has the following features: - Multiple data types. Includes common database field types (integer, float, character), custom types (IP address, mailbox, ID number, etc.) - Simulate multi-table association data By formulating some fields as enumerated types (randomly selected from the specified data list), in the case of a large amount of data, it can ensure that multiple tables can be associated with each other and query data. - Support batch data and stream data generation, and specify stream data interval time - Support multiple data output methods, including screen printing, files and remote data sources - Support for multiple data sources. Currently supports relational databases, Hive, Kafka. Will be extended to Mongo, ES and other data sources. - Can specify the output format, currently supports text, json ## 3. Architecture Datafaker is written in python and supports python2.7, python3.4+. The current version has been released on pypi. <!-- <div align=center><img --> <!-- src="https://github.com/gangly/datafaker/blob/master/doc/img/datafaker.png" width="500" height="600" alt="软件架构"/> --> <!-- </div> -->  The architecture diagram completely shows the execution process of the tool. From the figure, the tool has gone through five modules: - Parameter parser. Parse the commands that the user enters from the terminal command line. - Metadata parser. Users can specify metadata from local files or remote data source tables. After the parser obtains the content of the file, the text content is parsed into table field metadata and data construction rules according to the rules. - Data construction engine. The construction engine constructs rules based on the data generated by the metadata parser, simulating the generation of different types of data. - Data routing. According to different data output types, it is divided into batch data and stream data generation. Stream data can specify the frequency of generation. The data is then converted to a user-specified format for output to a different data source. - Data source adapter. Adapt to different data sources and import the data into the data source. ## 4. Installation #### Method 1, install from source code: Download the source code, unzip and install: ```bash python setup.py install ``` #### Method 2, use pip: ```bash pip install datafaker ``` #### Upgrade tool ```bash pip install datafaker --upgrade ``` #### Uninstall tool ```bash pip uninstall datafaker ``` #### Install require package | data source | package | note | | -------- | -------- | ------ | |mysql/tidb| mysql-python/mysqlclient | windows+python3 use mysqlclient| |oracle| cx-Oracle | need some oracle lib | |postgresql/redshift | psycopg2 | | | sqlserver | pyodbc | mssql+pyodbc://mssql-v | |Hbase | happybase,thrift | | |es | elasticsearch | | |hive | pyhive | | |kafka | kafka-python | | ## 5. examples [usage example(使用举例)](doc/UseExample.md) ## 6. command parameters [parameters detail(命令行参数)](doc/cmdParameters.md) ## 7. construction rule [construction rule(构造规则)](doc/ConstructionRule.md) ## 8. note [note(注意事项)](doc/note.md) ## 9. Release note [Release note(发布记录)](doc/release_note.md) _____ **Give a star or donate a coffee to the author** - 给作者点个star或请作者喝杯咖啡 

Chaos engineering tool for simulating real-world distributed system failures

# <img src="https://cloud.githubusercontent.com/assets/53900/26097013/7c930660-3a66-11e7-9b5c-780b0630d5a4.gif" alt="Muxy Logo" style="height: 80px;" height="80px"/> Proxy for simulating real-world distributed system failures to improve resilience in your applications. [](https://app.wercker.com/project/bykey/e45703ebafd48632db56f022cc54546b) [](https://goreportcard.com/report/github.com/mefellows/muxy) [](https://godoc.org/github.com/mefellows/muxy) [](https://coveralls.io/github/mefellows/muxy?branch=HEAD) ## Introduction Muxy is a proxy that _mucks_ with your system and application context, operating at Layers 4, 5 and 7, allowing you to simulate common failure scenarios from the perspective of an application under test; such as an API or a web application. If you are building a distributed system, Muxy can help you test your resilience and fault tolerance patterns. <p align="center"> <img width="880" src="https://cdn.rawgit.com/mefellows/muxy/master/images/muxy.svg"> </p> ### Contents <!-- TOC depthFrom:2 depthTo:4 withLinks:1 updateOnSave:1 orderedList:0 --> - [Introduction](#introduction) - [Contents](#contents) - [Features](#features) - [Installation](#installation) - [On Mac OSX using Homebrew](#on-mac-osx-using-homebrew) - [Using Go Get](#using-go-get) - [Using Muxy](#using-muxy) - [5-minute example](#5-minute-example) - [Muxy as part of a test suite](#muxy-as-part-of-a-test-suite) - [Notes](#notes) - [Proxies and Middlewares](#proxies-and-middlewares) - [Proxies](#proxies) - [HTTP Proxy](#http-proxy) - [TCP Proxy](#tcp-proxy) - [Middleware](#middleware) - [Delay](#delay) - [HTTP Tamperer](#http-tamperer) - [Network Shaper](#network-shaper) - [TCP Tamperer](#tcp-tamperer) - [Logger](#logger) - [Configuration Reference](#configuration-reference) - [Examples](#examples) - [Hystrix](#hystrix) - [Usage with Docker](#usage-with-docker) - [Extending Muxy](#extending-muxy) - [Proxies](#proxies) - [Middleware](#middleware) - [Contributing](#contributing) <!-- /TOC --> ## Features - Ability to tamper with network devices at the transport level (Layer 4) - Ability to tamper with the TCP session layer (Layer 5) - ...and HTTP requests/responses at the HTTP protocol level (Layer 7) - Supports custom proxy routing (aka basic reverse proxy) - Advanced matching rules allow you to target specific requests - Introduce randomness into symptoms - Simulate real-world network connectivity problems/partitions for mobile devices, distributed systems etc. - Ideal for use in CI/Test Suites to test resilience across languages/technologies - Simple native binary installation with no dependencies - Extensible and modular architecture - An official Docker [container](https://github.com/mefellows/docker-muxy) to simplify uses cases such as Docker Compose ## Installation Download a [release](https://github.com/mefellows/muxy/releases) for your platform and put it somewhere on the `PATH`. ### On Mac OSX using Homebrew If you are using [Homebrew](http://brew.sh) you can follow these steps to install Muxy: ```bash brew install https://raw.githubusercontent.com/mefellows/muxy/master/scripts/muxy.rb ``` ### Using Go Get ``` go get github.com/mefellows/muxy ``` ## Using Muxy Muxy is typically used in two ways: 1. In local development to see how your application responds under certain conditions 1. In test suites to automate resilience testing ### 5-minute example 1. Install Muxy 1. Create configuration file `config.yml`: ```yaml # Configures a proxy to forward/mess with your requests # to/from www.onegeek.com.au. This example adds a 5s delay # to the response. proxy: - name: http_proxy config: host: 0.0.0.0 port: 8181 proxy_host: www.onegeek.com.au proxy_port: 80 # Proxy plugins middleware: - name: http_tamperer config: request: host: "www.onegeek.com.au" # Message Delay request/response plugin - name: delay config: request_delay: 1000 response_delay: 500 # Log in/out messages - name: logger ``` 1. Run Muxy with your config: `muxy proxy --config ./config.yml` 1. Make a request to www.onegeek.com via the proxy: `time curl -v -H"Host: www.onegeek.com.au" http://localhost:8181/`. Compare that with a request direct to the website: `time curl -v www.onegeek.com.au` - it should be approximately 5s faster. That's it - running Muxy is a matter of configuring one or more [Proxies](#proxies), with 1 or more [Middleware](#middleware) components defined in a simple [YAML file](/examples/config.yml). ### Muxy as part of a test suite 1. Create an application 2. Build in fault tolerence (e.g. using something like [Hystrix](https://github.com/Netflix/Hystrix)) 3. Create integration tests 4. Run Muxy configuring a _proxy_ such as HTTP, and one or more *symptom*s such as network latency, partition or HTTP error 5. Point your app at Muxy 6. Run tests and check if system behaved as expected 7. Profit! ### Notes Muxy is a stateful system, and mucks with your low-level (system) networking interfaces and therefore cannot be run in parallel with other tests. It is also recommended to run within a container/virtual machine to avoid unintended consequences (like breaking Internet access from the host). ## Proxies and Middlewares ### Proxies #### HTTP Proxy Simple HTTP(s) Proxy that starts up on a local IP/Hostname and Port. Example configuration snippet: ```yaml proxy: - name: http_proxy config: ## Proxy host details host: 0.0.0.0 protocol: http port: 8181 ## Proxy target details proxy_host: 0.0.0.0 proxy_port: 8282 proxy_protocol: https ## Certificate to present to Muxy clients (i.e. server certs) proxy_ssl_key: proxy-server/test.key proxy_ssl_cert: proxy-server/test.crt ## Certificate to present to Muxy proxy targets (i.e. client certs) proxy_client_ssl_key: client-certs/cert-key.pem proxy_client_ssl_cert: client-certs/cert.pem proxy_client_ssl_ca: client-certs/ca.pem ## Enable this to proxy targets we don't trust # insecure: true # allow insecure https # Specify additional proxy rules. Default catch-all proxy still # applies with lowest matching precedence. # Request matchers are specified as valid regular expressions # and must be properly YAML escaped. # See https://github.com/mefellows/muxy/issues/11 for behaviour. - request: method: 'GET|DELETE' path: '^\/foo' host: '.*foo\.com' pass: path: '/bar' scheme: 'http' host: 'bar.com' ``` #### TCP Proxy Simple TCP Proxy that starts up on a local IP/Hostname and Port, forwarding traffic to the specified `proxy_host` on `proxy_port`. Example configuration snippet: ```yaml proxy: - name: tcp_proxy config: host: 0.0.0.0 # Local ip/hostname to bind to and accept connections. port: 8080 # Local port to bind to proxy_host: 0.0.0.0 proxy_port: 2000 nagles_algorithm: true packet_size: 64 ``` ### Middleware Middleware have the ability to intervene upon receiving a request (Pre-Dispatch) or before sending the response back to the client (Post-Dispatch). In some cases, such as the Network Shaper, the effect is applied _before any request is made_ (e.g. if the local network device configuration is altered). #### Delay A basic middleware that simply adds a delay of `delay` milliseconds to the request or response. Example configuration snippet: ```yaml middleware: - name: delay config: request_delay: 1000 # Delay in ms to apply to request to target response_delay: 500 # Delay in ms to apply to response from target # Specify additional matching rules. Default is to apply delay to all # requests on all http proxies. # Request matchers are specified as valid regular expressions # and must be properly YAML escaped. # See https://github.com/mefellows/muxy/issues/11 for behaviour. matching_rules: - method: "GET|DELETE" path: "^/boo" host: 'foo\.com' ``` #### HTTP Tamperer A Layer 7 tamperer, this plugin allows you to modify response headers, status code or the body itself. Example configuration snippet: ```yaml middleware: - name: http_tamperer config: request: host: "somehost" # Override Host header that's sent to target path: "/" # Override the request path method: "GET" # Override request method headers: x_my_request: "foo" # Override request header content_type: "application/x-www-form-urlencoded" content_length: "5" cookies: # Custom request cookies - name: "fooreq" value: "blahaoeuaoeu" domain: "localhost" path: "/foopath" secure: true rawexpires: "Sat, 12 Sep 2015 09:19:48 UTC" maxage: 200 httponly: true body: "wow, new body!" # Override request body response: status: 201 # Override HTTP Status code headers: # Override response headers content_length: "27" x_foo_bar: "baz" body: "my new body" # Override response body cookies: # Custom response cookies - name: "foo" value: "blahaoeuaoeu" domain: "localhost" path: "/foopath" secure: true rawexpires: "Sat, 12 Sep 2015 09:19:48 UTC" maxage: 200 httponly: true # Specify additional matching rules. Default is to apply delay to all # requests on all http proxies. # Request matchers are specified as valid regular expressions # and must be properly YAML escaped. # See https://github.com/mefellows/muxy/issues/11 for behaviour. matching_rules: - method: "GET|DELETE" path: "^/boo" host: 'foo\.com' ``` #### Network Shaper The network shaper plugin is a Layer 4 tamperer, and requires _root access_ to work, as it needs to configure the local firewall and network devices. Using the excellent [Comcast](https://github.com/tylertreat/comcast) library, it can shape and interfere with network traffic, including bandwidth, latency, packet loss and jitter on specified ports, IPs and protocols. NOTE: This component only works on MacOSX, FreeBSD, Linux and common \*nix flavours. Example configuration snippet: ```yaml middleware: - name: network_shape config: latency: 250 # Latency to add in ms target_bw: 750 # Bandwidth in kbits/s packet_loss: 0.5 # Packet loss, as a % target_ips: # Target ipv4 IP addresses - 0.0.0.0 target_ips6: # Target ipv6 IP addresses - "::1/128" target_ports: # Target destination ports - "80" target_protos: # Target protocols - "tcp" - "udp" - "icmp" device: "lo" # defaults to eth0 ``` #### TCP Tamperer The TCP Tamperer is a Layer 5 tamperer, modifying the messages in and around TCP sessions. Crudely, you can set the body of inbound and outbound TCP packets, truncate the last character of messages or randomise the text over the wire. ```yaml - name: tcp_tamperer config: request: body: "wow, new request!" # Override request body randomize: true # Replaces input message with a random string truncate: true # Removes last character from the request message response: body: "wow, new response!" # Override response body randomize: true # Replaces response message with a random string truncate: true # Removes last character from the response message ``` #### Logger Log the in/out messages, optionally requesting the output to be hex encoded. Example configuration snippet: ```yaml middleware: - name: logger config: hex_output: false # Display output as Hex instead of a string ``` ## Configuration Reference Refer to the [example](/examples/config.yml) YAML file for a full reference. ## Examples ### Hystrix Using the [Hystrix Go](https://github.com/afex/hystrix-go) library, we use Muxy to trigger a circuit breaker and return a canned response, ensuring we don't have downtime. View the [example](examples/hystrix). ## Usage with Docker Download the [Docker image](https://github.com/mefellows/docker-muxy) by running: ``` docker pull mefellows/muxy ``` After creating a [config](#configuration-reference] file (let's assume it's at `./conf/config.yml`), and assuming you are proxying something on port `80`, you can now run the image locally: ``` docker run \ -d \ -p 80:80 \ -v "$PWD/conf":/opt/muxy/conf \ --privileged \ mefellows/muxy ``` You should now be able to hit this Docker container and simulate any failures as per usual. e.g. `curl docker:80/some/endpoint`. The [Hystrix](#hystrix) example above has a detailed example on how to use Muxy with a more complicated system, using Docker Compose to orchestrate a number of containers. ## Extending Muxy Muxy is built as a series of configurable plugins (using [Plugo](https://github.com/mefellows/plugo)) that must be specified in the configuration file to be activated. Start with a quick tour of Plugo before progressing. ### Proxies Proxies must implement the [Proxy](/muxy/proxy.go) interface, and register themselves via `PluginFactories.register` to be available at runtime. Take a look at the [HTTP Proxy](protocol/http.go) for a good working example. ### Middleware Middlewares implement the [Middleware](/muxy/middle.go) interface and register themselves via `PluginFactories.register` to be available at runtime. Take a look at the [HTTP Delay](symptom/http_delay.go) for a good working example. ## Contributing See [CONTRIBUTING](CONTRIBUTING.md).

Python Engineer Roadmap

<a id="top"></a> <br /> # Python Engineer Roadmap [](README.pdf) [Python](https://www.python.org/) can be used in a lot of computer science fields. In this repository, we have collected resources for each field of computer science that are related to Python.\ **Not sure which source to choose?** You can follow the resources marked with a ✅ symbol, they are highly recommended by the community. ### Contribution Before you head over, read the [Contribution Guide](CONTRIBUTING.md) first. You are new to contribution process? For more information about the steps and guides, check out the [First Contribution Guide](https://github.com/firstcontributions/first-contributions). ### Table of Contents - [Prerequisites](#prerequisites) - [Algorithms and Data Structures](#algorithms-and-data-structures) - [System Design](#system-design) - [Git](#git) - [Operating System](#operating-system) - [Virtual Environment](#virtual-environment) - [Python](#python) - [Career Path](#career-path) - [Backend](#backend) - [Django](#django) - [FastAPI](#fastapi) - [Flask](#flask) - [Tornado](#tornado) - [Web2Py](#web2py) - [Sanic](#sanic) - [AIOHTTP](#aiohttp) - [Bottle](#bottle) - [Dash](#dash) - [Data Science](#data-science) - [Data Analysis](#data-analysis) - [Numpy](#numpy) - [Scipy](#scipy) - [Pandas](#pandas) - [Data Visualization](#data-visualization) - [Matplotlib](#matplotlib) - [Plotly](#plotly) - [Machine Learning](#machine-learning) - [Deep Learning](#deep-learning) - [Neural Networks](#neural-networks) - [Image Processing](#image-processing) - [DevOps](#devops) - [Hacking](#hacking) - [Algorithmic Trading](#algorithmic-trading) - [Bot](#bot) - [Web](#web) - [Selenium](#selenium) - [WebBot](#webbot) - [Telegram](#telegram) - [Telethon](#telethon) - [Pygram](#pygram) - [Pyrogram](#pyrogram) - [Python Telegram Bot](#python-telegram-bot) - [AIOGram](#aiogram) - [PyTelegramBotApi](#pytelegrambotapi) - [TeleBot](#telebot) - [Discord](#discord) - [DiscordPy](#discordpy) - [Instagram](#instagram) - [Instagram-Scraper](#instagram-scraper) - [InstaPy](#instapy) - [Advanced Topics](#advanced-topics) - [Databases](#databases) - [General](#general) - [SQLite](#sqlite) - [PostgreSQL](#postgresql) - [MySQL](#mysql) - [Oracle](#oracle) - [MongoDB](#mongodb) - [Redis](#redis) - [MemCached](#memcached) - [Apache Cassandra](#apache-cassandra) - [Clean Code](#clean-code) - [Clean Architecture](#clean-architecture) - [Caching](#caching) - [Testing](#testing) - [Python `unittest` Package](#python-unittest-package) - [`PyTest` Testing Package](#pytest-testing-package) - [DRF Test Framework](#drf-test-framework) - [Container Platforms](#container-platforms) - [Docker](#docker) - [Kubernetes](#kubernetes) - [Programming Paradigms](#programming-paradigms) - [Object-Oriented Programming](#object-oriented-programming) - [Functional Programming](#functional-programming) - [Architectural Patterns](#architectural-patterns) - [Microservice](#microservice) - [Enterprise Applications](#enterprise-applications) - [Design Principles](#design-principles) - [SOLID](#solid) - [KISS](#kiss) - [DRY](#dry) - [Design Patterns](#design-patterns) - [Message Brokers](#message-brokers) - [RabbitMQ](#rabbitmq) - [Apache Kafka](#apache-kafka) - [WSGI Servers](#wsgi-servers) - [Gunicorn](#gunicorn) - [uWSGI](#uwsgi) - [ASGI Servers](#asgi-servers) - [Uvicorn](#uvicorn) - [Starlette](#starlette) - [Web Servers](#web-servers) - [Nginx](#nginx) - [Apache](#apache) - [API](#api) - [Design](#design) - [Security](#security) - [Availability and Reliability](#availability-and-reliability) - [Distributed Systems](#distributed-systems) - [Reactive Systems](#reactive-systems) - [Refactoring](#refactoring) - [Security](#security) - [Monitoring](#monitoring) - [Soft Skill](#soft-skill) - [Public Cloud](#public-cloud) - [IoT](#iot) - [Where to Go Next?](#where-to-go-next) ## Prerequisites - ### Algorithms and Data Structures - **Book** - ✅ [Grokking Algorithms by Aditya Bhargava](https://www.amazon.com/Grokking-Algorithms-illustrated-programmers-curious/dp/1617292230) - ✅ [Cracking the Coding Interview by Gayle Laakmann McDowell](https://www.amazon.com/Cracking-Coding-Interview-Programming-Questions/dp/0984782850) - [Data Structure and Algorithmic Thinking with Python: Data Structure and Algorithmic Puzzles by Narasimha Karumanchi](https://www.amazon.com/Data-Structure-Algorithmic-Thinking-Python/dp/8192107590) - [Introduction to Algorithms (CLRS)](https://www.amazon.com/Introduction-Algorithms-3rd-MIT-Press/dp/0262033844) - **Video** - [Data Structures And Algorithms Course by Mosh Hamedani](https://codewithmosh.com/p/data-structures-algorithms) - **Platform** - ✅ [LeetCode](https://leetcode.com/) - [HackerRank](https://www.hackerrank.com/) - [CodeWars](https://www.codewars.com/) - [TheAlgorithms](https://the-algorithms.com/) - [Codeforces](https://codeforces.com/) - **Repo** - ✅ [Coding University](https://github.com/jwasham/coding-interview-university) - **Cheat Sheet** - [Data Structures Cheat Sheet](https://intellipaat.com/mediaFiles/2019/02/Python-Data-structures-cheat-sheet.pdf) - ### System Design - **Book** - ✅ [System Design Interview by Alex Xu](https://www.amazon.com/System-Design-Interview-insiders-Second/dp/B08CMF2CQF) - [System Design Interview: Volume 2 by Alex Xu & Sahn Lam](https://www.amazon.com/System-Design-Interview-Insiders-Guide/dp/1736049119) - **Course** - [Educative - Grokking the System Design Interview](https://www.educative.io/courses/grokking-the-system-design-interview) - ### Git - **Documentation** - [Git Documentation](https://git-scm.com/docs) - **Video** - ✅ [Git Course by Mosh Hamedani](https://codewithmosh.com/p/the-ultimate-git-course) - [Git and GitHub tutorial for beginners by Amigoscode](https://www.youtube.com/watch?v=3fUbBnN_H2c) - [Git and GitHub crash course by freeCodeCamp](https://www.youtube.com/watch?v=RGOj5yH7evk) - [Git For Professionals course by Trevor Miller](https://egghead.io/courses/practical-git-for-everyday-professional-use) - **Book** - [Pro Git](https://git-scm.com/book/en/) - [Git Notes for Professionals](https://books.goalkicker.com/GitBook/) - **Website** - [Git For Beginners by tutorialspoint](https://www.tutorialspoint.com/git/index.htm) - [Git For Intermediates and Professionals by W3schools](https://www.w3schools.com/git/) - [Advanced Git Tips by atlassian](https://www.atlassian.com/git/tutorials/advanced-overview) - [Learn Git Branching](https://learngitbranching.js.org/) - **Cheat Sheet** - [Git cheat sheet](https://wac-cdn.atlassian.com/dam/jcr:e7e22f25-bba2-4ef1-a197-53f46b6df4a5/SWTM-2088_Atlassian-Git-Cheatsheet.pdf?cdnVersion=353) - ### Operating System - **Book** - ✅ [LPIC-1: Linux Professional Institute Certification Study Guide: Exams 101 and 102 by Roderick W. Smith](https://www.amazon.com/LPIC-1-Linux-Professional-Institute-Certification/dp/1118495632) - **Video** - [Lpic-1 Course by Jadi](https://www.youtube.com/watch?v=AKkNUvEHXhk&list=PLFOYXCPEqdNUU55Xvgst8wGTWnz_sd-cj) - **Platform** - [Linux Journey](https://linuxjourney.com/) - **Community** - [Discord Linux group](https://discord.gg/discord-linux) - [Linux For Everyone Community](https://t.me/linux4everyone) - **Cheat Sheet** - [Linux commands cheat sheet](https://www.guru99.com/linux-commands-cheat-sheet.html) - ### Virtual Environment - **VENV** - **Documentation** - [VENV Documentation](https://docs.python.org/3/library/venv.html) - **VirtualEnvWrapper** - **Documentation** - [VirtualEnvWrapper Documentation](https://virtualenvwrapper.readthedocs.io/en/latest/) - **PipEnv** - **Documentation** - [PipEnv Documentation](https://pipenv.pypa.io/en/latest/) - **Conda** - **Documentation** - [Conda Documentation](https://docs.conda.io/en/latest/) - **Python-Poetry** - **Documentation** - [Python-Poetry Documentation](https://python-poetry.org/docs/) - ### Python - **Documentation** - [Python Documentation](https://docs.python.org/3/) - **Beginner** - **Book** - ✅ [Python Crash Course by Eric Matthes](https://www.amazon.co.uk/dp/1593276036/) - [Head First Python by Paul Barry](https://www.amazon.com/Head-First-Python-Brain-Friendly-Guide/dp/1449382673) - [Learn Python the Hard Way by Zed Shaw](https://www.amazon.com/Learn-Python-Hard-Way-Introduction/dp/0321884914) - [Essential Python Tools](https://books.agiliq.com/projects/essential-python-tools/en/latest/) - **Video** - [Python Beginner Tutorial by NeuralNine](https://www.youtube.com/playlist?list=PL7yh-TELLS1E6dNCzfQl-NG-KJP3C-4mc) - [Python Programming Tutorials by Tech with Tim](https://www.youtube.com/playlist?list=PLzMcBGfZo4-mFu00qxl0a67RhjjZj3jXm) - **Platform** - [W3schools](https://www.w3schools.com/python/default.asp) - [Codecademy Python 2](https://www.codecademy.com/learn/learn-python) - [Codecademy Python 3](https://www.codecademy.com/learn/learn-python-3) - [Sololearn Python](https://www.sololearn.com/learning/1073) - **Intermediate** - **Book** - ✅ [Python Cookbook by David Beazley & Brian Jones](https://www.amazon.com/Python-Cookbook-Third-David-Beazley/dp/1449340377) - [Beyond the Basic Stuff with Python Best Practices for Writing Clean Code by Sweigart, Al](https://www.amazon.de/-/en/Al-Sweigart/dp/1593279663) - [Fluent Python by Luciano Ramalho 2nd Edition](https://www.amazon.com/Fluent-Python-Concise-Effective-Programming/dp/1492056359) - [Effective Python by Brett Slatkin](https://www.amazon.com/Effective-Python-Specific-Software-Development/dp/0134853989) - [Python Concurrency with asyncio](https://www.manning.com/books/python-concurrency-with-asyncio) - **Video** - [Python Intermediate Tutorial by NeuralNine](https://www.youtube.com/playlist?list=PL7yh-TELLS1F3KytMVZRFO-xIo_S2_Jg1) - [Intermediate Python Tutorials by Tech with Tim](https://www.youtube.com/playlist?list=PLzMcBGfZo4-nhWva-6OVh1yKWHBs4o_tv) - **Platform** - [GeeksForGeeks](https://www.geeksforgeeks.org/python-programming-language) - [Programiz](https://www.programiz.com/python-programming) - [Scaler Topics](https://www.scaler.com/topics/python/) - **Advanced** - **Book** - ✅ [Architecture Patterns with Python by Harry Percival & Bob Gregory](https://www.amazon.com/Architecture-Patterns-Python-Domain-Driven-Microservices/dp/1492052205) - ✅ [Practices of the Python Pro by Dane Hillard](https://www.amazon.com/Practices-Python-Pro-Dane-Hillard/dp/1617296082) - ✅ [Python Tricks by Dan Bader](https://www.amazon.com/Python-Tricks-Buffet-Awesome-Features/dp/1775093301) - [Python Testing with pytest by Brian Okken](https://www.amazon.com/Python-Testing-pytest-Effective-Scalable/dp/1680502409) - [Python Concurrency with asyncio by Matthew Fowler](https://www.manning.com/books/python-concurrency-with-asyncio) - [Python for Programmers by Deitel Developer Series](https://deitel.com/python-for-programmers-book/) - [Serious Python by Julien Danjou](https://serious-python.com/) - [Python Notes for Professionals](https://books.goalkicker.com/PythonBook/) - **Video** - [Python3: Deep Dive (4 Parts)](https://www.udemy.com/course/python-3-deep-dive-part-1/) - **Platform** - ✅ [RealPython](https://realpython.com/) - [Python-Course](https://python-course.eu/) - **Community** - [Python Discord group](https://discord.gg/python) - [Python Telegram group](https://t.me/Python) - **Cheat Sheet** - [Beginners Python cheat sheet](https://edu.anarcho-copy.org/Programming%20Languages/Python/Python%20CheatSheet/beginners_python_cheat_sheet_pcc_django.pdf) - [Python cheat sheet](https://perso.limsi.fr/pointal/_media/python:cours:mementopython3-english.pdf) ## Career Path - ### Backend - #### Django - **Documentation** - [Django Documentation](https://www.djangoproject.com/) - [Django Tutorial - w3schools](https://www.w3schools.com/django/) - **Book** - [Django for Beginners by William S. Vincent](https://www.amazon.com/gp/product/1735467200) - [Django for APIs by William S. Vincent](https://www.amazon.com/gp/product/1735467227/) - [Django for Professionals by William S. Vincent](https://www.amazon.com/gp/product/1735467235) - [Two Scoops of Django 3.x by Daniel Roy Greenfeld, Audrey Roy Greenfeld](https://www.feldroy.com/books/two-scoops-of-django-3-x) - [Test-Driven Development with Python: Obey the Testing Goat: Using Django, Selenium, and JavaScript by Harry Percival](https://www.obeythetestinggoat.com/book/praise.harry.html) - [Test-Driven Development with Django by Kevin Harvey](https://www.amazon.com/Test-Driven-Development-Django-Kevin-Harvey/dp/178528116X) - [Django3 by example by antonio mele](https://www.amazon.com/Django-Example-powerful-reliable-applications-dp-1838981950/dp/1838981950/ref=mt_other?_encoding=UTF8&me=&qid=) - **Video** - [Django Web Framework - Full Course for Beginners by Justin Mitchel](https://www.youtube.com/watch?v=F5mRW0jo-U4) - [Build REST APIs with Django REST Framework and Python By Shubham Sarda](https://www.packtpub.com/product/build-rest-apis-with-django-rest-framework-and-python-video/9781801819022) - [Django For Everybody - Full Course by Dr. Charles Severance](https://youtu.be/o0XbHvKxw7Y) - [Django ORM Mastery - Very Academy](https://www.youtube.com/watch?v=iQF6pln3Gog&list=PLOLrQ9Pn6cazjoDEnwzcdWWf4SNS0QZml) - [Learn Django Class Base View - Very Academy](https://www.youtube.com/watch?v=GxA2I-n8NR8&list=PLOLrQ9Pn6caxNb9eFZJ6LfY29nZkKmmXT) - [Django Course by Mosh Hamedani](https://codewithmosh.com/p/the-ultimate-django-series) - [Try Django 3.2 - Python Web Development Tutorial Series by Justin Mitchel](https://www.youtube.com/playlist?list=PLEsfXFp6DpzRMby_cSoWTFw8zaMdTEXgL) - **Awesome Django** - [Awesome Django](https://github.com/wsvincent/awesome-django#readme) - **Community** - [Django Discord group](https://discord.me/unofficial-django) - [Django Telegram group](https://t.me/django) - **Cheat Sheet** - [Django Cheat Sheet](https://cheatography.com/ogr/cheat-sheets/django/) - [Django Models Cheat Sheet](https://cheatography.com/lewiseason/cheat-sheets/django-models/) - [Django Class Based Views Cheat Sheet](https://cheatography.com/papousekp/cheat-sheets/django-class-based-views/) - [Django Class Based Views Cheat Sheet 2](https://ccbv.co.uk/) - #### FastAPI - **Video** - [Python API Development - Comprehensive Course for Beginners by Sanjeev Thiyagarajan](https://www.youtube.com/watch?v=0sOvCWFmrtA) - [FastAPI course by testdriven.io & talkpython.fm](https://testdriven.io/talkpython/) - **Documentation** - [FastAPI documentation](https://fastapi.tiangolo.com) - [FastAPI Utilities documentation](https://fastapi-utils.davidmontague.xyz/) - **Awesome FastAPI** - [Awesome FastAPI](https://github.com/mjhea0/awesome-fastapi#readme) - **Community** - [FastApi Discord group](https://discord.gg/sATRypy9) - #### Flask - **Book** - [Flask Web Development: Developing Web Applications with Python](https://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world) - [Flask Framework Cookbook](https://www.amazon.de/Flask-Framework-Cookbook-techniques-development/dp/1789951291/) - [The New And Improved Flask Mega-Tutorial](https://www.amazon.com/New-Improved-Flask-Mega-Tutorial/dp/B09YQ33QYT) - **Video** - [Flask Tutorial by Tech With Tim](https://youtube.com/playlist?list=PLzMcBGfZo4-n4vJJybUVV3Un_NFS5EOgX) - [REST APIs with Flask and Python by Jose Salvatierra](https://www.udemy.com/course/rest-api-flask-and-python/) - **Documentation** - [Flask Document](https://flask.palletsprojects.com/) - **Cheat Sheet** - [Flask Cheat Sheet and Quick Reference](https://s3.us-east-2.amazonaws.com/prettyprinted/flask_cheatsheet.pdf) - #### Tornado - **Book** - [Introduction to Tornado by Michael Dory](https://www.amazon.com/Introduction-Tornado-Michael-Dory-2012-03-31/dp/B01FEK31OM) - **Video** - [Tornado, Coroutines and Concurrency by Bek Brace](https://www.youtube.com/watch?v=-gJ21qzpieA) - [Tornado in Depth by Oscar Vilaplana](https://www.youtube.com/watch?v=4Ztq-Yz1ero) - [More than just a pretty web framework, the Tornado IOLoop by Gavin M.Roy](https://www.youtube.com/watch?v=3BYN3ouwkRA) - **Documentation** - [Tornado Document](https://www.tornadoweb.org/en/stable/) - #### Web2Py - **Documentation** - [Web2Py Document](https://web2py.readthedocs.io/en/latest/) - **Book** - [Complete Reference Manual by Massimo Di Pierro](http://www.web2py.com/book) - [Killer Web Development by Marco Laspe](http://killer-web-development.com/) - #### Sanic - **Documentation** - [Sanic Document](https://sanic.readthedocs.io/en/stable/index.html) - [Sanic Guide](https://sanic.dev/en/guide/) - **Article** - [Getting Started with Sanic for Python by Mukul Khanna](https://scoutapm.com/blog/go-fast-getting-started-with-sanic-for-python) - **Video** - [Async Web Apps with Sanic by Dougal Matthews](https://www.youtube.com/watch?v=wb0lk4e9DEg) - #### AIOHTTP - **Documentation** - [AIOHTTP Document](https://docs.aiohttp.org/en/stable/) - #### Bottle - **Documentation** - [Bottle Document](https://bottlepy.org/docs/dev/) - #### Dash - **Documentation** - [Dash-Python Document](https://dash.plotly.com/introduction) - **Awesome Dash** - [Awesome Dash](https://github.com/ucg8j/awesome-dash#readme) - **Template** - [Dash Clean Architecture Template](https://github.com/CzakoZoltan08/dash-clean-architecture-template) - [List Of All Python Backend Web Frameworks](https://wiki.python.org/moin/WebFrameworks) - ### Data Science - #### Data Analysis - ##### Numpy - **Documentation** - [Numpy Document](https://numpy.org/doc/stable/user/index.html) - ##### Scipy - **Documentation** - [Scipy Document](https://docs.scipy.org/doc/scipy/tutorial/index.html) - ##### Pandas - **Documentation** - [Pandas Document](https://pandas.pydata.org/docs/user_guide/index.html) - #### Data Visualization - ##### Matplotlib - **Documentation** - [Matplotlib Document](https://matplotlib.org/stable/users/index.html) - ##### Plotly - **Documentation** - [Plotly Document](https://plotly.com/python-api-reference/) - ### Machine Learning - **Video** - [Machine Learning Course by Andrew Ng](https://coursera.org/learn/machine-learning) - ### Deep Learning - **Video** - [Deep Learning Specialization by Andrew Ng](https://www.coursera.org/specializations/deep-learning) - [AladdinPersson](https://www.youtube.com/c/AladdinPersson) - ### Neural Networks - **Video** - [Neural Networks and Calculus](https://www.youtube.com/c/3blue1brown) - ### Image Processing - ### DevOps - **Community** - [DevOps, SRE, & Infrastructure](https://discord.com/invite/VEEnHkPzY6) - **CI/CD** - [CI/CD Full Course | Continuous Integration And Continuous](https://www.youtube.com/watch?v=h9K1NnqwUvE) - [GitLab CI CD Tutorial for Beginners](https://www.youtube.com/watch?v=qP8kir2GUgo) - ### Hacking - **Book** - [Black Hat Python, 2nd Edition: Python Programming for Hackers and Pentesters](https://www.amazon.com/Black-Hat-Python-2nd-Programming/dp/1718501129) - ### Algorithmic Trading - ### Bot - #### Web - #### Selenium - [Selenium (Main Home)](https://github.com/SeleniumHQ/selenium) - [Source](https://github.com/SeleniumHQ/selenium/tree/trunk/py) - [Documentation](https://www.selenium.dev/selenium/docs/api/py/) - [Helium](https://github.com/mherrmann/selenium-python-helium) - [Base](https://github.com/seleniumbase/SeleniumBase) - [InstaPy](https://github.com/InstaPy/InstaPy) - [AutoCrawler](https://github.com/YoongiKim/AutoCrawler) - [Wire](https://github.com/wkeeling/selenium-wire) - [Cucucumber](https://github.com/executeautomation/SeleniumWithCucucumber) - [Requestium](https://github.com/tryolabs/requestium) - [Undetected](https://github.com/ultrafunkamsterdam/undetected-chromedriver) - #### WebBot - [Source](https://github.com/nateshmbhat/webbot) - #### Telegram - #### Telethon - [Source](https://github.com/LonamiWebs/Telethon) - [Documentation](https://docs.telethon.dev/) - #### Pygram - [Source](https://github.com/pygram/pygram) - [Documentation](https://pygram.readthedocs.io/en/latest/) - #### Pyrogram - [Source](https://github.com/pyrogram/pyrogram) - [Documentation](https://docs.pyrogram.org/) - #### Python Telegram Bot - [Source](https://github.com/python-telegram-bot/python-telegram-bot) - [Documentation](https://python-telegram-bot.readthedocs.io/) - #### AIOGram - [Source](https://github.com/aiogram/aiogram) - [Documentation](https://docs.aiogram.dev/) - #### PyTelegramBotApi - [Source](https://github.com/eternnoir/pyTelegramBotAPI) - [Documentation](https://pytba.readthedocs.io/) - #### TeleBot - [Source](https://github.com/KyleJamesWalker/telebot) - #### Discord - #### DiscordPy - [Source](https://github.com/Rapptz/discord.py) - [Documentation](https://discordpy.readthedocs.io) - #### Instagram - #### Instagram-Scraper - [Source](https://github.com/realsirjoe/instagram-scraper) - #### InstaPy - [Source](https://github.com/InstaPy/InstaPy) ## Advanced Topics ⚠️ The following topics don't have any order or priority of learning.\ 🔥 Choose topics that you are **interested in** or **suit your needs**. - ### Databases - #### General - **Book** - ✅ [Designing Data-Intensive Applications: The Big Ideas Behind Reliable, Scalable, and Maintainable Systems](https://www.amazon.com/Designing-Data-Intensive-Applications-Reliable-Maintainable/dp/1449373321) - [Seven Databases in Seven Weeks: A Guide to Modern Databases and the NoSQL Movement](https://www.amazon.com/Seven-Databases-Weeks-Modern-Movement/dp/1680502530/) - #### SQLite - **Documentation** - [SQLite Documentation](https://www.sqlite.org/docs.html) - **Tutorials** - [SQLite Tutorial](https://www.sqlitetutorial.net/) - #### PostgreSQL - **Documentation** - [PostgreSQL Documentation](https://www.postgresql.org/docs/) - **Book** - [Essential Postgres: Database Development using PostgreSQL](https://www.amazon.com/Essential-Postgres-Database-Development-PostgreSQL/dp/B08KH136G4) - **Community** - [PostgreSQL Telegram group](https://t.me/pg_sql) - **Cheat Sheet** - [PostgreSQL Cheat Sheet By GoalKicker](https://books.goalkicker.com/PostgreSQLBook/PostgreSQLNotesForProfessionals.pdf) - [PostgreSQL CHEAT SHEET](https://www.postgresqltutorial.com/wp-content/uploads/2018/03/PostgreSQL-Cheat-Sheet.pdf) - [POSTGRESQL 8.3 PSQL CHEAT SHEET](http://www.postgresonline.com/downloads/special_feature/postgresql83_psql_cheatsheet.pdf) - #### MySQL - **Documentation** - [MySQL Documentation](https://dev.mysql.com/doc/) - **Tutorials** - [MySQL Tutorial](https://www.mysqltutorial.org/) - **Cheat Sheet** - [MySQL Cheat Sheet by GoalKicker](https://books.goalkicker.com/MySQLBook/MySQLNotesForProfessionals.pdf) - #### Oracle - **Documentation** - [Oracle Documentation](https://docs.oracle.com/en/database/index.html) - **Tutorials** - [Oracle Tutorial](https://www.oracletutorial.com/) - **Cheat Sheet** - [Oracle Cheat Sheet by GoalKicker](https://books.goalkicker.com/OracleDatabaseBook/OracleDatabaseNotesForProfessionals.pdf) - #### MongoDB - **Documentation** - [MongoDB Documentation](https://www.mongodb.com/docs/) - **Tutorial** - [Python MongoDB](https://www.w3schools.com/python/python_mongodb_getstarted.asp) - **Cheat Sheet** - [MongoDB Cheat Sheet by GoalKicker](https://books.goalkicker.com/MongoDBBook/MongoDBNotesForProfessionals.pdf) - #### Redis - **Documentation** - [Redis Documentation](https://redis.io/docs/) - **Video** - [Redis Crash Course 1](https://www.youtube.com/watch?v=Hbt56gFj998) - [Redis Crash Course 2](https://www.youtube.com/watch?v=OqCK95AS-YE) - **Article** - [How to use redis with python by Brad Solomon](https://realpython.com/python-redis/) - **Cheat Sheet** - [Redis Cheat Sheet 1](https://cheatography.com/tasjaevan/cheat-sheets/redis/) - [Redis Cheat Sheet 2](https://masonoise.files.wordpress.com/2010/03/redis-cheatsheet-v1.pdf) - #### MemCached - **Documentation** - [MemCached Wiki](https://github.com/memcached/memcached/wiki) - #### Apache Cassandra - **Documentation** - [Apache Cassandra Documentation](https://cassandra.apache.org/_/index.html) - ### Clean Code - **Book** - ✅ [Clean Code: A Handbook of Agile Software Craftsmanship](https://www.amazon.com/gp/product/0132350882) - ✅ [Clean Code in Python by Mariano Anaya](https://www.amazon.com/Clean-Code-Python-maintainable-efficient/dp/1800560214) - [Code Complete: A Practical Handbook of Software Construction, Second Edition by Steve Mcconnell](https://www.amazon.com/Code-Complete-Practical-Handbook-Construction/dp/0735619670) - ### Clean Architecture (In Progress) - ### Caching - **Article** - [Caching in django with redis by Real Python](https://realpython.com/caching-in-django-with-redis/) - **Video** - [Redis Course - In-Memory Database Tutorial](https://www.youtube.com/watch?v=XCsS_NVAa1g) - ### Testing - #### Python `unittest` package - **Documentation** - [Testing in Python](https://docs.python.org/3/library/unittest.html) - [Getting Started With Testing in Python](https://realpython.com/python-testing/) - #### `PyTest` Testing Package - **Documentation** - [Official PyTest Documentation](https://docs.pytest.org/en/stable/index.html) - #### DRF Test Framework - **Documentation** - [Testing - Django REST framework](https://www.django-rest-framework.org/api-guide/testing/) - **Video** - [Pytest Django and Django Rest Framework](https://www.youtube.com/watch?v=KIIdbVs7e8I&list=PLP1DxoSC17LZTTzgfq0Dimkm6eWJQC9ki) - ### Container Platforms - #### Docker - **Documentation** - [Docker Documentation](https://docs.docker.com/) - **Book** - [Docker in Action, Second Edition](https://www.manning.com/books/docker-in-action-second-edition) - [Docker Deep Dive: Zero to Docker in a single book](https://www.amazon.com/Docker-Deep-Dive-Nigel-Poulton-ebook/dp/B01LXWQUFF) - **Video** - [Docker Mastery With Django - very academy](https://www.youtube.com/watch?v=W5Ov0H7E_o4&list=PLOLrQ9Pn6cazCfL7v4CdaykNoWMQymM_C) - [Docker Course by Mosh Hamedani](https://codewithmosh.com/p/the-ultimate-docker-course) - [Docker Swarm Step by Step](https://www.youtube.com/watch?v=74p7csxKN8M) - **Cheat Sheet** - [Docker Cheat Sheet](https://www.docker.com/wp-content/uploads/2022/03/docker-cheat-sheet.pdf) - #### Kubernetes - **Documentation** - [Kubernetes Documentation](https://kubernetes.io/docs/home/) - **Video** - ["Just me and Opensource" YouTube channel](https://www.youtube.com/playlist?list=PL34sAs7_26wNBRWM6BDhnonoA5FMERax0) - **Book** - [Kubernetes: Up and Running, 2nd Edition](https://www.oreilly.com/library/view/kubernetes-up-and/9781492046523) - [Kubernetes in Action, Second Edition](https://www.manning.com/books/kubernetes-in-action-second-edition) - **Community** - [Kubernetes Discord group](https://discord.gg/k8s-at-home) - ### Programming Paradigms - #### Object-Oriented Programming - **Tutorial** - [Python Classes and Objects by W3Schools (Beginners)](https://www.w3schools.com/python/python_classes.asp) - [Python Object Oriented Programming by programiz.com (Beginners)](https://www.programiz.com/python-programming/object-oriented-programming) - **Article** - [Python OOPs Concepts 3 by GeeksForGeeks (Beginners)](https://www.geeksforgeeks.org/python-oops-concepts/) - [Object-Oriented Programming (OOP) in Python 3 by David Amos (Intermediate)](https://realpython.com/python3-object-oriented-programming/#:~:text=Programming%20with%20Python.-,What%20Is%20Object%2DOriented%20Programming%20in%20Python%3F,are%20bundled%20into%20individual%20objects.) - **Book** - [Python Object-Oriented Programming](https://www.amazon.com/Python-Object-Oriented-Programming-maintainable-object-oriented/dp/1789615852/ref=pd_sbs_sccl_2_2/138-1551814-9810765?pd_rd_w=jzyei&pf_rd_p=3676f086-9496-4fd7-8490-77cf7f43f846&pf_rd_r=MFK3P1Y675XM2K837YAX&pd_rd_r=392af586-64f4-4790-83f3-4b2ba1954b3d&pd_rd_wg=0Wk4G&pd_rd_i=1789615852&psc=1) - #### Functional Programming - **Article** - [Functional Programming in Python](https://realpython.com/python-functional-programming/) - ### Architectural Patterns - #### Microservice - **Book** - [Microservice Architecture](https://www.oreilly.com/library/view/microservice-architecture/9781491956328) - [Building Microservices, 2nd Edition](https://www.oreilly.com/library/view/building-microservices-2nd/9781492034018/) - #### Enterprise Applications - **Book** - [Patterns of Enterprise Application Architecture](https://www.amazon.de/Patterns-Enterprise-Application-Architecture-Martin/dp/0321127420) - [Enterprise Integration Patterns: Designing, Building, and Deploying Messaging Solutions](https://www.amazon.de/-/en/Gregor-Hohpe/dp/0321200683/) - ### Design Principles - #### SOLID - **Article** - [SOLID Principles In Python by Philip Norton](https://www.hashbangcode.com/article/solid-principles-python) - [Uncle Bob's SOLID principles made easy 🍀 - in Python!](https://www.youtube.com/watch?v=pTB30aXS77U) - #### KISS - #### DRY - ### Design Patterns - **Book** - [Head First Design Patterns: Building Extensible and Maintainable Object-Oriented Software](https://www.amazon.com/Head-First-Design-Patterns-Object-Oriented/dp/149207800X) - [Django Design Patterns and Best Practices (by Arun Ravindran)](https://www.amazon.com/Django-Design-Patterns-Practices-Industry-standard/dp/1788831349) - [Dive Into Design Patterns by Alexander Shvets](https://refactoring.guru/design-patterns/book) - **Video** - [Design Patterns Course by Mosh Hamedani](https://codewithmosh.com/p/design-patterns) - [Become a better software developer](https://www.youtube.com/c/ArjanCodes) - ### Message Brokers - #### RabbitMQ - **Documentation** - [RabbitMQ Documentation](https://www.rabbitmq.com/documentation.html) - **Article** - [RabbitMQ Hello World](https://www.rabbitmq.com/tutorials/tutorial-one-python.html) - [RabbitMQ Work Queues](https://www.rabbitmq.com/tutorials/tutorial-two-python.html) - [RabbitMQ Publish/Subscribe](https://www.rabbitmq.com/tutorials/tutorial-three-python.html) - [RabbitMQ Routing](https://www.rabbitmq.com/tutorials/tutorial-four-python.html) - [RabbitMQ Topics](https://www.rabbitmq.com/tutorials/tutorial-five-python.html) - [RabbitMQ Remote procedure call (RPC)](https://www.rabbitmq.com/tutorials/tutorial-six-python.html) - **Cheat Sheet** - [RabbitMQ Cheat Sheet 1](https://cheatography.com/francisuk/cheat-sheets/rabbitmq/pdf/) - [RabbitMQ Cheat Sheet 2](https://lzone.de/cheat-sheet/RabbitMQ) - #### Apache Kafka - **Documentation** - [Apache Kafka Documentation](https://kafka.apache.org/documentation/) - **Cheat Sheet** - [Apache Kafka Cheat Sheet 1](https://gist.github.com/sahilsk/d2a6ec384f5f2333e3fef40a581a97e1) - [Apache Kafka Cheat Sheet 2](https://medium.com/@TimvanBaarsen/apache-kafka-cli-commands-cheat-sheet-a6f06eac01b) - ### WSGI Servers - #### Gunicorn - **Documentation** - [Gunicorn Documentation](https://docs.gunicorn.org/en/stable/) - #### uWSGI - **Documentation** - [uWSGI Documentation](https://uwsgi-docs.readthedocs.io/en/latest/) - ### ASGI Servers - #### Uvicorn - **Documentation** - [Uvicorn Documentation](https://www.uvicorn.org/) - #### Starlette - **Documentation** - [Starlette Documentation](https://www.starlette.io/) - ### Web Servers - #### Nginx - **Documentation** - [NGINX Documentation](http://nginx.org/en/docs/) - **Book** - [NGINX Cookbook](https://www.nginx.com/resources/library/complete-nginx-cookbook/) - **Cheat Sheet** - [NGINX CHEAT SHEET](https://kiza.dev/notes/nginx-cheat-sheet) - #### Apache - **Documentation** - [Apache Documentation](https://httpd.apache.org/docs/) - **Book** - [Apache Cookbook: Solutions and Examples for Apache Administrators](https://www.amazon.com/Apache-Cookbook-Solutions-Examples-Administrators/dp/0596529945) - **Cheat Sheet** - [Apache Cheat Sheet](http://www.cheat-sheets.org/saved-copy/apache-refcard-a4.pdf) - ### API - #### Design - **Guidelines and Best Practices** - [Zalando RESTful API and Event Guidelines](https://opensource.zalando.com/restful-api-guidelines/) - [Microsoft REST API Guidelines](https://github.com/microsoft/api-guidelines) - #### Security - **Checklist** - [API Security Checklist](https://github.com/bobycloud/API-Security-Checklist/blob/master/README-en.md) - ### Availability and Reliability (In Progress) - ### Distributed Systems (In Progress) - ### Reactive Systems (In Progress) - ### Refactoring - **Video** - [Dive Into REFACTORING](https://refactoring.guru/refactoring/course) - ### Security - **Book** - [The Web Application Hacker's Handbook](https://www.amazon.com/Web-Application-Hackers-Handbook-Exploiting/dp/1118026470) - [Application_Security_Program_Handbook - a guide for software engineers](https://www.mysterylovescompany.com/book/9781633439818) - [Designing secure software - a guide for devlopers](https://www.amazon.com/Designing-Secure-Software-Guide-Developers/dp/1718501927) - [Hacking APIs Breaking Web Application Programming Interfaces](https://www.amazon.com/Hacking-APIs-Application-Programming-Interfaces/dp/1718502443) - [Web Application Security Exploitation and Countermeasures for Modern Web Applications](https://www.amazon.com/Web-Application-Security-Exploitation-Countermeasures/dp/1492053112) - [Web Security for Developers: Real Threats, Practical Defense](https://www.amazon.com/Web-Security-Developers-Malcolm-McDonald/dp/1593279949) - [Mastering Modern Web Penetration Testing](https://www.amazon.com/Mastering-Modern-Web-Penetration-Testing/dp/1785284584) - **WebSite** - [OWASP Top 10](https://owasp.org/www-project-top-ten/) - [OWASP Top 10 for Web with live training](https://application.security/free/owasp-top-10) - [SANS SWAT Checklist](https://www.sans.org/cloud-security/securing-web-application-technologies/) - ### Monitoring (In Progress) - ### Soft Skill - **Book** - [The Clean Coder: A Code of Conduct for Professional Programmers](https://www.amazon.com/Clean-Coder-Conduct-Professional-Programmers/dp/0137081073) - ### Public Cloud (In Progress) - ### IoT - #### Concept - #### Protocol - [Practical MQTT with Steve](http://www.steves-internet-guide.com/) ### Where to Go Next? (In Progress) <p align="right"><a href="#top"><img src="https://raw.githubusercontent.com/DjangoEx/python-engineer-roadmap/main/statics/top.png" width=50 height=50 /></a></p>

Full featured next gen Clojure test runner

<p align="center"><img src="kaocha.png"></p> Full featured next generation test runner for Clojure. Jump to [Quick start](#quick-start) | [Docs](#docs) ## Projects <!-- projects --> | Project | CI | Docs | Release | Coverage | |---------|----|------|---------|----------| | [kaocha](https://github.com/lambdaisland/kaocha) | [](https://circleci.com/gh/lambdaisland/kaocha) | [](https://cljdoc.org/d/lambdaisland/kaocha) | [](https://clojars.org/lambdaisland/kaocha) | [](https://codecov.io/gh/lambdaisland/kaocha) | | [kaocha-cljs](https://github.com/lambdaisland/kaocha-cljs) | [](https://circleci.com/gh/lambdaisland/kaocha-cljs) | [](https://cljdoc.org/d/lambdaisland/kaocha-cljs) | [](https://clojars.org/lambdaisland/kaocha-cljs) | [](https://codecov.io/gh/lambdaisland/kaocha-cljs) | | [kaocha-cucumber](https://github.com/lambdaisland/kaocha-cucumber) | [](https://circleci.com/gh/lambdaisland/kaocha-cucumber) | [](https://cljdoc.org/d/lambdaisland/kaocha-cucumber) | [](https://clojars.org/lambdaisland/kaocha-cucumber) | [](https://codecov.io/gh/lambdaisland/kaocha-cucumber) | | [kaocha-junit-xml](https://github.com/lambdaisland/kaocha-junit-xml) | [](https://circleci.com/gh/lambdaisland/kaocha-junit-xml) | [](https://cljdoc.org/d/lambdaisland/kaocha-junit-xml) | [](https://clojars.org/lambdaisland/kaocha-junit-xml) | [](https://codecov.io/gh/lambdaisland/kaocha-junit-xml) | | [kaocha-cloverage](https://github.com/lambdaisland/kaocha-cloverage) | [](https://circleci.com/gh/lambdaisland/kaocha-cloverage) | [](https://cljdoc.org/d/lambdaisland/kaocha-cloverage) | [](https://clojars.org/lambdaisland/kaocha-cloverage) | [](https://codecov.io/gh/lambdaisland/kaocha-cloverage) | | [kaocha-boot](https://github.com/lambdaisland/kaocha-boot) | [](https://circleci.com/gh/lambdaisland/kaocha-boot) | [](https://cljdoc.org/d/lambdaisland/kaocha-boot) | [](https://clojars.org/lambdaisland/kaocha-boot) | [](https://codecov.io/gh/lambdaisland/kaocha-boot) | | [deep-diff](https://github.com/lambdaisland/deep-diff) | [](https://circleci.com/gh/lambdaisland/deep-diff2) | [](https://cljdoc.org/d/lambdaisland/deep-diff) | [](https://clojars.org/lambdaisland/deep-diff) | [](https://codecov.io/gh/lambdaisland/deep-diff) | <!-- /projects --> ## 考察 [kǎo chá] - to inspect - to observe and study - on-the-spot investigation See the [Line Dict entry](https://dict.naver.com/linedict/zhendict/dict.html#/cnen/entry/89b3f694bb3a4fd49e3241c6bd1cb79f) for an audio sample. ## Need help? Are you - reporting a bug? -> [File an issue](https://github.com/lambdaisland/kaocha/issues) - looking for support? -> [Post to the forum](https://clojureverse.org/c/projects/kaocha) - looking to contribute? -> Create a pull request or start by discussing your plans [on the forum](https://clojureverse.org/c/projects/kaocha) There is also a [#kaocha](https://clojurians.slack.com/messages/CCY2V0U6A/convo/CCY2V0U6A-1559819261.002300/) channel on Clojurians Slack (sign up [here](http://clojurians.net/)), where users can help each other. ## Docs <!-- docs-toc --> - [1. Introduction](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/1-introduction) - [2. Installing](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/2-installing) - [3. Configuration](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/3-configuration) - [4. Running Kaocha CLI](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/4-running-kaocha-cli) - [5. Running Kaocha From the REPL](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/5-running-kaocha-from-the-repl) - [6. Focusing and Skipping](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/6-focusing-and-skipping) - [7. Watch mode](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/7-watch-mode) - [8. Plugins](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/8-plugins) - [9. Extending](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/9-extending) - [10. Hooks](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/10-hooks) - [`clojure.test` assertion extensions](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/-clojure-test-assertion-extensions) - [Capability check for org.clojure/tools.cli](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/capability-check-for-org-clojure-tools-cli) - [CLI: `--fail-fast` option](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/cli-fail-fast-option) - [CLI: Print the Kaocha configuration](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/cli-print-the-kaocha-configuration) - [CLI: `--profile` option](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/cli-profile-option) - [CLI: `--reporter` option](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/cli-reporter-option) - [CLI: Selecting test suites](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/cli-selecting-test-suites) - [Configuration: Bindings](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/configuration-bindings) - [Configuration: Warnings](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/configuration-warnings) - [Focusing based on metadata](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/focusing-based-on-metadata) - [Focusing on specific tests](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/focusing-on-specific-tests) - [Skipping based on metadata](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/skipping-based-on-metadata) - [Skipping test based on ids](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/skipping-test-based-on-ids) - [Marking tests as pending](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/marking-tests-as-pending) - [Plugin: Capture output](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/plugin-capture-output) - [Plugin: Hooks](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/plugin-hooks) - [Plugin: Notifier (desktop notifications)](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/plugin-notifier-desktop-notifications-) - [Orchestra (spec instrumentation)](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/orchestra-spec-instrumentation-) - [Plugin: Clojure/Java Version filter](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/plugin-clojure-java-version-filter) - [Automatic spec test check generation](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/automatic-spec-test-check-generation) - [Syntax errors are preserved](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/syntax-errors-are-preserved) <!-- /docs-toc --> ## Features Features include - Filtering tests based on test names or metadata - Watch mode: watch the file system for changes and re-run tests - Pretty, pluggable reporting - Randomize test order - Detect when interrupted with ctrl-C and print report - Fail fast mode: stop at first failure and print report - Profiling (show slowest tests) - Dynamic classpath handling - Tests as data (get test config, test plan, or test results as EDN) - Extensible test types (clojure.test, Midje, ...) - Extensible through plugins - Tool agnostic (Clojure CLI, Leiningen, ...) ## Quick start This is no replacement for reading the docs, but if you're particularly impatient to try it out, or if you already know Kaocha and need a quick reference how to set up a new project, then this guide is for you. ### Clojure CLI (tools.deps) Add Kaocha as a dependency, preferably under an alias. ``` clojure ;; deps.edn {:deps { ,,, } :aliases {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.77.1236"}} :main-opts ["-m" "kaocha.runner"]}}} ``` Add a binstub called `bin/kaocha` ``` mkdir -p bin echo '#!/usr/bin/env sh' > bin/kaocha echo 'clojure -M:test "$@"' >> bin/kaocha chmod +x bin/kaocha ``` ### Leiningen Add a profile and alias ``` clojure ;; project.clj (defproject my-proj "0.1.0" :dependencies [,,,] :profiles {:kaocha {:dependencies [[lambdaisland/kaocha "1.77.1236"]]}} :aliases {"kaocha" ["with-profile" "+kaocha" "run" "-m" "kaocha.runner"]}) ``` Add a binstub called `bin/kaocha` ``` shell mkdir -p bin echo '#!/usr/bin/env sh' > bin/kaocha echo 'lein kaocha "$@"' >> bin/kaocha chmod +x bin/kaocha ``` ### Boot In your `build.boot` add the Kaocha dependency, and import the Kaocha task ``` clojure ;; build.boot (set-env! :source-paths #{"src"} :dependencies '[[lambdaisland/kaocha-boot "..."]]) (require '[kaocha.boot-task :refer [kaocha]]) ``` Add a binstub called `bin/kaocha` ``` bash mkdir -p bin echo '#!/usr/bin/env sh' > bin/kaocha echo 'boot kaocha "$@"' >> bin/kaocha chmod +x bin/kaocha ``` #### Clojure CLI (tools.deps) :exec-fn alternative We also support using the Clojure CLI `:exec-fn`/`-X`. However, we recommend the binstub approach above because it allows you to use traditional long and short options. If you nonetheless prefer `:exec-fn`/`-X`, you can set up `deps.edn`: ```clojure ;; deps.edn {:deps { ,,, } :aliases {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.77.1236"}} :exec-fn kaocha.runner/exec-fn :exec-args {}}}} ``` And then Kaocha can be invoked this way: `clojure -X:test` Generally speaking, we recommend using `tests.edn` for all of your configuration rather than putting it in `exec-args` unless there's an alternative combination of options you frequently run. In that case, you can put configuration options `:exec-args` as though it were `tests.edn`. Let's say you frequently use watch with `:fail-fast` and a subset of tests skipped. You could save that configuration with an additional alias: `clojure -X:watch-test` like so: ```clojure ;; deps.edn {:deps { ,,, } :aliases {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.77.1236"}} :exec-fn kaocha.runner/exec-fn :exec-args {}} :watch-test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.77.1236"}} :exec-fn kaocha.runner/exec-fn :exec-args {:watch? true :skip-meta :slow :fail-fast? true }}}} ``` If you wanted to turn off `fail-fast` temporarily, you could run `clojure -X:watch-test :fail-fast? false` ### All tools By default, Kaocha assumes that: - source files are in the `src/` folder, - test files are in the `test/` folder, - all test namespaces _names_ end with `-test` (e.g. `my-project.core-test`). Also, the default test suite id is `:unit` (just `unit` on the command line). If your tests don't seem to run (outcome is `0 tests, 0 assertions, 0 failures`) you may need to write up your own configuration: add a `tests.edn` at the root of the project to configure actual test and source paths, and optionally set a reporter or load plugins (cf. Configuration in the [documentation](https://cljdoc.org/d/lambdaisland/kaocha/)). Example of a catch-all `tests.edn` config file (should run all tests found in `src/` and `/test`, in any namespace). ``` clojure #kaocha/v1 {:tests [{:id :unit :test-paths ["test" "src"] :ns-patterns [".*"]}] ;; :reporter kaocha.report.progress/report ;; :plugins [:kaocha.plugin/profiling :kaocha.plugin/notifier] } ``` Warning: this is not an optimal configuration. To avoid extra churn, you should try and target only folders and namespaces that actually contain tests. Run your tests ``` shell bin/kaocha # Watch for changes bin/kaocha --watch # Exit at first failure bin/kaocha --fail-fast # Only run the `unit` suite bin/kaocha unit # Only run a single test bin/kaocha --focus my.app.foo-test/bar-test # Use an alternative config file bin/kaocha --config-file tests_ci.edn # See all available options bin/kaocha --test-help ``` ## Third party projects * [kaocha-noyoda](https://github.com/magnars/kaocha-noyoda) Don't speak like Yoda, write `(is (= actual expected))` instead of `(is (= expected actual))` ## Requirements Kaocha requires Clojure 1.9 or later. <!-- opencollective --> ## Lambda Island Open Source [Become a backer](https://opencollective.com/lambda-island) and show your support to our open source projects. <a href="https://opencollective.com/mochajs"><img src="https://opencollective.com/mochajs/tiers/backers.svg?limit=30&button=false&avatarHeight=46&width=750"></a> <img align="left" src="https://github.com/lambdaisland/open-source/raw/master/artwork/lighthouse_readme.png"> &nbsp; kaocha is part of a growing collection of quality Clojure libraries created and maintained by the fine folks at [Gaiwan](https://gaiwan.co). Pay it forward by [becoming a backer on our Open Collective](http://opencollective.com/lambda-island), so that we may continue to enjoy a thriving Clojure ecosystem. You can find an overview of our projects at [lambdaisland/open-source](https://github.com/lambdaisland/open-source). &nbsp; &nbsp; <!-- /opencollective --> <!-- contributing --> ## Contributing We warmly welcome patches to kaocha. Please keep in mind the following: - adhere to the [LambdaIsland Clojure Style Guide](https://nextjournal.com/lambdaisland/clojure-style-guide) - write patches that solve a problem - start by stating the problem, then supply a minimal solution `*` - by contributing you agree to license your contributions as EPL 1.0 - don't break the contract with downstream consumers `**` - don't break the tests We would very much appreciate it if you also - update the CHANGELOG and README - add tests for new functionality We recommend opening an issue first, before opening a pull request. That way we can make sure we agree what the problem is, and discuss how best to solve it. This is especially true if you add new dependencies, or significantly increase the API surface. In cases like these we need to decide if these changes are in line with the project's goals. `*` This goes for features too, a feature needs to solve a problem. State the problem it solves first, only then move on to solving it. `**` Projects that have a version that starts with `0.` may still see breaking changes, although we also consider the level of community adoption. The more widespread a project is, the less likely we're willing to introduce breakage. See [LambdaIsland-flavored Versioning](https://github.com/lambdaisland/open-source#lambdaisland-flavored-versioning) for more info. <!-- /contributing --> <!-- license --> ## License Copyright &copy; 2018-2023 Arne Brasseur and contributors Available under the terms of the Eclipse Public License 1.0, see LICENSE.txt <!-- /license -->

Mocha is a mocking and stubbing library for Ruby

## Mocha [](https://app.circleci.com/pipelines/github/freerange/mocha) [](http://badge.fury.io/rb/mocha) ### Description * A Ruby library for [mocking](http://xunitpatterns.com/Mock%20Object.html) and [stubbing](http://xunitpatterns.com/Test%20Stub.html) - but deliberately not (yet) [faking](http://xunitpatterns.com/Fake%20Object.html) or [spying](http://xunitpatterns.com/Test%20Spy.html). * A unified, simple and readable syntax for both full & partial mocking. * Built-in support for MiniTest and Test::Unit. * Supported by many other test frameworks. ### Intended Usage Mocha is intended to be used in unit tests for the [Mock Object](http://xunitpatterns.com/Mock%20Object.html) or [Test Stub](http://xunitpatterns.com/Test%20Stub.html) types of [Test Double](http://xunitpatterns.com/Test%20Double.html), not the [Fake Object](http://xunitpatterns.com/Fake%20Object.html) or [Test Spy](http://xunitpatterns.com/Test%20Spy.html) types. Although it would be possible to extend Mocha to allow the implementation of fakes and spies, we have chosen to keep it focused on mocks and stubs. ### Installation #### Gem Install the latest version of the gem with the following command... $ gem install mocha Note: If you are intending to use Mocha with Test::Unit or MiniTest, you should only setup Mocha *after* loading the relevant test library... ##### Test::Unit ```ruby require 'rubygems' gem 'mocha' require 'test/unit' require 'mocha/test_unit' ``` ##### MiniTest ```ruby require 'rubygems' gem 'mocha' require 'minitest/unit' require 'mocha/minitest' ``` #### Bundler If you're using Bundler, include Mocha in the `Gemfile` and then setup Mocha later once you know the test library has been loaded... ##### Test::Unit ```ruby # Gemfile gem 'mocha' # Elsewhere after Bundler has loaded gems e.g. after `require 'bundler/setup'` require 'test/unit' require 'mocha/test_unit' ``` ##### MiniTest ```ruby # Gemfile gem 'mocha' # Elsewhere after Bundler has loaded gems e.g. after `require 'bundler/setup'` require 'minitest/unit' require 'mocha/minitest' ``` ##### RSpec RSpec includes a mocha adapter. Just tell RSpec you want to mock with `:mocha`: ```ruby # Gemfile in Rails app gem 'mocha' # Within `spec/spec_helper.rb` RSpec.configure do |config| config.mock_with :mocha end ``` Note: There is no need to use a require statement to setup Mocha; RSpec does this itself. ##### Cucumber ```ruby # In e.g. features/support/mocha.rb require 'mocha/api' World(Mocha::API) Around do |scenario, block| begin mocha_setup block.call mocha_verify ensure mocha_teardown end end ``` #### Rails If you're loading Mocha using Bundler within a Rails application, you should setup Mocha manually e.g. at the bottom of your `test_helper.rb`. ##### MiniTest Note that since Rails v4 (at least), `ActiveSupport::TestCase` has inherited from `Minitest::Test` or its earlier equivalents. Thus unless you are *explicitly* using Test::Unit, you are likely to be using MiniTest. ```ruby # Gemfile in Rails app gem 'mocha' # At bottom of test_helper.rb (or at least after `require 'rails/test_help'`) require 'mocha/minitest' ``` ##### Other Test Framework Follow the instructions for the relevant test framework in the [Bundler](#bundler) section, but ensure that the relevant Mocha file (`mocha/minitest`, `mocha/test_unit`, or `mocha/api`) is required **after** the test framework has been loaded, e.g. at the bottom of `test_helper.rb` or `spec_helper.rb`, or at least after `rails/test_help` has been required. #### Known Issues * In Mocha v1.10.0 an undocumented feature of `API#mock`, `API#stub` & `API#stub_everything` was changed. Previously when these methods were passed a single symbol, they returned a mock object that responded to the method identified by the symbol. Now Passing a single symbol is equivalent to passing a single string, i.e. it now defines the 'name' of the mock object. * In Mocha v1.2.0 there is a scenario where stubbing a class method originally defined in a module hangs the Ruby interpreter due to [a bug in Ruby v2.3.1](https://bugs.ruby-lang.org/issues/12832). See #272. This was fixed in Mocha v1.2.1. * Since v1.1.0 Mocha has used prepended modules internally for stubbing methods. There is [an obscure Ruby bug](https://bugs.ruby-lang.org/issues/12876) in many (but not all) versions of Ruby between v2.0 & v2.3 which under certain circumstances may cause your Ruby interpreter to hang. See the Ruby bug report for more details. The bug has been fixed in Ruby v2.3.3 & v2.4.0. * Stubbing an aliased class method, where the original method is defined in a module that's used to `extend` the class doesn't work in Ruby 1.8.x. See stub_method_defined_on_module_and_aliased_test.rb for an example of this behaviour. * 0.13.x versions cause a harmless, but annoying, deprecation warning when used with Rails 3.2.0-3.2.12, 3.1.0-3.1.10 & 3.0.0-3.0.19. * 0.11.x versions don't work with Rails 3.2.13 (`TypeError: superclass mismatch for class ExpectationError`). See #115. * Versions 0.10.2, 0.10.3 & 0.11.0 of the Mocha gem were broken. Please do not use these versions. ### Usage #### Quick Start ```ruby require 'test/unit' require 'mocha/test_unit' class MiscExampleTest < Test::Unit::TestCase def test_mocking_a_class_method product = Product.new Product.expects(:find).with(1).returns(product) assert_equal product, Product.find(1) end def test_mocking_an_instance_method_on_a_real_object product = Product.new product.expects(:save).returns(true) assert product.save end def test_stubbing_instance_methods_on_real_objects prices = [stub(:pence => 1000), stub(:pence => 2000)] product = Product.new product.stubs(:prices).returns(prices) assert_equal [1000, 2000], product.prices.collect {|p| p.pence} end def test_stubbing_an_instance_method_on_all_instances_of_a_class Product.any_instance.stubs(:name).returns('stubbed_name') product = Product.new assert_equal 'stubbed_name', product.name end def test_traditional_mocking object = mock('object') object.expects(:expected_method).with(:p1, :p2).returns(:result) assert_equal :result, object.expected_method(:p1, :p2) end def test_shortcuts object = stub(:method1 => :result1, :method2 => :result2) assert_equal :result1, object.method1 assert_equal :result2, object.method2 end end ``` #### Mock Objects ```ruby class Enterprise def initialize(dilithium) @dilithium = dilithium end def go(warp_factor) warp_factor.times { @dilithium.nuke(:anti_matter) } end end require 'test/unit' require 'mocha/test_unit' class EnterpriseTest < Test::Unit::TestCase def test_should_boldly_go dilithium = mock() dilithium.expects(:nuke).with(:anti_matter).at_least_once # auto-verified at end of test enterprise = Enterprise.new(dilithium) enterprise.go(2) end end ``` #### Partial Mocking ```ruby class Order attr_accessor :shipped_on def total_cost line_items.inject(0) { |total, line_item| total + line_item.price } + shipping_cost end def total_weight line_items.inject(0) { |total, line_item| total + line_item.weight } end def shipping_cost total_weight * 5 + 10 end class << self def find_all # Database.connection.execute('select * from orders... end def number_shipped_since(date) find_all.select { |order| order.shipped_on > date }.length end def unshipped_value find_all.inject(0) { |total, order| order.shipped_on ? total : total + order.total_cost } end end end require 'test/unit' require 'mocha/test_unit' class OrderTest < Test::Unit::TestCase # illustrates stubbing instance method def test_should_calculate_shipping_cost_based_on_total_weight order = Order.new order.stubs(:total_weight).returns(10) assert_equal 60, order.shipping_cost end # illustrates stubbing class method def test_should_count_number_of_orders_shipped_after_specified_date now = Time.now; week_in_secs = 7 * 24 * 60 * 60 order_1 = Order.new; order_1.shipped_on = now - 1 * week_in_secs order_2 = Order.new; order_2.shipped_on = now - 3 * week_in_secs Order.stubs(:find_all).returns([order_1, order_2]) assert_equal 1, Order.number_shipped_since(now - 2 * week_in_secs) end # illustrates stubbing instance method for all instances of a class def test_should_calculate_value_of_unshipped_orders Order.stubs(:find_all).returns([Order.new, Order.new, Order.new]) Order.any_instance.stubs(:shipped_on).returns(nil) Order.any_instance.stubs(:total_cost).returns(10) assert_equal 30, Order.unshipped_value end end ``` ### Thread safety Mocha currently *does not* attempt to be thread-safe. #### Can I test multi-threaded code with Mocha? The short answer is no. In multi-threaded code Mocha exceptions may be raised in a thread other than the one which is running the test and thus a Mocha exception may not be correctly intercepted by Mocha exception handling code. #### Can I run my tests across multiple threads? Maybe, but probably not. Partial mocking changes the state of objects in the `ObjectSpace` which is shared across all threads in the Ruby process and this access to what is effectively global state is not synchronized. So, for example, if two tests are running concurrently and one uses `#any_instance` to modify a class, both tests will see those changes immediately. ### Expectation matching / invocation order Stubs and expectations are basically the same thing. A stub is just an expectation of zero or more invocations. The `Expectation#stubs` method is syntactic sugar to make the intent of the test more explicit. When a method is invoked on a mock object, the mock object searches through its expectations from newest to oldest to find one that matches the invocation. After the invocation, the matching expectation might stop matching further invocations. See the [documentation](https://mocha.jamesmead.org/Mocha/Mock.html) for `Mocha::Mock` for further details. ### Configuration If you want, Mocha can generate a warning or raise an exception when: * stubbing a method unnecessarily * stubbing method on a non-mock object * stubbing a non-existent method * stubbing a non-public method See the [documentation](https://mocha.jamesmead.org/Mocha/Configuration.html) for `Mocha::Configuration` for further details. ##### MOCHA_OPTIONS `MOCHA_OPTIONS` is an environment variable whose value can be set to a comma-separated list, so that we can specify multiple options e.g. `MOCHA_OPTIONS=debug,use_test_unit_gem`. Only the following values are currently recognized and have an effect: * `debug`: Enables a debug mode which will output backtraces for each deprecation warning. This is useful for finding where in the test suite the deprecated calls are. ### Semantic versioning * Every effort is made to comply with [semantic versioning](https://semver.org/). * However, this only applies to the behaviour documented in the public API. * The documented public API does *not* include the content or format of messsages displayed to the user, e.g. assertion failure messages. ### Useful Links * [Official Documentation](https://mocha.jamesmead.org) * [Source Code](http://github.com/freerange/mocha) * [Mailing List](http://groups.google.com/group/mocha-developer) * [James Mead's Blog](http://jamesmead.org/blog/) * [An Introduction To Mock Objects In Ruby](http://jamesmead.org/talks/2007-07-09-introduction-to-mock-objects-in-ruby-at-lrug/) * [Mocks Aren't Stubs](http://martinfowler.com/articles/mocksArentStubs.html) * [Growing Object-Oriented Software Guided By Tests](http://www.growing-object-oriented-software.com/) * [Mock Roles Not Objects](http://www.jmock.org/oopsla2004.pdf) * [jMock](http://www.jmock.org/) ### Contributors See this [list of contributors](https://github.com/freerange/mocha/graphs/contributors). ### Releasing a new version * Update the RELEASE.md file with a summary of changes * Bump the version in `lib/mocha/version.rb` * Commit & push to GitHub * Check CircleCI build is passing - https://app.circleci.com/pipelines/github/freerange/mocha * Sign in to Google Analytics - https://analytics.google.com/analytics/web/ * Find the web property ID for floehopper (625523) > Mocha Documentation (UA-625523-7) * Generate documentation: ```bash $ MOCHA_GENERATE_DOCS=true bundle install $ MOCHA_GENERATE_DOCS=true GOOGLE_ANALYTICS_WEB_PROPERTY_ID=UA-625523-7 rake generate_docs ``` * Commit documentation & push to GitHub * Sign in to rubygems.org and find API key - https://rubygems.org/profile/edit ```bash $ curl -u <email-address> -H 'OTP:<one-time-password>' https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials ``` * Release gem to Rubygems: ```bash $ rake release [runs tests] mocha 1.2.0 built to pkg/mocha-1.2.0.gem. Tagged v1.2.0. Pushed git commits and tags. Pushed mocha 1.2.0 to rubygems.org. ``` ### History Mocha was initially harvested from projects at [Reevoo](http://www.reevoo.com/). It's syntax is heavily based on that of [jMock](http://www.jmock.org). ### License &copy; Copyright Revieworld Ltd. 2006 You may use, copy and redistribute this library under the same terms as [Ruby itself](http://www.ruby-lang.org/en/LICENSE.txt) or under the [MIT license](http://www.opensource.org/licenses/MIT).

Humbug is a Mutation Testing framework for PHP to measure the real effectiveness of your test suites and assist in their improvement. It eats Code Coverage for breakfast.

Humbug: Mutation Testing for PHP ================================ 🚨 This package is deprecated, check out [Infection](https://github.com/infection/infection) instead. Humbug is a Mutation Testing framework for PHP. It is currently in development and so, while it does actually work quite well, it will have rough edges that a team of minions are working hard to hammer out. If it falls out of the gate, you have been warned ;). [](https://travis-ci.org/humbug/humbug) [](https://ci.appveyor.com/project/humbug/humbug/branch/master) [](https://scrutinizer-ci.com/g/humbug/humbug/?branch=master) [](https://styleci.io/repos/28300862) [](https://packagist.org/packages/humbug/humbug) [](https://symfony.com/slack-invite) ⚠️️ Update your remotes! Humbug has transferred to a new location. While your existing repositories will redirect transparently for any operations, take some time to transition to the new URL. ```sh $ git remote set-url upstream https://github.com/humbug/humbug.git ``` Replace `upstream` with the name of the remote you use locally; `upstream` is commonly used but you may be using something else. You may also using a different URL (e.g. [email protected]:mockery/mockery.git). Run `git remote -v` to see what you're actually using. **Table of Contents** - [Introduction](#introduction) - [Contributing](#contributing) - [Installation](#installation) - [Git](#git) - [Phar](#phar) - [Composer](#composer) - [Usage](#usage) - [Configuration](#configuration) - [Configure command](#configure-command) - [Manual Configuration](#manual-configuration) - [Running Humbug](#running-humbug) - [The Metrics](#the-metrics) - [Command Line Options](#command-line-options) - [Overriding The Configured Timeout](#overriding-the-configured-timeout) - [Restricting Files To Mutate](#restricting-files-to-mutate) - [Mutate specific files](#mutate-specific-files) - [Incremental Analysis](#incremental-analysis) - [Performance](#performance) - [Mutators](#mutators) Introduction ------------ Mutation Testing is, in a nutshell, giving your unit tests a run for their money. It involves injecting small defects into source code and then checking if the unit tests noticed. If they do, then your unit tests have "killed" the mutation. If not, the mutation has escaped detection. As unit tests are intended to prevent regressions, having a real regression pass unnoticed would be a bad thing! Whereas Code Coverage can tell you what code your tests are executing, Mutation Testing is intended to help you judge how well your unit tests actually perform and where they could be improved. I've written in more detail about why Mutation Testing is worth having: [Lies, Damned Lies and Code Coverage: Towards Mutation Testing](http://padraic.github.io/humbug.html) Contributing ------------ Humbug is an open source project that welcomes pull requests and issues from anyone. Before opening pull requests, please read our short [Contribution Guide](https://github.com/humbug/humbug/blob/master/.github/CONTRIBUTING.md). Installation ------------ #### Git You can clone and install Humbug's dependencies using Composer: ```sh git clone https://github.com/humbug/humbug.git cd humbug /path/to/composer.phar install ``` The humbug command is now at bin/humbug. #### Phar If you don't want to track the master branch directly, you can install the Humbug phar as follows: ```sh wget https://padraic.github.io/humbug/downloads/humbug.phar wget https://padraic.github.io/humbug/downloads/humbug.phar.pubkey # If you wish to make humbug.phar directly executable chmod +x humbug.phar ``` On Windows, you can just download using a browser or from Powershell v3 using the following commands where `wget` is an alias for `Invoke-WebRequest`: ```sh wget https://padraic.github.io/humbug/downloads/humbug.phar -OutFile humbug.phar wget https://padraic.github.io/humbug/downloads/humbug.phar.pubkey -OutFile humbug.phar.pubkey ``` If you're stuck with Powershell v2: ```sh $client = new-object System.Net.WebClient $client.DownloadFile("https://padraic.github.io/humbug/downloads/humbug.phar", "humbug.phar") $client.DownloadFile("https://padraic.github.io/humbug/downloads/humbug.phar.pubkey", "humbug.phar.pubkey") ``` ##### PHAR Updates The phar is signed with an openssl private key. You will need the pubkey file to be stored beside the phar file at all times in order to use it. If you rename `humbug.phar` to `humbug`, for example, then also rename the key from `humbug.phar.pubkey` to `humbug.pubkey`. The phar releases are currently done manually so they will not be updated with the same frequency as git master. To update your current phar, just run: ```sh ./humbug.phar self-update ``` Note: Using a phar means that fixes may take longer to reach your version, but there's more assurance of having a stable development version. The public key is downloaded only once. It is re-used by self-update to verify future phar releases. Once releases commence towards stable, there will be an alpha, beta, RC and a final release. Your development track phar file will self-update automatically until it reaches a stable release. If you wish to continue tracking the development level phars, you will need to indicate this using one of the stability flags: ```sh ./humbug.phar self-update --dev ``` ###### Self-Update Request Debugging If you experience any issues self-updating with unexpected `openssl` or SSL errors, please ensure that you have enabled the `openssl` extension. On Windows, you can do this by adding or uncommenting the following line in the `php.ini` file for PHP on the command line (if different than the file for your http server): ``` extension=php_openssl.dll ``` Certain other SSL errors may arise due missing certificates. You can rectify this by finding their location on your system (e.g. `C:/xampp/php/ext/cacert.pem`), or alternatively downloading a copy from http://curl.haxx.se/ca/cacert.pem. Then ensure the following option is correctly pointing to this file: ``` openssl.cafile=C:/path/to/cacert.pem ``` #### Composer Due to Humbug's dependencies being pegged to recent versions, adding Humbug to composer.json may give rise to conflicts. The above two methods of installation are preferred where this occurs. You can however install it globally as any other general purpose tool: ```sh composer global require 'humbug/humbug=~1.0@dev' ``` And if you haven't done so previously...add this to `~/.bash_profile` (or `~/.bashrc`): ```sh export PATH=~/.composer/vendor/bin:$PATH ``` Humbug currently works on PHP 5.4 or greater. Usage ----- ### Configuration Humbug is still under development so, to repeat, beware of rough edges. #### Configure command To configure humbug in your project you may run: ```sh humbug configure ``` This tool will ask some questions required to create the Humbug configuration file (`humbug.json.dist`). #### Manual Configuration In the base directory of your project create a `humbug.json.dist` file: ```js { "timeout": 10, "source": { "directories": [ "src" ] }, "logs": { "text": "humbuglog.txt", "json": "humbuglog.json" } } ``` You can commit the `humbug.json.dist` to your VCS and override it locally with a `humbug.json` file. Edit as appropriate. If you do not define at least one log, detailed information about escaped mutants will not be available. The Text log is human readable. If source files exist in the base directory, or files in the source directories must be excluded, you can add exclude patterns (here's one for files in base directory where composer vendor and Tests directories are excluded): ```js { "timeout": 10, "source": { "directories": [ "." ], "excludes": [ "vendor", "Tests" ] }, "logs": { "text": "humbuglog.txt" } } ``` If, from your project's base directory, you must run tests from another directory then you can signal this also. You should not need to run Humbug from any directory other than your project's base directory. ```js { "chdir": "tests", "timeout": 10, "source": { "directories": [ "src" ], } } ``` ### Running Humbug Ensure that your tests are all in a passing state (incomplete and skipped tests are allowed). Humbug will quit if any of your tests are failing. The magic command, while in your project's base directory (using the PHAR download) is: ```sh ./humbug.phar ``` or if you just cloned Humbug: ```sh ../humbug/bin/humbug ``` or if you added Humbug as a composer dependency to your project: ```sh ./vendor/bin/humbug ``` Instead of php with the xdebug extension you may also run Humbug via [phpdbg](http://phpdbg.com/): ```sh phpdbg -qrr humbug.phar ``` If all went well, you will get something similar to: ``` _ _ _ | || |_ _ _ __ | |__ _ _ __ _ | __ | || | ' \| '_ \ || / _` | |_||_|\_,_|_|_|_|_.__/\_,_\__, | |___/ Humbug version 1.0-dev Humbug running test suite to generate logs and code coverage data... 361 [==========================================================] 28 secs Humbug has completed the initial test run successfully. Tests: 361 Line Coverage: 64.86% Humbug is analysing source files... Mutation Testing is commencing on 78 files... (.: killed, M: escaped, S: uncovered, E: fatal error, T: timed out) .....M.M..EMMMMMSSSSMMMMMSMMMMMSSSE.ESSSSSSSSSSSSSSSSSM..M.. | 60 ( 7/78) ...MM.ES..SSSSSSSSSS...MMM.MEMME.SSSS.............SSMMSSSSM. | 120 (12/78) M.M.M...TT.M...T.MM....S.....SSS..M..SMMSM...........M...... | 180 (17/78) MM...M...ESSSEM..MMM.M.MM...SSS.SS.M.SMMMMMMM..SMMMMS....... | 240 (24/78) .........SMMMSMMMM.MM..M.SSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSS | 300 (26/78) SSSSSSSSM..E....S......SS......M.SS..S..M...SSSSSSSS....MMM. | 360 (37/78) .M....MM..SM..S..SSSSSSSS.EM.S.E.M............M.....M.SM.M.M | 420 (45/78) ..M....MMS...MMSSS................M.....EME....SEMS...SSSSSS | 480 (52/78) SSSSS.EMSSSSM..M.MMMM...SSE.....MMM.M..MM..MSSSSSSSSSSSSSSSS | 540 (60/78) SSS....SSSSSSSSMM.SSS..........S..M..MSSMS.SSSSSSSSSSSSSSSSS | 600 (68/78) ......E...M..........SM.....M..MMMMM.MMMMMSSSSSSSM.SS 653 mutations were generated: 284 mutants were killed 218 mutants were not covered by tests 131 covered mutants were not detected 17 fatal errors were encountered 3 time outs were encountered Metrics: Mutation Score Indicator (MSI): 47% Mutation Code Coverage: 67% Covered Code MSI: 70% Remember that some mutants will inevitably be harmless (i.e. false positives). Humbug results are being logged as JSON to: log.json Humbug results are being logged as TEXT to: log.txt ``` To explain the perhaps cryptic progress output: * Killed Mutation (.): A mutation that caused unit tests to fail which is a positive outcome. * Escaped Mutation (M): A mutation where the unit tests still passed which is not what we want! Our unit tests should detect any behaviour changes. * Uncovered Mutation (S): A mutation which occurs on a line not covered by any unit test. Since there are no unit tests, this is another undesireable result. * Fatal Error (E): A mutation created a fatal error. Usually a positive result since it's obviously going to be noticed. In some cases, however, it might be a Humbug problem that needs fixing. * Timeout (T): This is where unit tests exceed the allowed timeout configured for Humbug. Likely a positive result if your timeout is appropriate, and often occurs when a mutation ends up creating an infinite loop. Kills, errors and timeouts are all counted as detected mutations. We report errors in the logs on the off chance that Humbug itself encountered an internal error, i.e. a bug to be reported as an issue here! #### The Metrics The example summary results reported a number of metric scores: * A Mutation Score Indicator (MSI) of 47%. This means that 47% of all generated mutations were detected (i.e. kills, timeouts or fatal errors). The MSI is the primary Mutation Testing metric. Given the code coverage of 65%, there is a 18% discrepancy so Code Coverage was a terrible quality measurement in this example. * Mutation Code Coverage is 67%. On average it should be within the same ballpark as your normal code coverage, but code coverage ignores mutation frequency. * The Mutation Score Indicator for code that is actually covered by tests was 70% (i.e. ignoring code not even tested). This gives you some idea of how effective the tests that do exist really are. If you examine these metrics, the standout issue is that the MSI of 47% is 18 points lower than the reported Code Coverage at 65%. These unit tests are far less effective than Code Coverage alone could detect. Interpreting these results requires some context. The logs will list all undetected mutations as diffs against the original source code. Examining these will provide further insight as to what specific mutations went undetected. Command Line Options -------------------- Humbug has a few command line options of note, other than those normally associated with any Symfony Console application. #### Overriding The Configured Timeout You can manually set the timeout threshold for any single test: ```sh humbug --timeout=10 ``` #### Restricting Files To Mutate If you're only interested in mutating a subset of your files, you can pass any number of `--file` options containing simple file names, globs or regular expressions. Basically, these are all passed to the Symfony Finder's `name()` method. ```sh humbug --file=NewClass.php --file=*Driver.php ``` This in no way restricts the initial Humbug check on the overall test suite which is still executed in full to ensure all tests are passing correctly before proceeding. #### Mutate specific files If you want to mutate only a few specific files, you can pass any number of `--path` options containing full path file names. This option will be passed to a filter `\Closure` that will intersect files found using the config and/or `--file` option with the files provided by you using the `--path` option. ```sh humbug --path=src/Data/NewClass.php --path=src/Driver/Driver.php ``` Note: This in no way restricts the initial Humbug check on the overall test suite which is still executed in full to ensure all tests are passing correctly before proceeding. #### Incremental Analysis Incremental Analysis (IA) is an experimental unfinished mode of operation where results are cached locally between runs and reused where it makes sense. At present, this mode operates very naively by eliminating test runs where both the immediate file being mutated and the relevant tests for a mutated line have not been modified since the last run (as determined by comparing the SHA1 of the files involved). ```sh humbug --incremental ``` The IA mode offers a significant performance increase for relatively stable code bases, and you're free to test it and see how it fares in real life. In the future, it does need to take into accounts changes in files which contain parent classes, imported traits and the classes of its immediate dependencies, all of which have an impact on the behaviour of any given object. IA utilises a local permanent cache, e.g. `/home/padraic/.humbug`. Performance ----------- Mutation Testing has traditionally been slow. The concept being to re-run your test suite for each mutation generated. To speed things up significantly, Humbug does the following: * On each test run, it only uses those test classes which cover the specific file and line on which the mutation was inserted. * It orders test classes to run so that the slowest go last (hopefully the faster tests will detect mutations early!). * If a mutation falls on a line not covered by any tests, well, we don't bother running any tests. * Performance may, depending on the source code, be significantly impacted by timeouts. The default of 60s may be far too high for smaller codebases, and far too low for larger ones. As a rule of thumb, it shouldn't exceed the seconds needed to normally run the tests being mutated (and can be set lower). While all of this speeds up Humbug, do be aware that a Humbug run will be slower than unit testing. A 2 second test suite may require 30 seconds for mutation testing. Or 5 minutes. It all depends on the interplay between lines of code, number of tests, level of code coverage, and the performance of both code and tests. Mutators -------- Humbug implements a basic suite of Mutators, which essentially tells us when a particular PHP token can be mutated, and also apply that mutation to an array of tokens. Note: Source code held within functions (rather than class methods) is not mutated at this time. Binary Arithmetic: | Original | Mutated | Original | Mutated | | :------: |:-------:| :------: |:-------:| | + | - | /= | *= | | - | + | %= | *= | | * | / | **= | /= | | / | * | & | &#124; | | % | * | &#124; | & | | ** | / | ^ | & | | += | -= | ~ | | | -= | += | >> | << | | *= | /= | << | >> | Boolean Substitution: This temporarily encompasses logical mutators. | Original | Mutated | | :------: |:-------:| | true | false | | false | true | | && | &#124;&#124; | | &#124;&#124; | && | | and | or | | or | and | | ! | | Conditional Boundaries: | Original | Mutated | :------: |:-------: | > | >= | < | <= | >= | > | <= | < Negated Conditionals: | Original | Mutated | Original | Mutated | | :------: |:-------:| :------: |:-------:| | == | != | > | <= | | != | == | < | >= | | <> | == | >= | < | | === | !== | <= | > | | !== | === | Increments: | Original | Mutated | | :------: |:-------:| | ++ | -- | | -- | ++ | Return Values: | Original | Mutated | Original | Mutated | | :------: |:-------:| :------: |:-------:| | return true; | return false; | return <Any Float > 1.0>; | return -(<Float> + 1); | | return false; | return true; | return $this; | return null; | | return 0; | return 1; | return function(); | function(); return null; | | return <Any Integer>; | return 0; | return new Class; | new Class; return null; | | return 0.0; | return 1.0; | return (`Anything`); | (`Anything`); return null; | | return 1.0; | return 0.0; | Literal Numbers: | Original | Mutated | | :------: |:-------:| | 0 | 1 | | 1 | 0 | | Int > 1 | Int + 1 | | Float >= 1 / <= 2 | Float + 1 | | Float > 2 | 1 | If Statements: All if statements are covered largely by previous mutators, but there are special cases such as using native functions or class methods without any compares or operations, e.g. `is_int()` or `in_array()`. This would not cover functions defined in files since they don't exist until runtime (something else to work on!). | Original | Mutated | | :------: |:-------:| | if(is_int(1)) | if(!is_int(1)) | More Mutators will be added over time. JSON Log Stats -------------- ```sh bin/humbug stats ../my-project/humbuglog.json ../my-project/list-of-classes.txt --skip-killed=yes [-vvv] ``` Parses stats from humbuglog.json or your custom named JSON log. CLI reference: ```sh humbug stats [humbuglog.json location] [class list location] [--skip-killed=yes] [-vvv] ``` humbuglog.json location, defaults to ./humbuglog.json class list location, a path to a text file containing full class names, one per line. only this files-related stats would be shown --skip-killed=yes is used to completely skip output of "killed" section various verbosity levels define amount of info to be displayed: by default, there's one line per class with amount of mutants killed/escaped/errored/timed out (depending on output section) -v adds one line per each mutant with line number and method name -vv adds extra line for each mutant, displaying diff view of line mutant is detected in -vvv shows full diff with several lines before and after This can be tested on humbug itself, by running in humbug's dir: bin/humbug bin/humbug stats [-vvv] Did I Say Rough Edges? ---------------------- This is a short list of known issues: * Humbug does initial test runs, logging and code coverage. Should allow user to do that optionally. * Test classes (not tests) are run in a specific order, fastest first. Interdependent test classes may therefore fail regularly which will skew the results. * Currently 100% PHPUnit specific, well 98.237%. There is an adapter where PHPUnit code is being shovelled. * Certain test suite may make assumptions about having sole access to resources like /tmp which will cause errors when Humbug tries using same. * Fine grained test ordering by speed (as opposed to large grained test class ordering) is awaiting implementation. * Should test classes be used to carry non-PHPUnit dependent testing code (e.g. register_shutdown_function()), it may create issues when combined with one or more of Humbugs optimisations which assume a finished test really is finished. Bah, Humbug! ============ Courtesy of [Craig Davis](https://github.com/craig-davis) who saw potential in a once empty repository :P. ``` .:::::::::::... .::::::::::::::::::::. .::::::::::::::::::::::::. ::::::::::::::::::::::::::::. ::::::::::::::::::::::::::::::: .,uuu ... :::::::::::::::::::::::::::::::: dHHHHHLdHHHHb ....:::::::'` ::::::::::::::::::' uHHHHHHHHHHHHHF .uHHHHHHHHH' ::::::::::::::`. uHHHHHHHHHHHHHP" HHHHHHHHHHH `:::::::::::',dHHuHHHHHHHHP".g@@g J"HHHHHHHHHP 4H ::::::::' u$$$. ".HHHHHHHHP" .,uHP :::::' uHHHHHHHHHHP"",e$$$$$c HHHHHHHF' dHHHHf `````.HHHHHHHHHHP",d$$$$$$$P%C .dHHHP"" JHHHHbuuuu,JHHHHHHHHP",d$$$$$$$$$e=,z$$$$$$$$ee.. "" .HHHHHHHHHHHHHHHHHP",gdP" ..3$$$Jd$$$$$$$$$$$$$$e. dHHHHHHHHHHHHHHP".edP " .zd$$$$$$$$$$$"3$$$$$$$$c `???""??HHHHP",e$$F" .d$,?$$$$$$$$$$$$$F d$$$$$$$$F" ?be.eze$$$$$".d$$$$ $$$E$$$$P".,ede`?$$$$$$$$ 4."?$$$$$$$ z$$$$$$ $$$$r.,.e ?$$$$ $$$$$$$$$ '$c "$$$$ .d$$$$$$$ 3$$$.$$$$ 4$$$ d$$$$P"`,, """- "$$".`$$" " $$f,d$$P".$$P zeee.zd$$$$$. ze. .C$C"=^" ..$$$$$$P".$$$'e$$$$$P?$$$$$$ .e$$$$$$$"="$f",c,3eee$$$$$$$$P $$$P'd$$$$"..::.."?$% 4d$$$P d$$$dF.d$$$$$$$$$$$$$$$$f $$$ d$$$" :::::::::. $$$$$$ d$$$$$ $$$$$$$$$$$$$$$$$$ J$$",$$$'.:::::::::::: "$$$$$$ ?$$$$ d$$$$$$$$$$$$$$$P".dP'e$$$$'::::::::::::::: 4$$$$$$c $$$$b`$$$$$$$$$$$P"",e$$",$$$$$' :::::::::::::::: ' ?"?$$$b."$$$$.?$$$$$$P".e$$$$F,d$$$$$F :::::::::::::::::: "?$$bc."$b.$$$$F z$$P?$$",$$$$$$$ :::::::::::::::::::: `"$$c"?$$$".$$$)e$$F,$$$$$$$' :::::::::::::::::::: ':. "$b...d$$P4$$$",$$$$$$$" ::::::::::::::::::::: ':::: "$$$$$".,"".d$$$$$$$F :::::::::::::::::::::: :::: be."".d$$$4$$$$$$$$F ::::::::::::::::::::::: :::: "??$$$$$$$$$$?$P" ::::::::::::::::::::::::: :::::: ?$$$$$$$$f .:::::::::::::::::::::::::::: :::::::`"????"".:::::::::::::::::::::::::::::: ```

Fixture-based test framework for Rust

[![Crate][crate-image]][crate-link] [![Docs][docs-image]][docs-link] [![Status][test-action-image]][test-action-link] [![Apache 2.0 Licensed][license-apache-image]][license-apache-link] [![MIT Licensed][license-mit-image]][license-mit-link] # Fixture-based test framework for Rust ## Introduction `rstest` uses procedural macros to help you on writing fixtures and table-based tests. To use it, add the following lines to your `Cargo.toml` file: ``` [dev-dependencies] rstest = "0.16.0" ``` ### Fixture The core idea is that you can inject your test dependencies by passing them as test arguments. In the following example, a `fixture` is defined and then used in two tests, simply providing it as an argument: ```rust use rstest::*; #[fixture] pub fn fixture() -> u32 { 42 } #[rstest] fn should_success(fixture: u32) {     assert_eq!(fixture, 42); } #[rstest] fn should_fail(fixture: u32) {     assert_ne!(fixture, 42); } ``` ### Parametrize You can also inject values in some other ways. For instance, you can create a set of tests by simply providing the injected values for each case: `rstest` will generate an independent test for each case. ```rust use rstest::rstest; #[rstest] #[case(0, 0)] #[case(1, 1)] #[case(2, 1)] #[case(3, 2)] #[case(4, 3)] fn fibonacci_test(#[case] input: u32, #[case] expected: u32) { assert_eq!(expected, fibonacci(input)) } ``` Running `cargo test` in this case executes five tests: ```bash running 5 tests test fibonacci_test::case_1 ... ok test fibonacci_test::case_2 ... ok test fibonacci_test::case_3 ... ok test fibonacci_test::case_4 ... ok test fibonacci_test::case_5 ... ok test result: ok. 5 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out ``` If you need to just providing a bunch of values for which you need to run your test, you can use `#[values(list, of, values)]` argument attribute: ```rust use rstest::rstest; #[rstest] fn should_be_invalid( #[values(None, Some(""), Some(" "))] value: Option<&str> ) { assert!(!valid(value)) } ``` Or create a _matrix_ test by using _list of values_ for some variables that will generate the cartesian product of all the values. #### Use Parametrize definition in more tests If you need to use a test list for more than one test you can use [`rstest_reuse`][reuse-crate-link] crate. With this helper crate you can define a template and use it everywhere . ```rust use rstest::rstest; use rstest_reuse::{self, *}; #[template] #[rstest] #[case(2, 2)] #[case(4/2, 2)] fn two_simple_cases(#[case] a: u32, #[case] b: u32) {} #[apply(two_simple_cases)] fn it_works(#[case] a: u32, #[case] b: u32) { assert!(a == b); } ``` See [`rstest_reuse`][reuse-crate-link] for more dettails. ### Magic Conversion If you need a value where its type implement `FromStr()` trait you can use a literal string to build it: ```rust # use rstest::rstest; # use std::net::SocketAddr; #[rstest] #[case("1.2.3.4:8080", 8080)] #[case("127.0.0.1:9000", 9000)] fn check_port(#[case] addr: SocketAddr, #[case] expected: u16) { assert_eq!(expected, addr.port()); } ``` You can use this feature also in value list and in fixture default value. ### Async `rstest` provides out of the box `async` support. Just mark your test function as `async` and it'll use `#[async-std::test]` to annotate it. This feature can be really useful to build async parametric tests using a tidy syntax: ```rust use rstest::*; #[rstest] #[case(5, 2, 3)] #[should_panic] #[case(42, 40, 1)] async fn my_async_test(#[case] expected: u32, #[case] a: u32, #[case] b: u32) { assert_eq!(expected, async_sum(a, b).await); } ``` Currently only `async-std` is supported out of the box. But if you need to use another runtime that provide it's own test attribute (i.e. `tokio::test` or `actix_rt::test`) you can use it in your `async` test like described in [Inject Test Attribute](#inject-test-attribute). To use this feature, you need to enable `attributes` in the `async-std` features list in your `Cargo.toml`: ```toml async-std = { version = "1.5", features = ["attributes"] } ``` If your test input is an async value (fixture or test parameter) you can use `#[future]` attribute to remove `impl Future<Output = T>` boilerplate and just use `T`: ```rust use rstest::*; #[fixture] async fn base() -> u32 { 42 } #[rstest] #[case(21, async { 2 })] #[case(6, async { 7 })] async fn my_async_test(#[future] base: u32, #[case] expected: u32, #[future] #[case] div: u32) { assert_eq!(expected, base.await / div.await); } ``` ### Test `#[timeout()]` You can define an execution timeout for your tests with `#[timeout(<duration>)]` attribute. Timeouts works both for sync and async tests and is runtime agnostic. `#[timeout(<duration>)]` take an expression that should return a `std::time::Duration`. Follow a simple async example: ```rust use rstest::*; use std::time::Duration; async fn delayed_sum(a: u32, b: u32,delay: Duration) -> u32 { async_std::task::sleep(delay).await; a + b } #[rstest] #[timeout(Duration::from_millis(80))] async fn single_pass() { assert_eq!(4, delayed_sum(2, 2, ms(10)).await); } ``` In this case test pass because the delay is just 10 milliseconds and timeout is 80 milliseconds. You can use `timeout` attribute like any other attibute in your tests and you can override a group timeout with a case specific one. In the follow example we have 3 tests where first and third use 100 millis but the second one use 10 millis. Another valuable point in this example is to use an expression to compute the duration. ```rust fn ms(ms: u32) -> Duration { Duration::from_millis(ms.into()) } #[rstest] #[case::pass(ms(1), 4)] #[timeout(ms(10))] #[case::fail_timeout(ms(60), 4)] #[case::fail_value(ms(1), 5)] #[timeout(ms(100))] async fn group_one_timeout_override(#[case] delay: Duration, #[case] expected: u32) { assert_eq!(expected, delayed_sum(2, 2, delay).await); } ``` If you want to use `timeout` for `async` test you need to use `async-timeout` feature (enabled by default). ### Inject Test Attribute If you would like to use another `test` attribute for your test you can simply indicate it in your test function's attributes. For instance if you want to test some async function with use `actix_rt::test` attribute you can just write: ```rust use rstest::*; use actix_rt; use std::future::Future; #[rstest] #[case(2, async { 4 })] #[case(21, async { 42 })] #[actix_rt::test] async fn my_async_test(#[case] a: u32, result: #[case] #[future] u32) { assert_eq!(2 * a, result.await); } ``` Just the attributes that ends with `test` (last path segment) can be injected. ### Use `#[once]` Fixture If you need to a fixture that should be inizialized just once for all tests you can use `#[once]` attribute. `rstest` call your fixture function just once and return a reference to your function result to all your tests: ```rust #[fixture] #[once] fn once_fixture() -> i32 { 42 } #[rstest] fn single(once_fixture: &i32) { // All tests that use once_fixture will share the same reference to once_fixture() // function result. assert_eq!(&42, once_fixture) } ``` ## Complete Example All these features can be used together with a mixture of fixture variables, fixed cases and bunch of values. For instance, you might need two test cases which test for panics, one for a logged in user and one for a guest user. ```rust use rstest::*; #[fixture] fn repository() -> InMemoryRepository { let mut r = InMemoryRepository::default(); // fill repository with some data r } #[fixture] fn alice() -> User { User::logged("Alice", "2001-10-04", "London", "UK") } #[rstest] #[case::authed_user(alice())] // We can use `fixture` also as standard function #[case::guest(User::Guest)] // We can give a name to every case : `guest` in this case // and `authed_user` #[should_panic(expected = "Invalid query error")] // We whould test a panic fn should_be_invalid_query_error( repository: impl Repository, #[case] user: User, #[values(" ", "^%$some#@invalid!chars", ".n.o.d.o.t.s.")] query: &str, ) { repository.find_items(&user, query).unwrap(); } ``` This example will generate exactly 6 tests grouped by 2 different cases: ``` running 6 tests test should_be_invalid_query_error::case_1_authed_user::query_1_____ - should panic ... ok test should_be_invalid_query_error::case_2_guest::query_2_____someinvalid_chars__ - should panic ... ok test should_be_invalid_query_error::case_1_authed_user::query_2_____someinvalid_chars__ - should panic ... ok test should_be_invalid_query_error::case_2_guest::query_3____n_o_d_o_t_s___ - should panic ... ok test should_be_invalid_query_error::case_1_authed_user::query_3____n_o_d_o_t_s___ - should panic ... ok test should_be_invalid_query_error::case_2_guest::query_1_____ - should panic ... ok test result: ok. 6 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s ``` Note that the names of the values _try_ to convert the input expression in a Rust valid identifier name to help you to find wich tests fail. ## More Is that all? Not quite yet! A fixture can be injected by another fixture and they can be called using just some of its arguments. ```rust #[fixture] fn user(#[default("Alice")] name: &str, #[default(22)] age: u8) -> User { User::new(name, age) } #[rstest] fn is_alice(user: User) { assert_eq!(user.name(), "Alice") } #[rstest] fn is_22(user: User) { assert_eq!(user.age(), 22) } #[rstest] fn is_bob(#[with("Bob")] user: User) { assert_eq!(user.name(), "Bob") } #[rstest] fn is_42(#[with("", 42)] user: User) { assert_eq!(user.age(), 42) } ``` As you noted you can provide default values without the need of a fixture to define it. Finally if you need tracing the input values you can just add the `trace` attribute to your test to enable the dump of all input variables. ```rust #[rstest] #[case(42, "FortyTwo", ("minus twelve", -12))] #[case(24, "TwentyFour", ("minus twentyfour", -24))] #[trace] //This attribute enable traceing fn should_fail(#[case] number: u32, #[case] name: &str, #[case] tuple: (&str, i32)) { assert!(false); // <- stdout come out just for failed tests } ``` ``` running 2 tests test should_fail::case_1 ... FAILED test should_fail::case_2 ... FAILED failures: ---- should_fail::case_1 stdout ---- ------------ TEST ARGUMENTS ------------ number = 42 name = "FortyTwo" tuple = ("minus twelve", -12) -------------- TEST START -------------- thread 'should_fail::case_1' panicked at 'assertion failed: false', src/main.rs:64:5 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace. ---- should_fail::case_2 stdout ---- ------------ TEST ARGUMENTS ------------ number = 24 name = "TwentyFour" tuple = ("minus twentyfour", -24) -------------- TEST START -------------- thread 'should_fail::case_2' panicked at 'assertion failed: false', src/main.rs:64:5 failures: should_fail::case_1 should_fail::case_2 test result: FAILED. 0 passed; 2 failed; 0 ignored; 0 measured; 0 filtered out ``` In case one or more variables don't implement the `Debug` trait, an error is raised, but it's also possible to exclude a variable using the `#[notrace]` argument attribute. You can learn more on [Docs][docs-link] and find more examples in [`tests/resources`](tests/resources) directory. ## Changelog See [CHANGELOG.md](CHANGELOG.md) ## License Licensed under either of * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [license-apache-link]) * MIT license [LICENSE-MIT](LICENSE-MIT) or [license-MIT-link] at your option. [//]: # (links) [crate-image]: https://img.shields.io/crates/v/rstest.svg [crate-link]: https://crates.io/crates/rstest [docs-image]: https://docs.rs/rstest/badge.svg [docs-link]: https://docs.rs/rstest/ [test-action-image]: https://github.com/la10736/rstest/workflows/Test/badge.svg [test-action-link]: https://github.com/la10736/rstest/actions?query=workflow:Test [license-apache-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg [license-mit-image]: https://img.shields.io/badge/license-MIT-blue.svg [license-apache-link]: http://www.apache.org/licenses/LICENSE-2.0 [license-MIT-link]: http://opensource.org/licenses/MIT [reuse-crate-link]: https://crates.io/crates/rstest_reuse

Hackable HTTP proxy for resiliency testing and simulated network conditions

# toxy [](https://travis-ci.org/h2non/toxy) [](https://codeclimate.com/github/h2non/toxy) [](https://www.npmjs.org/package/toxy) [](http://standardjs.com) > **Not actively maintained, may not work with latest node.js runtimes**. If you are interested in maintaining toxy, please open an issue. **Hackable HTTP proxy** to **simulate** server **failure scenarios**, **systems resiliency testing** and **unexpected network conditions**, built for [node.js](http://nodejs.org). <img align="right" height="180" src="http://s8.postimg.org/ikc9jxllh/toxic.jpg" /> It was mainly designed for failure resistance testing, when toxy becomes particularly useful in order to cover fault tolerance and resiliency capabilities of a system, especially in [disruption-tolerant networks](https://en.wikipedia.org/wiki/Delay-tolerant_networking) and [service-oriented](http://microservices.io/patterns/index.html) architectures, where toxy may act as MitM proxy among services in order to inject failure. toxy allows you to plug in [poisons](#poisons), optionally filtered by [rules](#rules), which essentially can intercept and alter the HTTP flow as you need, performing multiple evil actions in the middle of that process, such as limiting the bandwidth, delaying network packets, injecting network jitter latency or replying with a custom error or status code. It primarily operates at L7, although it can simulate L3 network conditions. toxy can be fluently used [programmatically](#programmatic-api) or via [HTTP API](#http-api). It was built on top of [rocky](https://github.com/h2non/rocky), a full-featured middleware-oriented HTTP proxy, and it's also [pluggable](https://github.com/h2non/toxy/blob/master/examples/express.js) in [connect](https://github.com/senchalabs/connect)/[express](http://expressjs.com) as standard middleware. Requires node.js +4. ## Contents - [Features](#features) - [Introduction](#introduction) - [Why toxy?](#why-toxy) - [Concepts](#concepts) - [How it works](#how-it-works) - [Usage](#usage) - [Installation](#installation) - [Examples](#examples) - [Benchmark](#benchmark) - [Poisons](#poisons) - [Poisoning scopes](#poisoning-scopes) - [Poisoning phases](#poisoning-phases) - [Built-in poisons](#built-in-poisons) - [Latency](#latency) - [Inject response](#inject-response) - [Bandwidth](#bandwidth) - [Rate limit](#rate-limit) - [Slow read](#slow-read) - [Slow open](#slow-open) - [Slow close](#slow-close) - [Throttle](#throttle) - [Abort connection](#abort-connection) - [Timeout](#timeout) - [How to write poisons](#how-to-write-poisons) - [Rules](#rules) - [Built-in rules](#built-in-rules) - [Probability](#probability) - [Time threshold](#time-threshold) - [Method](#method) - [Content Type](#content-type) - [Headers](#headers) - [Response headers](#response-headers) - [Body](#body) - [Response body](#response-body) - [Response status](#response-status) - [Third-party rules](#third-party-rules) - [How to write rules](#how-to-write-rules) - [Programmatic API](#programmatic-api) - [HTTP API](#http-api) - [Usage](#usage) - [Authorization](#authorization) - [API](#api) - [Programmatic API](#programmatic-api-1) - [License](#license) ## Features - Full-featured HTTP/S proxy (backed by [rocky](https://github.com/h2non/rocky) and [http-proxy](https://github.com/nodejitsu/node-http-proxy)) - Hackable and elegant programmatic API (inspired on connect/express) - Admin HTTP API for external management and dynamic configuration - Featured built-in router with nested configuration - Hierarchical and composable poisoning with rule based filtering - Hierarchical middleware layer (both global and route scopes) - Easily augmentable via middleware (based on connect/express middleware) - Supports both incoming and outgoing traffic poisoning - Built-in poisons (bandwidth, error, abort, latency, slow read...) - Rule-based poisoning (probabilistic, HTTP method, headers, body...) - Supports third-party poisons and rules - Built-in balancer and traffic interceptor via middleware - Inherits API and features from [rocky](https://github.com/h2non/rocky) - Compatible with connect/express (and most of their middleware) - Able to run as standalone HTTP proxy ## Introduction ### Why toxy? There're some other similar solutions like `toxy` in the market, but most of them do not provide a proper programmatic control and usually are not easy to hack, configure or are directly closed to extensibility. Furthermore, the majority of those solutions only operates at TCP L3 level stack instead of providing high-level abstractions to cover common requirements in the specific domain and nature of the HTTP L7 protocol, like toxy tries to provide toxy brings a powerful hackable and extensible solution with a convenient abstraction, but without losing a proper low-level interface capabilities to deal with HTTP protocol primitives easily. toxy was designed based on the rules of composition, simplicity and extensibility. Via its built-in hierarchical domain specific middleware layer you can easily augment toxy features to your own needs. ### Concepts `toxy` introduces two directives: poisons and rules. **Poisons** are the specific logic which infects an incoming or outgoing HTTP transaction (e.g: injecting a latency, replying with an error). One HTTP transaction can be poisoned by one or multiple poisons, and those poisons can be also configured to infect both global or route level traffic. **Rules** are a kind of match validation filters that inspects an HTTP request/response in order to determine, given a certain rules, if the HTTP transaction should be poisoned or not (e.g: if headers matches, query params, method, body...). Rules can be reused and applied to both incoming and outgoing traffic flows, including different scopes: global, route or poison level. ### How it works ``` ↓ ( Incoming request ) ↓ ↓ ||| ↓ ↓ +-------------+ ↓ ↓ | Toxy Router | ↓ -> Match the incoming request ↓ +-------------+ ↓ ↓ ||| ↓ ↓ +--------------------+ ↓ ↓ | Incoming phase | ↓ -> The proxy receives the request from the client ↓ |~~~~~~~~~~~~~~~~~~~~| ↓ ↓ | ---------------- | ↓ ↓ | | Exec Rules | | ↓ -> Apply configured rules for the incoming request ↓ | ---------------- | ↓ ↓ | ||| | ↓ ↓ | ---------------- | ↓ ↓ | | Exec Poisons | | ↓ -> If all rules passed, then poison the HTTP flow ↓ | ---------------- | ↓ ↓ +~~~~~~~~~~~~~~~~~~~~+ ↓ ↓ / \ ↓ ↓ \ / ↓ ↓ +--------------------+ ↓ ↓ | HTTP dispatcher | ↓ -> Forward the HTTP traffic to the target server, either poisoned or not ↓ +--------------------+ ↓ ↓ / \ ↓ ↓ \ / ↓ ↓ +--------------------+ ↓ ↓ | Outgoing phase | ↓ -> Receives response from target server ↓ |~~~~~~~~~~~~~~~~~~~~| ↓ ↓ | ---------------- | ↓ ↓ | | Exec Rules | | ↓ -> Apply configured rules for the outgoing request ↓ | ---------------- | ↓ ↓ | ||| | ↓ ↓ | ---------------- | ↓ ↓ | | Exec Poisons | | ↓ -> If all rules passed, then poison the HTTP flow before send it to the client ↓ | ---------------- | ↓ ↓ +~~~~~~~~~~~~~~~~~~~~+ ↓ ↓ ||| ↓ ↓ ( Send to the client ) ↓ -> Finally, send the request to the client, either poisoned or not ``` ## Usage ### Installation ``` npm install toxy ``` ### Examples See [examples](https://github.com/h2non/toxy/tree/master/examples) directory for more use cases. ```js var toxy = require('toxy') var poisons = toxy.poisons var rules = toxy.rules // Create a new toxy proxy var proxy = toxy() // Default server to forward incoming traffic proxy .forward('http://httpbin.org') // Register global poisons and rules proxy .poison(poisons.latency({ jitter: 500 })) .rule(rules.probability(25)) // Register multiple routes proxy .get('/download/*') .forward('http://files.myserver.net') .poison(poisons.bandwidth({ bps: 1024 })) .withRule(rules.headers({'Authorization': /^Bearer (.*)$/i })) // Infect outgoing traffic only (after the server replied properly) proxy .get('/image/*') .outgoingPoison(poisons.bandwidth({ bps: 512 })) .withRule(rules.method('GET')) .withRule(rules.timeThreshold({ duration: 1000, threshold: 1000 * 10 })) .withRule(rules.responseStatus({ range: [ 200, 400 ] })) proxy .all('/api/*') .poison(poisons.rateLimit({ limit: 10, threshold: 1000 })) .withRule(rules.method(['POST', 'PUT', 'DELETE'])) // And use a different more permissive poison for GET requests .poison(poisons.rateLimit({ limit: 50, threshold: 1000 })) .withRule(rules.method('GET')) // Handle the rest of the traffic proxy .all('/*') .poison(poisons.slowClose({ delay: 1000 })) .poison(poisons.slowRead({ bps: 128 })) .withRule(rules.probability(50)) proxy.listen(3000) console.log('Server listening on port:', 3000) console.log('Test it:', 'http://localhost:3000/image/jpeg') ``` ## Benchmark See [toxy/benchmark](https://github.com/h2non/toxy/tree/master/benchmark) for details. ## Poisons Poisons host specific logic which intercepts and mutates, wraps, modify and/or cancel an HTTP transaction in the proxy server. Poisons can be applied to incoming or outgoing, or even both traffic flows (see [poison phases](#poisoning-phases)). Poisons can be composed and reused for different HTTP scenarios. They are executed in FIFO order and asynchronously. ### Poisoning scopes `toxy` has a hierarchical design based on two different scopes: `global` and `route`. **Global** scope points to all the incoming HTTP traffic received by the proxy server, regardless of the HTTP method or path. **Route** scope points to any incoming traffic which matches with a specific HTTP verb and URI path. Poisons can be plugged to both scopes, meaning you can operate with better accuracy and restrict the scope of the poisoning, for instance, you might wanna apply a bandwidth limit poisoning only to a certain routes, such as `/download` or `/images`. See [routes.js](https://github.com/h2non/toxy/blob/master/examples/routes.js) for a featured example. ### Poisoning phases Poisons can be plugged to incoming or outgoing traffic flows, or even both. **Incoming** poisoning is applied when the traffic has been received by proxy but it has not been forwarded to the target server yet. **Outgoing** poisoning refers to the traffic that has been forwarded to the target server and when proxy receives the response from it, but that response has not been sent to the client yet. This means, essentially, that you can plug in your poisons to infect the HTTP traffic before or after the request is forwarded to the target HTTP server or sent to the client. This allows you apply a better and more accurated poisoning based on the request or server response. For instance, given the nature of some poisons, like `inject error`, you may want to enable it according to the target server response (e.g: some header is present or not). See [poison-phases.js](https://github.com/h2non/toxy/blob/master/examples/poison-phases.js) for a featured example. ### Built-in poisons #### Latency <table> <tr> <td><b>Name</b></td><td>latency</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Infects the HTTP flow injecting a latency jitter in the response **Arguments**: - **options** `object` - **jitter** `number` - Jitter value in milliseconds - **max** `number` - Random jitter maximum value - **min** `number` - Random jitter minimum value ```js toxy.poison(toxy.poisons.latency({ jitter: 1000 })) // Or alternatively using a random value toxy.poison(toxy.poisons.latency({ max: 1000, min: 100 })) ``` #### Inject response <table> <tr> <td><b>Name</b></td><td>inject</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>false (only as incoming poison)</td> </tr> </table> Injects a custom response, intercepting the request before sending it to the target server. Useful to inject errors originated in the server. **Arguments**: - **options** `object` - **code** `number` - Response HTTP status code. Default `500` - **headers** `object` - Optional headers to send - **body** `mixed` - Optional body data to send. It can be a `buffer` or `string` - **encoding** `string` - Body encoding. Default to `utf8` ```js toxy.poison(toxy.poisons.inject({ code: 503, body: '{"error": "toxy injected error"}', headers: {'Content-Type': 'application/json'} })) ``` #### Bandwidth <table> <tr> <td><b>Name</b></td><td>bandwidth</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Limits the amount of bytes sent over the network in outgoing HTTP traffic for a specific time frame. This poison is basically an alias to [throttle](#throttle). **Arguments**: - **options** `object` - **bytes** `number` - Amount of chunk of bytes to send. Default `1024` - **threshold** `number` - Packets time frame in milliseconds. Default `1000` ```js toxy.poison(toxy.poisons.bandwidth({ bytes: 512 })) ``` #### Rate limit <table> <tr> <td><b>Name</b></td><td>rateLimit</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Limits the amount of requests received by the proxy in a specific threshold time frame. Designed to test API limits. Exposes typical `X-RateLimit-*` headers. Note that this is very simple rate limit implementation, indeed limits are stored in-memory, therefore are completely volatile. There're a bunch of featured and consistent rate limiter implementations in [npm](https://www.npmjs.com/search?q=rate+limit) that you can plug in as poison. You might be also interested in [token bucket algorithm](http://en.wikipedia.org/wiki/Token_bucket). **Arguments**: - **options** `object` - **limit** `number` - Total amount of requests. Default to `10` - **threshold** `number` - Limit time frame in milliseconds. Default to `1000` - **message** `string` - Optional error message when limit is reached. - **code** `number` - HTTP status code when limit is reached. Default to `429`. ```js toxy.poison(toxy.poisons.rateLimit({ limit: 5, threshold: 10 * 1000 })) ``` #### Slow read <table> <tr> <td><b>Name</b></td><td>slowRead</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Reads incoming payload data packets slowly. Only valid for non-GET request. **Arguments**: - **options** `object` - **chunk** `number` - Packet chunk size in bytes. Default to `1024` - **threshold** `number` - Limit threshold time frame in milliseconds. Default to `1000` ```js toxy.poison(toxy.poisons.slowRead({ chunk: 2048, threshold: 1000 })) ``` #### Slow open Name: `slowOpen` <table> <tr> <td><b>Name</b></td><td>slowOpen</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Delays the HTTP connection ready state. **Arguments**: - **options** `object` - **delay** `number` - Delay connection in milliseconds. Default to `1000` ```js toxy.poison(toxy.poisons.slowOpen({ delay: 2000 })) ``` #### Slow close <table> <tr> <td><b>Name</b></td><td>slowClose</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Delays the HTTP connection close signal (EOF). **Arguments**: - **options** `object` - **delay** `number` - Delay time in milliseconds. Default to `1000` ```js toxy.poison(toxy.poisons.slowClose({ delay: 2000 })) ``` #### Throttle <table> <tr> <td><b>Name</b></td><td>throttle</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Restricts the amount of packets sent over the network in a specific threshold time frame. **Arguments**: - **options** `object` - **chunk** `number` - Packet chunk size in bytes. Default to `1024` - **delay** `object` - Data chunk delay time frame in milliseconds. Default to `100` ```js toxy.poison(toxy.poisons.throttle({ chunk: 2048, threshold: 1000 })) ``` #### Abort connection <table> <tr> <td><b>Name</b></td><td>abort</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>false (only as incoming poison)</td> </tr> </table> Aborts the TCP connection. From the low-level perspective, this will destroy the socket on the server, operating only at TCP level without sending any specific HTTP application level data. **Arguments**: - **options** `object` - **delay** `number` - Aborts TCP connection after waiting the given milliseconds. Default to `0` - **next** `boolean` - If `true`, the connection will be aborted if the target server takes more than the `delay` param time to reply. Default to `false` - **error** `Error` - Custom internal node.js error to use when destroying the socket. Default to `null` ```js // Basic connection abort toxy.poison(toxy.poisons.abort()) // Abort after a delay toxy.poison(toxy.poisons.abort(1000)) // In this case, the socket will be closed if // the target server takes more than // 2 seconds to respond toxy.poison(toxy.poisons.abort({ delay: 2000, next: true })) ``` #### Timeout <table> <tr> <td><b>Name</b></td><td>timeout</td> </tr> <tr> <td><b>Poisoning Phase</b></td><td>incoming / outgoing</td> </tr> <tr> <td><b>Reaches the server</b></td><td>true</td> </tr> </table> Defines a response timeout. Useful when forward to potentially slow servers. **Arguments**: - **milliseconds** `number` - Timeout limit in milliseconds ```js toxy.poison(toxy.poisons.timeout(5000)) ``` ### How to write poisons Poisons are implemented as standard middleware function with the same interface as connect/express middleware. Some poisons are not trivial to implement so you've to be familiar with node.js [http](https://nodejs.org/api/http.html) module and its API. Here's a simple example of a server latency poison: ```js var toxy = require('toxy') function customLatencyPoison (delay) { // We name the function since toxy uses it as identifier to get/disable/remove it in the future return function customLatency (req, res, next) { var timeout = setTimeout(process, delay) req.once('close', onClose) function onClose () { clearTimeout(timeout) next('client connection closed') } function process () { req.removeListener('close', onClose) next() } } } var proxy = toxy() // Register and enable the poison proxy .get('/foo') .poison(customLatencyPoison(2000)) ``` You can optionally extend the build-in poisons with your own poisons: ```js toxy.addPoison(customLatency) // Then you can use it as a built-in poison proxy .get('/foo') .poison(toxy.poisons.customLatency) ``` For featured real example, take a look to the [built-in poisons](https://github.com/h2non/toxy/tree/master/lib/poisons) implementation. ## Rules Rules are simple validation filters which inspects an incoming or outgoing HTTP traffic in order to determine, given a certain rules (e.g: matches the method, headers, query params, body...), if the current HTTP transaction should be poisoned or not, based on the resolution value of the rule. Rules are useful to compose, decouple and reuse logic among different scenarios of poisoning. Rules can be applied to global, route or even poison scope, and it also applies to both [phases of poisoning](#poisoning-phases). Rules are executed in FIFO order. Their evaluation logic is equivalent to `Array#every()` in JavaScript: all the rules must pass in order to proceed with the poisoning. ### Built-in rules #### Probability <table> <tr> <td><b>Name</b></td><td>probability</td> </tr> <tr> <td><b>Poison Phase</b></td><td>incoming / outgoing</td> </tr> </table> Enables the rule by a random probabilistic. Useful for random poisoning. **Arguments**: - **percentage** `number` - Percentage of filtering. Default `50` ```js var rule = toxy.rules.probability(85) toxy.rule(rule) ``` #### Time threshold <table> <tr> <td><b>Name</b></td><td>timeThreshold</td> </tr> <tr> <td><b>Poison Phase</b></td><td>incoming / outgoing</td> </tr> </table> Simple rule to enable poisons based on a specific time threshold and duration. For instance, you can enable a certain poisons during a specific amount of time (e.g: 1 second) within a time threshold (e.g: 1 minute). **Arguments**: - **options** `object` - **duration** `number` - Enable time interval in milliseconds. Default to `1000` - **threshold** `number` - Time threshold in milliseconds to wait before re-enable the poisoning. Default to `10000` ```js // Enable the poisoning only 100 milliseconds per each 10 seconds proxy.rule(toxy.rules.timeThreshold(100)) // Enable poisoning during 1 second every minute proxy.rule(toxy.rules.timeThreshold({ duration: 1000, period: 1000 * 60 })) ``` #### Method <table> <tr> <td><b>Name</b></td><td>method</td> </tr> <tr> <td><b>Poison Phase</b></td><td>incoming / outgoing</td> </tr> </table> Filters by HTTP method. **Arguments**: - **method** `string|array` - Method or methods to filter. ```js var method = toxy.rules.method(['GET', 'POST']) toxy.rule(method) ``` #### Content Type Filters by content type header. It should be present **Arguments**: - **value** `string|regexp` - Header value to match. ```js var rule = toxy.rules.contentType('application/json') toxy.rule(rule) ``` #### Headers <table> <tr> <td><b>Name</b></td><td>headers</td> </tr> <tr> <td><b>Poison Phase</b></td><td>incoming / outgoing</td> </tr> </table> Filter by request headers. **Arguments**: - **headers** `object` - Headers to match by key-value pair. `value` can be a string, regexp, `boolean` or `function(headerValue, headerName) => boolean` ```js var matchHeaders = { 'content-type': /^application/\json/i, 'server': true, // meaning it should be present, 'accept': function (value, key) { return value.indexOf('text') !== -1 } } var rule = toxy.rules.headers(matchHeaders) toxy.rule(rule) ``` #### Response headers <table> <tr> <td><b>Name</b></td><td>responseHeaders</td> </tr> <tr> <td><b>Poison Phase</b></td><td>outgoing</td> </tr> </table> Filter by response headers from target server. Same as `headers` rule, but evaluating the outgoing request. **Arguments**: - **headers** `object` - Headers to match by key-value pair. `value` can be a `string`, `regexp`, `boolean` or `function(headerValue, headerName) => boolean` ```js var matchHeaders = { 'content-type': /^application/\json/i, 'server': true, // meaning it should be present, 'accept': function (value, key) { return value.indexOf('text') !== -1 } } var rule = toxy.rules.responseHeaders(matchHeaders) toxy.rule(rule) ``` #### Body <table> <tr> <td><b>Name</b></td><td>body</td> </tr> <tr> <td><b>Poison Phase</b></td><td>incoming / outgoing</td> </tr> </table> Match incoming body payload by a given `string`, `regexp` or custom filter `function`. This rule is pretty simple, so for complex body matching (e.g: validating against a JSON schema) you should probably write your own rule. **Arguments**: - **match** `string|regexp|function` - Body content to match - **limit** `string` - Optional. Body limit in human size. E.g: `5mb` - **encoding** `string` - Body encoding. Default to `utf8` - **length** `number` - Body length. Default taken from `Content-Length` header ```js var rule = toxy.rules.body('"hello":"world"') toxy.rule(rule) // Or using a filter function returning a boolean var rule = toxy.rules.body(function contains(body) { return body.indexOf('hello') !== -1 }) toxy.rule(rule) ``` #### Response body <table> <tr> <td><b>Name</b></td><td>responseBody</td> </tr> <tr> <td><b>Poison Phase</b></td><td>outgoing</td> </tr> </table> Match outgoing body payload by a given `string`, `regexp` or custom filter `function`. **Arguments**: - **match** `string|regexp|function` - Body content to match - **encoding** `string` - Body encoding. Default to `utf8` - **length** `number` - Body length. Default taken from `Content-Length` header ```js var rule = toxy.rules.responseBody('"hello":"world"') toxy.rule(rule) // Or using a filter function returning a boolean var rule = toxy.rules.responseBody(function contains(body) { return body.indexOf('hello') !== -1 }) toxy.rule(rule) ``` #### Response status <table> <tr> <td><b>Name</b></td><td>responseStatus</td> </tr> <tr> <td><b>Poison Phase</b></td><td>outgoing</td> </tr> </table> Evaluates the response status from the target server. Only applicable to outgoing poisons. **Arguments**: - **range** `array` - Pair of status code range to match. Default `[200, 300]`. - **lower** `number` - Compare status as `lower than` operation. Default to `null`. - **higher** `number` - Compare status as `higher than` operation. Default to `null`. - **value** `number` - Status code to match using a strict equality comparison. Default `null`. - **include** `array` - Unordered list of status codes to match. Useful to specify custom status. Default `null` ```js // Strict evaluation of the status code toxy.rule(toxy.rules.responseBody(200)) // Using a range of valid status toxy.rule(toxy.rules.responseBody([200, 204])) // Using relational comparison toxy.rule(toxy.rules.responseBody({ higher: 199, lower: 400 })) // Custom unordered status code to match toxy.rule(toxy.rules.responseBody({ include: [200, 204, 400, 404] })) ``` ### Third-party rules List of available third-party rules provided by the community. PR are welcome. - [IP](https://github.com/h2non/toxy-ip) - Enable/disable poisons based on the client IP address (supports CIDR, subnets, ranges...). ### How to write rules Rules are simple middleware functions that resolve asynchronously with a `boolean` value to determine if a given HTTP transaction should be ignored when poisoning. Your rule must resolve with a `boolean` param calling the `next(err, shouldIgnore)` function in the middleware, passing a `true` value if the rule has not matches and should not apply the poisoning, and therefore continuing with the next middleware stack. Here's an example of a simple rule matching the HTTP method to determine if: ```js var toxy = require('toxy') function customMethodRule(matchMethod) { /** * We name the function since it's used by toxy to identify the rule to get/disable/remove it in the future */ return function customMethodRule(req, res, next) { var shouldIgnore = req.method !== matchMethod next(null, shouldIgnore) } } var proxy = toxy() // Register and enable the rule proxy .get('/foo') .rule(customMethodRule('GET')) .poison(/* ... */) ``` You can optionally extend the build-in rules with your own rules: ```js toxy.addRule(customMethodRule) // Then you can use it as a built-in poison proxy .get('/foo') .rules(toxy.rules.customMethodRule) ``` For featured real examples, take a look to the built-in rules [implementation](https://github.com/h2non/toxy/tree/master/lib/rules) ## Programmatic API `toxy` API is completely built on top the [rocky API](https://github.com/h2non/rocky#programmatic-api). In other words, you can use any of the methods, features and middleware layer natively provided by `rocky`. ### toxy([ options ]) Create a new `toxy` proxy. For supported `options`, please see rocky [documentation](https://github.com/h2non/rocky#configuration) ```js var toxy = require('toxy') toxy({ forward: 'http://server.net', timeout: 30000 }) toxy .get('/foo') .poison(toxy.poisons.latency(1000)) .withRule(toxy.rules.contentType('json')) .forward('http://foo.server') toxy .post('/bar') .poison(toxy.poisons.bandwidth({ bps: 1024 })) .withRule(toxy.rules.probability(50)) .forward('http://bar.server') toxy .post('/boo') .outgoingPoison(toxy.poisons.bandwidth({ bps: 1024 })) .withRule(toxy.rules.method('GET')) .forward('http://boo.server') toxy.all('/*') toxy.listen(3000) ``` #### toxy#get(path, [ middleware... ]) Return: `ToxyRoute` Register a new route for `GET` method. #### toxy#post(path, [ middleware... ]) Return: `ToxyRoute` Register a new route for `POST` method. #### toxy#put(path, [ middleware... ]) Return: `ToxyRoute` Register a new route for `PUT` method. #### toxy#patch(path, [ middleware... ]) Return: `ToxyRoute` #### toxy#delete(path, [ middleware... ]) Return: `ToxyRoute` Register a new route for `DELETE` method. #### toxy#head(path, [ middleware... ]) Return: `ToxyRoute` Register a new route for `HEAD` method. #### toxy#all(path, [ middleware... ]) Return: `ToxyRoute` Register a new route for any method. #### toxy#poisons `=>` Object Exposes a map with the built-in poisons. Prototype alias to `toxy.poisons` #### toxy#rules `=>` Object Exposes a map with the built-in poisons. Prototype alias to `toxy.rules` #### toxy#forward(url) Define a URL to forward the incoming traffic received by the proxy. #### toxy#balance(urls) Forward to multiple servers balancing among them. For more information, see the [rocky docs](https://github.com/h2non/rocky#programmatic-api) #### toxy#replay(url) Define a new replay server. You can call this method multiple times to define multiple replay servers. For more information, see the [rocky docs](https://github.com/h2non/rocky#programmatic-api) #### toxy#use(middleware) Plug in a custom middleware. For more information, see the [rocky docs](https://github.com/h2non/rocky#middleware-layer). #### toxy#useResponse(middleware) Plug in a response outgoing traffic middleware. For more information, see the [rocky docs](https://github.com/h2non/rocky#middleware-layer). #### toxy#useReplay(middleware) Plug in a replay traffic middleware. For more information, see the [rocky docs](https://github.com/h2non/rocky#middleware-layer) #### toxy#requestBody(middleware) Intercept incoming request body. Useful to modify it on the fly. For more information, see the [rocky docs](https://github.com/h2non/rocky#programmatic-api) #### toxy#responseBody(middleware) Intercept outgoing response body. Useful to modify it on the fly. For more information, see the [rocky docs](https://github.com/h2non/rocky#programmatic-api) #### toxy#middleware() Return a standard middleware to use with connect/express. #### toxy#host(host) Overwrite the `Host` header with a custom value. Similar to `forwardHost` option. #### toxy#redirect(url) Redirect traffic to the given URL. #### toxy#findRoute(routeIdOrPath, [ method ]) Find a route by ID or path and method. #### toxy#listen(port) Starts the built-in HTTP server, listening on a specific TCP port. #### toxy#close([ callback ]) Closes the HTTP server. #### toxy#poison(poison) Alias: `usePoison`, `useIncomingPoison` Register a new poison to infect [incoming](#poisoning-phases) traffic. #### toxy#outgoingPoison(poison) Alias: `useOutgoingPoison`, `responsePoison` Register a new poison to infect [outgoing](#poisoning-phases) traffic. #### toxy#rule(rule) Alias: `useRule` Register a new rule. #### toxy#withRule(rule) Aliases: `ifRule`, `whenRule`, `poisonRule`, `poisonFilter` Apply a new rule for the latest registered poison. #### toxy#enable(poison) Enable a poison by name identifier #### toxy#disable(poison) Disable a poison by name identifier #### toxy#remove(poison) Return: `boolean` Remove an incoming traffic poison by name identifier or object reference. #### toxy#removeOutgoing(poison) Return: `boolean` Remove an outgoing traffic poison by name identifier or object reference. #### toxy#isEnabled(poison) Return: `boolean` Checks if a poison is enabled by name identifier. #### toxy#disableAll() Alias: `disablePoisons` Disable all the registered poisons. #### toxy#getPoison(name) Return: `Directive|null` Searches and retrieves a registered poison in the stack by name identifier. #### toxy#getIncomingPoison(name) Return: `Directive|null` Searches and retrieves a registered `incoming` poison in the stack by name identifier. #### toxy#getOutgoingPoison(name) Return: `Directive|null` Searches and retrieves a registered `outgoing` poison in the stack by name identifier. #### toxy#getPoisons() Return: `array<Directive>` Return an array of registered poisons. #### toxy#getIncomingPoisons() Return: `array<Directive>` Return an array of registered `incoming` poisons. #### toxy#getOutgoingPoisons() Return: `array<Directive>` Return an array of registered `outgoing` poisons. #### toxy#flush() Alias: `flushPoisons` Remove all the registered poisons for both incoming and outgoing traffic flows. #### toxy#enableRule(rule) Enable a rule by name identifier. #### toxy#disableRule(rule) Disable a rule by name identifier. #### toxy#removeRule(rule) Return: `boolean` Remove a rule by name identifier. #### toxy#disableRules() Disable all the registered rules. #### toxy#isRuleEnabled(rule) Return: `boolean` Checks if the given rule is enabled by name identifier. #### toxy#getRule(rule) Return: `Directive|null` Searches and retrieves a registered rule in the stack by name identifier. #### toxy#getRules() Return: `array<Directive>` Returns and array with the registered rules wrapped as `Directive`. #### toxy#flushRules() Remove all the rules. ### toxy.addPoison(name, fn) Extend built-in poisons. ### toxy.addRule(name, fn) Extend built-in rules. ### toxy.poisons `=>` Object Exposes a map with the built-in poisons. ### toxy.rules `=>` Object Exposes a map with the built-in rules. ### toxy.VERSION `=>` String Current toxy semantic version. ### ToxyRoute `ToxyRoute` exposes the same interface as `Toxy` global interface, it just adds some route level [additional methods](https://github.com/h2non/rocky#routepath). Further actions you perform against the `ToxyRoute` API will only be applicable at route-level (nested). In other words: you already know the API. This example will probably clarify possible doubts: ```js var toxy = require('toxy') var proxy = toxy() // Now using the global API proxy .forward('http://server.net') .poison(toxy.poisons.bandwidth({ bps: 1024 })) .rule(toxy.rules.method('GET')) // Now create a route var route = proxy .get('/foo') .toPath('/bar') // Route-level API method .host('server.net') // Route-level API method .forward('http://new.server.net') // Now using the ToxyRoute interface route .poison(toxy.poisons.bandwidth({ bps: 512 })) .rule(toxy.rules.contentType('json')) ``` ### Directive(middlewareFn) A convenient wrapper internally used for poisons and rules. Normally you don't need to know this interface, but for hacking purposes or more low-level actions might be useful. #### Directive#enable() Return: `boolean` #### Directive#disable() Return: `boolean` #### Directive#isEnabled() Return: `boolean` #### Directive#rule(rule) Alias: `filter` #### Directive#handler() Return: `function(req, res, next)` ## HTTP API The `toxy` HTTP API follows the [JSON API](http://jsonapi.org) conventions, including resource based hypermedia linking. ### Usage For a featured use case, see the [admin server](examples/admin.js) example. ```js const toxy = require('toxy') // Create the toxy admin server var admin = toxy.admin({ cors: true }) admin.listen(9000) // Create the toxy proxy var proxy = toxy() proxy.listen(3000) // Add the toxy instance to be managed by the admin server admin.manage(proxy) // Then configure the proxy proxy .forward('http://my.target.net') proxy .get('/slow') .poison(toxy.poisons.bandwidth({ bps: 1024 })) // Handle the rest of the traffic proxy .all('/*') .poison(toxy.poisons.bandwidth({ bps: 1024 * 5 })) console.log('toxy proxy listening on port:', 3000) console.log('toxy admin server listening on port:', 9000) ``` For more details about the admin programmatic API, see [below](#programmatic-api-1). ### Authorization The HTTP API can be protected to unauthorized clients. Authorized clients must define the API key token via `API-Key` or `Authorization` HTTP headers. To enable it, you should simple pass the following options to `toxy` admin server: ```js const toxy = require('toxy') const opts = { apiKey: 's3cr3t' } var admin = toxy.admin(opts) admin.listen(9000) console.log('protected toxy admin server listening on port:', 9000) ``` ### API **Hierarchy**: - **Servers** - Managed `toxy` instances - **Rules** - Globally applied rules - **Poisons** - Globally applied poisons - **Rules** - Poison-specific rules - **Routes** - List of configured routes - **Route** - Object for each specific route - **Rules** - Route-level registered rules - **Poisons** - Route-level registered poisons - **Rules** - Route-level poison-specific rules #### GET / ### Servers #### GET /servers #### GET /servers/:id ### Rules #### GET /servers/:id/rules #### POST /servers/:id/rules Accepts: `application/json` Example payload: ```js { "name": "method", "options": "GET" } ``` #### DELETE /servers/:id/rules #### GET /servers/:id/rules/:id #### DELETE /servers/:id/rules/:id ### Poisons #### GET /servers/:id/poison #### POST /servers/:id/poisons Accepts: `application/json` Example payload: ```js { "name": "latency", "phase": "outgoing", "options": { "jitter": 1000 } } ``` #### DELETE /servers/:id/poisons #### GET /servers/:id/poisons/:id #### DELETE /servers/:id/poisons/:id #### GET /servers/:id/poisons/:id/rules #### POST /servers/:id/poisons/:id/rules Accepts: `application/json` Example payload: ```js { "name": "method", "options": "GET" } ``` #### DELETE /servers/:id/poisons/:id/rules #### GET /servers/:id/poisons/:id/rules/:id #### DELETE /servers/:id/poisons/:id/rules/:id ### Routes #### GET /servers/:id/routes #### POST /servers/:id/routes Accepts: `application/json` Example payload: ```js { "path": "/foo", // Required "method": "GET", // use ALL for all the methods "forward": "http://my.server", // Optional custom forward server URL } ``` #### DELETE /servers/:id/routes #### GET /servers/:id/routes/:id #### DELETE /servers/:id/routes/:id ### Route rules #### GET /servers/:id/routes/:id/rules #### POST /servers/:id/routes/:id/rules Accepts: `application/json` Example payload: ```js { "name": "method", "options": "GET" } ``` #### DELETE /servers/:id/routes/:id/rules #### GET /servers/:id/routes/:id/rules/:id #### DELETE /servers/:id/routes/:id/rules/:id ### Route poisons #### GET /servers/:id/routes/:id/poisons #### POST /servers/:id/routes/:id/poisons Accepts: `application/json` Example payload: ```js { "name": "latency", "phase": "outgoing", "options": { "jitter": 1000 } } ``` #### DELETE /servers/:id/routes/:id/poisons #### GET /servers/:id/routes/:id/poisons/:id #### DELETE /servers/:id/routes/:id/poisons/:id #### GET /servers/:id/routes/:id/poisons/:id/rules #### POST /servers/:id/routes/:id/poisons/:id/rules Accepts: `application/json` Example payload: ```js { "name": "method", "options": "GET" } ``` #### DELETE /servers/:id/routes/:id/poisons/:id/rules #### GET /servers/:id/routes/:id/poisons/:id/rules/:id #### DELETE /servers/:id/routes/:id/poisons/:id/rules/:id ### Programmatic API The built-in HTTP admin server also provides a simple interface open to extensibility and hacking purposes. For instance, you can plug in additional middleware to the admin server, or register new routes. #### toxy.admin([ opts ]) Returns: `Admin` **Supported options**: - **apiKey** `string` - Optional API key to protect the server - **port** `number` - Optional. TCP port to listen - **cors** `boolean` - Enable CORS for web browser access - **middleware** `array<function>` - Plug in additional middleware - **ssl** `object` - Node.js HTTPS server [TLS options](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener). ##### Admin#listen([ port, host ]) Start listening on the network. ##### Admin#manage(toxy) Manage a `toxy` server instance. ##### Admin#find(toxy) Find a toxy instance. Accepts toxy server ID or toxy instance. ##### Admin#remove(toxy) Stop managing a toxy instance. ##### Admin#use(...middleware) Register a middleware. ##### Admin#param(...middleware) Register a param middleware. ##### Admin#get(path, [ ...middleware ]) Register a GET route. ##### Admin#post(path, [ ...middleware ]) Register a POST route. ##### Admin#put(path, [ ...middleware ]) Register a PUT route. ##### Admin#delete(path, [ ...middleware ]) Register a DELETE route. ##### Admin#patch(path, [ ...middleware ]) Register a PATCH route. ##### Admin#all(path, [ ...middleware ]) Register a route accepting any HTTP method. ##### Admin#middleware(req, res, next) Middleware to plug in with connect/express. ##### Admin#close(cb) Stop the server. ## License MIT - Tomas Aparicio [](https://sourcegraph.com/github.com/h2non/toxy)

Hassle-free inline clojure.spec with semi-automatic generative testing and side effect detection

A smooth testing lib for F#. APIs made for humans! Strong testing methodologies for everyone!

<h1 align="center">Expecto</h1> <p align="center">An advanced testing library for F#</p> <p align="center"> <a href="https://travis-ci.org/haf/expecto"><img alt="Linux Build" src="https://travis-ci.org/haf/expecto.svg?branch=master"></a> <a href="https://ci.appveyor.com/project/haf/expecto"><img alt="Windows Build" src="https://ci.appveyor.com/api/projects/status/mscx44sh1ci3xdlr?svg=true&branch=master"></a> <a href="https://www.nuget.org/packages/expecto"><img alt="Nuget" src="https://buildstats.info/nuget/expecto"></a> <img src="https://img.shields.io/github/languages/top/haf/expecto?color=%23b845fc"> <a href="https://opensource.org/licenses/Apache-2.0"><img alt="License - Apache 2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> <a href="https://github.com/sponsors/haf" title="Sponsor this"><img src="https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=red" /></a> </p> <br> Expecto aims to make it easy to test CLR based software; be it with unit tests, stress tests, regression tests or property based tests. Expecto tests are parallel and async by default, so that you can use all your cores for testing your software. This also opens up a new way of catching threading and memory issues for free using stress testing.  With Expecto you write tests as values. Tests can be composed, reduced, filtered, repeated and passed as values, because they are values. This gives the programmer a lot of leverage when writing tests. Setup and teardown are just simple functions, no need for attributes. Expecto comes with batteries included with an integrated test runner, but it's still open for extension due to its compositional model. Expecto comes with performance testing, making statistically sound performance comparison simple. Expecto also provides a simple API for property based testing using FsCheck. ## Quickstart dotnet new -i Expecto.Template::* dotnet new expecto -n PROJECT_NAME -o FOLDER_NAME Follow [Smooth Testing](https://www.youtube.com/channel/UC2SN9CUu9LlOBukXXv_bT5Q) on YouTube to learn the basics. What follows is the Table of Contents for this README, which also serves as the documentation for the project. <!-- toc --> - [Installing](#installing) - [IDE integrations](#IDE-integrations) - [.Net integration](#net-integration) - [Prettify stacktraces/ship test logs](#prettify-stacktracesship-test-logs) - [TestResults file](#testresults-file) - [.Net support](#net-support) - [Testing "Hello world"](#testing-hello-world) - [Running tests](#running-tests) - [`runTests`](#runtests) - [`runTestsWithArgs`](#runtestswithargs) - [`runTestsWithCLIArgs`](#runtestswithcliargs) - [`runTestsWithCancel`](#runTestsWithCancel) - [`runTestsWithArgsAndCancel`](#runTestsWithArgsAndCancel) - [`runTestsWithCLIArgsAndCancel`](#runTestsWithCLIArgsAndCancel) - [`runTestsInAssembly`](#runtestsinassembly) - [`runTestsInAssemblyWithCLIArgs`](#runtestsinassemblywithcliargs) - [`runTestsInAssemblyWithCancel`](#runTestsInAssemblyWithCancel) - [`runTestsInAssemblyWithCLIArgsAndCancel`](#runTestsInAssemblyWithCLIArgsAndCancel) - [Filtering with `filter`](#filtering-with-filter) - [Shuffling with `shuffle`](#shuffling-with-shuffle) - [Stress testing](#stress-testing) - [Writing tests](#writing-tests) - [Normal tests](#normal-tests) - [`testList` for grouping](#testlist-for-grouping) - [Test fixtures](#test-fixtures) - [Pending tests](#pending-tests) - [Focusing tests](#focusing-tests) - [Sequenced tests](#sequenced-tests) - [Parameterised tests with `testParam`](#parameterised-tests-with-testparam) - [Setup and teardown](#setup-and-teardown) - [Property based tests](#property-based-tests) - [Link collection](#link-collection) - [Code from FsCheck](#code-from-fscheck) - [Expectations with `Expect`](#expectations-with-expect) - [`Expect` module](#expect-module) - [`Performance` module](#performance-module) - [Example](#example) - [Performance.findFastest](#performancefindfastest) - [`main args` and command line – how to run console apps examples](#main-args-and-command-line-%e2%80%93-how-to-run-console-apps-examples) - [Contributing and building](#contributing-and-building) - [BenchmarkDotNet usage](#benchmarkdotnet-usage) - [You're not alone!](#youre-not-alone) - [Testing hardware](#testing-hardware) - [Sending e-mail on failure – custom printers](#sending-e-mail-on-failure-%e2%80%93-custom-printers) - [About test parallelism](#about-test-parallelism) - [What does 'expected to have type TestCode' mean?](#what-does-expected-to-have-type-testcode-mean) <!-- tocstop -->  ## Installing In your `paket.dependencies`: nuget Expecto nuget Expecto.BenchmarkDotNet nuget Expecto.FsCheck nuget Expecto.Hopac Tests should be first-class values so that you can move them around and execute them in any context that you want. Let's have look at what an extensive unit test suite looks like when running with Expecto:  ## IDE integrations There's a nuget `Expecto.VisualStudio.TestAdapter` for Visual Studio integration. ## .Net integration You can use `dotnet run` or `dotnet watch` from the command line. dotnet watch -p MyProject.Tests run -f net6.0 ### Prettify stacktraces/ship test logs To get a [complete logging solution][logary] and stacktrace highlighting, parsing and the ability to ship your build logs somewhere, also add these: nuget Logary.Adapters.Facade prerelease And in your tests: ```fsharp open Hopac open Logary open Logary.Configuration open Logary.Adapters.Facade open Logary.Targets [<EntryPoint>] let main argv = let logary = Config.create "MyProject.Tests" "localhost" |> Config.targets [ LiterateConsole.create LiterateConsole.empty "console" ] |> Config.processing (Events.events |> Events.sink ["console";]) |> Config.build |> run LogaryFacadeAdapter.initialise<Expecto.Logging.Logger> logary // Invoke Expecto: runTestsInAssemblyWithCLIArgs [] argv ``` Now, when you use Logary in your app, you can see your log messages together with the log output/summary/debug printing of Expecto, and the output won't be interlaced due to concurrency. ### TestResults file Use `--nunit-summary TestResults.xml` or `--junit-summary TestResults.junit.xml` (JUnit support is incomplete). ## .Net support [Expecto has it's own .Net template](https://github.com/MNie/Expecto.Template)! You could create a base .Net project with expecto. How to do that? Simply write following lines: dotnet new -i 'Expecto.Template::*' dotnet new expecto -n PROJECT_NAME -o FOLDER_NAME How to run it? dotnet restore dotnet run  ## Testing "Hello world" The test runner is the test assembly itself. It's recommended to compile your test assembly as a console application. You can run a test directly like this: ```fsharp open Expecto let tests = test "A simple test" { let subject = "Hello World" Expect.equal subject "Hello World" "The strings should equal" } [<EntryPoint>] let main args = runTestsWithCLIArgs [] args tests ``` No magic is involved here. We just created a single test and hooked it into the assembly entry point. The `Expect` module contains functions that you can use to assert with. A testing library without a good assertion library is like love without kisses. Now compile and run! `xbuild Sample.fsproj && mono --debug bin/Debug/Sample.exe` ## Running tests Here's a simple test: ```fsharp open Expecto let simpleTest = testCase "A simple test" <| fun () -> let expected = 4 Expect.equal expected (2+2) "2+2 = 4" ``` Then run it like this, e.g. in the interactive or through a console app. ```fsharp runTestsWithCLIArgs [] [||] simpleTest ``` which returns 1 if any tests failed, otherwise 0. Useful for returning to the operating system as error code. It's worth noting that `<|` is just a way to change the associativity of the language parser. In other words; it's equivalent to: ```fsharp testCase "A simple test" (fun () -> Expect.equal 4 (2+2) "2+2 should equal 4") ``` ### `runTests` Signature `ExpectoConfig -> Test -> int`. Runs the passed tests with the passed configuration record. Note: now deprecated please use CLIArgs below. ### `runTestsWithArgs` Signature `ExpectoConfig -> string[] -> Test -> int`. Runs the passed tests and also overrides the passed `ExpectoConfig` with the command line parameters. Note: now deprecated please use CLIArgs below. ### `runTestsWithCLIArgs` Signature `CLIArguments seq -> string[] -> Test -> int`. Runs the passed tests and also overrides the passed `CLIArguments` with the command line parameters. ### `runTestsWithCancel` Signature `CancellationToken -> ExpectoConfig -> Test -> int`. Runs the passed tests with the passed configuration record. Note: now deprecated please use CLIArgs below. ### `runTestsWithArgsAndCancel` Signature `CancellationToken -> ExpectoConfig -> Test -> int`. Runs the passed tests and also overrides the passed `ExpectoConfig` with the command line parameters. configuration record. Note: now deprecated please use CLIArgs below. ### `runTestsWithCLIArgsAndCancel` Signature `CancellationToken -> ExpectoConfig -> Test -> int`. Runs the passed tests and also overrides the passed `CLIArguments` with the command line parameters. ### `runTestsInAssembly` Signature `ExpectoConfig -> string[] -> int`. Runs the tests in the current assembly and also overrides the passed `ExpectoConfig` with the command line parameters. All tests need to be marked with the `[<Tests>]` attribute. Note: now deprecated please use CLIArgs below. ### `runTestsInAssemblyWithCLIArgs` Signature `CLIArguments seq -> string[] -> int`. Runs the tests in the current assembly and also overrides the passed `CLIArguments` with the command line parameters. All tests need to be marked with the `[<Tests>]` attribute. ### `runTestsInAssemblyWithCancel` Signature `CancellationToken -> ExpectoConfig -> string[] -> int`. Runs the tests in the current assembly and also overrides the passed `ExpectoConfig` with the command line parameters. All tests need to be marked with the `[<Tests>]` attribute. ### `runTestsInAssemblyWithCLIArgsAndCancel` Signature `CancellationToken -> CLIArguments seq -> string[] -> int`. Runs the tests in the current assembly and also overrides the passed `CLIArguments` with the command line parameters. All tests need to be marked with the `[<Tests>]` attribute. ### Filtering with `filter` You can single out tests by filtering them by name (e.g. in the interactive/REPL). For example: ```fsharp open Expecto open MyLib.Tests integrationTests // from MyLib.Tests |> Test.filter defaultConfig.joinWith.asString (fun z -> (defaultConfig.joinWith.format z).StartsWith "another test" ) // the filtering function |> runTestsWithCLIArgs [] [||] ``` ### Shuffling with `shuffle` You can shuffle the tests randomly to help ensure there are no run order dependencies. For example: ```fsharp open Expecto open MyLib.Tests myTests // from MyLib.Tests |> Test.shuffle defaultConfig.joinWith.asString |> runTestsWithCLIArgs [] [||] ``` ### Stress testing Tests can also be run randomly for a fixed length of time. The idea is that this will catch the following types of bugs: - Memory leaks. - Threading bugs running same test at same time. - Rare threading bugs. - Rare property test fails. The default config will run FsCheck tests with a higher end size than normal. ## Writing tests Expecto supports the following test constructors: - normal test cases with `testCase` and `testCaseAsync` - lists of tests with `testList` - test fixtures with `testFixture` - pending tests (that aren't run) with `ptestCase` and `ptestCaseAsync` - focused tests (that are the only ones run) with `ftestCase` and `ftestCaseAsync` - sequenced tests with `testSequenced` and `testSequencedGroup` (tests inside a group are run in sequence w.r.t each other) - parametised tests with `testParam` - testCases with the workflow builder `test`, `ptest`, `ftest` supporting deterministic disposal, loops and such - property based tests with `testProperty`, `testPropertyWithConfig` and `testPropertyWithConfigs`, `testPropertyWithConfigsStdGen`, `testPropertyWithConfigStdGen` from `Expecto.FsCheck` - performance tests with `Expecto.BenchmarkDotNet` and `benchmark<TBench> : string -> Test`. - wrapping your test with a label with `testLabel`. If your root label is the same across your test project, you'll have an easier time filtering tests. All of the above compile to a `Test` value that you can compose. For example, you can compose a `test` and a `testCaseAsync` in a `testList` which you wrap in `testSequenced` because all tests in the list use either `Expect.fasterThan` or they are using `Expecto.BenchmarkDotNet` for performance tests. You have to remember that **the fully qualified names of tests need to be unique across your test project.** ### Normal tests - `test : string -> TestCaseBuilder` - Builds a test case in a computation expression. - `testAsync : string -> TestAsyncBuilder` - Builds an async test case in a computation expression. - `testTask : string -> TestTaskBuilder` - Builds a task test case in a computation expression. - `testCase : string -> (unit -> unit) -> Test` - Builds a test case from a test function. - `testCaseAsync : string -> Async<unit> -> Test` - Builds an async test case from an async expression. ### `testList` for grouping Tests can be grouped (with arbitrary nesting): ```fsharp let tests = testList "A test group" [ test "one test" { Expect.equal (2+2) 4 "2+2" } test "another test that fails" { Expect.equal (3+3) 5 "3+3" } testAsync "this is an async test" { let! x = async { return 4 } Expect.equal x (2+2) "2+2" } testTask "this is a task test" { let! n = Task.FromResult 2 Expect.equal n 2 "n=2" } ] |> testLabel "samples" ``` Also have a look at [the samples](https://github.com/haf/expecto/blob/master/Expecto.Sample/Expecto.Sample.fs). ### Test fixtures - `testFixture : ('a -> unit -> unit) -> (seq<string * 'a>) -> seq<Test>` The test fixture takes a factory and a sequence of partial tests. The `'a` parameter will be inferred to the *function type*, such as `MemoryStream -> 'a -> unit -> 'a`. Example: ```fsharp testList "Setup & teardown 3" [ let withMemoryStream f () = use ms = new MemoryStream() f ms yield! testFixture withMemoryStream [ "can read", fun ms -> ms.CanRead ==? true "can write", fun ms -> ms.CanWrite ==? true ] ] ``` ### Pending tests - `ptestCase` - `ptest` - `ptestAsync` - `ptestTask` - `ptestCaseAsync` You can mark an individual spec or container as Pending. This will prevent the spec (or specs within the list) from running. You do this by adding a `p` before *testCase* or *testList* or `P` before *Tests* attribute (when reflection tests discovery is used). ```fsharp open Expecto [<PTests>] let skippedTestFromReflectionDiscovery = testCase "skipped" <| fun () -> Expect.equal (2+2) 4 "2+2" [<Tests>] let myTests = testList "normal" [ testList "unfocused list" [ ptestCase "skipped" <| fun () -> Expect.equal (2+2) 1 "2+2?" testCase "will run" <| fun () -> Expect.equal (2+2) 4 "2+2" ptest "skipped" { Expect.equal (2+2) 1 "2+2?" } ptestAsync "skipped async" { Expect.equal (2+2) 1 "2+2?" } ] testCase "will run" <| fun () -> Expect.equal (2+2) 4 "2+2" ptestCase "skipped" <| fun () -> Expect.equal (2+2) 1 "2+2?" ptestList "skipped list" [ testCase "skipped" <| fun () -> Expect.equal (2+2) 1 "2+2?" ftest "skipped" { Expect.equal (2+2) 1 "2+2?" } ] ] ``` Optionally, in the `TestCode` (function body): - `Tests.skiptest` - `Tests.skiptestf` ### Focusing tests Focusing can be done with - `ftestCase` - `ftestList` - `ftestCaseAsync` - `ftest` - `ftestAsync` - `ftestTask` It is often convenient, when developing to be able to run a subset of specs. Expecto allows you to focus specific test cases or tests list by putting `f` before *testCase* or *testList* or `F` before attribute *Tests*(when reflection tests discovery is used). ```fsharp open Expecto [<FTests>] let someFocusedTest = test "will run" { Expect.equal (2+2) 4 "2+2" } [<Tests>] let someUnfocusedTest = test "skipped" { Expect.equal (2+2) 1 "2+2?" } ``` or ```fsharp open Expecto [<Tests>] let focusedTests = testList "unfocused list" [ ftestList "focused list" [ testCase "will run" <| fun () -> Expect.equal (2+2) 4 "2+2" ftestCase "will run" <| fun () -> Expect.equal (2+2) 4 "2+2" test "will run" { Expect.equal (2+2) 4 "2+2" } ] testList "unfocused list" [ testCase "skipped" <| fun () -> Expect.equal (2+2) 1 "2+2?" ftestCase "will run" <| fun () -> Expect.equal (2+2) 4 "2+2" test "skipped" { Expect.equal (2+2) 1 "2+2?" } ftest "will run" { Expect.equal (2+2) 4 "2+2" } ] testCase "skipped" <| fun () -> Expect.equal (2+2) 1 "2+2?" ] ``` Expecto accepts the command line argument `--fail-on-focused-tests`, which checks if focused tests exist. This parameter can be set in build scripts and allows CI servers to reject commits that accidentally included focused tests. ### Sequenced tests You can mark an individual spec or container as Sequenced. This will make sure these tests are run sequentially. This can be useful for timeout and performance testing. ```fsharp [<Tests>] let timeout = testSequenced <| testList "Timeout" [ test "fail" { let test = TestCase(Test.timeout 10 (TestCode.Sync (fun _ -> Thread.Sleep 100)), Normal) async { let! eval = Impl.evalTests defaultConfig test let result = Impl.TestRunSummary.fromResults eval result.failed.Length ==? 1 } |> Async.RunSynchronously } test "pass" { let test = TestCase(Test.timeout 1000 (TestCode.Sync ignore), Normal) async { let! eval = Impl.evalTests defaultConfig test let result = Impl.TestRunSummary.fromResults eval result.passed.Length ==? 1 } |> Async.RunSynchronously } ] ``` You can also mark a test list as a Sequenced Group. This will make sure the tests in this group are not run at the same time. ```fsharp [<Tests>] let timeout = let lockOne = obj() let lockTwo = obj() testSequencedGroup "stop deadlock" <| testList "possible deadlock" [ testAsync "case A" { lock lockOne (fun () -> Thread.Sleep 10 lock lockTwo (fun () -> () ) ) } testAsync "case B" { lock lockTwo (fun () -> Thread.Sleep 10 lock lockOne (fun () -> () ) ) } ] ``` ### Parameterised tests with `testParam` - `testParam` ```fsharp testList "numberology 101" ( testParam 1333 [ "First sample", fun value () -> Expect.equal value 1333 "Should be expected value" "Second sample", fun value () -> Expect.isLessThan value 1444 "Should be less than" ] |> List.ofSeq) ``` ### Setup and teardown A simple way to perform setup and teardown is by using `IDisposable` resources: ```fsharp let simpleTests = testList "simples" [ test "test one" { use resource = new MyDatabase() // test code } ] ``` For more complex setup and teardown situations we can write one or more setup functions to manage resources: ```fsharp let clientTests setup = [ test "test1" { setup (fun client store -> // test code ) } test "test2" { setup (fun client store -> // test code ) } // other tests ] let clientMemoryTests = clientTests (fun test -> let client = memoryClient() let store = memoryStore() test client store ) |> testList "client memory tests" let clientIntegrationTests = clientTests (fun test -> // setup code try let client = realTestClient() let store = realTestStore() test client store finally // teardown code ) |> testList "client integration tests" ``` ### Property based tests Reference [FsCheck](https://github.com/fscheck/FsCheck) and Expecto.FsCheck to test properties. ```fsharp module MyApp.Tests // the ExpectoFsCheck module is auto-opened by this // the configuration record is in the Expecto namespace in the core library open Expecto let config = { FsCheckConfig.defaultConfig with maxTest = 10000 } let properties = testList "FsCheck samples" [ testProperty "Addition is commutative" <| fun a b -> a + b = b + a testProperty "Reverse of reverse of a list is the original list" <| fun (xs:list<int>) -> List.rev (List.rev xs) = xs // you can also override the FsCheck config testPropertyWithConfig config "Product is distributive over addition" <| fun a b c -> a * (b + c) = a * b + a * c ] Tests.runTestsWithCLIArgs [] [||] properties ``` You can freely mix testProperty with testCase and testList. The config looks like the following. ```fsharp type FsCheckConfig = /// The maximum number of tests that are run. { maxTest: int /// The size to use for the first test. startSize: int /// The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. endSize: int /// If set, the seed to use to start testing. Allows reproduction of previous runs. replay: (int * int) option /// The Arbitrary instances on this class will be merged in back to front order, i.e. instances for the same generated type at the front /// of the list will override those at the back. The instances on Arb.Default are always known, and are at the back (so they can always be /// overridden) arbitrary: Type list /// Callback when the test case had input parameters generated. receivedArgs: FsCheckConfig -> (* test name *) string -> (* test number *) int -> (* generated arguments *) obj list -> Async<unit> /// Callback when the test case was successfully shrunk successfulShrink: FsCheckConfig -> (* test name *) string -> (* shrunk new arguments *) obj list -> Async<unit> /// Callback when the test case has finished finishedTest: FsCheckConfig -> (* test name *) string -> Async<unit> } ``` Here is another example of testing with custom generated data: ```fsharp module MyApp.Tests // the ExpectoFsCheck module is auto-opened by this // the configuration record is in the Expecto namespace in the core library open Expecto open FsCheck type User = { Id : int FirstName : string LastName : string } type UserGen() = static member User() : Arbitrary<User> = let genFirsName = Gen.elements ["Don"; "Henrik"; null] let genLastName = Gen.elements ["Syme"; "Feldt"; null] let createUser id firstName lastName = {Id = id; FirstName = firstName ; LastName = lastName} let getId = Gen.choose(0,1000) let genUser = createUser <!> getId <*> genFirsName <*> genLastName genUser |> Arb.fromGen let config = { FsCheckConfig.defaultConfig with arbitrary = [typeof<UserGen>] } let properties = testList "FsCheck samples" [ // you can also override the FsCheck config testPropertyWithConfig config "User with generated User data" <| fun x -> Expect.isNotNull x.FirstName "First Name should not be null" ] Tests.runTestsWithCLIArgs [] [||] properties ``` And a further example of creating constraints on generated values ```fsharp open System open Expecto open FsCheck module Gen = type Float01 = Float01 of float let float01Arb = let maxValue = float UInt64.MaxValue Arb.convert (fun (DoNotSize a) -> float a / maxValue |> Float01) (fun (Float01 f) -> f * maxValue + 0.5 |> uint64 |> DoNotSize) Arb.from type 'a ListOf100 = ListOf100 of 'a list let listOf100Arb() = Gen.listOfLength 100 Arb.generate |> Arb.fromGen |> Arb.convert ListOf100 (fun (ListOf100 l) -> l) type 'a ListOfAtLeast2 = ListOfAtLeast2 of 'a list let listOfAtLeast2Arb() = Arb.convert (fun (h1,h2,t) -> ListOfAtLeast2 (h1::h2::t)) (function | ListOfAtLeast2 (h1::h2::t) -> h1,h2,t | e -> failwithf "not possible in listOfAtLeast2Arb: %A" e) Arb.from let addToConfig config = {config with arbitrary = typeof<Float01>.DeclaringType::config.arbitrary} [<AutoOpen>] module Auto = let private config = Gen.addToConfig FsCheckConfig.defaultConfig let testProp name = testPropertyWithConfig config name let ptestProp name = ptestPropertyWithConfig config name let ftestProp name = ftestPropertyWithConfig config name let etestProp stdgen name = etestPropertyWithConfig stdgen config name module Tests = let topicTests = testList "topic" [ testProp "float between 0 and 1" (fun (Gen.Float01 f) -> () // test ) testProp "list of 100 things" (fun (Gen.ListOf100 l) -> () // test ) testProp "list of at least 2 things" (fun (Gen.ListOfAtLeast2 l) -> () // test ) testProp "list of at least 2 things without gen" (fun h1 h2 t -> let l = h1::h2::t () // test ) ] ``` It will be translated to the FsCheck-specific configuration at runtime. You can pass your own callbacks and use `Expecto.Logging` like shown in the [Sample](https://github.com/haf/expecto/blob/master/Expecto.Sample/Expecto.Sample.fs#L23) to get inputs for tests and tests printed. If a property fails, the output could look like this. [11:06:35 ERR] samples/addition is not commutative (should fail) failed in 00:00:00.0910000. Failed after 1 test. Parameters: 2 1 Shrunk 2 times to: 1 0 Result: False Focus on error: etestProperty (1865288075, 296281834) "addition is not commutative (should fail)" The output that Expecto gives you, lets you recreate the exact test (that's from the 18..., 29... seed numbers). It's also a good idea to lift inputs and the test-case/parameter combination that failed into its *own* test (which isn't a property based test). FsCheck `Arb.Register` can't be used with Expecto because it is thread local and Expecto runs multithreaded by default. This could be worked around but `Arb.Register` is being deprecated by FsCheck. The recommended way to register and use custom generators is to define `testPropertyWithConfig` functions like `testProp` above for each area with common generator use. This ensures the library will always be used in a thread safe way. #### Link collection These are a few resources that will get you on your way towards fully-specified systems with property-based testing. - [An introduction to property-based testing](http://fsharpforfunandprofit.com/posts/property-based-testing/) with [slides and video](http://fsharpforfunandprofit.com/pbt/) - [Choosing properties for property-based testing](http://fsharpforfunandprofit.com/posts/property-based-testing-2/) - [(video) Race conditions, distribution and interactions](https://vimeo.com/68383317) - [Test data: generators, shrinkers and Arbitrary instances](https://fscheck.github.io/FsCheck/TestData.html) - [Model based testing](https://fscheck.github.io/FsCheck/StatefulTesting.html) - [Testing and quality assurance in Haskell](http://book.realworldhaskell.org/read/testing-and-quality-assurance.html) - [Property-based testing for better code](https://www.youtube.com/watch?v=shngiiBfD80) #### Code from FsCheck These code snippets show a bit of the API usage and how to create Arbitrary instances (which encapsulate generation with Gen instances and shrinkage), respectively. - [FsCheck Examples.fs](https://github.com/fscheck/FsCheck/blob/master/examples/FsCheck.Examples/Examples.fs) - [FsCheck Arbitrary.fs](https://github.com/fscheck/FsCheck/blob/master/src/FsCheck/Arbitrary.fs#L26) ## Expectations with `Expect` All expect-functions have the signature `actual -> expected -> string -> unit`, leaving out `expected` when obvious from the function. ### `Expect` module This module is your main entry-point when asserting. - `throws` - `throwsC` - `throwsT` - `isNone` - `isSome` - `isChoice1Of2` - `isChoice2Of2` - `isOk` - Expect the value to be a Result.Ok value - `isError` - Expect the value to be a Result.Error value - `isNull` - `isNotNull` - `isNotNaN` - `isNotPositiveInfinity` - `isNotNegativeInfinity` - `isNotInfinity` - `isLessThan` - `isLessThanOrEqual` - `isGreaterThan` - `isGreaterThanOrEqual` - `notEqual` - `isFalse` - `isTrue` - `exists` - Expect that some element from `actual` sequence satisfies the given `asserter` - `all` - Expect that all elements from `actual` satisfy the given `asserter` - `allEqual` - Expect that all elements from `actual` are equal to `equalTo` - `sequenceEqual` - `floatClose : Accuracy -> float -> float -> string -> unit` - Expect the floats to be within the combined absolute and relative accuracy given by `abs(a-b) <= absolute + relative * max (abs a) (abs b)`. Default accuracy available are: `Accuracy.low = {absolute=1e-6; relative=1e-3}`, `Accuracy.medium = {absolute=1e-8; relative=1e-5}`, `Accuracy.high = {absolute=1e-10; relative=1e-7}`, `Accuracy.veryHigh = {absolute=1e-12; relative=1e-9}`. - `floatLessThanOrClose : Accuracy -> float -> float -> string -> unit` - Expect actual to be less than expected or close. - `floatGreaterThanOrClose : Accuracy -> float -> float -> string -> unit` - Expect actual to be greater than expected or close. - `sequenceStarts` - Expect the sequence `subject` to start with `prefix`. If it does not then fail with `format` as an error message together with a description of `subject` and `prefix`. - `sequenceContainsOrder` - Expect the sequence `actual` to contains elements from sequence `expected` in the right order. - `isAscending` - Expect the sequence `subject` to be ascending. If it does not then fail with `format` as an error message. - `isDescending` - Expect the sequence `subject` to be descending. If it does not then fail with `format` as an error message. - `stringContains` – Expect the string `subject` to contain `substring` as part of itself. If it does not, then fail with `format` and `subject` and `substring` as part of the error message. - `isMatch` - Expect the string `actual` to match `pattern` - `isRegexMatch` - Expect the string `actual` to match `regex` - `isMatchGroups` - Expects the string `actual` that matched groups (from a `pattern` match) match with `matchesOperator` - `isMatchRegexGroups` - Expects the string `actual` that matched groups (from a `regex` match) match with `matchesOperator` - `isNotMatch` - Expect the string `actual` to not match `pattern` - `isNotRegexMatch` - Expect the string `actual` to not match `regex` - `stringStarts` – Expect the string `subject` to start with `prefix` and if it does not then fail with `format` as an error message together with a description of `subject` and `prefix`. - `stringEnds` - Expect the string `subject` to end with `suffix`. If it does not then fail with `format` as an error message together with a description of `subject` and `suffix`. - `stringHasLength` - Expect the string `subject` to have length equals `length`. If it does not then fail with `format` as an error message together with a description of `subject` and `length`. - `isNotEmpty` - Expect the string `actual` to be not null nor empty - `isNotWhitespace` - Expect the string `actual` to be not null nor empty nor whitespace - `isEmpty` - Expect the sequence `actual` to be empty - `isNonEmpty` - Expect the sequence `actual` to be not empty - `hasCountOf` - Expect that the counts of the found value occurrences by `selector` in `actual` equals the `expected`. - `contains : 'a seq -> 'a -> string -> unit` – Expect the sequence to contain the item. - `containsAll: 'a seq -> 'a seq -> string -> unit` - Expect the sequence contains all elements from second sequence (not taking into account an order of elements). - `distribution: 'a seq -> Map<'a, uint32> -> string -> unit` - Expect the sequence contains all elements from map (first element in tuple is an item expected to be in sequence, second is a positive number of its occurrences in a sequence). Function is not taking into account an order of elements. - `streamsEqual` – Expect the streams to be byte-wise identical. - `isFasterThan : (unit -> 'a) -> (unit -> 'a) -> string -> unit` – Expect the first function to be faster than the second function with the passed string message, printed on failure. See the next section on [Performance](#performance-module) for example usage. - `isFasterThanSub` – Like the above but with passed function signature of `Performance.Measurer<unit,'a> -> 'a`, allowing you to do setup and teardown of your subject under test (the function) before calling the `measurer`. See the next section on [Performance](#performance-module) for example usage. - `wantOk` - Expect the result to be `Ok` and returns its value, otherwise fails. - `wantError` - Expect the result to be `Error` and returns its value, otherwise fails. Also note, that there's a "fluent" API, with which you can pipe the test-subject value into the expectation: ```fsharp open Expecto open Expecto.Flip let compute (multiplier: int) = 42 * multiplier test "yup yup" { compute 1 |> Expect.equal "x1 = 42" 42 compute 2 |> Expect.equal "x2 = 82" 84 } |> runTestsWithCLIArgs [] [||] ``` ### `Performance` module Expecto supports testing that an implementation is faster than another. Use it by calling `Expect.isFasterThan` wrapping your `Test` in `testSequenced`.  This function makes use of a statistical test called [Welch's t-test](https://en.wikipedia.org/wiki/Welch's_t-test). It starts with the null hypothesis that the functions mean execution times are the same. The functions are run alternately increasing the sample size to test this hypothesis. Once the probability of getting this result based on the null hypothesis goes below 0.01% it rejects the null hypothesis and reports the results. If the performance is very close the test will declare them equal when there is 99.99% confidence they differ by less than 0.5%. 0.01%/99.99% are chosen such that if a test list has 100 performance tests a false test failure would be reported once in many more than 100 runs. This results in a performance test that is very quick to run (the greater the difference the quicker it will run). Also, because it is a relative test it can normally be run across all configurations as part of unit testing. The functions must return the same result for same input. Note that since Expecto also has a FsCheck integration, your outer (sequenced) test could be the property test, generating random data, and your TestCode/function body/ actual test could be an assertion that for the same (random instance) of test data, one function should be faster than the other. From `Expect.isFasterThanSub`, these results are possible (all of which generate a test failure, except the `MetricLessThan` case): ```fsharp type 'a CompareResult = | ResultNotTheSame of result1:'a * result2:'a | MetricTooShort of sMax:SampleStatistics * machineResolution:SampleStatistics | MetricLessThan of s1:SampleStatistics * s2:SampleStatistics | MetricMoreThan of s1:SampleStatistics * s2:SampleStatistics | MetricEqual of s1:SampleStatistics * s2:SampleStatistics ``` You can explore these cases yourself with `Expecto.Performance.timeCompare`, should you wish to. #### Example All of the below tests pass. ```fsharp [<Tests>] let performance = testSequenced <| testList "performance" [ testCase "1 <> 2" <| fun () -> let test () = Expect.isFasterThan (fun () -> 1) (fun () -> 2) "1 equals 2 should fail" assertTestFailsWithMsgContaining "same" (test, Normal) testCase "half is faster" <| fun () -> Expect.isFasterThan (fun () -> repeat10000 log 76.0) (fun () -> repeat10000 log 76.0 |> ignore; repeat10000 log 76.0) "half is faster" testCase "double is faster should fail" <| fun () -> let test () = Expect.isFasterThan (fun () -> repeat10000 log 76.0 |> ignore; repeat10000 log 76.0) (fun () -> repeat10000 log 76.0) "double is faster should fail" assertTestFailsWithMsgContaining "slower" (test, Normal) ptestCase "same function is faster should fail" <| fun () -> let test () = Expect.isFasterThan (fun () -> repeat100000 log 76.0) (fun () -> repeat100000 log 76.0) "same function is faster should fail" assertTestFailsWithMsgContaining "equal" (test, Normal) testCase "matrix" <| fun () -> let n = 100 let rand = Random 123 let a = Array2D.init n n (fun () _ -> rand.NextDouble()) let b = Array2D.init n n (fun () _ -> rand.NextDouble()) let c = Array2D.zeroCreate n n let reset() = for i = 0 to n-1 do for j = 0 to n-1 do c.[i,j] <- 0.0 let mulIJK() = for i = 0 to n-1 do for j = 0 to n-1 do for k = 0 to n-1 do c.[i,k] <- c.[i,k] + a.[i,j] * b.[j,k] let mulIKJ() = for i = 0 to n-1 do for k = 0 to n-1 do let mutable t = 0.0 for j = 0 to n-1 do t <- t + a.[i,j] * b.[j,k] c.[i,k] <- t Expect.isFasterThanSub (fun measurer -> reset(); measurer mulIKJ ()) (fun measurer -> reset(); measurer mulIJK ()) "ikj faster than ijk" testCase "popcount" <| fun () -> let test () = Expect.isFasterThan (fun () -> repeat10000 (popCount16 >> int) 987us) (fun () -> repeat10000 (popCount >> int) 987us) "popcount 16 faster than 32 fails" assertTestFailsWithMsgContaining "slower" (test, Normal) ] ``` A failure would look like this: ``` [13:23:19 ERR] performance/double is faster failed in 00:00:00.0981990. double is faster. Expected f1 (0.3067 ± 0.0123 ms) to be faster than f2 (0.1513 ± 0.0019 ms) but is ~103% slower. ``` ### Performance.findFastest Expecto can use `isFasterThan` to find the fastest version of a function for a given `int` input. This can be useful for optimising algorithm constants such as buffer size. ```fsharp [<Tests>] let findFastest = testSequenced <| testList "findFastest" [ testCase "different values gives an error" (fun _ -> Performance.findFastest id 10 20 |> ignore ) |> assertTestFailsWithMsgStarting "Expected results to be the same." testCase "find fastest sleep" (fun _ -> let f i = Threading.Thread.Sleep(abs(i-65)*10) let result = Performance.findFastest f 0 100 Expect.equal result 65 "find min" ) testCase "find fastest hi" (fun _ -> let f i = Threading.Thread.Sleep(abs(i-110)*10) let result = Performance.findFastest f 0 100 Expect.equal result 100 "find min" ) testCase "find fastest lo" (fun _ -> let f i = Threading.Thread.Sleep(abs(i+10)*10) let result = Performance.findFastest f 0 100 Expect.equal result 0 "find min" ) ] ``` ## `main args` and command line – how to run console apps examples From code you can run: ```fsharp Tests.runTestsInAssemblyWithCLIArgs [Stress 0.1;Stress_Timeout 0.2] [||] ``` From the command line you can run: ``` dotnet run -p Expecto.Tests -f net5.0 -c release -- --help dotnet watch -p Expecto.Tests run -f net5.0 -c release -- --colours 256 ``` ## Contributing and building Please review the [guidelines for contributing](./CONTRIBUTING.md) to Expecto; this document also includes instructions on how to build. We'd specifically like to call out the following people for their great contributions to Expecto in the past: - @mausch — for building Fuchu which became the foundation of Expecto - @AnthonyLloyd — for maintaining Expecto for some years and drastically improving it ## BenchmarkDotNet usage The integration with [BenchmarkDotNet](http://benchmarkdotnet.org/). ```fsharp open Expecto type ISerialiser = abstract member Serialise<'a> : 'a -> unit type MySlowSerialiser() = interface ISerialiser with member __.Serialise _ = System.Threading.Thread.Sleep(30) type FastSerialiser() = interface ISerialiser with member __.Serialise _ = System.Threading.Thread.Sleep(10) type FastSerialiserAlt() = interface ISerialiser with member __.Serialise _ = System.Threading.Thread.Sleep(20) type Serialisers() = let fast, fastAlt, slow = FastSerialiser() :> ISerialiser, FastSerialiserAlt() :> ISerialiser, MySlowSerialiser() :> ISerialiser [<Benchmark>] member __.FastSerialiserAlt() = fastAlt.Serialise "Hello world" [<Benchmark>] member __.SlowSerialiser() = slow.Serialise "Hello world" [<Benchmark(Baseline = true)>] member __.FastSerialiser() = fast.Serialise "Hello world" [<Tests>] let tests = testList "performance tests" [ test "three serialisers" { benchmark<Serialisers> benchmarkConfig (fun _ -> null) |> ignore } ] ``` In the current code-base I'm just printing the output to the console; and by default all tests are run in parallel; so you'll need to use `--sequenced` as input to your exe, or set parallel=false in the config to get valid results. To read more about how to benchmark with BenchmarkDotNet, see its [Getting started](http://benchmarkdotnet.org/GettingStarted.htm) guide. Happy benchmarking! ## You're not alone! Others have discovered the beauty of tests-as-values in easy-to-read F#. * [Logary](https://github.com/logary/logary) * [Unquote has built-in support](https://github.com/SwensenSoftware/unquote/pull/128) * [Visual Studio Plugin for Expecto](https://www.nuget.org/packages/Expecto.VisualStudio.TestAdapter/) – just add the `nuget Expecto.VisualStudio.TestAdapter version_in_path: true` to your paket file and you're off to the races! * [FsCheck supports it](https://fscheck.github.io/FsCheck/QuickStart.html#Integration-with-Expecto)  ### Testing hardware People have been testing hardware with Expecto.  ## Sending e-mail on failure – custom printers The printing mechanism in Expecto is based on the [Logary Facade](https://github.com/logary/logary#the-logary-facade-adapter), which grants some privileges, like being able to use **any** Logary target to print. Just follow the above link to learn how to initialise Logary. Then if you wanted to get notified over e-mail whenever one of your tests fail, configure Logary with `Logary.Targets.Mailgun`: ```fsharp open Logary open Logary.Configuration open Logary.Adapters.Facade open Logary.Targets open Hopac open Mailgun open System.Net.Mail let main argv = let mgc = MailgunLogaryConf.Create( MailAddress("[email protected]"), [ MailAddress("[email protected]") ], { apiKey = "deadbeef-2345678" }, "example.com", // sending domain of yours Error) // cut-off level use logary = withLogaryManager "MyTests" ( withTargets [ LiterateConsole.create LiterateConsole.empty "stdout" Mailgun.create mgc "mail" ] >> withRules [ Rule.createForTarget "stdout" Rule.createForTarget "mail" ]) |> run // initialise Logary Facade with Logary proper: LogaryFacadeAdapter.initialise<Expecto.Logging.Logger> logary // run all tests Tests.runTestsInAssemblyWithCLIArgs [] argv ``` ## About test parallelism Since the default is to run all of your tests in parallel, it's important that you don't use global variables, global singletons or mutating code. If you do, you'll have to slow down all of your tests by sequencing them (or use locks in your testing code). Furthermore, `printfn` and sibling functions aren't thread-safe, i.e. a given string may be logged in many passes and concurrent calls to printfn and Console.X-functions have their outputs interleaved. If you want to log from tests, you can use code like: ```fsharp open Expecto.Logging open Expecto.Logging.Message let logger = Log.create "MyTests" // stuff here testCase "reading prop" <| fun () -> let subject = MyComponent() // this will output to the right test context: logger.info( eventX "Has prop {property}" >> setField "property" subject.property) Expect.equal subject.property "Goodbye" "Should have goodbye as its property" ``` ### What does 'expected to have type TestCode' mean? If you get an error message like this: ``` This expression was expected to have type 'TestCode' but here has type 'unit' ``` It means that you have code like `testCase "abc" <| Expect.equal ...`. Instead you should create a function like so: `testCase "abc" <| fun () -> Expect.equal ...`. ### My tests are hanging and I can't see why This might be due to how terminals/the locking thereof work: try running your tests with `--no-spinner` and see if that works.  [logary]: https://github.com/logary/logary#using-logary-in-a-library

A collection of public resources about how software companies test their software

# How They Test [](http://makeapullrequest.com) > A curated collection of publicly available resources on how software companies around the world test their software systems and build their quality culture. ## Foreword One of the outcomes of the various [Taqelah](https://www.facebook.com/groups/148322462547482/) meetups was that many software companies got to share their testing and quality culture with the community. It was absolutely fantastic to see the amazing stuff companies are doing to test their software, and ensure quality of their products and platforms. Apart from this, many companies regularly come forward and share their best practices, tools, techniques and culture of software testing on various public platforms like conferences, blogs & meetups. The resources are there but dispersed, lost into the internet. There is no single knowledge repository that gives a direct look at these best practices, tools, techniques and culture of software testing these companies adopt. This repository intends to do that. Happy Learning! *Please note, that all the resources mentioned here are publicly available resources.* ## Kind of topics here Testing / quality of software goes beyond traditional activities of pre-release functional testing and test automation. Hence the kind of topics you can expect to read about here are: - Functional testing - Non-functional testing - Test automation - Testing in CI/CD - Release management and it's impact on quality/testing. - Quality processes and culture - Testing in production (monitoring/observability, chaos engineering, site reliability engineering etc.) - Customer / user support - User research / user testing from product/UX perspective ## Companies & how they test their software <details> <summary>ACV Auctions</summary> #### Blogs * [Scaling Quality at ACV](https://acv.engineering/posts/scaling-quality-at-acv/) </details> <details> <summary>Adore Me</summary> #### Blogs * [Android and iOS application testing with appium and wiremock - intro](https://adoreme.tech/android-and-ios-app-testing-with-appium-and-wiremock-intro-fe1dc34f0fc) * [Android and iOS application testing with appium and wiremock - setup](https://adoreme.tech/android-and-ios-app-testing-with-appium-and-wiremock-the-setup-640bd0863b2d) * [Android and iOS application testing with appium and wiremock - all together](https://adoreme.tech/android-and-ios-app-testing-with-appium-and-wiremock-appium-wiremock-cfb89cd52afe) * [UI Testing: A deep dive in (apparently) shallow water](https://adoreme.tech/ui-testing-a-deep-dive-in-apparently-shallow-water-af677a0f6100) </details> <details> <summary>Airbnb</summary> #### Blogs * [Testing at Airbnb](https://medium.com/airbnb-engineering/testing-at-airbnb-199f68a0a40d?_branch_match_id=611046764098403464) * [Better Android Testing Part 1](https://medium.com/airbnb-engineering/better-android-testing-at-airbnb-3f5b90b9c40a) * [Better Android Testing Part 2](https://medium.com/airbnb-engineering/better-android-testing-at-airbnb-a77ac9531cab) * [Better Android Testing Part 3](https://medium.com/airbnb-engineering/better-android-testing-at-airbnb-1d1e91e489b4) * [Better Android Testing Part 4](https://medium.com/airbnb-engineering/better-android-testing-at-airbnb-part-4-testing-viewmodels-550d929126c8) * [Better Android Testing Part 5](https://medium.com/airbnb-engineering/better-android-testing-at-airbnb-661a554a8c8b) * [Better Android Testing Part 6](https://medium.com/airbnb-engineering/better-android-testing-at-airbnb-a11f6832773f) * [Better Android Testing Part 7](https://medium.com/airbnb-engineering/better-android-testing-at-airbnb-eacec3a8a72f) * [Building an effective test pipeline in a service oriented architecture](https://medium.com/airbnb-engineering/building-an-effective-test-pipeline-in-a-service-oriented-world-6968c513c6bd) * [Tracking the money scaling financial reporting](https://medium.com/airbnb-engineering/tracking-the-money-scaling-financial-reporting-at-airbnb-6d742b80f040) </details> <details> <summary>Amazon</summary> #### Blogs & Articles * [How does Amazon get by with so few hours spent by its QA teams relative to Microsoft?](https://docs.microsoft.com/en-us/archive/blogs/seliot/software-testing-cage-match-amazon-com-vs-microsoft) * [How Amazon handles a new software deployment every second](https://www.zdnet.com/article/how-amazon-handles-a-new-software-deployment-every-second/) * [How is software developed at Amazon](http://highscalability.com/blog/2019/3/4/how-is-software-developed-at-amazon.html) * [Amazon's approach to automated testing](https://medium.com/@twikstro/amazons-approach-to-automated-testing-at-re-invent-2019-ad2d49dc9a1f) * [Automated testing for Alexa](https://developer.amazon.com/en-US/blogs/alexa/alexa-skills-kit/2018/08/unit-testing-create-functional-alexa-skills) * [Best practices for testing your Alexa skills](https://developer.amazon.com/blogs/alexa/post/66232175-530c-4f52-890e-60b21db73d84/best-practices-for-testing-your-alexa-skills) #### Videos * [Testing and Troubleshooting with AWS Device Farm](https://www.youtube.com/watch?v=zej5tdLMo3Y) * [Proactive security testing at AWS](https://www.youtube.com/watch?v=iyNDEAs8hRk) * [Advanced Continuous Delivery Best Practices at Amazon](https://www.youtube.com/watch?v=Jnl29J3RJQ4) * [UI, Load and Performance testing at Amazon](https://www.youtube.com/watch?v=UVS4CQvO4_M) * [Best Practices for Benchmarking and Performance Analysis in the Cloud](https://www.youtube.com/watch?v=__tT5de64cI) * [Large Scale Load Testing Amazon.com's Traffic on AWS](https://www.youtube.com/watch?v=pgnQQoTMBhI) * [Chaos Engineering on AWS](https://www.youtube.com/watch?v=B1nUzbuVEUs) * [Continuous Integration best practices for software development](https://www.youtube.com/watch?v=GEPJ7Lo346A) </details> <details> <summary>Appian</summary> #### Blogs & Articles * [A look inside the quality engineering team at Appian](https://careers.appian.com/blog/engineering-and-product/a-look-inside-the-quality-engineering-team-at-appian/) * [Dogfooding Appian](https://careers.appian.com/blog/the-tech-corner/dogfooding-appian/) * [Chaos Testing a Distributed System with Jepsen](https://careers.appian.com/blog/the-tech-corner/chaos-testing-a-distributed-system-with-jepsen/) * [Chaos Testing a Distributed System with Jepsen — Part II](https://careers.appian.com/blog/the-tech-corner/chaos-testing-a-distributed-system-with-jepsen-part-ii/) * [Chaos Testing a Distributed System with Jepsen — Part III](https://careers.appian.com/blog/the-tech-corner/chaos-testing-a-distributed-system-with-jepsen-part-iii/) * [My Journey as a Quality Engineer Intern at Appian](https://careers.appian.com/blog/early-careers-and-internships/my-journey-as-a-quality-engineer-intern-at-appian/) * [Women in Tech: Meet 3 Quality Engineers At Appian](https://careers.appian.com/blog/engineering-and-product/women-in-tech-meet-3-quality-engineers-at-appian/) * [What Does “Quality Assurance” Mean in an Agile World?](https://careers.appian.com/blog/the-tech-corner/what-does-quality-assurance-mean-in-an-agile-world-1/) </details> <details> <summary>Apple</summary> #### Blogs & Articles * [Apple overhauling it's testing approach](https://www.bloomberg.com/news/articles/2019-11-21/apple-ios-14-features-changes-testing-after-ios-13-bugs) * [Testing Your Apps in Xcode](https://developer.apple.com/documentation/xcode/testing-your-apps-in-xcode) #### Videos * [Testing in XCode - WWDC](https://developer.apple.com/videos/play/wwdc2019/413/) * [UI testing in XCode - WWDC](https://developer.apple.com/videos/play/wwdc2015/406/) * [Advanced Testing and Continuous Integration - WWDC](https://developer.apple.com/videos/play/wwdc2016/409/) * [Engineering for Testability - WWDC](https://developer.apple.com/videos/play/wwdc2017/414/) * [What's new in testing - WWDC](https://developer.apple.com/videos/play/wwdc2018/403/) * [Testing tips & tricks - WWDC](https://developer.apple.com/videos/play/wwdc2018/417/) </details> <details> <summary>ASOS</summary> #### Blogs * [How to go about front-end testing with Cypress.io — a success story](https://medium.com/asos-techblog/how-to-go-about-front-end-testing-with-cypress-io-a-success-story-898451ff1c79) * [Automated security testing using language you already know](https://medium.com/asos-techblog/automated-security-testing-using-language-you-already-know-60b968d55cec) * [Behaviour driven automation testing in .NET Core using BDTest](https://medium.com/asos-techblog/behaviour-driven-automation-testing-in-net-core-using-bdtest-685b55d73d93) * [My Testing Safari](https://medium.com/asos-techblog/my-testing-safari-9a50cea3981b) * [Begin with the end in mind: one team’s journey towards Continuous Integration](https://medium.com/asos-techblog/begin-with-the-end-in-mind-one-teams-journey-towards-continuous-integration-ed1f3a74ba3c) * [Gaining confidence in automated checks](https://medium.com/asos-techblog/begin-with-the-end-in-mind-gaining-confidence-in-our-automated-checks-88b2e40590c5) * [Witness the (Android) fitness](https://medium.com/asos-techblog/witness-the-android-fitness-d4ae52dfec94) * [How to test your React · Redux application](https://medium.com/asos-techblog/how-to-test-your-react-redux-application-48d90481a253) * [How to write acceptance tests for a Facebook Messenger bot](https://medium.com/asos-techblog/how-to-write-acceptance-tests-for-a-facebook-messenger-bot-2d869ec268d3) * [An introduction to Pact testing in .Net Core](https://medium.com/asos-techblog/pact-testing-in-net-core-6bfc5b0e9131) * [Finding balance as a Testing Specialist](https://medium.com/asos-techblog/finding-balance-as-a-testing-specialist-51f61d95b944) * [Continuous Testing in Customer Experience @ ASOS](https://medium.com/asos-techblog/continuous-testing-in-customer-experience-asos-d75b0f968bc9) * [Responsive website testing with Sizzy](https://medium.com/asos-techblog/responsive-website-testing-with-sizzy-bab1e0d7c5b6) * [Testing authorisation scenarios in ASP.NET Core Web APIs](https://medium.com/asos-techblog/testing-authorization-scenarios-in-asp-net-core-web-api-484bc95d5f6f) #### Videos [Enhancing the Processes of Test Driven Development - Talk](https://www.youtube.com/watch?v=IpBXhOzoPsU) </details> <details> <summary>Atlassian</summary> #### Blogs & Articles * [Quality assistance: how Atlassian does QA](https://www.atlassian.com/inside-atlassian/qa) * [Moving from quality assurance to quality assistance](https://www.atlassian.com/inside-atlassian/quality-assurance-vs-quality-assistance) * [Developing quality assistance skills](https://www.atlassian.com/inside-atlassian/software-QA-skills) * [Quality Health Monitor: Gauging your team’s quality maturity](https://www.atlassian.com/inside-atlassian/quality-health-monitor) * [Automated testing: 5 lessons from Atlassian’s Kubernetes team on testing infrastructure as code](https://www.atlassian.com/engineering/automated-testing-5-lessons-from-atlassians-kubernetes-team-on-testing-infrastructure-as-code) #### Videos * [Meet the Atlassian QE team](https://www.youtube.com/watch?v=3IvRSrvGJ1g) * [The Future of QA at Atlassian - Atlassian Summit 2016](https://www.youtube.com/watch?v=9giJYYag6wQ) * [Quality at Speed, How JIRA Does QA](https://www.youtube.com/watch?v=yRP29wFqu20) * [Verifying Microservice Integrations with Contract Testing](https://www.youtube.com/watch?v=-6x6XBDf9sQ) * [Agile Testing: It's about time - Atlassian Summit 2011](https://www.youtube.com/watch?v=dYFzehMukAc) * [Finding bugs before writing code - Sigge Birgisson](https://www.youtube.com/watch?v=Ix61aEREKNU) * [Code Reviews vs. Pull Requests - Atlassian Summit 2016](https://www.youtube.com/watch?v=6qKpbWyb6tg) * [Mock Servers - Fake all the things! - Peggy Kuo](https://www.youtube.com/watch?v=lk4-UYD3KC4) * [Quality at Speed](https://www.youtube.com/watch?v=w5MN1JWRM1I) * [Improving Software Quality with Effective Feedback - Atlassian Summit 2012](https://www.youtube.com/watch?v=3MomT1nNOnQ) </details> <details> <summary>Automattic (Wordpress)</summary> #### Videos * [Your Tests Aren't Flaky. GTAC 2015](https://www.youtube.com/watch?v=hmk1h40shaE&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=10), [Slides](https://docs.google.com/presentation/d/1L9hGYqCAgjZyXE9ch4Toh4ziuYYkB2OiMCdFpgfTko0/pub) </details> <details> <summary>Basecamp</summary> #### Videos * [Testing without test damage or excessive isolation](https://www.youtube.com/watch?v=5hN6OZDyQtk) </details> <details> <summary>BBC</summary> #### Blogs & Articles * [10x your collaboration on writing tests - Part 1: Understanding](https://www.bbc.co.uk/blogs/internet/entries/ecedc9af-4bc8-4fb3-9cd3-754a85a1ce19) * [10 guidelines on readability and consistency when writing Integration Tests](https://www.bbc.co.uk/blogs/internet/entries/e9356c0f-cf17-4ccc-bb05-2fa5d13fa289) * [Maintaining Mobile: Update on Mobile Compatibility Programme](https://www.bbc.co.uk/blogs/internet/entries/4bc791fd-ff24-4c82-ab24-16dfa1bba3c8) * [Improving test automation with PUMA](https://www.bbc.co.uk/blogs/internet/entries/ba0c030e-d031-4ab6-8ba6-3afe41807b55) * [Test Automation with PhantomJS, Grunt and Friends](https://www.bbc.co.uk/blogs/internet/entries/a456cf81-a154-3082-a726-d13f4f28ee23) * [Behaviour Driven Development: Tips for writing better feature files](https://www.bbc.co.uk/blogs/internet/entries/ff14236d-098a-3565-b678-ff4ba5776a5f) * [Testing BBC Connected Red Button](https://www.bbc.co.uk/blogs/internet/entries/41a89085-ab51-3454-a3a2-22799b0bfd50) * [Automating testing for BBC iPlayer mobile part one: 3 Amigos](https://www.bbc.co.uk/blogs/internet/entries/36670ed6-d3f9-3610-aaf6-e55ed3663eb1) * [Automating testing for BBC iPlayer mobile part two: automation](https://www.bbc.co.uk/blogs/internet/entries/3da2f879-b752-3ee7-8778-421aad2ddefb) * [Automating BBC iPlayer mobile testing part three: legacy vs new features](https://www.bbc.co.uk/blogs/internet/entries/b3f9264f-c88b-3a48-9b39-a0a6398108cc) * [Testing BBC iPlayer Mobile App](https://www.bbc.co.uk/blogs/internet/entries/ee74c1c5-91f0-34a8-b267-bd00b52a2d07) * [New BBC iPlayer: internal testing of user journeys](https://www.bbc.co.uk/blogs/internet/entries/b6b17932-326e-3ad1-9d1d-4318fd4ec277) * [Testing mobiles: Mobile Compatibility Program](https://www.bbc.co.uk/blogs/internet/entries/96d29a45-cbb5-3cf6-8d73-ef29882d1d01) * [Testing BBC iPlayer: Krispy Gherkin feature file aggregator](https://www.bbc.co.uk/blogs/internet/entries/d1a1d55b-30b7-32ea-93dc-5f5c9a47447c) * [Testing BBC iPlayer: reading XML, JSON response into Java](https://www.bbc.co.uk/blogs/internet/entries/f853c875-880f-356b-bf12-966de30bc58f) * [Testing BBC iPlayer Release For Android Downloads](https://www.bbc.co.uk/blogs/internet/entries/67c6f28f-3742-3725-9efa-10107857d5e8) * [Testing for BBC Online: The creation of the POD Test Group](https://www.bbc.co.uk/blogs/internet/entries/a1d07db6-64bb-3225-966a-304405b06349) #### Videos * [BBC College of Technology: Develop conference videos](https://www.bbc.co.uk/blogs/internet/entries/25e3af59-ccd9-45af-85ae-7059a797c3e1) * [GTAC 2016: Scale vs Value: Test Automation at the BBC, GTAC 2016](https://youtu.be/MkPHntWZAPc?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1_bNn_HTI1Vst6WAB62KHTtgbvxocjpnt2Y-8ugGyP8U/edit#slide=id.p497) </details> <details> <summary>Box</summary> #### Videos * [GTAC 2016: ClusterRunner: making fast test-feedback easy through horizontal scaling](https://youtu.be/V7fhx1i4qPE?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1_bNn_HTI1Vst6WAB62KHTtgbvxocjpnt2Y-8ugGyP8U/edit#slide=id.p359) </details> <details> <summary>Bumble</summary> #### Blogs & Articles * [Bumble Tech Blog - QA](https://medium.com/bumble-tech/tagged/qa) * [How 3 Process Patterns will change the way you do Test Automation](https://medium.com/bumble-tech/how-3-process-patterns-will-change-the-way-you-do-test-automation-277acc0d3171) * [Checking your app’s paid services without losing money](https://medium.com/bumble-tech/checking-your-apps-paid-services-without-losing-money-ba5558a6260) * [Add Superpowers to your Appium-Android tests](https://medium.com/bumble-tech/add-superpowers-to-your-appium-android-tests-f408ac2f1b59) * [A monolithic architecture for our clients’ hundreds of versions: how we write and support tests](https://medium.com/bumble-tech/a-monolithic-architecture-for-our-clients-hundreds-of-versions-how-we-write-and-support-tests-php-e8fe0b79c0bc) * [White-box testing with Appium Espresso Driver](https://medium.com/bumble-tech/white-box-testing-with-appium-espresso-driver-f51cda81c1bb) * [Catching bugs on the client-side: how we developed our error tracking system](https://medium.com/bumble-tech/catching-bugs-on-a-client-48c793720b9b) #### Videos * [The Joy Of Green Builds - Running Tests Smartly](https://confengine.com/conferences/selenium-conf-2020/proposal/13749/the-joy-of-green-builds-running-tests-smartly) * [Uncover Secrets of Your App with EspressoDriver](https://www.youtube.com/watch?v=3E-koZaG60w) * [Application Backdoor via Appium](https://www.youtube.com/watch?v=qHU5Q-BWH4k) * [Automate the impossible: blending the best of Android drivers](https://www.youtube.com/watch?v=dKHudzto4TM&t=17s) * [Why do we do Test Automation Internal Mentorships for our QA Engineers?](https://youtu.be/fC7lqn-uwwQ?t=3335) * [iOS Parallel Automation: run faster than fast](https://www.youtube.com/watch?v=bAH4hky-1Ac) * [How we saved time by teaching developers to test their own code](https://www.youtube.com/watch?v=bFR2iQPW-b0) </details> <details> <summary>Canva</summary> #### Blogs & Articles * [Why we left manual UI testing behind](https://canvatechblog.com/why-we-left-manual-ui-testing-behind-293b98a58183) * [Recommender systems: When they fail, who are you gonna call?](https://canvatechblog.com/recommender-systems-when-they-fail-who-are-you-gonna-call-3377d21534ee) * [Speeding up UI tests with CodeceptJS and Playwright](https://canvatechblog.com/speeding-up-ui-tests-with-codeceptjs-and-playwright-98daf6cb8a79) * [Testing Search Engine Optimization Scalably without Breaking a Sweat](https://canvatechblog.com/testing-search-engine-optimization-scalably-without-breaking-a-sweat-8f91ccfc451d) #### Videos * [User Testing: Finding That One Thing Meatloaf Won't Do For Love](https://www.youtube.com/watch?v=7FopNNQr2hY) * [Visual regression testing: why, what and how](https://youtu.be/fhVnTNyfUgs) </details> <details> <summary>CapitalOne</summary> #### Blogs and Articles * [Improvement and Parallelization of Android Automation Testing](https://medium.com/capital-one-tech/improvement-and-parallelization-of-android-automation-testing-capital-one-a05d10cae5b6) * [9 Things I Wish I Knew About Automated Software Testing Before I Started My Career](https://medium.com/capital-one-tech/9-things-i-wish-i-knew-about-automated-software-testing-before-i-started-my-career-69d2301d6b92) * [Improve Java Code Coverage and Quality with Unit Tests and JaCoCo](https://medium.com/capital-one-tech/improve-java-code-with-unit-tests-and-jacoco-b342643736ed) * [Learning To Love Automated Testing](https://medium.com/capital-one-tech/automated-tests-that-saved-me-2d38b7cb265b) * [Robot Pattern Testing for XCUITest](https://medium.com/capital-one-tech/robot-pattern-testing-for-xcuitest-4c2f0c40b4ad) * [Unit Testing Behavior of React Components with Test-Driven Development](https://medium.com/capital-one-tech/unit-testing-behavior-of-react-components-with-test-driven-development-ae15b03a3689) * [No Testing Strategy, No DevOps](https://medium.com/capital-one-tech/no-testing-strategy-no-devops-915287e1b4fd) * [Spec to Gherkin to Code](https://medium.com/capital-one-tech/spec-to-gherkin-to-code-902e346bb9aa) * [Blackbox API Testing With Kotlin for RESTful Microservices](https://medium.com/capital-one-tech/blackbox-api-testing-with-kotlin-for-restful-microservices-183adc2b8088) * [Performance Testing of Event-Driven Microservices](https://medium.com/capital-one-tech/performance-testing-of-event-driven-microservices-f5de74305985) * [Software Quality Testing: Creating Quality Filtration Stacks](https://medium.com/capital-one-tech/software-quality-testing-creating-quality-filtration-stacks-capital-one-b841afa6d70c) * [Testcontainers & LocalStack for Spring Boot Functional Tests](https://medium.com/capital-one-tech/testcontainers-localstack-for-spring-boot-functional-tests-c4c8d06dae88) * [Automated Detection, Diagnosis & Remediation of App Failure](https://medium.com/capital-one-tech/automated-detection-diagnosis-remediation-of-app-failure-9ee24fb97a35) * [Using Stub vs Mock in iOS Unit Testing](https://medium.com/capital-one-tech/using-stub-vs-mock-in-ios-unit-testing-634ec4cc6a10) * [Software Quality Testing: Creating Quality Filtration Stacks](https://medium.com/capital-one-tech/software-quality-testing-creating-quality-filtration-stacks-capital-one-b841afa6d70c) * [Using Apple’s Main Thread Checker Tool on UI Tests](https://medium.com/capital-one-tech/using-apples-main-thread-checker-tool-on-ui-tests-a89508bcd524) * [Marginal Utility and Taco Consumption](https://medium.com/capital-one-tech/marginal-utility-and-taco-consumption-762ca42afbf0) * [Spec to Gherkin to Code](https://medium.com/capital-one-tech/spec-to-gherkin-to-code-902e346bb9aa) * [Test-Driven Development –Ready, Set, Go with Google Cloud Test Lab](https://medium.com/capital-one-tech/be-ready-for-tdd-google-cloud-test-lab-20b07ddabc8b) * [Shifting Testing in Agile Teams to the Left](https://medium.com/capital-one-tech/shifting-testing-in-agile-teams-to-the-left-5f3a3d647a41) * [Getting Started With iOS UI Testing](https://medium.com/capital-one-tech/getting-started-with-ios-ui-testing-b85bf858496f) #### Videos * [GTAC 2016: What’s in your Wallet?](https://youtu.be/SF7F26E7l1I?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM) * [SauceCon 2017: FROM MANUAL TO CI/CD - THE JOURNEY OF A BOY AND HIS TOOLS - Gregory Schmidt](https://www.youtube.com/watch?v=LiB0HTL2VRQ) </details> <details> <summary>Carousell</summary> #### Blogs & Articles * [Prabhagharan DK : Building our inhouse virtual device lab "caroufarm"](https://medium.com/carousell-insider/building-our-in-house-virtual-device-lab-caroufarm-e72911e4593b) * [Martin Schneider : Automated end-to-end tests and how they fit into our testing culture](https://medium.com/carousell-insider/automated-end-to-end-tests-and-how-they-fit-into-our-testing-culture-54c3fcc5ff26) * [Carousell scales app automation with Browserstack](https://www.browserstack.com/case-study/carousell-scales-app-automation-with-browserstack) #### Videos * [HUSTEF 2019 - By Syam Sasi & Martin Schneider - Building a scalable device lab with Ansible at Carousell](https://www.youtube.com/watch?v=ntRd0tiMZdE) * [Carousell's automation journey with BrowserStack by Prabhgharan DK and Syam Sasi](https://www.youtube.com/watch?v=hRO5Hg-cRz8) * [End-end test code as first class citizens by Abhijeet Vaikar](https://www.youtube.com/watch?v=Iv7b4sJgzik&ab_channel=ConfEngine) - Covers some practices adopted at Carousell for quality of end-end test code. </details> <details> <summary>Cazoo</summary> #### Blogs & Articles * [Whole Team Quality at Cazoo](https://medium.com/cazoo/whole-team-quality-at-cazoo-14ad5d65f2b5) </details> <details> <summary>Deliveroo</summary> #### Blogs * [Testing Go services using interfaces](https://deliveroo.engineering/2019/05/17/testing-go-services-using-interfaces.html) * [Testing with Third Party Services in Go](https://deliveroo.engineering/2018/09/11/testing-with-third-parties-in-go.html) </details> <details> <summary>Disney+ Hotstar</summary> #### Blogs & Articles * [Machine Vision in Test Automation](https://blog.hotstar.com/machine-vision-in-test-automation-5ab8682254ba) * [Machine Vision For Test Automation — Part Two](https://blog.hotstar.com/machine-vision-for-test-automation-part-2-70769e8b768a) * [Using Apple's Testing Mjölnir: XCUITest](https://blog.hotstar.com/using-apples-testing-mj%C3%B6lnir-xcuitest-9c3bad88ae4b) * [Closed Loop API Test Automation](https://blog.hotstar.com/effective-api-testing-and-synthetic-monitoring-strategies-6bb1f69f13de) </details> <details> <summary>Dollar Shave Club</summary> #### Blogs * [How Dollar Shave Club 3x'd velocity and learned to love their tests](https://circleci.com/blog/how-dollar-shave-club-3x-d-velocity-and-learned-love-tests) * [QA Environments on Demand with Kubernetes](https://engineering.dollarshaveclub.com/qa-environments-on-demand-with-kubernetes-5a571b4e273c) </details> <details> <summary>DoorDash</summary> #### Blogs * [Using Fault Injection Testing to Improve DoorDash Reliability](https://doordash.engineering/2022/04/25/using-fault-injection-testing-to-improve-doordash-reliability/) * [Moving e2e testing into production with multi-tenancy for increased speed and reliability](https://doordash.engineering/2022/03/03/moving-e2e-testing-into-production-with-multi-tenancy-for-increased-speed-and-reliability/) * [A Framework For Speedy and Scalable Development Of Android UI Tests](https://doordash.engineering/2020/08/19/speedy-and-scalable-development-of-android-mobile-ui-tests/) * [Contract Testing with Pact](https://doordash.engineering/2018/11/05/contract-testing-with-pact/) </details> <details> <summary>Dream11</summary> #### Blogs & Articles * [Finding Order in Chaos: How We Automated Performance Testing with Torque](https://about.dream11.in/blog/2020/12/finding-order-in-chaos-how-we-automated-performance-testing-with-torque) </details> <details> <summary>Dropbox</summary> #### Blogs & Articles * [Offensive testing to make Dropbox (and the world) a safer place](https://dropbox.tech/security/offensive-testing-to-make-dropbox-and-the-world-a-safer-place) * [Accelerating Iteration Velocity on Dropbox’s Desktop Client, Part 1](https://dropbox.tech/application/accelerating-iteration-velocity-on-dropboxs-desktop-client-part-1) * [Accelerating Iteration Velocity on Dropbox’s Desktop Client, Part 2](https://dropbox.tech/application/accelerating-iteration-velocity-on-dropboxs-desktop-client-part-2) * [Two years at Dropbox](https://chadaustin.me/2019/11/two-years-at-dropbox/) * [Creating a culter of accessibility](https://dropbox.tech/frontend/creating-a-culture-of-accessibility) * [Finding Kafka’s throughput limit in Dropbox infrastructure](https://dropbox.tech/infrastructure/finding-kafkas-throughput-limit-in-dropbox-infrastructure) * [Athena: Our automated build health management system](https://dropbox.tech/infrastructure/athena-our-automated-build-health-management-system) * [The Programmer Mindset: Main Debug Loop](https://dropbox.tech/frontend/the-programmer-mindset-main-debug-loop) * [Testing sync at Dropbox](https://dropbox.tech/infrastructure/-testing-our-new-sync-engine) #### Videos * [Integration testing with Bazel](https://www.youtube.com/watch?v=muvU1DYrY0w) * [Virtualizing Mac Infrastructure at Scale: A CI Case Study with Dropbox and MacStadium](https://www.youtube.com/watch?v=oBVB0Tc_drM) * [GTAC 2014: Scalable Continuous Integration - Using Open Source](http://www.youtube.com/watch?v=eax-t5LBJiY&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/dzoYNC) </details> <details> <summary>Duolingo</summary> #### Blogs & Articles * [The process: Launching Duolingo’s Arabic language course - Increment magazine](https://increment.com/testing/launching-duolingos-arabic-language-course/) - How the language-learning app used staggered releases, dogfooding, and a culture of A/B testing everything to ship its first Arabic course for English speakers. </details> <details> <summary>eBay</summary> #### Blogs & Articles * [Tiered Test Automation](https://tech.ebayinc.com/engineering/tiered-test-automation/) * [Becoming a World-Class Tester](https://tech.ebayinc.com/engineering/becoming-a-world-class-tester/) * [Early Detection of Frontend Single Points of Failure](https://tech.ebayinc.com/engineering/early-detection-of-frontend-single-points-of-failure/) * [eBay Motors: Screenshot Testing with Flutter](https://tech.ebayinc.com/engineering/ebay-motors-screenshot-testing-with-flutter/) * [Discovering Continuous Automation With Request Mirroring](https://tech.ebayinc.com/engineering/discovering-continuous-automation-with-request-mirroring/) * [Failbot—Improving Visibility on End-to-end Tests](https://tech.ebayinc.com/engineering/failbot/) * [Your Own Spring Test Context](https://tech.ebayinc.com/engineering/your-own-spring-test-context/) * [GUI Testing Powered by Deep Learning](https://tech.ebayinc.com/research/gui-testing-powered-by-deep-learning/) * [Integration Testing with React and Enzyme](https://tech.ebayinc.com/engineering/integration-testing-with-react-and-enzyme/) * [Introducing Regressr - An Open Source Command Line Tool to Regression Test HTTP Services](https://tech.ebayinc.com/engineering/introducing-regressr-an-open-source-command-line-tool-to-regression-test-http-services/) * [eBay Releases Dynamic Application Security Testing Proxy as Open Source](https://tech.ebayinc.com/engineering/ebay-releases-dynamic-application-security-testing-proxy-as-open-source/) * [Scalable and Nimble Continuous Integration for Hadoop Projects](https://tech.ebayinc.com/engineering/scalable-and-nimble-continuous-integration-for-hadoop-projects/) * [Functional iOS Testing in Swift](https://tech.ebayinc.com/engineering/functional-ios-testing-in-swift/) * [Next-generation BDD: From Automated Web Tests to Automated Web Acceptance Testing](https://tech.ebayinc.com/engineering/next-generation-bdd-from-automated-web-tests-to-automated-web-acceptance-testing/) * [Validating Hadoop Platform Releases](https://tech.ebayinc.com/engineering/validating-hadoop-platform-releases/) * [Finding Usability Bugs with Automated Tests](https://queue.acm.org/detail.cfm?id=1925091) * [100% test coverage is not enough](https://ebaytech.berlin/100-percent-test-coverage-is-not-enough-3d733551bc3f) * [Ensuring Software Quality at eBay Denmark](https://www.infoq.com/news/2020/08/software-quality-ebay-denmark/) * [Software Quality: Elevating the Game](https://tech.ebayinc.com/engineering/software-quality-elevating-the-game/) #### Videos * [Lightning talk at Selenium Conf about their test automation framework Breeze](https://youtu.be/RwiF4eCqiI0?t=18) * [Applied Testing Heuristics in the Context of eBay](https://www.youtube.com/watch?v=YuBpYFIa3Mc) * [Test automation for Android testing](https://www.youtube.com/watch?v=VZP6aZq8I-k) * [Implementing Test Automation in Agile Projects with Open Source Tools](https://www.youtube.com/watch?v=9YxSski7Tac) * [Test Automation - 10 (sometimes painful) Lessons Learned](https://www.youtube.com/watch?v=tJ0O8p5PajQ) * [Parallizing UI tests on iOS](https://www.youtube.com/watch?v=-JMMujEaqvs) * [Bingsheng Ru — How to build Automation Test as a Service for large-scale e-commerce website](https://www.youtube.com/watch?v=53CBISohOWc) * [How we build & test software at eBay DE](https://www.youtube.com/watch?v=RhTBOl61QyI) </details> <details> <summary>Elsevier</summary> #### Blogs & Articles * [Quality Engineering at Elsevier](https://www.linkedin.com/pulse/quality-engineering-elsevier-thomas-goodman) </details> <details> <summary>Etsy</summary> #### Handbook * [Teaching Testing: Our Testing 101 Materials](https://codeascraft.com/2014/08/20/teaching-testing-our-testing-101-materials/) #### Blogs & Articles * [Culture of Quality: Measuring Code Coverage at Etsy](https://codeascraft.com/2018/02/15/culture-of-quality-measuring-code-coverage-at-etsy/) * [Quality Matters: The Benefits of QA-Focused Retros](https://codeascraft.com/2016/02/08/quality-matters-the-benefits-of-qa-focused-retros/) * [Divide and Concur](https://codeascraft.com/2011/04/20/divide-and-concur/) * [Etsy’s Journey to Continuous Integration for Mobile Apps](https://codeascraft.com/2014/02/28/etsys-journey-to-continuous-integration-for-mobile-apps/) * [Etsy’s Device Lab](https://codeascraft.com/2013/08/09/mobile-device-lab/) * [What’s the value of transparency in testing and deployment?, Increment Magazine](https://increment.com/testing/ask-an-expert-transparency-testing/) * [Mutation Testing: A Tale of Two Suites](https://codeascraft.com/2020/08/17/mutation-testing-a-tale-of-two-suites/) </details> <details> <summary>Everon</summary> #### Blogs & Articles * [AngularJS and UI-Router testing — the right way, Part 1](https://medium.com/everon-engineering/angularjs-and-ui-router-testing-the-right-way-part-1-c165c4565549) * [AngularJS and UI-Router testing — the right way, Part 2](https://medium.com/everon-engineering/angularjs-and-ui-router-testing-the-right-way-part-2-ba5fbdb03e84) * [Contract testing in Everon](https://medium.com/everon-engineering/contract-testing-in-everon-751e739038eb) </details> <details> <summary>Expedia</summary> #### Blogs & Articles * [How Expedia.com Uses Accessibility Automation](https://medium.com/expedia-group-tech/how-expedia-com-uses-accessibility-automation-d3de3e3ff775) * [Improving iOS UI Testing](https://medium.com/expedia-group-tech/improving-ios-ui-testing-ad55470825b4) * [Unit Testing Apache Spark Applications using Hive Tables](https://medium.com/expedia-group-tech/unit-testing-apache-spark-applications-using-hive-tables-ec653c6f25be) * [The Cost of 100% Reliability](https://medium.com/expedia-group-tech/the-cost-of-100-reliability-ecb2901f23a4) * [Getting started with a Dockerized Selenium Grid in your On-Prem Data Centers](https://medium.com/expedia-group-tech/getting-started-with-a-dockerized-selenium-grid-on-your-on-prem-data-centers-5b472a2d35a) * [DA Kube — Selenium Grid using Kubernetes, Docker, Helm and Traefik](https://medium.com/expedia-group-tech/da-kube-selenium-grid-using-kubernetes-docker-helm-and-traefik-856b802d1d08) * [Distributed Automation: How to run 1000 UI Automation Tests in 5mins](https://medium.com/expedia-group-tech/distributed-automation-how-to-run-1000-ui-automation-tests-in-5mins-cf9a84ca32d1) * [Integration Testing in React](https://medium.com/expedia-group-tech/integration-testing-in-react-21f92a55a894) * [How to Earn a Black Belt in GraphQL Testing](https://medium.com/expedia-group-tech/how-to-earn-a-black-belt-in-graphql-testing-bd0beb6365a7) * [How to: Emulate Amazon Simple Queue Service (SQS) for Testing Purposes](https://medium.com/expedia-group-tech/how-to-emulate-sqs-amazon-queue-for-testing-purpose-d9db7f4143b1) * [Fixing Flaky Time Based Unit Tests](https://medium.com/expedia-group-tech/fixing-flaky-time-based-unit-tests-176accf5096e) * [Conversational Integration Tests for your Alexa Skills (Node/JS)](https://medium.com/expedia-group-tech/conversational-integration-tests-for-your-alexa-skills-node-js-874bf70758e3) * [Better Test Code Coverage Through Data](https://medium.com/expedia-group-tech/better-test-code-coverage-through-data-c51b16d6385e) * [Do you want to speed up your integration tests by 10x?](https://medium.com/expedia-group-tech/do-you-want-to-speed-up-your-integration-tests-by-10x-eb047c72a252) * [Testing Elasticsearch Applications](https://medium.com/expedia-group-tech/testing-elasticsearch-applications-bbf7107dba9f) #### Videos * [Mobile Automation in Continuous Delivery Pipeline](https://www.youtube.com/watch?v=NWDByCVThfE) * [Distributed Automation Using Selenium Grid / AWS / Autoscaling](https://www.youtube.com/watch?v=cbIfU1fvGeo) * [AWS re:Invent 2017: Use Amazon EC2 Systems Manager to Perform Automated Resilience Testing](https://www.youtube.com/watch?v=jihhLckop6A) </details> <details> <summary>Facebook</summary> #### Blogs & Articles * [Open-sourcing Python Test Runner for multiple tests in parallel](https://engineering.fb.com/open-source/python-test-runner/) * [Predictive test selection: A more efficient way to ensure reliability of code changes](https://engineering.fb.com/developer-tools/predictive-test-selection/) * [MobileLab: Highly accurate testing to prevent mobile performance regressions](https://engineering.fb.com/android/mobilelab/) * [Sapienz: Intelligent automated software testing at scale](https://engineering.fb.com/developer-tools/sapienz-intelligent-automated-software-testing-at-scale/) * [Preventing performance regressions with Health Compass and Incident Tracker](https://engineering.fb.com/developer-tools/incident-tracker/) * [Finding and fixing software bugs automatically with SapFix and Sapienz](https://engineering.fb.com/developer-tools/finding-and-fixing-software-bugs-automatically-with-sapfix-and-sapienz/) * [Open-sourcing Flipper: a new extensible debugging tool](https://engineering.fb.com/android/flipper/) * [BrowserLab: Automated regression detection for the web](https://engineering.fb.com/web/browserlab-automated-regression-detection-for-the-web/) * [Getafix: How Facebook tools learn to fix bugs automatically](https://engineering.fb.com/developer-tools/getafix-how-facebook-tools-learn-to-fix-bugs-automatically/) * [Stetho: A new debugging platform for Android](https://engineering.fb.com/android/stetho-a-new-debugging-platform-for-android/) * [Open-sourcing Facebook Infer: Identify bugs before you ship](https://engineering.fb.com/developer-tools/open-sourcing-facebook-infer-identify-bugs-before-you-ship/) * [Building and testing at Facebook](https://engineering.fb.com/uncategorized/building-and-testing-at-facebook/) * [Watir to WebDriver: Unit Test Frameworks](https://engineering.fb.com/developer-tools/watir-to-webdriver-unit-test-frameworks/) * [Rapid release at massive scale](https://engineering.fb.com/web/rapid-release-at-massive-scale/) * [Finding inter-procedural bugs at scale with Infer static analyzer](https://engineering.fb.com/android/finding-inter-procedural-bugs-at-scale-with-infer-static-analyzer/) * [Zoncolan: How Facebook uses static analysis to detect and prevent security issues](https://engineering.fb.com/security/zoncolan/) * [How do you test your tests? An approach on probablistic flakiness score](https://engineering.fb.com/2020/12/10/developer-tools/probabilistic-flakiness/) * [Faster, more efficient systems for finding and fixing regressions](https://engineering.fb.com/2021/02/17/developer-tools/fix-fast/) * [Test plans at Facebook](https://frantic.im/test-plan/) * [Improving end-to-end tests' reliability at Facebook](https://frantic.im/e2e-tests/) * [Autonomous testing of services at scale](https://engineering.fb.com/2021/10/20/developer-tools/autonomous-testing/) #### Videos * [Systems @Scale 2019 - Continuous Deployment at Facebook Scale](https://www.youtube.com/watch?v=qN6BiLzZGfs) * [Mobile End to End Testing at Scale - SeleniumConf 2015](https://www.youtube.com/watch?v=7tzA2nsg1jQ&feature=emb_title) * [Turning iOS End to End Testing up to 11 - Lawrence Lomax](https://www.youtube.com/watch?v=lTxW4rbu6Bk) * [Readable. Stable. Maintainable. E2E Testing @ Facebook - Archit Pal Singh Sachdeva](https://www.youtube.com/watch?v=diYgXpktTqo) * [Automated Fault-Finding and Fixing at Facebook](https://www.youtube.com/watch?v=CbQ6bJlOU7A) * [Damien Sereni, Testing and moving fast making Selenium work for Facebook](https://www.youtube.com/watch?v=_7KYs0NN82w) * [Taqelah - Facebook Meetup - Raj Kamal - Shreya Bhat](https://www.youtube.com/watch?v=ra6wq2wgOE4) * [GTAC 2013: Simon Stewart - How Facebook Tests Facebook on Android](https://www.youtube.com/watch?v=HUE_yrd8tl0) * [GTAC 2014: Never Send a Human to do a Machine’s Job: How Facebook uses bots to manage tests](https://www.youtube.com/watch?v=_5Sr4EYH7M8) * [Facebook Infer: Advanced Static Analysis at Speed and Scale - Facebook - DevTools@Scale2017](https://www.youtube.com/watch?v=gZ3dA4QD8jk) * [Building Mobile Apps with Open Source Tools - Simon Stewart - Mobile @ Scale](https://www.youtube.com/watch?v=c2Q22KDjXmI) </details> <details> <summary>Figma</summary> #### Blogs & Articles * [Figma Quality Week: Inside our bug bashing party](https://www.figma.com/blog/figma-quality-week-inside-our-bug-bashing-party/) * [Inside Figma: a case study on strict null checks](https://www.figma.com/blog/inside-figma-a-case-study-on-strict-null-checks/) </details> <details> <summary>Flipkart</summary> #### Blogs & Articles * [Astra — Automated Security Testing for REST API’s](https://tech.flipkart.com/astra-automated-security-testing-for-rest-apis-a54b999dbfe9) </details> <details> <summary>GitHub</summary> #### Blogs & Articles * [How GitHub uses automated testing to empower developers to write less](https://ben.balter.com/2015/09/10/blog-style-tests/) * [MySQL infrastructure testing automation at GitHub](https://github.blog/2017-07-06-mysql-testing-automation-at-github/) * [octocatalog-diff: GitHub’s Puppet development and testing tool](https://github.blog/2016-10-20-octocatalog-diff-github-s-puppet-development-and-testing-tool/) * [Browser Monitoring for GitHub.com](https://github.blog/2015-05-19-browser-monitoring-for-github-com/) * [How we ship GitHub Mobile every week](https://github.blog/2022-01-12-how-we-ship-github-mobile-every-week/) #### Videos * [The elusive quest to measure developer productivity](https://www.youtube.com/watch?v=cRJZldsHS3c) </details> <details> <summary>GitLab</summary> #### Handbook * [Quality Department Handbook](https://about.gitlab.com/handbook/engineering/quality/) #### Blogs and Articles * [An inside look at software testing at GitLab](https://about.gitlab.com/blog/2019/08/30/software-test-at-gitlab/) * [Introducing Accessibility Testing in GitLab](https://about.gitlab.com/blog/2020/03/04/introducing-accessibility-testing-in-gitlab/) * [How our QA team leverages GitLab’s performance testing tool (and you can too)](https://about.gitlab.com/blog/2020/02/18/how-were-building-up-performance-testing-of-gitlab/) * [How GitLab switched to Headless Chrome for testing](https://about.gitlab.com/blog/2017/12/19/moving-to-headless-chrome/) * [How recent acquisitions introduce fuzz testing to GitLab](https://about.gitlab.com/blog/2020/07/17/fuzz-testing/) * [How the Search Team at GitLab Implemented a Risk Map to Direct Automated Testing Efforts](https://about.gitlab.com/blog/2020/09/03/risk-mapping/) </details> <details> <summary>GoDaddy</summary> #### Blogs & Articles * [Move over Selenium - UI Testing with Cypress](https://sg.godaddy.com/engineering/2018/11/06/cypress-vs-selenium/) * [Mocking SOAP APIs in functional tests using Nock](https://sg.godaddy.com/engineering/2018/10/02/mocking-soap-apis-in-functional-tests-using-nock/) * [React Native Application UI testing using WebDriverIO and Appium](https://sg.godaddy.com/engineering/2018/07/09/react-native-wdio/) </details> <details> <summary>Goibibo</summary> #### Blogs & Articles * [Let’s take it live!](https://tech.goibibo.com/lets-take-it-live-e1639699e160) * [RENDEZVOUS WITH Goibibo](https://tech.goibibo.com/rendezvous-with-goibibo-392cc8f385e9) * [Mr. Postman for Integration Testing](https://tech.goibibo.com/mr-postman-for-integration-testing-879a4031f916) </details> <details> <summary>GoJek</summary> #### Blogs * [It's Time To Find And Kill Bugs](https://blog.gojek.io/its-time-to-find-and-kill-bugs/) * [Test Mobile Apps Using Web Traffic Interception and Mocking](https://blog.gojek.io/test-mobile-apps-using-web-traffic-interception-and-mocking/) * [Why you should automate tests early](https://blog.gojek.io/why-you-should-automate-tests-early/) * [Screenshot Testing our Design System on Android](https://blog.gojek.io/screenshot-testing-our-design-system-on-android/) * [Advice from a Test Journeyman](https://blog.gojek.io/advice-from-a-test-journeyman/) * [How I Gave My First Conference Talk](https://blog.gojek.io/how-i-gave-my-first-conference-talk/) * [7 Myths About Software Testing](https://blog.gojek.io/7-myths-about-software-testing/) * [The Untold Story of Golang Testing](https://blog.gojek.io/the-untold-story-of-golang-testing) * [The first principles of ‘Testing’](https://blog.gojek.io/the-first-principles-of-testing/) * [How to Run Grouped TestNG Tests Using Gradle](https://blog.gojek.io/how-to-run-grouped-testng-tests-using-gradle/) * [Golang Integration Testing Made Easy - How we at Gojek implement integration testing in our development processes.](https://blog.gojek.io/golang-integration-testing-made-easy/) * [Everyone’s A Tester While ‘Mob Testing’](https://blog.gojek.io/everyones-a-tester-while-mob-testing) * [Good bug reports lead to great bug fixes](https://blog.gojek.io/good-bug-reports-lead-to-great-bug-fixes) </details> <details> <summary>Google</summary> #### Books * [James Whittaker](https://twitter.com/docjamesw), [Jason Arbon](https://twitter.com/jarbon) and [Jeff Carolllo](https://twitter.com/joweeba) provide insights into testing at Google in their (slightly outdated) 2012 book [How Google Tests Software](https://books.google.com.sg/books?id=VrAx1ATf-RoC). There is a seven part summary on the [Google Testing Blog](https://testing.googleblog.com) as well: * [How Google Tests Software - Part One](https://testing.googleblog.com/2011/01/how-google-tests-software.html) * [How Google Tests Software - Part Two](https://testing.googleblog.com/2011/02/how-google-tests-software-part-two.html) * [How Google Tests Software - Part Three](https://testing.googleblog.com/2011/02/how-google-tests-software-part-three.html) * [How Google Tests Software - Part Four](https://testing.googleblog.com/2011/03/how-google-tests-software-part-four.html) * [How Google Tests Software - Part Five](https://testing.googleblog.com/2011/03/how-google-tests-software-part-five.html) * [How Google Tests Software - Part Six](https://testing.googleblog.com/2011/05/how-google-tests-software-part-six.html) * [How Google Tests Software - Part Seven](https://testing.googleblog.com/2011/05/how-google-tests-software-part-seven.html) #### Blogs * [Google Testing Blog](https://testing.googleblog.com) #### Videos * [Meet Test Engineers at Google](https://www.youtube.com/watch?v=C7OLZf5099Y) * [GTAC 2016: Evolution of Business and Engineering Productivity](https://youtu.be/Vf7axkwtTOw?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1iVf-TogkdoIcvs8OpRMMWx76s9Zk4_f0JJ-e1sZIxog/edit#slide=id.p155) * [GTAC 2016: The Quirkier Side of Testings](https://youtu.be/QHV-PSwzvIQ?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1iVf-TogkdoIcvs8OpRMMWx76s9Zk4_f0JJ-e1sZIxog/edit#slide=id.p155) * [GTAC 2016: How Flaky Tests in Continuous Integration: Current Practice at Google and Future Directions](https://youtu.be/CrzpkF1-VsA?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1iVf-TogkdoIcvs8OpRMMWx76s9Zk4_f0JJ-e1sZIxog/edit#slide=id.p659) * [GTAC 2016: OpenHTF - The Open-Source Hardware Testing Framework](https://youtu.be/bC5YhAo1kHc?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1_bNn_HTI1Vst6WAB62KHTtgbvxocjpnt2Y-8ugGyP8U/edit#slide=id.p147) * [GTAC 2016: Integration Testing with Multiple Mobile Devices and Services](https://youtu.be/8tjsxxSMkpA?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1_bNn_HTI1Vst6WAB62KHTtgbvxocjpnt2Y-8ugGyP8U/edit#slide=id.p439) * [GTAC 2016: Finding bugs in C++ libraries using LibFuzzer](https://youtu.be/FzaR3iH2iZs?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1_bNn_HTI1Vst6WAB62KHTtgbvxocjpnt2Y-8ugGyP8U/edit#slide=id.p548) * [GTAC 2015: Juggling Chainsaws for Fun and Profit: Lessons Learned from Mobile Cross-Platform Integration Testing](https://www.youtube.com/watch?v=jaWD60t69Wg&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=5), [Slides](https://docs.google.com/presentation/d/1Z2lWJDsZu_iyr8wFLodG-6R27vB_EodcbN0euqCXgz0/pub) * [GTAC 2015: How to Component Test Soup Dumplings](https://www.youtube.com/watch?v=OLesBZSd-cM&index=7&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1), [Slides](https://docs.google.com/presentation/d/1x7FjkFqLjwOTNUM_Mgag8Ar_MXQ5HZsQ-18CVqoR5MQ/pub) * [GTAC 2015: Chromecast Test Automation](https://www.youtube.com/watch?v=TfAVJLhb_k0&index=8&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1), [Slides](https://docs.google.com/presentation/d/1gBGS5UFyyR0mcwg990I1YDOFQwAhL-nmonNPGvGYnlk/pub) * [GTAC 2015: Automated Accessibility Testing for Android Applications](https://www.youtube.com/watch?v=vvwc8MVlusY&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=13), [Slides](https://docs.google.com/presentation/d/18ZUiXTZIGx0ydeLcKxnp5BxnI5kv7Cxm6rPaTf-c0ms/pub) * [GTAC 2015: Statistical Data Sampling](https://www.youtube.com/watch?v=cXi1Jo5V7UM&index=15&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1), [Slides](https://docs.google.com/presentation/d/1zAgKXFOQn02PVik9b4YkV0ZJ2wJIaGAf5oFY_dUyDD8/pub) * [GTAC 2015: Nest Automation Infrastructure](https://www.youtube.com/watch?v=lIoAq2Mjjas&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=16), [Slides](https://docs.google.com/presentation/d/1x-l6xb9uUzFA9n0EFxcsvIEj6dQPQBcCu3JucAVe-8E/pub) * [GTAC 2015: Fake Backends with RpcReplay](https://www.youtube.com/watch?v=wJPfsyRRmyw&index=26&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1), [Slides](https://docs.google.com/presentation/d/1IF30CK1z8xzj8xZxJiE7LBQoyzK770yZuBzJR2pfHng/pub) * [GTAC 2014: Chrome OS Test Automation Lab](https://www.youtube.com/watch?v=08CyrK2d1t0&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=27), [Slides](https://docs.google.com/presentation/d/1ZbtToNrkpG6jLZBXbuUXVFzHilrr6_ZTFFAFdgpl4FQ/pub) * [GTAC 2014: Make Chrome the best mobile browser](http://www.youtube.com/watch?v=ugX-80lMu7A&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/vuW93B) * [GTAC 2014: Test coverage at Google](http://www.youtube.com/watch?v=4bublRBCLVQ&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/f0pVxT) * [GTAC 2014: The Importance of Automated Testing on Real and Virtual Mobile Devices](http://www.youtube.com/watch?v=nOFel7yNAsE&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/xuevSM) * [GTAC 2014: Free Tests Are Better Than Free Bananas: Using Data Mining and Machine Learning To Automate Real-Time Production Monitoring](http://www.youtube.com/watch?v=ExXATBlygl0&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://www.youtube.com/watch?v=ExXATBlygl0&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1) * [GTAC 2014: Google BigQuery Analytics](http://www.youtube.com/watch?v=YW4AV260Zis&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/2DyuC8) * [GTAC 2014: The Testing User Experience](http://www.youtube.com/watch?v=J7c0Bw840X8&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/3p7zcm) * [GTAC 2014: Going Green: Cleaning up the Toxic Mobile Environment](http://www.youtube.com/watch?v=aHcmsK9jfGU&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/QCQDDh) * [GTAC 2013: Opening Keynote - Evolution from Quality Assurance to Test Engineering](http://www.youtube.com/watch?v=nyOHJ4GR4iU&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/76Ggf) * [GTAC 2013: Webdriver for Chrome](http://www.youtube.com/watch?v=dMwUZxRgJWs&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/6rA9q) * [GTAC 2013: Karma - Test Runner for JavaScript](http://www.youtube.com/watch?v=YG5DEzaQBIc&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d) * [GTAC 2013: Automated Video Quality Measurements](http://www.youtube.com/watch?v=IbLNm3LsMaw&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/sF7Fm) * [GTAC 2013: Testable JavaScript - Architecting Your Application for Testability](http://www.youtube.com/watch?v=JjqKQ8ezwKQ&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/E1v14) * [GTAC 2013: Breaking the Matrix - Android Testing at Scale](http://www.youtube.com/watch?v=uHoB0KzQGRg&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/RltPp) * [GTAC 2013: Android UI Automation](http://www.youtube.com/watch?v=O1u8iBLUFL0&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/kpJCL) * [GTAC 2013: Building Scalable Mobile Test Infrastructure for Google+ Mobile](http://www.youtube.com/watch?v=Dnqxo0QtU98&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/xWZKt) * [GTAC 2013: Espresso: Fresh Start to Android UI Testing](http://www.youtube.com/watch?v=T7ugmCuNxDU&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/ieunS) * [GTAC 2013: Web Performance Testing with WebDriver](http://www.youtube.com/watch?v=0_kAPWSZNY4&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/5QHVY) * [GTAC 2013: Continuous Maps Data Testing](http://www.youtube.com/watch?v=ca_NjBKfZaM&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/UG3BN) * [GTAC 2013: Finding Culprits Automatically in Failing Builds - i.e. Who Broke the Build?](http://www.youtube.com/watch?v=SZLuBYlq3OM&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/q9dGd) </details> <details> <summary>GovTech Singapore - GDS(DCUBE)</summary> #### Blogs & Articles * [Security Dashboard — Part 1](https://blog.gds-gov.tech/security-dashboard-part-1-d71a3adf84b8) * [Security Dashboard — Part 2](https://blog.gds-gov.tech/security-dashboard-part-2-3eb7c92c4edd) * [Software Bill of Materials (SBoM)](https://blog.gds-gov.tech/software-bill-of-materials-sbom-c13c800abaa1) * [Basics of Web Performance Testing](https://blog.gds-gov.tech/basics-of-web-performance-testing-9876f903ea49) * [Web Performance Testing — DCube’s Practices](https://blog.gds-gov.tech/web-performance-testing-dcubes-practices-fbbc20606000) * [Agile Testing Practices](https://blog.gds-gov.tech/agile-testing-practices-c771c00ae7b3) * [Why automate tests and not do it manually?](https://blog.gds-gov.tech/why-automate-test-and-not-do-it-manually-1a4947cd91d8) * [Test Automation— Our challenges and how to overcome them](https://blog.gds-gov.tech/test-automation-our-challenges-and-how-to-overcome-them-4e7122518568) * [Developers working peacefully with the security folks — How?](https://blog.gds-gov.tech/developers-working-peacefully-with-the-security-folks-how-239671a1d4de) * [Secure code review process in Agile processes — how?](https://blog.gds-gov.tech/secure-code-review-process-in-agile-processes-how-937ba9e1faf0) * [Application security testing process in Agile processes — how?](https://blog.gds-gov.tech/application-security-testing-process-in-agile-processes-how-d7051359c491) * [Mobile Test Automation — What is it?](https://blog.gds-gov.tech/mobile-test-automation-what-is-it-2934e7c5b002) * [Mobile Test Automation — The Bigger Picture](https://blog.gds-gov.tech/mobile-test-automation-the-bigger-picture-5291960fb8a3) * [Integration Tests (with examples)](https://blog.gds-gov.tech/integration-tests-with-examples-ac2f9cded974) * [Hacking the Bug Bounty Program](https://blog.gds-gov.tech/hacking-the-bug-bounty-program-1d02dde62901) * [Basic Coding Practices & Hygiene](https://blog.gds-gov.tech/basic-coding-practices-hygiene-28e67c269ea) * [To BBP or not to BBP?](https://blog.gds-gov.tech/to-bbp-or-not-to-bbp-d3c73efc3e5a) * [When using 3rd-party libraries…](https://blog.gds-gov.tech/when-using-third-party-resources-abf5cd11d767) * [API Testing](https://blog.gds-gov.tech/api-testing-e07d6d004079) * [Performance Testing - What to consider…](https://blog.gds-gov.tech/performance-testing-what-to-consider-2bdb5b64341b) * [The Good Unit Test](https://blog.gds-gov.tech/the-good-unit-test-51baf1e50c3f) * [Basic Web Security Testing - Sessions](https://blog.gds-gov.tech/basic-web-security-testing-sessions-224537e1f7bd) * [Basic Web Security Testing — File Upload](https://blog.gds-gov.tech/basic-web-security-testing-file-upload-d1cde33672ce) * [Basic Web Security Testing — APIs](https://blog.gds-gov.tech/basic-web-security-testing-apis-58f37e01a730) * [All my functional tests passed — time to celebrate?](https://blog.gds-gov.tech/all-my-functional-tests-passed-time-to-celebrate-5d6af22c5365) * [Mobile Testing in the Cloud](https://blog.gds-gov.tech/mobile-testing-in-the-cloud-b95841d90e19) </details> <details> <summary>Grab</summary> #### Blogs & Articles * [Marionette - Enabling E2E user-scenario simulation](https://engineering.grab.com/marionette-enabling-e2e-user-scenario-simulation) </details> <details> <summary>Helpshift</summary> #### Blogs & Articles * [Testing business logic using DSLs in Clojure](https://medium.com/helpshift-engineering/testing-business-logic-using-dsls-in-clojure-bb7d6235f562) * [Functional Testing of Mobile and Web Apps using Clojure](https://medium.com/helpshift-engineering/functional-testing-of-mobile-and-web-apps-using-clojure-4bedb365c7ca) * [Load Testing using Tsung](https://medium.com/helpshift-engineering/load-testing-using-tsung-ef26a662929b) * [The Convoluted Magic of Leiningen Test Selectors](https://medium.com/helpshift-engineering/the-convoluted-magic-of-leiningen-test-selectors-2eb6c452dfcf) * [On the testability of Ring Middleware in Clojure](https://medium.com/helpshift-engineering/on-the-testability-of-ring-middlewares-in-clojure-6795eae60f2a) #### Videos * [Testing business logic using DSLs in Clojure](https://youtu.be/YOsfPrgNY_M) * [Clojure for functional testing of Mobile and Web apps](https://youtu.be/G-fjpO6nYPQ) </details> <details> <summary>hh.ru</summary> #### Blogs & Articles * [Quality assurance for mobile development at hh.ru](https://medium.com/hh-ru/quality-assurance-for-mobile-development-at-hh-ru-b9683e63414f) * [Automating the release process](https://medium.com/hh-ru/automating-the-release-process-af8f97edc7bc) * [How to bring off a gentleman’s release](https://medium.com/hh-ru/how-to-bring-off-a-gentlemans-release-9884a954e4a7) * [Top 5 Junior Automation Tester’s Questions About Automated Testing](https://medium.com/hh-ru/top-5-junior-automation-testers-questions-about-automated-testing-c7c03c674eeb) * [Top 5 Technical Director’s Questions About Automated Testing](https://medium.com/hh-ru/top-5-technical-directors-questions-about-automated-testing-ca2fe4619aab) * [Top 5 Manager’s Questions About Automated Testing](https://medium.com/hh-ru/top-5-manager-questions-about-automated-testing-4f194bc02375) * [Top 5 Manual Testers’ Questions About Automated Testing](https://medium.com/hh-ru/top-5-manual-testers-questions-about-automated-testing-aae16a3402bc) * [Olya, tests and factory — the path to beautiful architecture and clean code](https://medium.com/hh-ru/olya-tests-and-factory-the-path-to-beautiful-architecture-and-clean-code-b0bb0766d46d) </details> <details> <summary>Instacart</summary> #### Blogs & Articles * [Measuring software quality at scale](https://tech.instacart.com/understanding-software-quality-at-scale-79ebb25cb3ac) #### Videos * [Measuring software quality at Instacart - Dash 2020](https://www.youtube.com/watch?v=EQ0QD4-E84s&ab_channel=Datadog) </details> <details> <summary>Intel</summary> #### Videos * [GTAC 2016: IATF: An new Automated Cross-platform and Multi-device API Test Framework](https://youtu.be/mHJspt6BgZU?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1iVf-TogkdoIcvs8OpRMMWx76s9Zk4_f0JJ-e1sZIxog/edit#slide=id.p490) * [GTAC 2016: Docker Based Geo Dispersed Test Farm - Test Infrastructure Practice in Intel Android Program](https://youtu.be/EgmSnHFutEc?list=PLSIUOFhnxEiAeGHYoBZCvEMY5wCOIpyOM), [Slides](https://docs.google.com/presentation/d/1_bNn_HTI1Vst6WAB62KHTtgbvxocjpnt2Y-8ugGyP8U/edit#slide=id.p120) * [GTAC 2016: Automation on Wearable Devices](https://www.youtube.com/watch?v=1agsqcPXPHo&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=22), [Slides](https://docs.google.com/presentation/d/1nOvdDY4k7grcPSo83GpsBJRj6z8Ty1rscd2A8VSG0W0/pub) </details> <details> <summary>KeepTruckin</summary> #### Blogs & Articles * [Simplifying UI Testing with Page Object Model and Controllers](https://medium.com/keeptruckin-eng/simplifying-ui-test-automation-with-page-object-model-and-controllers-8115657908b9) </details> <details> <summary>La Redoute</summary> #### Blogs & Articles * [96% Successful Daily Web Production Deploy](https://laredoute.io/blog/96-successful-daily-web-production-deploy/) * [Quality at Speed for our Mobile Application](https://laredoute.io/blog/quality-at-speed-for-our-mobile-application/) * [How We Test Our Event-Driven Microservices](https://laredoute.io/blog/how-we-test-our-event-driven-microservices/) * [Cerberus, the birth of our Open Source Testing](https://laredoute.io/blog/cerberus-the-birth-of-our-open-source-testing-solution/) * [The Traditional Test Automation Pyramid, Pitfalls and Anti-patterns](https://laredoute.io/blog/the-traditional-test-pyramid-pitfalls-and-anti-patterns/) #### Videos * [Quality at Speed @ La Redoute](https://www.youtube.com/watch?v=D-prcP5ZRew) </details> <details> <summary>LinkedIn</summary> #### Blogs & Articles * [LinkedIn’s approach to automated accessibility (A11y) testing](https://engineering.linkedin.com/blog/2020/automated-accessibility-testing) * [Quality Control - LinkedIn's Testing Methodology](https://engineering.linkedin.com/testing/quality-control-linkedins-testing-methodology) * [iOS: Test Pyramid](https://engineering.linkedin.com/blog/2016/11/ios--test-pyramid) * [Writing Maintainable Integration Tests](https://engineering.linkedin.com/blog/2016/08/writing-maintainable-integration-tests) * ["Testscaling" with Test Engineering](https://engineering.linkedin.com/blog/2016/02/-testscaling--with-test-engineering) * [UI Automation: Keep it Functional – and Stable!](https://engineering.linkedin.com/blog/2016/01/ui-automation--keep-it-functional--and-stable-) * [Test Stability - How We Make UI Tests Stable](https://engineering.linkedin.com/blog/2015/12/test-stability---how-we-make-ui-tests-stable) * [Getting Code to Production With Less Friction and High Quality](https://engineering.linkedin.com/developer-happiness/getting-code-production-less-friction-and-high-quality) * [Eliminating toil with fully automated load testing](https://engineering.linkedin.com/blog/2019/eliminating-toil-with-fully-automated-load-testing) * [The testing lifecycle at LinkedIn](https://engineering.linkedin.com/41/testing-lifecycle-linkedin) * [Testing Frontier, LinkedIn's Web Framework](https://engineering.linkedin.com/37/testing-frontier-linkedins-web-framework) #### Videos * [Testing in production at LinkedIn - Szczepan Faber](https://www.youtube.com/watch?v=lbO6INBICpQ) * [GTAC 2015: Mock the Internet](https://www.youtube.com/watch?v=6gPNrujpmn0&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=20) </details> <details> <summary>Loveholidays</summary> #### Blogs & Articles * [Load testing in production with Grafana Loki, Kubernetes and Golang](https://tech.loveholidays.com/load-testing-in-production-with-grafana-loki-kubernetes-and-golang-1699554d2aa3) </details> <details> <summary>McDonald’s</summary> #### Blogs & Articles * [OpenTest: McDonald’s debut into open-source software](https://medium.com/mcdonalds-technical-blog/opentest-mcdonalds-debut-into-open-source-software-487def26019) </details> <details> <summary>Mattermost</summary> #### Blogs & Articles * [Improving performance (and more) through load testing](https://developers.mattermost.com/blog/improving-performance-through-load-testing/) * [Automated UI Testing With Cypress](https://developers.mattermost.com/blog/automated-ui-testing-with-cypress/) * [Unit Testing mmctl Commands](https://developers.mattermost.com/blog/unit-testing-mmctl-commands/) * [Avoiding Flaky Tests](https://developers.mattermost.com/blog/avoiding-flaky-tests/) </details> <details> <summary>Mailchimp</summary> #### Blogs & Articles * [Designing automated tests for React, Increment Magazine](https://increment.com/testing/designing-automated-tests-for-react/) </details> <details> <summary>ManoMano</summary> #### Blogs & Articles * [Software Quality & Craftsmanship at ManoMano](https://medium.com/manomano-tech/software-quality-craftsmanship-at-manomano-121f11ce0a5) * [How we set a decentralized QA culture at ManoMano](https://medium.com/manomano-tech/how-we-set-a-decentralized-quality-assurance-culture-at-manomano-faa5fef02f20) </details> <details> <summary>Meesho Tech</summary> #### Blogs & Articles * [Scaling For Sale: Automating JMeter Distributed Load Testing](https://medium.com/meesho-tech/scaling-for-sale-automating-jmeter-distributed-load-testing-c128c000cd01) * [How Meesho's dedicated A/B Infra enables us to experiment and scale new features](https://medium.com/meesho-tech/meeshos-dedicated-a-b-infra-enables-us-to-experiment-and-scale-new-features-99f2c2a508ad) * [How we reduced our test automation development time by 20%](https://www.meesho.io/blog/how-we-reduced-test-automation-by-20) </details> <details> <summary>Mercari</summary> #### Blogs & Articles * [We have created unit testing guidelines](https://engineering.mercari.com/en/blog/entry/20220418-e406d51f15/) * [Automatically generating snapshot tests from Xcode Previews](https://engineering.mercari.com/en/blog/entry/20201204-1f94b9dca2/) * [Android automated testing to support one-week releases](https://engineering.mercari.com/en/blog/entry/20211210-merpay-android-test-automation/) * [What We Talk About When We Talk About Quality Assurance.](https://engineering.mercari.com/en/blog/entry/20210915-c9577ca624/) * [Running distributed testing to reduce testing time](https://engineering.mercari.com/en/blog/entry/20211206-5aa2ac7efc/) * [Learn the differences of Test Doubles](https://engineering.mercari.com/en/blog/entry/20220420-learn-the-differences-of-test-doubles/) * [Test parallelization in Go: Understanding the t.Parallel() method](https://engineering.mercari.com/en/blog/entry/20220408-how_to_use_t_parallel/) * [Tool created to help improve local web frontend performance](https://engineering.mercari.com/en/blog/entry/20211217-856683a917/) * [The current state of automation in the Merpay QA Team](https://engineering.mercari.com/en/blog/entry/20211224-merpay-qa-for-automation-test/) * [The Merpay QA Team: Maintaining Quality for Safe and Secure Products #TeamInterview](https://engineering.mercari.com/en/blog/entry/20211111-504f3da724/) * [A Deep Dive into Table-Driven Testing in Golang](https://engineering.mercari.com/en/blog/entry/20211221-a-deep-dive-into-table-driven-testing-in-golang/) * [Accessibility Testing 101](https://engineering.mercari.com/en/blog/entry/20211215-accessibility-testing-101/) * [How is Security Testing Different from Typical Software Testing?](https://engineering.mercari.com/en/blog/entry/20211210-how-is-security-testing-different-from-typical-software-testing/) * [Test Automation Policy in Merpay Frontend](https://engineering.mercari.com/en/blog/entry/20211208-test-automation-policy-in-merpay-frontend/) * [Mercari’s QA Engineering Initiatives 2020](https://engineering.mercari.com/en/blog/entry/20201221-79f9540f3a/) * [Merry Christmas and a Gift for QA Team](https://engineering.mercari.com/en/blog/entry/20201225-merry-christmas-and-a-gift-for-qa-team/) * [Quality Assurance is Engineering Excellence](https://engineering.mercari.com/en/blog/entry/20201211-quality-assurance-is-engineering-excellence/) * [Introducing Testdeck, an Open Source Tool for Microservices QA & Security Testing](https://engineering.mercari.com/en/blog/entry/20200930-testdeck/) * [Specifying Kotlin tests with Spek](https://engineering.mercari.com/en/blog/entry/2019-12-12-100000/) * [Super fast and parallelized Android UITest(Appium) environment using AWS, Docker and Android emulator](https://tech.mercari.com/entry/2018/12/28/175147) * [Speeding up Windows 10 / Microsoft Edge browser testing (Selenium WebDriver) using Azure DevTest Labs](https://tech.mercari.com/entry/2019/09/09/113455) * [How HeadSpin will change mobile testing and monitoring?](https://tech.mercari.com/entry/2019/02/18/173236) </details> <details> <summary>Microsoft</summary> #### Books * [How We Test Software at Microsoft](https://books.google.com.sg/books?id=X5lCAwAAQBAJ) by and Alan C. Page, Ken Johnston and [BJ Rollison](https://twitter.com/testingmentor) is a good starting point. #### Articles * [Munil Shah: Evolving Test Practices at Microsoft](https://docs.microsoft.com/en-us/azure/devops/learn/devops-at-microsoft/evolving-test-practices-microsoft) * [CSE Code With Engineering Playbook: Automated testing](https://microsoft.github.io/code-with-engineering-playbook/automated-testing/) </details> <details> <summary>Miro</summary> #### Blogs & Articles * [QA process at Miro](https://medium.com/miro-engineering/qa-process-at-miro-4c35e60e0b42) * [Managing hundreds of servers for load testing: Autoscaling, custom monitoring, DevOps culture](https://medium.com/miro-engineering/managing-hundreds-of-servers-for-load-testing-autoscaling-custom-monitoring-devops-culture-390fd1c7e699) * [Reliable load testing with regards to unexpected nuances](https://medium.com/miro-engineering/reliable-load-testing-with-regards-to-unexpected-nuances-6f38c82196a5) </details> <details> <summary>Monese</summary> #### Blogs & Articles * [Design QA; minimising design debt in a fast paced world.](https://medium.com/monese/design-qa-minimising-design-debt-in-a-fast-paced-world-82381b5f23a9) * [Mobile testing at Monese](https://medium.com/monese/mobile-testing-at-monese-f06a6c3bc789) </details> <details> <summary>Monzo</summary> #### Blogs & Articles * [Automated Testing & Accessibility on iOS](https://monzo.com/blog/2016/04/26/automated-testing) * [How we load tested our bank before our £20 million crowdfunding round](https://monzo.com/blog/2019/01/15/crowdfunding-technology-testing) </details> <details> <summary>Mozilla</summary> #### Handbook * [Quality Assurance at Moziila](https://developer.mozilla.org/en-US/docs/Mozilla/QA) #### Blogs & Articles * [Engineering code quality in the Firefox browser: A look at our tools and challenges](https://hacks.mozilla.org/2020/04/code-quality-tools-at-mozilla/) #### Videos * [Automation for a Better Web, GTAC 2014](http://www.youtube.com/watch?v=z3sFt8kxS-Y&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/frxhlA) * [How Do You Test a Mobile OS?, GTAC 2013](http://www.youtube.com/watch?v=X41eqcmC2Dk&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/7UeEI) </details> <details> <summary>NASA</summary> #### Blogs & Articles * [Intelligent test automation gives orion spacecraft boos](https://techbeacon.com/app-dev-testing/intelligent-test-automation-gives-orion-spacecraft-boost) * [How did NASA make reliable software if they didn't invent unit tests?](https://news.ycombinator.com/item?id=12121739) * [Software Development & Test](https://www.nasa.gov/centers/ames/engineering/small-sat/arc-capabilities/software) * [Automated testing of nasa software](https://www.slideshare.net/dganesan11/automated-testing-of-nasa-software) * [NASA releases updated open source software bundle including testing tools](https://www.softwaretestingnews.co.uk/nasa-releases-updated-open-source-software-bundle-including-testing-tools/) * [Jon McBride Software Testing and Research (JSTAR)](https://www.nasa.gov/centers/ivv/jstar/JSTAR.html) * [They Write the Right Stuff](https://www.fastcompany.com/28121/they-write-right-stuff) * [Agile Development Brings New Challenges for Software Assurance at NASA](https://sma.nasa.gov/news/articles/newsitem/2014/09/04/agile-development-brings-new-challenges-for-software-assurance-at-nasa) * [How NASA does software testing and QA](https://www.functionize.com/blog/how-nasa-does-software-testing-and-qa/) * [Product Verification from their System Engineering Handbook](https://www.nasa.gov/seh/5-3-product-verification) #### Other * [An interesting Twitter thread on how NASA tests software](https://twitter.com/hankgreen/status/1362511440767148037) </details> <details> <summary>Netflix</summary> #### Blogs & Articles * [Edgar: Solving Mysteries Faster with Observability](https://netflixtechblog.com/edgar-solving-mysteries-faster-with-observability-e1a76302c71f) * [Automation as a Service — Introducing Scriptflask](https://netflixtechblog.com/automation-as-a-service-introducing-scriptflask-17a8e4ad954b) * [Automated testing on devices](https://netflixtechblog.com/automated-testing-on-devices-fc5a39f47e24) * [Product Integration Testing at the Speed of Netflix](https://netflixtechblog.com/product-integration-testing-at-the-speed-of-netflix-72e4117734a7) * [Automated Failure Testing](https://netflixtechblog.com/automated-failure-testing-86c1b8bc841f) * [Announcing Electric Eye](https://netflixtechblog.com/announcing-electric-eye-2bb8ffcf9b1b) * [From Chaos to Control — Testing the resiliency of Netflix’s Content Discovery Platform](https://netflixtechblog.com/from-chaos-to-control-testing-the-resiliency-of-netflixs-content-discovery-platform-ce5566aef0a4) * [NTS: Real-time Streaming for Test Automation](https://netflixtechblog.com/nts-real-time-streaming-for-test-automation-7cb000e933a1) * [FIT: Failure Injection Testing](https://netflixtechblog.com/fit-failure-injection-testing-35d8e2a9bb2) * [Testing Netflix on Android](https://netflixtechblog.com/testing-netflix-on-android-78e5f71b89ab) * [Lerner — using RL agents for test case scheduling](https://netflixtechblog.com/lerner-using-rl-agents-for-test-case-scheduling-3e0686211198) * [Announcing Sleepy Puppy — Cross-Site Scripting Payload Management for Web Application Security Testing](https://netflixtechblog.com/announcing-sleepy-puppy-cross-site-scripting-payload-management-for-web-application-security-d32e62d72e29) * [How Netflix does A/B Testing](https://uxdesign.cc/how-netflix-does-a-b-testing-87df9f9bf57c) * [Fixing Performance Regressions Before they Happen](https://netflixtechblog.com/fixing-performance-regressions-before-they-happen-eab2602b86fe) * [Improving Pull Request Confidence for the Netflix TV App](https://netflixtechblog.medium.com/improving-pull-request-confidence-for-the-netflix-tv-app-b85edb05eb65) #### Videos * [GTAC 2015: Enabling Streaming Experiments at Netflix](https://www.youtube.com/watch?v=5aDqes-EUKg&index=19&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1), [Slides](https://docs.google.com/presentation/d/1K16NtKd-vqdjFmMVVOJusSmBTXJESTxNPXF4s36BjXI/pub) * [GTAC 2014: I Don't Test Often ... But When I Do, I Test in Production](http://www.youtube.com/watch?v=xkP70Zhhix4&list=PLSIUOFhnxEiDFckNDSjKWqOCtd8ksJrh4&index=1), [Slides](http://goo.gl/7PNKA7) * [GTAC 2013: When Bad Things Happen to Good Applications...](http://www.youtube.com/watch?v=zBEtAOEy360&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/8epF0) * [Design Testing at Netflix](https://www.youtube.com/watch?v=-Gy8TnoXZf8) * [Testing In Production, The Netflix Way](https://www.youtube.com/watch?v=3WRVgC8SiGc) * [Test Automation at Scale](https://www.youtube.com/watch?v=FrBN94gUn_I&ab_channel=NetflixDevices) * [Evolution of Payments Testing at Netflix](https://www.youtube.com/watch?v=x4vLS8WWqIE&feature=youtu.be&ab_channel=ByronLam) * [Test Selection: Heuristics and Machine Learning](https://www.youtube.com/watch?v=l7-8_0A9IF8&feature=youtu.be&ab_channel=NetflixDevices) * [The Automation before pressing Play](https://www.youtube.com/watch?v=AGEXxB-nWMw&feature=youtu.be&ab_channel=NetflixDevices) * [Applying Failure Testing Research @Netflix](https://www.youtube.com/watch?v=a3mHQCkr-4I&feature=youtu.be&ab_channel=InfoQ) * [Getting Netflix on a Variety of Devices](https://www.youtube.com/watch?v=JI6qew26wi8&feature=youtu.be&ab_channel=NetflixDevices) * [Electric Eye](https://www.youtube.com/watch?v=uEQ3be0ss2A&feature=youtu.be&ab_channel=NetflixDevices) * [Measuring Perceptual Video Quality at Scale](https://www.youtube.com/watch?v=kEo2TrXm7F4&ab_channel=Demuxed) </details> <details> <summary>Ninjavan</summary> #### Blogs & Articles * [Integration Tests with Testcontainers at Ninja Van](https://medium.com/ninjavan-tech/integration-tests-at-ninja-van-5b6abb0ff59d) </details> <details> <summary>Nubank</summary> #### Blogs & Articles * [Why We Killed Our End-to-End Test Suite](https://building.nubank.com.br/why-we-killed-our-end-to-end-test-suite/) </details> <details> <summary>OutSystems</summary> #### Blogs & Articles * [Way Beyond Testing: The Future of Quality is Smarter, Faster, Better](https://medium.com/@joaoneto_19612/way-beyond-testing-the-future-of-quality-is-smarter-faster-better-59a07429b01b) #### Videos * [What do you mean a Quality Owner?](https://www.youtube.com/watch?v=jlygHJIFjTA) </details> <details> <summary>PayPal</summary> #### Blogs & Articles * [Write Once, Test Everywhere — Simplified SDK Testing](https://medium.com/paypal-tech/write-once-test-everywhere-simplified-sdk-testing-6ea11e7d1f27) </details> <details> <summary>Picnic</summary> #### Blogs & Articles * [Reinventing the QA process](https://blog.picnic.nl/reinventing-the-qa-process-25854fee51f3) * [The Role & Relevance of API Testing in an Agile World](https://blog.picnic.nl/the-role-relevance-of-api-testing-in-an-agile-world-c6cc8f2529cb) * [User testing: setting up the Picnic user testing lab](https://blog.picnic.nl/user-testing-setting-up-the-picnic-user-testing-lab-3569c8a72595) </details> <details> <summary>Pinterest</summary> </details> <details> <summary>Razorpay</summary> #### Blogs & Articles * [Detecting Goroutine Leaks with Test Cases](https://engineering.razorpay.com/detecting-goroutine-leaks-with-test-cases-b0f8f8a88648) * [Releasing features with confidence in your mobile app](https://engineering.razorpay.com/releasing-features-with-confidence-in-the-mobile-app-b3abf73d6646) </details> <details> <summary>Slalom Build</summary> #### Blogs & Articles * [23 Books for Quality Assurance Professionals](https://medium.com/slalom-build/23-books-for-quality-assurance-professionals-9a7db9945e8) * [Q&A with Slalom Build’s Inaugural 2019 Quality Engineering Academy](https://medium.com/slalom-build/a-q-a-with-slalom-builds-inaugural-qe-academy-8881b5e90876) * [Eight Signs Your Agile Testing Isn’t That Agile](https://medium.com/slalom-build/eight-signs-your-agile-testing-isnt-that-agile-d3989bc1b9bb) * [Journey of a Manual QA into an Automation World](https://medium.com/slalom-build/journey-of-a-manual-qa-into-an-automation-world-c99808dc107) * [Playwright vs WebDriver: The Future of Browser Automation](https://medium.com/slalom-build/playwright-vs-webdriver-the-future-of-browser-automation-854a7ae63218) * [Quality Engineer Learning Roadmap](https://medium.com/slalom-build/quality-engineer-learning-roadmap-fddfcb77409e) * [Quality Engineering: Adapt and Apply](https://medium.com/slalom-build/quality-engineering-adapt-and-apply-a77edb781289) * [The challenge of testing Data Pipelines](https://medium.com/slalom-build/the-challenge-of-testing-data-pipelines-4450744a84f1) * [Quality Engineering Core Principles](https://medium.com/slalom-build/quality-engineering-core-principles-13cbc34bf389) * [What is the ROI of my test automation?](https://medium.com/slalom-build/what-is-the-roi-of-my-test-automation-10ae7bf0d9ed) * [The Regression Death Spiral](https://medium.com/slalom-build/the-regression-death-spiral-18f88b9fb030) * [Testing Angular Applications with Selenium Java](https://medium.com/slalom-build/testing-angular-applications-with-selenium-java-4bca1c6d08b5) * [Why isn’t all test automation run on the pipeline?](https://medium.com/slalom-build/why-isnt-all-test-automation-run-on-the-pipeline-b2c57afbdf5a) * [How to test Internationalization with UI automation](https://medium.com/slalom-build/how-to-test-internationalization-with-ui-automation-ff829bb718cc) * [Redefining “Using Promises with the Page Object Model”](https://medium.com/slalom-build/redefining-using-promises-with-the-page-object-model-6dfd49a3594b) * [Load Testing in a Nutshell](https://medium.com/slalom-build/load-testing-in-a-nutshell-7f7568811217) * [Mobile Testing with Microsoft’s Xamarin Test Cloud](https://medium.com/slalom-build/mobile-app-testing-with-microsoft-test-cloud-services-part-1-c0b40b7c19d0) * [Using Promises with the Page Object Model](https://medium.com/slalom-build/using-promises-in-page-object-model-test-automation-2a505be9d79f) </details> <details> <summary>Salesforce</summary> #### Blogs & Articles * [Automating Complex End-to-End Tests](https://engineering.salesforce.com/automating-complex-end-to-end-tests-b0a5fc003592) </details> <details> <summary>Shazam</summary> #### Blogs & Articles * [Shazam on iOS: UI testing + Shazam Pro User Tip](https://medium.com/@kardakov/shazam-on-ios-ui-testing-shazam-pro-user-tip-8347a9ed66a5) * [A Kotlin DSL for Acceptance Tests](https://medium.com/@edwardharks/a-kotlin-dsl-for-acceptance-tests-8a825388879e) * [CI at Shazam](https://speakerdeck.com/edwardfrancesco/ci-at-shazam-a-quest-for-shipping-high-quality-code) #### Videos * [Keeping 100+ million users happy: how we test Shazam on Android](https://www.youtube.com/watch?v=xgjYSf8pjVg) * [3 years of backend testing at Shazam - the stuff we got wrong](https://www.youtube.com/watch?v=9kWslvOpQfw) </details> <details> <summary>Shopify</summary> #### Blogs & Articles * [Webhook testing made easy](https://engineering.shopify.com/blogs/engineering/17488436-webhook-testing-made-easy) * [The Unreasonable Effectiveness of Test Retries: An Android Monorepo Case Study](https://engineering.shopify.com/blogs/engineering/unreasonable-effectiveness-test-retries-android-monorepo-case-study) * [iOS Application Testing Strategies at Shopify](https://engineering.shopify.com/blogs/engineering/ios-application-testing-strategies-at-shopify) * [Building and Testing Resilient Ruby on Rails Applications](https://engineering.shopify.com/blogs/engineering/building-and-testing-resilient-ruby-on-rails-applications) * [Four Steps to Creating Effective Game Day Tests](https://engineering.shopify.com/blogs/engineering/four-steps-creating-effective-game-day-tests) * [Mobile Tophatting at Shopify](https://engineering.shopify.com/blogs/engineering/mobile-tophatting-at-shopify-1) * [Great Code Reviews—The Superpower Your Team Needs](https://engineering.shopify.com/blogs/engineering/great-code-reviews) * [Mobile Release Engineering at Scale with Shipit Mobile](https://engineering.shopify.com/blogs/engineering/mobile-release-engineering-scale-shipit-mobile) * [Software Release Culture at Shopify](https://engineering.shopify.com/blogs/engineering/software-release-culture-shopify) #### Videos * [Scaling R&D to thousands of people without dedicated QA - Adam Archer (Shopify)](https://youtu.be/O3JpS_kvP0g) * [Chat Ops and Developer Productivity [John Arthorne, Shopify]](https://youtu.be/pJpWUgJwkrg) * [Resiliency Testing with Toxiproxy](https://youtu.be/XMj8BmNZD4c) * [ChatOps at Shopify: Inviting Bots in Our Day-to-Day Operations](https://youtu.be/tR31klRieU0) * [Testing Rails at Scale by Emil Stolarsky](https://youtu.be/zWR477ypEsc) </details> <details> <summary>Slack</summary> #### Blogs & Articles * [Everything You Need to Know About How Slack Approaches Accessibility Testing](https://www.3playmedia.com/2019/08/12/slack-approaches-accessibility-testing/) * [Android UI Automation: Part 1, Building Trust](https://slack.engineering/android-ui-automation-part-1-building-trust-de3deb1c5995) * [Android UI Automation: Part 2, Making It Easy](https://slack.engineering/android-ui-automation-part-2-making-it-easy-57335c7379cc) * [Surf’s Up! Preparing for Huge Waves of Traffic via Load Testing](https://slack.engineering/%EF%B8%8F-surfs-up-preparing-for-huge-waves-of-traffic-via-load-testing-62b64da15ffc) * [How About Code Reviews?](https://slack.engineering/how-about-code-reviews-2695fb10d034) * [On Empathy & Pull Requests](https://slack.engineering/on-empathy-pull-requests-979e4257d158) * [Disasterpiece Theater: Slack’s process for approachable Chaos Engineering](https://slack.engineering/disasterpiece-theater-slacks-process-for-approachable-chaos-engineering-3434422afb54) * [Scaling End-to-End User Interface Tests](https://slack.engineering/scaling-end-to-end-user-interface-tests/) * [Handling Flaky Tests at Scale: Auto Detection & Suppression](https://slack.engineering/handling-flaky-tests-at-scale-auto-detection-suppression/) #### Videos * [UI testing is so easy - said no developer ever - Valera Zakharov, Kevin Lai](https://www.youtube.com/watch?v=SkkO6x6LhCQ) * [Mobile performance testing at Slack – Valera Zakharov](https://www.youtube.com/watch?v=xKMIGN1WHgo) * ["Better Integration Tests for Performance Monitoring" by Maude Lemaire](https://www.youtube.com/watch?v=j0PJhD5XNJ8) * [Valera Zakharov: Testing](https://www.youtube.com/watch?v=fySCosLQQws) </details> <details> <summary>Soundcloud</summary> #### Blogs & Articles * [Release Quality and Mobile Trains](https://developers.soundcloud.com/blog/quality-mobile-trains) * [Integration Testing for Memory Leaks](https://developers.soundcloud.com/blog/integration-testing-for-memory-leaks) * [Hands-Off Deployment with Canary](https://developers.soundcloud.com/blog/hands-off-deployment-with-canary) * [Running Android UI Test Suites on Firebase Test Lab](https://developers.soundcloud.com/blog/running-android-ui-test-suites-on-firebase-test-lab) * [Automatic Stubbing of Network Requests to Deflakify Automation Testing](https://developers.soundcloud.com/blog/automatic-stubbing-of-network-requests-to-de-flakify-automation-testing) * [Alerting on SLOs like Pros](https://developers.soundcloud.com/blog/alerting-on-slos) * [Periskop: Exception Monitoring Service](https://developers.soundcloud.com/blog/periskop-exception-monitoring-service) #### Videos * [Continuous Integration at SoundCloud - Vincent Garrigues](https://www.youtube.com/watch?v=cJS08Kuu3zg&ab_channel=IstanbulTechTalks) | [Slides](https://speakerdeck.com/istanbultechtalks/itt-2015-vincent-garrigues-continuous-integration-at-soundcloud) </details> <details> <summary>Spotify</summary> #### Blogs & Articles * [Test Flakiness – Methods for identifying and dealing with flaky tests](https://engineering.atspotify.com/2019/11/18/test-flakiness-methods-for-identifying-and-dealing-with-flaky-tests/) * [Testing of Microservices](https://engineering.atspotify.com/2018/01/11/testing-of-microservices/) * [Generating test cases so you don’t have to](https://engineering.atspotify.com/2015/06/25/rapid-check/) * [Test Strategies and Spotify – Kristian Karl](https://www.thepercept.com/test-strategies-spotify-kristian-karl/) * [How to Build a QA Strategy Like Spotify](https://www.rainforestqa.com/blog/2018-04-20-how-to-build-qa-strategy-like-spotify) * [How Spotify does test automation](https://www.slideshare.net/SmartBear_Software/how-spotify-does-test-management-kristian-karl) * [Model Based Testing at Spotify](https://www.cs.tut.fi/tapahtumat/testaus12/kalvot/Karl_ta.pdf) * [How We Improved Developer Productivity for Our DevOps Teams](https://engineering.atspotify.com/2020/08/27/how-we-improved-developer-productivity-for-our-devops-teams/) #### Videos * [Spotify Model Based Testing - Kristian Karl](https://www.youtube.com/watch?v=psOThLDKOFc) * [Experiences Of Test Automation At Spotify - Kristian Karl](https://www.youtube.com/watch?v=Vlw-4q8lnIw) * [Scaling Android Application Testing at Spotify - Sean Kenny](https://www.youtube.com/watch?v=Br7yPblkQnI) * [How Spotify Does Testing for Mobile - Sean Kenny](https://www.youtube.com/watch?v=69Ea4WyFNyQ) * [Test flakiness - Methods for dealing with flaky tests - Jason Palmer](https://www.youtube.com/watch?v=38pW08_nY_k) * [Applying Testing Mindset to Software Development - Andrew Dzynia](https://www.youtube.com/watch?v=RPshbKHe3NE). | [Slides](https://www.slideshare.net/AndrewDzynia/applying-testing-mindset-to-software-development) </details> <details> <summary>Squarespace</summary> #### Blogs & Articles * [Engineering a Better Working Group](https://engineering.squarespace.com/blog/2020/engineering-a-better-working-group) * [Turbocharging Our UI Tests](https://engineering.squarespace.com/blog/2016/turbocharging-our-ui-tests) * [UI Testing at Squarespace: Part I](https://engineering.squarespace.com/blog/2017/ui-testing-at-squarespace-part-i) * [UI Testing at Squarespace: Part II](https://engineering.squarespace.com/blog/2017/ui-testing-at-squarespace-part-ii) * [Six Attributes of Beautiful Systems](https://engineering.squarespace.com/blog/2018/six-attributes-of-beautiful-systems) * [Under the Hood: Ensuring Site Reliability](https://engineering.squarespace.com/blog/2017/under-the-hood-ensuring-site-reliability) * [Continuous Localization at Squarespace](https://engineering.squarespace.com/blog/2018/continuous-localization-at-squarespace) * [Creating a Code Review Culture, Part 1: Organizations and Authors](https://engineering.squarespace.com/blog/2019/code-review-culture-part-1) * [Creating a Code Review Culture, Part 2: Code Reviewers](https://engineering.squarespace.com/blog/2019/code-review-culture-part-2) </details> <details> <summary>Stackoverflow</summary> #### Blogs & Articles (& stackoverflow questions about stackoverflow obviously! :) ) * [Which tools and libraries are used for testing by StackOverflow developers?](https://meta.stackexchange.com/questions/263773/which-tools-and-libraries-are-used-for-testing-by-stackoverflow-developers) * [How TDD-oriented is the SE team?](https://meta.stackexchange.com/questions/204249/how-tdd-oriented-is-the-se-team) * [Does Stack Overflow have automated tests?](https://meta.stackexchange.com/questions/33761/does-stack-overflow-have-automated-tests) * [What tools and techniques are used to test UI changes?](https://meta.stackexchange.com/questions/283484/what-tools-and-techniques-are-used-to-test-ui-changes?rq=1) * [Adding Static Code Analysis to Stack Overflow](https://stackoverflow.blog/2019/10/08/adding-static-code-analysis-to-stack-overflow/) </details> <details> <summary>Stripe</summary> #### Blogs & Articles * [Running three hours of Ruby tests in under three minutes](https://stripe.com/blog/distributed-ruby-testing) * [Game Day Exercises at Stripe - Learning from `kill -9`](https://stripe.com/blog/game-day-exercises-at-stripe) * [Fast and flexible observability with canonical log lines](https://stripe.com/blog/canonical-log-lines) * [Learning to operate Kubernetes reliably](https://stripe.com/blog/operating-kubernetes) </details> <details> <summary>Stuart Engineering</summary> #### Blogs & Articles * [⬅️ Shifting left QA](https://medium.com/stuart-engineering/shifting-left-qa-341e9c8cdc38) * [What QA Engineers do at Stuart](https://medium.com/stuart-engineering/what-qa-engineers-do-at-stuart-665bbbe4b003) * [🌎 Webhook Testing At Stuart](https://medium.com/stuart-engineering/webhook-testing-at-stuart-3768e8c4b362) * [🔬 Under The QA Testing Microscope](https://medium.com/stuart-engineering/under-the-qa-testing-microscope-8a5191767eda) </details> <details> <summary>Swiggy</summary> #### Blogs & Articles * [#BehindTheBug - Learning from our mistakes](https://bytes.swiggy.com/root-cause-analysis-swiggy-2fac5fe4510b) * [Gradle Incremental Test Runner](https://bytes.swiggy.com/gradle-incremental-test-runner-125cee1e68a7) * [Service Level Testing for Microservices in Swiggy](https://bytes.swiggy.com/service-level-testing-for-microservices-in-swiggy-62b6b3f865f4) </details> <details> <summary>The Guardian</summary> #### Blogs & Articles * [Software quality in a world of microservices and continuous deployment](https://www.theguardian.com/info/2019/dec/06/software-quality-in-a-world-of-microservices-and-continuous-deployment) * [Testing in Production: rethinking the conventional deployment pipeline](https://www.theguardian.com/info/developer-blog/2016/dec/20/testing-in-production-rethinking-the-conventional-deployment-pipeline) * [Data-Driven Quality](https://www.theguardian.com/info/developer-blog/2016/mar/21/data-driven-quality) * [Testing in the right places](https://www.theguardian.com/info/developer-blog/2016/feb/09/testing-in-the-right-places) * [The software testing identity crisis](https://www.theguardian.com/info/developer-blog/2015/nov/02/the-software-testing-identity-crisis) * [Device wall of awesome: how Lego helped our digital development](https://www.theguardian.com/info/developer-blog/2015/jul/31/device-wall-of-awesome-how-lego-helped-our-digital-development) * [QA testing for the Guardian's Content API](https://www.theguardian.com/info/developer-blog/2014/feb/07/qa-testing-for-the-guardians-content-api) * [Real-time QA: staying confident with code](https://www.theguardian.com/info/developer-blog/2012/dec/06/real-time-qa-confident-code) * [Testing, testing: the Guardian attends a QA community meet-up](https://www.theguardian.com/info/developer-blog/2012/aug/10/qa-testing-competition) </details> <details> <summary>The Signal Group</summary> #### Blogs & Articles * [Testing complex business flows: From cones to pyramids](https://medium.com/tech-thesignalgroup/testing-complex-business-flows-from-cones-to-pyramids-85935577b5da) </details> <details> <summary>Trendyol</summary> #### Blogs & Articles * [Manual Testing for Mobile Applications](https://medium.com/trendyol-tech/manual-testing-for-mobile-applications-cb8f4612d070) * [Acceptance Tests On CI Pipeline](https://medium.com/trendyol-tech/acceptance-tests-on-ci-pipeline-e6272c418152) * [Regression Testing in Mobile Development](https://medium.com/trendyol-tech/regression-testing-in-mobile-development-c4895f262fb9) * [Automated Integration Testing over Gitlab](https://medium.com/trendyol-tech/automated-integration-testing-over-gitlab-ci-cd-for-dotnet-core-via-testcontainers-b18c7f81e65f) * [UI Testing Challenges of The Trendyol Mobile App](https://medium.com/trendyol-tech/ui-testing-challenges-of-the-trendyol-mobile-app-6d17d817a700) * [Get the Most Out of UI Tests With XCode Test Plans](https://medium.com/trendyol-tech/get-the-most-out-of-ui-tests-with-xcode-test-plans-d089a2252ba2) * [How to Test Deeplinks with XCUITest](https://medium.com/trendyol-tech/how-to-test-deeplinks-with-xcuitest-d24c8e5318ee) * [Writing Pact Contract Tests with GoLang](https://medium.com/trendyol-tech/writing-pact-contract-tests-with-golang-2c20b5049e0c) * [Integrate Slather to Trendyol Project](https://medium.com/trendyol-tech/integrate-slather-to-trendyol-project-39191cee7b7c) * [UI Test Roadmap with Kaspresso](https://medium.com/trendyol-tech/ui-test-roadmap-with-kaspresso-fa78d4ee7150) * [Trendyol Android Team Unit Test Practice](https://medium.com/trendyol-tech/trendyol-android-team-unit-test-practice-907cf8d0346) * [The Importance of A/B and Exploratory Testing (ET) in Trendyol iOS App](https://medium.com/trendyol-tech/the-importance-of-a-b-and-exploratory-testing-et-in-trendyol-ios-app-5900f81a9628) * [Mobile App Complexity: Things to Consider While Estimating Test Effort](https://medium.com/trendyol-tech/mobile-app-complexity-things-to-consider-while-estimating-test-effort-1cde0645d31a) * [Couchbase Integration Testing for Golang via Testcontainers](https://medium.com/trendyol-tech/couchbase-integration-testing-for-golang-via-testcontainers-25b906bc2c0d) * [The Different Types of Testing on Trendyol iOS App](https://medium.com/trendyol-tech/the-different-types-of-testing-on-trendyol-ios-app-f345124da2b3) * [PIT Mutation Testing on CI/CD Pipeline](https://medium.com/trendyol-tech/pit-mutation-testing-on-ci-cd-pipeline-1298f355bae5) * [How to Test Database Queries and More with Node.js](https://medium.com/trendyol-tech/how-to-test-database-queries-and-more-with-node-js-2f02b08707a7) * [Differences Between Mobile Web and Mobile Platform Tests](https://medium.com/trendyol-tech/differences-between-mobile-web-and-mobile-platform-tests-463e0378187b) * [Mocking API Calls in UI Tests](https://medium.com/trendyol-tech/mocking-api-calls-in-ui-tests-b908dbf6b305) * [How to Make iOS UI Testing fast and reliable](https://medium.com/trendyol-tech/how-to-make-ios-ui-testing-fast-and-reliable-6f572a0955f2) * [How to Write Unit Tests for Selector Functions in Swift](https://medium.com/trendyol-tech/how-to-write-unit-tests-for-selector-functions-in-swift-109fe13756c0) * [Integration testing with Wiremock](https://medium.com/trendyol-tech/integration-testing-with-wiremock-e5ca731d693d) * [Device Selection for iOS App Testing](https://medium.com/trendyol-tech/device-selection-for-ios-app-testing-fad5d0d1eea0) * [Measuring Data in App with Marketing Event Tests](https://medium.com/trendyol-tech/measuring-data-in-app-with-marketing-event-tests-30c11aff3bd1) * [Heuristic Test Strategy for Mobile Software Test](https://medium.com/trendyol-tech/heuristic-test-strategy-for-mobile-software-test-remember-important-aspects-c718da8f01a9) * [Meaningful Error Messages for iOS UI Tests](https://medium.com/trendyol-tech/meaningful-error-messages-for-ios-ui-tests-6085ce15b78) * [Make UI Testing possible with TYGenerator](https://medium.com/trendyol-tech/make-ui-testing-possible-with-tygenerator-c3654425d782) * [Adaptation of Empathy Mapping to Mobile Test](https://medium.com/trendyol-tech/adaptation-of-empathy-mapping-to-mobile-test-f7d94a228516) * [Automated Visual Testing With Snapshots: Part 1](https://medium.com/trendyol-tech/automated-visual-testing-with-snapshots-part-1-ee9c5cf58cca) * [Automated Visual Testing With Snapshots: Part 2](https://medium.com/trendyol-tech/automated-visual-testing-with-snapshots-part-2-19354052c6d9) </details> <details> <summary>Trivago</summary> #### Blogs * [Building fast and reliable web applications](https://tech.trivago.com/2018/10/12/building-fast-and-reliable-web-applications) * [Cucable Maven plugin for parallel execution of Cucumber scenarios](https://tech.trivago.com/2017/06/30/cucable-maven-plugin-for-parallel-execution-of-cucumber-scenarios) * [Creating a Culture of Quality](https://tech.trivago.com/2015/08/31/culture_of_quality) * [Elasticsearch and Kibana for Selenium Automation](https://tech.trivago.com/2015/12/02/selenium_with_kibana) </details> <details> <summary>Twilio</summary> #### Blogs & Articles * [Integrating Cypress Tests With Docker, Buildkite, and CICD](https://sendgrid.com/blog/integrating-cypress-tests-with-docker-buildkite-and-cicd-frontendtwiliosendgrid/) * [What to Consider When Writing E2E Tests](https://sendgrid.com/blog/what-to-consider-when-writing-e2e-tests-frontendtwiliosendgrid/) * [1,000 Foot Overview of Writing Cypress Tests](https://sendgrid.com/blog/1000-foot-overview-of-writing-cypress-tests-frontendtwiliosendgrid/) * [TypeScript All the Things in Your Cypress](https://sendgrid.com/blog/typescript-in-your-cypress-tests-frontendtwiliosendgrid/) * [Dealing With Email Flows in Cypress Tests](https://sendgrid.com/blog/dealing-with-email-flows-in-cypress-tests-frontendtwiliosendgrid/) * [Ideas for Configuring, Organizing, and Consolidating Your Cypress Tests](https://sendgrid.com/blog/ideas-for-configuring-organizing-and-consolidating-your-cypress-tests-frontendtwiliosendgrid/) </details> <details> <summary>Twitter</summary> #### Videos * [GTAC 2015: Hands Off Regression Testing](https://www.youtube.com/watch?v=2zjhKmV0UFA&index=12&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1), [Slides](https://docs.google.com/presentation/d/1KITWbK46rm-lDZce_SqxegHTPjc9Ez-broxDTpfBpK8/pub) * [GTAC 2013: Testing Systems at Scale @Twitter](http://www.youtube.com/watch?v=99RABfKNfcY&list=SPSIUOFhnxEiCODb8XQB-RUQ0RGNZ2yW7d), [Slides](http://goo.gl/9VY2b) * [Testing for products with a microservice architecture - Building an agnostic test framework](https://www.youtube.com/watch?v=lN5bc0coO3k&feature=emb_title&ab_channel=BrowserStack) </details> <details> <summary>Uber</summary> #### Videos * [GTAC 2015: The Uber Challenge of Cross-Application/Cross-Device Testing](https://www.youtube.com/watch?v=p6gsssppeT0&list=PLSIUOFhnxEiCWGsN9t5A-XOhRbmz54IS1&index=3), [Slides](https://docs.google.com/presentation/d/1vYXhkvgLKun72Ix91LQDDWZQdcY5VOBqKVvI1Y6riYo/pub) * [Using the Octopus Framework - Jeff Hu](https://www.youtube.com/watch?v=80wc8gWebrk&ab_channel=Touchlab) * [Inside Uber's secret self-driving car testing facility](https://www.youtube.com/watch?v=SnR2449jFV8&ab_channel=CBSThisMorning) * [Ludwig: A Toolbox for Training and Testing Deep Learning Models without Writing Code](https://www.youtube.com/watch?v=OGweVw57kus&ab_channel=UberEngineering) * [Chaos Engineering @ Uber -- Dianne Laguerta](https://www.youtube.com/watch?v=ywSAwYsIk8k&ab_channel=UberEngineering) * [Observability infra @ Uber](https://youtu.be/nO8AYhEok1c?t=703) #### Blogs & Articles * [Introducing Shadower: A Minimalistic Load Testing Tool](https://www.uber.com/en-GB/blog/introducing-shadower-a-minimalistic-load-testing-tool/) * [Supercharging A/B Testing at Uber](https://www.uber.com/en-GB/blog/supercharging-a-b-testing-at-uber/) * [Introducing Ballast: An Adaptive Load Test Framework](https://www.uber.com/en-GB/blog/introducing-ballast-an-adaptive-load-test-framework/) * [Octopus to the Rescue: the Fascinating World of Inter-App Communications at Uber Engineering](https://eng.uber.com/rescued-by-octopus/) * [Introducing Hypothesis GU Funcs, an Open Source Python Package for Unit Testing](https://eng.uber.com/hypothesis-gu-funcs-unit-testing/) * [Best Practices for Unit Testing in React Version 16](https://eng.uber.com/best-practices-for-react-v16/) * [Monitoring Data Quality at Scale with Statistical Modeling](https://eng.uber.com/monitoring-data-quality-at-scale/) * [Introducing Piranha: An Open Source Tool to Automatically Delete Stale Code](https://eng.uber.com/piranha/) </details> <details> <summary>Veracode</summary> #### Handbook * [Test Lean and Ship Healthy: A Handbook on Delivering High Quality Software in the DevOps World](https://srcclr.github.io/test-lean/) #### Videos * [Test Lean and Ship Healthy: Delivering High Quality Software in the DevOps World](https://www.youtube.com/watch?v=sqtmcYKpy-A) </details> <details> <summary>Visma</summary> #### Videos * [Software Quality Engineering in Visma with Mili Orucevic](https://www.youtube.com/watch?v=MY5_q8bkvX4) </details> <details> <summary>WalmartLabs</summary> #### Blogs & Articles * [Test Automation of Query Understanding AI/ML based Model for an eCommerce Search - Kushal Kumar Verma](https://medium.com/analytics-vidhya/testing-query-understanding-ai-ml-based-model-for-an-ecommerce-search-d559510b82f) * [Elements of Successful Massive Scale Automated Testing - Maciej Adwent](https://medium.com/walmartglobaltech/elements-of-successful-massive-scale-automated-testing-f071c17f2907#.y4qn9hf9q) * [iOS Test Automation @WalmartLabs - Chaoyi Chen](https://medium.com/walmartglobaltech/ios-test-automation-walmartlabs-d8668d85a27) #### Videos * [SauceCon 2019: The Push From Within: A Journey Of Transformation - Claude Jones at Walmart Labs](https://www.youtube.com/watch?v=9QYDPnVTqjs) * [SauceCon 2019: Test Armada - Evolution of a Value-based Test Automation Platform - Pranav Verma at Walmart Labs](https://www.youtube.com/watch?v=YpA2jrH7rF8) </details> <details> <summary>Wikimedia</summary> #### Handbook * [Wikimedia Quality Handbook](https://www.mediawiki.org/wiki/Quality_Assurance) </details> <details> <summary>Wingify</summary> #### Blogs & Articles * [Performance Testing a data pipeline at scale](https://engineering.wingify.com/posts/performance-testing-a-data-pipeline-at-scale/) * [Automated Heatmap Verification E2E using Selenium and Canvas](https://engineering.wingify.com/posts/automated-heatmap-verification/) * [Automated environment deployments](https://engineering.wingify.com/posts/automated-environment-deployments/) * [Automating Web Push Notifications @Selenium Conference 2016](https://engineering.wingify.com/posts/automating-web-push-notifications/) * [Testing AngularJS Apps End to End Using Protractor](https://engineering.wingify.com/posts/angularapp-e2e-testing-with-protractor/) * [Overcoming the Challenges of Performance Testing Single-page Apps](https://engineering.wingify.com/posts/performance-testing/) </details> <details> <summary>Wix</summary> #### Blogs & Articles * [Software Developers, Communicate Your Intentions (TLDR: do it using tests)](https://www.wix.engineering/post/software-developers-communicate-your-intentions-tldr-do-it-using-tests) * [Meet Raven TestKit: Wix Engineering's Open Source Tool to Test Sentry Reports](https://www.wix.engineering/post/meet-raven-testkit-wix-engineering-s-open-source-tool-to-test-sentry-reports-1) * [How to Test Your Redux App](https://www.wix.engineering/post/how-to-test-your-redux-app) * [Testing Asynchronous Code](https://www.wix.engineering/post/testing-asynchronous-code) * [How to integrate 3rd Party APIs without Fear](https://medium.com/wix-engineering/how-to-integrate-3rd-party-apis-without-fear-part-1-a3dd4bf42cd6) * [Keep Your Tests Clean and Isolated with a Context](https://medium.com/wix-engineering/keep-your-tests-clean-and-isolated-with-a-context-258b31fe5cec) * [Asynchronous Sad Path Testing in React Using Jest and The Driver Pattern](https://medium.com/wix-engineering/asynchronous-sad-path-testing-in-react-using-jest-and-the-driver-pattern-84ad61d09b40) * [Keep your tests clean, by refactoring](https://medium.com/wix-engineering/https-medium-com-gavinrifkind-keep-your-tests-clean-by-refactoring-fd0310a103ed) * [Functional Testing with Tagless-Final](https://medium.com/wix-engineering/functional-testing-with-tagless-final-50eeacf5df6) * [Overestimated value of test documentation](https://medium.com/wix-engineering/overestimated-value-of-test-documentation-739dcf8ee85a) * [Testing Metrics: Are You Really Sure about the Quality of Your Product?](https://medium.com/wix-engineering/testing-metrics-are-you-really-sure-about-the-quality-of-your-product-8a5ef37ec3d4) * [Integration Tests in JavaScript That Don’t Suck](https://www.wix.engineering/post/integration-tests-in-javascript-that-don-t-suck) * [Building and Open-Sourcing Wix’s A/B Testing System](https://www.wix.engineering/post/building-and-open-sourcing-wix-s-a-b-testing-system) * [Mockingbird: The Why, When and How of Testing with Mocks — Part 1](https://medium.com/wix-engineering/mockingbird-why-when-and-how-of-testing-with-mocks-part-1-dceacd14e26f) * [Mockingbird: The Why, When and How of Testing with Mocks — Part 2](https://medium.com/wix-engineering/mockingbird-the-why-when-and-how-of-testing-with-mocks-part-2-50431cfd70be) * [Mockingbird — Part 3 — The Pitfalls](https://medium.com/wix-engineering/mockingbird-part-3-the-pitfalls-e42c03000a92) #### Videos * [The Price of TDD is Eternal Vigilance](https://youtu.be/lICpnTc5eQ8) * [Clean Tests](https://youtu.be/OD3lOVNGRDs) * [Testing with Protractor](https://youtu.be/iZjjb2xS-Ww) * [To Test or Not To Test?](https://youtu.be/wxd30bVd5x4) * [Screenshots in Automated Testing: When? How? Why?](https://youtu.be/voTJTi1Z_CA) * [Driving to UI Test Heaven](https://youtu.be/iqgIyOKISW4) * [Detox: tackling the flakiness of mobile automation](https://youtu.be/4rU0IGEt6OQ) * [Testing For Performance](https://youtu.be/T1Zuad-Mkg0) * [Detox: Graybox End to End Tests and Automation Library for Mobile Apps](https://youtu.be/qiRJT5Eig3g) * [TDD for the Curious](https://youtu.be/dOlkgAFlNxs) * [E2E testing with Javascript](https://youtu.be/Co6LKJPpxAM) * [Intro to TDD](https://youtu.be/Zf9O1FvPw1s) * [Meaningful Code Reviews](https://youtu.be/cALG01i6CkQ) * [E2E testing with Javascript](https://youtu.be/Co6LKJPpxAM) * [TDD: Discover Implementation by Stepping Small](https://youtu.be/EuXmP2uM-Wk) #### git * [Wix HTTP Testkit](https://github.com/wix/wix-http-testkit) </details> <details> <summary>Wrike</summary> #### Blogs & Articles * [Onboarding Process in Wrike QA Automation Team](https://medium.com/wriketechclub/onboarding-process-in-wrike-qa-automation-team-88a4265d6af7) * [Code Review Without Queues](https://medium.com/wriketechclub/code-review-without-queues-c252c1f05cfc) * [Generating a Smoke Test Suite](https://medium.com/wriketechclub/generating-a-smoke-test-suite-1fb5cddf6e7a) * [How To Improve Code Quality in an Autotest Project](https://medium.com/wriketechclub/how-to-improve-code-quality-in-an-autotest-project-36f9c9655d8b) * [Allure Integration at Wrike](https://medium.com/wriketechclub/allure-integration-at-wrike-c4d7280e4968) * [Test Markup in QA Automation](https://medium.com/wriketechclub/test-markup-in-qa-automation-59b6765a1d06) * [Autotesting Optimized: Intellij IDEA Plugins in Service of QA Automation](https://medium.com/wriketechclub/autotesting-optimized-intellij-idea-plugins-in-service-of-qa-automation-c2ebd99588a2) * [Callisto: An Easy Way To Run Selenium Tests in the Cloud](https://medium.com/wriketechclub/callisto-an-easy-way-to-run-selenium-tests-in-the-cloud-6c1bc39c49ae) * [All QA articles](https://medium.com/wriketechclub/qa/home) #### Videos * [Onboarding in QA Automation Team](https://www.youtube.com/watch?v=0xX8ndqkbaw) * [Test Markup in QA Automation](https://www.youtube.com/watch?v=Y4I6Vp4sk_o) * [Allure Integration at Wrike](https://www.youtube.com/watch?v=O6X2-1uoqAw) * [Smoke Tests Suite Generation](https://www.youtube.com/watch?v=9ND9d9YeY1U) * [Autotests Runs Optimization with IDEA Plugin](https://www.youtube.com/watch?v=RBwwf1xUAlc) * [How static analysis can help in QAA processes](https://www.youtube.com/watch?v=L42zH5ne074) * [Test quarantine or how to manage flaky tests](https://www.youtube.com/watch?v=kubqCb_7cxc) * [How to survive with lots of tests](https://www.youtube.com/watch?v=DX_VPu9VTdc) * [IntelliJ IDEA plugins in QA Automation](https://www.youtube.com/watch?v=DF9xhAeBo7k) * [Selenium(road to Kubernetes](https://www.youtube.com/watch?v=Y8muHzG_2nA) * [Callisto: how we learned to stop worrying and love Selenium](https://www.youtube.com/watch?v=pEMEczpx6s8) * [Performance testing of iOS applications](https://www.youtube.com/watch?v=wz_8Q8F8BDM) * [Why the Era of vintage TMS is going to be over?](https://www.youtube.com/watch?v=Aba4Yme7dlQ) * [How to save a year of your time every day](https://www.youtube.com/watch?v=LpCrLIwIUqU) * [Playlist with all 10 mins of Wrike QA](https://www.youtube.com/playlist?list=PLxcvsYzLfaTAlmnodUVvE971No9oi_SWU) * [QA playlist](https://www.youtube.com/playlist?list=PLxcvsYzLfaTBjBkFgSVMbwggMxAwu5sXt) </details> <details> <summary>Zalando</summary> #### Blogs & Articles * [Building an End to End load test automation system on top of Kubernetes](https://engineering.zalando.com/posts/2021/03/building-an-end-to-end-load-test-automation-system-on-top-of-kubernetes.html) * [Selenium Conf Gets a Dose of Zalenium](https://engineering.zalando.com/posts/2017/05/selenium-conf-gets-a-dose-of-zalenium.html) * [Zalenium: A Disposable and Flexible Selenium Grid Infrastructure](https://engineering.zalando.com/posts/2017/02/zalenium-a-disposable-and-flexible-selenium-grid-infrastructure.html) * [Zester – Unit Tests on Steroids](https://engineering.zalando.com/posts/2016/04/zester-mutation-testing.html) * [Selenium WebDriver Explained](https://engineering.zalando.com/posts/2016/03/selenium-webdriver-explained.html) * [Lean Testing, or Why Unit Tests are Worse than You Think](https://engineering.zalando.com/posts/2018/07/economic-perspective-testing.html) * [Do We Really Need UI Tests?](https://engineering.zalando.com/posts/2017/11/do-we-really-need-ui-testing.html) * [Integration tests with Testcontainers](https://engineering.zalando.com/posts/2021/02/integration-tests-with-testcontainers.html) * [Stop using constants. Feed randomized input to test cases.](https://engineering.zalando.com/posts/2021/02/randomized-input-testing-ios.html) * [End-to-end load testing Zalando’s production website](https://engineering.zalando.com/posts/2019/04/end-to-end-load-testing-zalandos-production-website.html) * [A Journey On End To End Testing A Microservices Architecture](https://engineering.zalando.com/posts/2019/02/end-to-end-microservices.html) </details> <details> <summary>Zerodha</summary> #### Blogs & Articles * [Hello, World!](https://zerodha.tech/blog/hello-world/) - Includes interesting aspects of how Zerodha managed testing and their principles around engineering quality. </details> ## Contributors <a href="https://github.com/abhivaikar/howtheytest/graphs/contributors"> <img src="https://contributors-img.web.app/image?repo=abhivaikar/howtheytest" /> </a> ## Contribution Want to contribute? Just fork and raise a PR! ## Credits - Images in banner used from https://undraw.co/ - Idea inspired from the [awesome](https://github.com/sindresorhus/awesome) lists. - Static site powered by [docsify](https://docsify.js.org/). - Contributors list generated using [contributors-img](https://contributors-img.web.app/preview) - All the authors and the companies they represented in the resources. ## Code of Conduct Please refer to the code of conduct [here](https://github.com/abhivaikar/howtheytest/blob/master/CODE_OF_CONDUCT.md). ## License [](https://creativecommons.org/publicdomain/zero/1.0/)

Curated list of resources on testing distributed systems

List of resources on testing distributed systems curated by Andrey Satarin ([@asatarin](https://twitter.com/asatarin)). If you are interested in my other stuff, checkout [talks](https://asatarin.github.io/talks) page. For any questions or suggestions you can reach out to me on Twitter ([@asatarin](https://twitter.com/asatarin)), Mastodon (<a rel="me" href="https://discuss.systems/@asatarin">https://discuss.systems/@asatarin</a>) or [LinkedIn](https://www.linkedin.com/in/asatarin/). **Table of Contents** <!-- Use TOC generator to update this https://luciopaiva.com/markdown-toc/ --> - [Overview of testing approaches](#overview-of-testing-approaches) - [Research Papers](#research-papers) - [Bugs](#bugs) - [Testing](#testing) - [Fault Tolerance](#fault-tolerance) - [Resilience In Complex Adaptive Systems](#resilience-in-complex-adaptive-systems) - [Jepsen](#jepsen) - [Formal Methods](#formal-methods) - [Lineage-driven Fault Injection](#lineage-driven-fault-injection) - [Chaos Engineering](#chaos-engineering) - [Fuzzing](#fuzzing) - [Microservices](#microservices) - [Game Days](#game-days) - [Performance and Benchmarking](#performance-and-benchmarking) - [Test Case Reduction](#test-case-reduction) - [Misc](#misc) - [Specific approaches in different distributed systems](#specific-approaches-in-different-distributed-systems) - [Google](#google) - [Amazon Web Services](#amazon-web-services) - [Netflix](#netflix) - [Microsoft](#microsoft) - [Meta](#meta) - [FoundationDB](#foundationdb) - [Cassandra](#cassandra) - [ScyllaDB](#scylladb) - [Dropbox](#dropbox) - [Elastic (Elasticsearch)](#elastic-elasticsearch) - [MongoDB](#mongodb) - [Confluent (Kafka)](#confluent-kafka) - [CockroachLabs (CockroachDB)](#cockroachlabs-cockroachdb) - [SingleStore](#singlestore) - [Twitter](#twitter) - [LinkedIn](#linkedin) - [Salesforce](#salesforce) - [VoltDB](#voltdb) - [PingCap (TiDB)](#pingcap-tidb) - [Cloudera](#cloudera) - [Wallaroo Labs](#wallaroo-labs) - [YugabyteDB](#yugabytedb) - [FaunaDB](#faunadb) - [Shopify](#shopify) - [Hazelcast](#hazelcast) - [Basho (Riak)](#basho-riak) - [CoreOS (etcd)](#coreos-etcd) - [Red Planet Labs](#red-planet-labs) - [Atomix Copycat](#atomix-copycat) - [Onyx](#onyx) - [Druid.io](#druidio) - [TigerBeetle](#tigerbeetle) - [Convex](#convex) - [Single node systems](#single-node-systems) - [SQLite](#sqlite) - [Sled](#sled) - [Clickhouse](#clickhouse) - [Tools](#tools) - [Network Simulation](#network-simulation) - [QuickCheck](#quickcheck) - [Benchmarking](#benchmarking) - [Linkbench](#linkbench) - [YCSB](#ycsb) ## Overview of testing approaches ### Research Papers #### Bugs * [What Bugs Live in the Cloud? A Study of 3000+ Issues in Cloud Systems](http://ucare.cs.uchicago.edu/pdf/socc14-cbs.pdf) — study of actual bugs in different popular distributed systems (Hadoop MapReduce, HDFS, HBase, Cassandra, ZooKeeper and Flume) * [TaxDC: A Taxonomy of Non-Deterministic Concurrency Bugs in Datacenter Distributed Systems](http://ucare.cs.uchicago.edu/pdf/asplos16-TaxDC.pdf) — comprehensive taxonomy of bugs in distributed systems (Cassandra, Hadoop MapReduce, HBase, ZooKeeper) * [An Empirical Study on Crash Recovery Bugs in Large-Scale Distributed Systems](https://dl.acm.org/doi/10.1145/3236024.3236030) — based on bug database from "What Bugs Live in the Cloud?" paper reseachers focus specifically on crash recovery bugs in Hadoop MapReduce, HBase, Cassandra, ZooKeeper. There is review of this paper by [Murat Demirbas](https://twitter.com/muratdemirbas) in [his blog](http://muratbuffalo.blogspot.com/2019/01/paper-review-empirical-study-on-crash.html). * [An empirical study on the correctness of formally verified distributed systems](https://blog.acolyer.org/2017/05/29/an-empirical-study-on-the-correctness-of-formally-verified-distributed-systems/) — study of bugs in formally verified distributed systems. Analysis includes Microsoft's [IronFleet distributed key-value store](https://www.microsoft.com/en-us/research/publication/ironfleet-proving-practical-distributed-systems-correct/) built from formal model. * [What bugs cause cloud production incidents?](https://blog.acolyer.org/2019/06/21/what-bugs-cause-cloud-production-incidents/) — research focused on bugs (and their resolution strategies) that actually cause production incidents in large-scale distributed services at [Microsoft](#microsoft) Azure. #### Testing * [Simple Testing Can Prevent Most Critical Failures: An Analysis of Production Failures in Distributed Data-Intensive Systems](https://www.usenix.org/conference/osdi14/technical-sessions/presentation/yuan) — Great overview of how even simple testing can help a lot, you just need right focus * [Early detection of configuration errors to reduce failure damage](https://blog.acolyer.org/2016/11/29/early-detection-of-configuration-errors-to-reduce-failure-damage/) — why and how to test configuration files of your system * [Why Is Random Testing Effective for Partition Tolerance Bugs?](https://dl.acm.org/doi/abs/10.1145/3158134) — just what it says in a title, authors try to explain why random testing ([Jepsen](#jepsen)) is effective and introduce notions of test coverage relating to network partition, see also ["The Morning Paper" review](https://blog.acolyer.org/2018/01/23/why-is-random-testing-effective-for-partition-tolerance-bugs/) or a [video](https://youtu.be/g5cehS7ZSJ8) from POPL 2018. * [FlyMC: Highly Scalable Testing of Complex Interleavings in Distributed Systems](https://ucare.cs.uchicago.edu/pdf/eurosys19-flyMC.pdf) — novel approach of systematically exploring interleavings in distributed systems augmented with static analysis and prioritization. This approach is faster than previous techniques and found old and new bugs in several systems (Cassandra, Ethereum Blockchain, Hadoop, Kudu, Raft LogCabin, Spark, ZooKeeper). * [Torturing Databases for Fun and Profit](https://www.usenix.org/system/files/conference/osdi14/osdi14-paper-zheng_mai.pdf) — checking ACID guarantees of open source and commercial databases under power loss, [additional material](https://www.usenix.org/node/186197) * [Understanding and Detecting Software Upgrade Failures in Distributed Systems](https://dl.acm.org/doi/10.1145/3477132.3483577) — paper presents first study of upgrade failures in distributed systems (Cassandra, HBase, Kafka, Mesos, YARN, ZooKeeper, etc). Authors look at severity, symptoms, causes and triggers of these failures and summarize results in a number of findings. They propose two new tools to improve testing targeting upgrade failures specifically and apply those tools to a few systems with good results (new bugs and potential bugs found). I gave an [overview talk](https://asatarin.github.io/talks/2022-09-upgrade-failures-in-distributed-systems/) of the paper in September 2022. #### Fault Tolerance * [Redundancy does not imply fault tolerance: analysis of distributed storage reactions to single errors and corruptions](https://blog.acolyer.org/2017/03/08/redundancy-does-not-imply-fault-tolerance-analysis-of-distributed-storage-reactions-to-single-errors-and-corruptions/) — study of several distributed systems (Redis, ZooKeeper, MongoDB, Cassandra, Kafka, RethinkDB) on how fault tolerant they are to data corruption and read/write errors * [The Case for Limping-Hardware Tolerant Clouds](https://www.usenix.org/node/174577) — research on effect of limping hardware on performance of a distributed systems (aka limplock), see also great blog post by Dan Luu on a similiar topic [Distributed systems: when limping hardware is worse than dead hardware](https://danluu.com/limplock/) * [Toward a Generic Fault Tolerance Technique for Partial Network Partitioning](https://www.usenix.org/conference/osdi20/presentation/alfatafta) — overview of netrwork partition failures in various distributed systems (MongoDB, HBase, HDFS, Kafka, RabbitMQ, Elasticsearch, Mesos, etc), common traits among them and strategies to mitigate those failures. * [Understanding, Detecting and Localizing Partial Failures in Large System Software](https://www.usenix.org/conference/nsdi20/presentation/lou) — what happens if your system loses some functionality due to failure as opposed to full fail-stop? Authors study how these partial failures manifest in distributed systems (ZooKeeper, Cassandra, HDFS, Mesos) and what triggers them. They propose runtime approach to detect those failure with mimic-style intrinsic watchdogs and show how these watchdogs could be generated automatically. They managed to reproduce 20 out of 22 real world partial failures and detect them using intrinsic watchdogs with great code localization and reaction time within a few seconds. See also [overview talk](https://asatarin.github.io/talks/2022-05-understanding-partial-failures/) on the paper. #### Technologies for Testing Distributed Systems by Colin Scott Colin Scott shares his viewpoint from academia on testing distributed systems, specifically regression testing for correctness and performance bugs. * [Technologies for Testing Distributed Systems, Part I](http://colin-scott.github.io/blog/2016/03/04/technologies-for-testing-and-debugging-distributed-systems/) * See also post [Distributed Systems Testing: The Lost World](http://tagide.com/blog/research/distributed-systems-testing-the-lost-world/) by Crista Lopes #### Testing in a Distributed World by Ines Sombra (RICON 2014) Great overview of techniques for testing distributed systems from practitioner, the [video](https://youtu.be/iZEXIN7-9tM) did age well and still extremely good overview of the landscape. Additional materials could be found in [this Github repo](https://github.com/Randommood/RICON2014) ### Resilience In Complex Adaptive Systems These materials are not directly related to testing distributed systems, but they greatly contribute to general understanding of such systems. * [Velocity NY 2013: Richard Cook, "Resilience In Complex Adaptive Systems"](https://youtu.be/PGLYEDpNu60) * [Velocity 2012: Richard Cook, "How Complex Systems Fail"](https://youtu.be/2S0k12uZR14) * [How Complex Systems Fail](http://web.mit.edu/2.75/resources/random/How%20Complex%20Systems%20Fail.pdf) ### Jepsen State of the art approach to testing stateful distributed systems. * [Jepsen Analyses](http://jepsen.io/analyses) — most recent Jepsen analyses of different distributed systems * [Jepsen Talks](http://jepsen.io/talks) — talks by Kyle Kingsbury on various conferences * [Aphyr's Jepsen posts](https://aphyr.com/tags/Jepsen) — older Jepsen analyses on Kyle Kingsbury's (Aphyr) personal site * [Jepsen Talks on Github](https://github.com/aphyr/jepsen-talks) — Jepsen talks slides before 2015 on Github * [Kyle Kingsbury on InfoQ](http://www.infoq.com/author/Kyle-Kingsbury) * [Call me maybe: Jepsen and flaky networks](http://www.slideshare.net/shalinmangar/call-me-maybe-jepsen-and-flaky-networks) — talk on Jepsen, not by Kyle * [Jepsen is used by Microsoft CosmosDB](https://twitter.com/dharmashukla/status/869104163510034432) — founder of Azure CosmosDB confirms, that they are using Jepsen Elle transactional consistency checker for black-box databases: * Elle [source code](https://github.com/jepsen-io/elle) * [Black-box Isolation Checking with Elle](https://youtu.be/OPJ_IcdSqig) — talk Kyle gave at [CMU DB](https://db.cs.cmu.edu/) database seminar descibing Elle and results obtained with it * [Elle: Inferring Isolation Anomalies from Experimental Observations](https://github.com/jepsen-io/elle/raw/master/paper/elle.pdf) — paper on Elle design by Kyle Kingsbury and Peter Alvaro Some notable Jepsen analyses: * [Jepsen: CockroachDB beta-20160829](https://jepsen.io/analyses/cockroachdb-beta-20160829) * [Jepsen: VoltDB 6.3](http://jepsen.io/analyses/voltdb-6-3) * [Jepsen: RethinkDB 2.2.3 reconfiguration](https://aphyr.com/posts/330-jepsen-rethinkdb-2-2-3-reconfiguration) * [Jepsen: RethinkDB 2.1.5](https://aphyr.com/posts/329-jepsen-rethinkdb-2-1-5) Jepsen is used by [CockroachDB](#cockroachlabs-cockroachdb), [VoltDB](#voltdb), [Cassandra](#cassandra), [ScyllaDB](#scylladb) and others. ### Formal Methods * [The verification of a distributed system By Caitie McCaffrey](http://queue.acm.org/detail.cfm?id=2889274) also [podcast](https://www.infoq.com/articles/podcast-caitie-mccaffrey) and [talk](https://www.infoq.com/presentations/distributed-systems-verification) on InfoQ.com and [accompanying materials](https://github.com/CaitieM20/Talks/tree/master/TheVerificationOfADistributedSystem) on GitHub and a [slidedeck](https://speakerdeck.com/caitiem20/qcon-newyork-2016-the-verification-of-a-distributed-system) * [Designing Distributed Systems in TLA+](https://www.hillelwayne.com/talks/distributed-systems-tlaplus/) by Hillel Wayne, and talk [Everything about distributed systems is terrible](https://youtu.be/tfnldxWlOhM) * [Comparisons of Alloy and Spin](http://www.pamelazave.com/compare.html) * [Verdi: Formally Verifying Distributed Systems](http://verdi.uwplse.org/) * [Verdi — A framework for formally verifying distributed systems implementations in Coq](https://github.com/uwplse/verdi) * [Network Semantics for Verifying Distributed Systems](https://homes.cs.washington.edu/~jrw12/network-semantics.html) * [Proving that Android’s, Java’s and Python’s sorting algorithm is broken (and showing how to fix it)](https://web.archive.org/web/20220329052326/http://envisage-project.eu/proving-android-java-and-python-sorting-algorithm-is-broken-and-how-to-fix-it/) — using formal verification to find a bug in TimSort sorting algorithm * [Proving JDK’s Dual Pivot Quicksort Correct](https://www.key-project.org/2017/08/17/dual-pivot/) — analizying quicksort implementation in Java Companies using TLA+ to verify correctness of algorithms: * [Amazon Web Services](#amazon-web-services) * [PingCap for TiDB](#pingcap-tidb) * [MongoDB](#mongodb) * [Microsoft](#microsoft) for services in Azure cloud * [Confluent](#confluent-kafka) for Apache Kafka ### Lineage-driven Fault Injection * [Lineage-driven Fault Injection](https://dl.acm.org/citation.cfm?id=2723711) * [Abstracting the Geniuses Away from Failure Testing](http://queue.acm.org/detail.cfm?id=3155114) [Netflix](#netflix) adopted lineage-driven fault injection techniques for testing microservices. ### Chaos Engineering * [Principles of Chaos Engineering](http://principlesofchaos.org/) * Free [Chaos Engineering](http://www.oreilly.com/webops-perf/free/chaos-engineering.csp) book by [Netflix](#netflix) engineers * [A curated list of awesome Chaos Engineering resources](https://github.com/dastergon/awesome-chaos-engineering) [Netflix](#netflix) pioneered chaos engineering discipline. ### Fuzzing There are two flavors of fuzzing. First, randomized concurrency testing, where the ordering of messages is fuzzed: * [Fuzzing Raft for Fun and Publication](https://colin-scott.github.io/blog/2015/10/07/fuzzing-raft-for-fun-and-profit/) * [Combining AFL and QuickCheck for Directed Fuzzing by Dan Luu](http://danluu.com/testing/) And input fuzzing, where message contents or user inputs are fuzzed: * [DNS parser, meet Go fuzzer](https://blog.cloudflare.com/dns-parser-meet-go-fuzzer/) * [Fuzz Testing with afl-fuzz (American Fuzzy Loop)](http://spin.atomicobject.com/2015/08/23/fuzz-testing-american-fuzzy-lop/) * [Randomized testing for Go](https://github.com/dvyukov/go-fuzz) and talk on this tool [GopherCon 2015: Dmitry Vyukov — Go Dynamic Tools](https://www.youtube.com/watch?v=a9xrxRsIbSU) * [Simple guided fuzzing for libraries using LLVM's new libFuzzer](http://blog.llvm.org/2015/04/fuzz-all-clangs.html) * [LibFuzzer – a library for coverage-guided fuzz testing](http://llvm.org/docs/LibFuzzer.html) * [How Heartbleed could've been found](https://blog.hboeck.de/archives/868-How-Heartbleed-couldve-been-found.html) — example of how fuzzing could be used for finding famous HeartBleed vulnerability ### Microservices Amazing and comprehensive overview of different strategies to test systems built with microservices by Cindy Sridharan. * [Testing Microservices, the sane way](https://copyconstruct.medium.com/testing-microservices-the-sane-way-9bb31d158c16) Series of blog posts specifically on testing in production — best practices, pitfaults, etc: * [Testing in Production, the safe way](https://copyconstruct.medium.com/testing-in-production-the-safe-way-18ca102d0ef1) * [Testing in Production: the hard parts](https://copyconstruct.medium.com/testing-in-production-the-hard-parts-3f06cefaf592) ### Game Days * [Sometimes Kill -9 Isn’t Enough](http://bravenewgeek.com/sometimes-kill-9-isnt-enough/) ### Performance and Benchmarking * [Your Load Generator Is Probably Lying To You](http://highscalability.com/blog/2015/10/5/your-load-generator-is-probably-lying-to-you-take-the-red-pi.html) * [Everything You Know About Latency Is Wrong](http://bravenewgeek.com/everything-you-know-about-latency-is-wrong/) — great overview of Gil Tene`s "How NOT to Measure Latency" talk * ["How NOT to Measure Latency" by Gil Tene](https://www.youtube.com/watch?v=lJ8ydIuPFeU) * ["Benchmarking: You're Doing It Wrong" by Aysylu Greenberg](https://www.youtube.com/watch?v=XmImGiVuJno) * [Performance Analysis Methodology](http://www.brendangregg.com/methodology.html) — approaches developed by Brendan Gregg for analysing performance in systematic fashion See also [benchmarking](#benchmarking) tools. ### Test Case Reduction * [Minimizing Faulty Executions of Distributed Systems](https://www.usenix.org/system/files/conference/nsdi16/nsdi16-paper-scott.pdf) — reducing the size of buggy executions to make them easier to understand. 60 minute talk [here](https://www.microsoft.com/en-us/research/video/minimizing-faulty-executions-distributed-systems/) * [Troubleshooting Blackbox SDN Control Software with Minimal Causal Sequences](https://dl.acm.org/doi/pdf/10.1145/2619239.2626304) — similar to above, but requires less instrumentation. * [Concurrency Debugging with Differential Schedule Projections](https://brandonlucia.com/pubs/symbiosis_final_pldi.pdf) — find and minimize concurrency bugs using program analysis. Shared memory systems are equivalent to message passing systems, so you can apply the same techniques to distributed systems. ### Misc * ["Simulation Testing" by Michael Nygard](https://youtu.be/N5HyVUPuU0E) * [Testing Distributed Systems for Linearizability](http://www.anishathalye.com/2017/06/04/testing-distributed-systems-for-linearizability/) * [Metamorphic Testing](https://www.hillelwayne.com/post/metamorphic-testing/) — overview of what metamorphic testing is and where it can help. For more details see paper ["Metamorphic Testing: A Review of Challenges and Opportunities"](https://www.cs.hku.hk/data/techreps/document/TR-2017-04.pdf). ## Specific approaches in different distributed systems ### Google * [Efficient Exploratory Testing of Concurrent Systems](http://www.pdl.cmu.edu/PDL-FTP/associated/CMU-PDL-11-113.pdf) — They don't mention it but looks like they describe testing of Google Omega * [Exploratory Testing Architecture (ETA) ](https://github.com/google/cluster-data/blob/master/ETAExplorationTraces.md) * [Paxos Made Live — An Engineering Perspective](http://research.google.com/pubs/pub33002.html) has a section on testing * [10 Years of Crashing Google](https://www.usenix.org/conference/lisa15/conference-program/presentation/krishnan) describes some war stories from Disaster Recovery Testing (DiRT) team at Google * [Testing for Reliability](https://landing.google.com/sre/book/chapters/testing-reliability.html) chapter from Google Site Reliability Engineering book * [Randomized Testing of Cloud Spanner](https://medium.com/@jcorbett_26889/randomized-testing-of-cloud-spanner-5286f1eaba75) — overview of randomized testing at Cloud Spanner, including how to scale it to large datasets and high concurrency ### Amazon Web Services * [The Evolution of Testing Methodology at AWS: From Status Quo to Formal Methods with TLA+](http://www.infoq.com/presentations/aws-testing-tla) * [Use of Formal Methods at Amazon Web Services](http://research.microsoft.com/en-us/um/people/lamport/tla/formal-methods-amazon.pdf) * [CACM Article "How Amazon Web Services Uses Formal Methods"](http://cacm.acm.org/magazines/2015/4/184701-how-amazon-web-services-uses-formal-methods/fulltext) * [Debugging Designs by Chris Newcombie](http://www.hpts.ws/papers/2011/sessions_2011/Debugging.pdf) there is also a [source bundle](http://www.hpts.ws/papers/2011/sessions_2011/amazonbundle.tar.gz) * [Millions of tiny databases](https://blog.acolyer.org/2020/03/04/millions-of-tiny-databases/) — has section on testing which describes several approaches: SimWorld simulation resembling approach used at [Foundation DB](#foundationdb), use of [Jepsen](#jepsen) and [formal methods](#formal-methods) and [game days](#game-days). * [Using lightweight formal methods to validate a key-value storage node in Amazon S3](https://www.amazon.science/publications/using-lightweight-formal-methods-to-validate-a-key-value-storage-node-in-amazon-s3) — paper on verifying correctness of a new key-value storage node implementation in S3. They are using property-based testing and stateless model checking extensively to balance trade-offs and follow pragmatic approach. I gave a talk ["Formal Methods at Amazon S3"](https://asatarin.github.io/talks/2022-02-formal-methods-at-amazon-s3/) on this paper for a reading group. See also [formal methods](#formal-methods) section. ### Netflix Automated failure injection (see also [Lineage-driven Fault Injection](#lineage-driven-fault-injection)): * [Monkeys in Lab Coats: Applying Failure Testing Research @Netflix](http://www.infoq.com/presentations/failure-test-research-netflix) * [“Monkeys in Labs Coats”: Applied Failure Testing Research at Netflix](http://www.infoq.com/news/2016/03/failure-testing-netflix) * [Automated Failure Testing](https://netflixtechblog.com/automated-failure-testing-86c1b8bc841f) * [Automating Failure Testing Research at Internet Scale](https://scholar.google.ru/scholar?hl=en&q=Automating+Failure+Testing+Research+at+Internet+Scale&btnG=&as_sdt=1%2C5&as_sdtp=) by P. Alvaro et.el Random/manual failure injection testing: * [Netflix Simian Army](https://netflixtechblog.com/the-netflix-simian-army-16e57fbab116) * [Failure Injection Testing](https://netflixtechblog.com/fit-failure-injection-testing-35d8e2a9bb2) * [From Chaos to Control — Testing the resiliency of Netflix’s Content Discovery Platform](https://netflixtechblog.com/from-chaos-to-control-testing-the-resiliency-of-netflixs-content-discovery-platform-ce5566aef0a4) * [Breaking Bad at Netflix: Building Failure as a Service](http://www.infoq.com/presentations/failure-as-a-service-netflix) * [GTAC 2014: I Don't Test Often ... But When I Do, I Test in Production](https://www.youtube.com/watch?v=xkP70Zhhix4) — Netflix different testing strategies See also [Chaos Engineering](#chaos-engineering). ### Microsoft * [Asynchronous programming, analysis and testing with state machines](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/paper-6.pdf) — Open source language for building distributed systems. Language is designed with tooling in mind, particularly, automatic exploration of message orderings in order to find bugs. * [Uncovering Bugs in Distributed Storage Systems during Testing (not in Production!)](http://research.microsoft.com/pubs/260939/paper.pdf) * [Windows Azure Storage: A Highly Available Cloud Storage Service with Strong Consistency](http://www.sigops.org/sosp/sosp11/current/2011-Cascais/11-calder-online.pdf) describes "Pressure Point Testing" approach used for Azure Cloud Storage * [Inside Azure Search: Chaos Engineering](https://azure.microsoft.com/ru-ru/blog/inside-azure-search-chaos-engineering/) * [TLA+ at Microsoft: 16 Years in Production](https://youtu.be/azx6cX-BlCs) by David Langworthy — how rejuvenation of TLA+ happened at Microsoft in 2016 and onwards See also [formal methods](#formal-methods) section. ### Meta * [BellJar: A new framework for testing system recoverability at scale](https://engineering.fb.com/2022/05/05/developer-tools/belljar/) — BellJar is a testing framework focused on answering question "What service dependencies are required for the service to recover after large scale disaster?". BellJar puts service in a vacuum environment with only handful of direct dependencies allowlisted to verify that recovery procedures succeed under those constraints. It checks those recovery procedures in CI/CD pipeline preventing unconstrained growth of dependency graph and circular dependencies. Based on BellJar tests one can construct the entire dependency graph of the services allowing to boostrap them in the correct order from bottom to top. ### FoundationDB * ["Testing Distributed Systems w/ Deterministic Simulation" by Will Wilson](https://youtu.be/4fFDFbi3toc) — talk on FoundationDB simulation testing. Their architecture was built from the ground up to suppport fully deterministic simulation testing * [Simulation and Testing](https://apple.github.io/foundationdb/testing.html) — public overview of FoundationDB simulation testing framework * [FoundationDB or: How I Learned to Stop Worrying and Trust the Database](https://youtu.be/OJb8A6h9jQQ) by Markus Pilman from Snowflake — updated talk on testing FoundationDB with determenistic simulation. Markus goes into details of what it takes to build determenistic simulation into a database. He mentions that it took two years to build a simulation framework before FoundationDB team started working on a database. * ["Buggify — Testing Distributed Systems with Deterministic Simulation"](https://transactional.blog/simulation/buggify.html) — Alex Miller ([https://twitter.com/oytyafln](https://twitter.com/oytyafln)), one of developers at FoundationDB, describes BUGGIFY macros, which helps bias simulation tests towards doing dangerous and bug finding things. This is a good example of cooperation between testing efforts and production code. * ["FoundationDB: A Distributed Unbundled Transactional Key Value Store"](https://sigmodrecord.org/publications/sigmodRecord/2203/pdfs/08_fdb-zhou.pdf) — SIGMOD 2021 paper on FoundationDB has a very detailed section on simulation testing at FoundationDB with discussions on determinism, test oracles, fault injection and limitations. ### Cassandra * [Testing Apache Cassandra with Jepsen](http://www.datastax.com/dev/blog/testing-apache-cassandra-with-jepsen) * [Testing Cassandra Guarantees under Diverse Failure Modes with Jepsen](http://www.slideshare.net/jkni/testing-cassandra-guarantees-under-diverse-failure-modes-with-jepsen-53168992) * [Testing Cassandra Guarantees under Diverse Failure Modes with Jepsen](http://cassandrasummit-datastax.com/agenda/testing-cassandra-guarantees-under-diverse-failure-modes-with-jepsen/) * [Jepsen Cassandra Testing on Git](https://github.com/riptano/jepsen) * [Netflix A STATE OF XEN — CHAOS MONKEY & CASSANDRA](https://vimeopro.com/user35188327/cassandra-summit-2015/video/140949186) from Cassandra Summit 2015 * [Testing Apache Cassandra with Jepsen: How to Understand and Produce Safe Distributed Systems](https://youtu.be/OnG1FCr5WTI) by Joel Knighton presented at Devoxx UK 2016 * [Testing Apache Cassandra 4.0](https://cassandra.apache.org/blog/2018/08/21/testing_apache_cassandra.html) — quick overview of approaches used to test next major version of Cassandra * [Fallout](https://github.com/datastax/fallout) — tool to run distributed tests as a service. It is meant to easily orchestrate cluster creation and testing tools like [Jepsen](#jepsen), performance testing tools and others, though extention and combining them in various ways with enviromental conditions. It could run tests either locally or on large scale clusters. * [Cassandra Harry](https://github.com/apache/cassandra-harry) — [Fuzz testing](#fuzzing) tool for Apache Cassandra. Aims to provide reproducible workloads to test correctness of Apache Cassandra. * [Fuzz Testing and Verification of Apache Cassandra with "Harry"](https://youtu.be/x885ck3mrZo) — talk on Harry fuzz testing tool by [Alex Petrov](https://twitter.com/ifesdjeen) at ApacheCon 2021 * [Harry, an Open Source Fuzz Testing and Verification Tool for Apache Cassandra](https://cassandra.apache.org/_/blog/Harry-an-Open-Source-Fuzz-Testing-and-Verification-Tool-for-Apache-Cassandra.html) by Alex Petrov — blog post about Harry fuzz testing tool for Apache Cassandra and how it helps to find bugs ### ScyllaDB They published series of blog posts on testing ScyllaDB: * [Scylla testing part 1: Cassandra compatibility testing](http://www.scylladb.com/2016/02/04/cassandra-compatibility-testing/) * [Scylla testing part 2: Extending Jepsen for testing Scylla](http://www.scylladb.com/2016/02/11/jepsen-testing/) * [CharybdeFS: a new fault-injecting filesystem for software testing](http://www.scylladb.com/2016/02/16/fault-injection-filesystem-software-testing/) * [Testing part 4: Distributed tests](http://www.scylladb.com/2016/03/10/dtest-scylla/) * [Testing part 5: Longevity testing](http://www.scylladb.com/2016/03/15/longevity-testing-scylla/) * [Fault-injecting filesystem cookbook](http://www.scylladb.com/2016/05/02/fault-injection-filesystem-cookbook/) Video from Scylla Summit 2017 on testing * [How We Constantly Try to Bring Scylla to its Knees](https://youtu.be/K38RDEdt070) and [slides](https://www.slideshare.net/ScyllaDB/scylla-summit-2017-cry-in-the-dojo-laugh-in-the-battlefield-how-we-constantly-try-to-bring-scylla-to-its-knees) — overview of different testing types at ScyllaDB * [Project Gemini: An Open Source Automated Random Testing Suite for Scylla and Cassandra Clusters](https://www.scylladb.com/2019/12/11/project-gemini-an-open-source-automated-random-testing-suite-for-scylla-and-cassandra-clusters/) — random test generator comparing results from cluster with injected faults against single node running without faults. Works on tops of CQL API and suitable for testing any database implementing it. See also talk on [Project Gemini](https://youtu.be/QPnlpglmPcY) and [open source code](https://github.com/scylladb/gemini) * [ScyllaDB NoSQL Database Testing](https://www.scylladb.com/product/technology/scylla-testing/) — highlights of testing approaches at Scylla ### Dropbox * [Mysteries of Dropbox Property-Based Testing of a Distributed Synchronization Service](http://www.cis.upenn.edu/~bcpierce/papers/mysteriesofdropbox.pdf) — example of how to use QuickCheck to test synchronisation in Dropbox and similar tools (Google Drive). John Hughes gave a [talk on this](https://youtu.be/H18vxq-VsCk). See also [QuickCheck](#quickcheck). * [Data Checking at Dropbox](https://youtu.be/WUaMN2kywR4) — If you have lots of data, you have to verify that is doesn't bit rot and protect it against rare bugs (e.g. race conditions) to guarantee long term durability. This talks explains intricacies of building data consistency checker(s) at Dropbox scale. * [Dropbox's Exabyte Storage System](https://www.facebook.com/atscaleevents/videos/1741691622770601/) (aka Magic Pocket) talk by James Cowling — describes number of strategies to achieve exteremely high durability. This includes: - guard against faulty disks, - guard against software defects, - guard against black swan events, - operational safeguards to reduce blast radius, - safeguards against deletes with multi stage soft-delete, - comprehensive testing strategy in-depth with increased scale, - redundancy across varios axis in software and hardware stacks, - continuous data integrity validation on many levels, - etc * [Testing sync at Dropbox](https://dropbox.tech/infrastructure/-testing-our-new-sync-engine) — comprehensive overview of two test frameworks at Dropbox for new sync engine implementation. CanopyCheck — single threaded and fully deterministic randomized testing framework with minimization for synchronization planner component of the engine. The other framework Trinity focuses on concurrency and larger surface area of componenents. Great discussion on tradeoffs between determinism, strengh of test oracles vs width of coverage and size of the system under test. ### Elastic (Elasticsearch) * [Growing a protocol](https://blog.acolyer.org/2017/08/23/growing-a-protocol/) — applying [lineage driven fault injection](#lineage-driven-fault-injection) to test Elasticsearch replication protocol * [Using TLA+ for fun and profit in the development of Elasticsearch](https://youtu.be/qYDcbcOVurc) by Yannick Welsch — Elasticsearch uses [TLA+](#formal-methods) to verify correctnes of their replication protocol ### MongoDB * [MongoDB’s JavaScript Fuzzer: Creating Chaos (1/2)](https://www.mongodb.com/blog/post/mongodbs-java-script-fuzzer-creating-chaos) * [MongoDB’s JavaScript Fuzzer: Harnessing the Havoc (2/2)](https://www.mongodb.com/blog/post/mongodb-java-script-fuzzer-harnessing-havoc-2) * [MongoDB's JavaScript Fuzzer](https://queue.acm.org/detail.cfm?id=3059007) article in ACM Queue * [Fixing a MongoDB Replication Protocol Bug with TLA+](https://youtu.be/x9zSynTfLDE) by William Schultz — how MongoDB uses [formal verification](#formal-methods) with TLA+ to check correctness of their replication protocol. Describes how replication bugs could have been found with help of formal model. * [eXtreme Modelling in Practice](https://arxiv.org/abs/2006.00915) — two attempts at MongoDB to check that code conforms to its formal model. * [Change Point Detection in Software Performance Testing](https://arxiv.org/abs/2003.00584) — paper on how MongoDB team automatically detects performance degradations in the presence of noise in continuous integration runs. The paper was presented at [ICPE 2020](https://youtu.be/rSBgcMFPkHU) See also [formal methods](#formal-methods) section. ### Confluent (Kafka) * [Kafka Fault Injection framework](https://cwiki.apache.org/confluence/display/KAFKA/Fault+Injection) * [TLA+ specification of the Kafka replication protocol](https://github.com/hachikuji/kafka-specification) and talk about using TLA+ for [hardening Kafka replication protocol](https://www.confluent.io/kafka-summit-sf18/hardening-kafka-replication) See also [formal methods](#formal-methods) section. ### CockroachLabs (CockroachDB) * [DIY Jepsen Testing CockroachDB](https://www.cockroachlabs.com/blog/diy-jepsen-testing-cockroachdb/) — great read about using Jepsen at Cockroach Labs * [CockroachDB Beta Passes Jepsen Testing](https://www.cockroachlabs.com/blog/cockroachdb-beta-passes-jepsen-testing/) — CockroachDB tested by Kyle Kingsbury (Jepsen.io) * [Introducing Pebble: A RocksDB Inspired Key-Value Store Written in Go](https://www.cockroachlabs.com/blog/pebble-rocksdb-kv-store/) — introduces new storage engine and includes thorough discussion on what it takes to properly test storage engine * [ParallelCommits.tla](https://github.com/cockroachdb/cockroach/blob/master/docs/tla-plus/ParallelCommits/ParallelCommits.tla) — Formal specification in TLA+ of the [parallel commit](https://www.cockroachlabs.com/blog/parallel-commits/) transaction protocol. See also [formal methods](#formal-methods). ### SingleStore Formerly known as MemSQL. * [Running SingleStore’s 107 Node Test Infrastructure on CoreOS](https://www.singlestore.com/blog/running-memsqls-107-node-test-infrastructure-on-coreos/). See also accompanying [talk](https://youtu.be/uJirOCUg67o). * [Practical Techniques to Achieve Quality in Large Software Projects](https://www.singlestore.com/blog/test-coverage-manage-long-tail-surfaced-bugs-using-force-multipliers/) * [How to Make a Believable Benchmark](https://www.singlestore.com/blog/how-to-make-a-believable-benchmark/) * [Building an Infinitely Scalable Testing System](https://www.singlestore.com/blog/building-an-infinitely-scalable-testing-system/) — description of internal test system PsyDuck ### Twitter * [Diffy: Testing services without writing tests](https://blog.twitter.com/2015/diffy-testing-services-without-writing-tests) * [How we break things at Twitter: failure testing](https://blog.twitter.com/2015/how-we-break-things-at-twitter-failure-testing) ### LinkedIn * [Simoorg Failure inducer framework](https://github.com/linkedin/simoorg) — Failure inducer implemented in Python * [A Deep Dive into Simoorg](https://engineering.linkedin.com/blog/2016/03/deep-dive-Simoorg-open-source-failure-induction-framework) * [Dynamometer: Scale Testing HDFS on Minimal Hardware with Maximum Fidelity](https://engineering.linkedin.com/blog/2018/02/dynamometer--scale-testing-hdfs-on-minimal-hardware-with-maximum) — testing scalability of large Hadoop clusters (namely NameNode) with just fraction of nodes ### Salesforce * [Go Fast and Don't Break Things: Ensuring Quality in the Cloud](http://www.hpts.ws/papers/2011/sessions_2011/HansmaHPTS2011.pdf) ### VoltDB Series of post on testing at VoltDB: * [How We Test at VoltDB](https://www.voltdb.com/blog/2015/09/30/how-we-test-at-voltdb/) * [Testing at VoltDB: SQLCoverage](https://web.archive.org/web/20210126003050/https://voltdb.com/blog/2016/03/testing-voltdb-sqlcoverage/) — describes how they test SQL query functionality using 5 millions queries generated from templates and comparing results against HSQLDB * [Testing VoltDB Against PostgreSQL](https://web.archive.org/web/20210830070918/https://www.voltdb.com/blog/2016/04/testing-voltdb-postgresql/) * [VoltDB 6.4 Passes Official Jepsen Testing](https://www.voltdb.com/blog/2016/07/12/voltdb-6-4-passes-official-jepsen-testing/) — VoltDB hired Kyle Kingsbury ([Jepsen](#jepsen)) to tests their database, they share results in this post Additional resources: * ["All In With Determinism for Performance and Testing in Distributed Systems" by John Hugg](https://www.youtube.com/watch?v=gJRj3vJL4wE) and a slide deck [Hugg-DeterministicDistributedSystems.pdf](https://github.com/strangeloop/StrangeLoop2015/blob/master/slides/talks/Hugg-DeterministicDistributedSystems.pdf) * [SelfCheck workload](https://github.com/VoltDB/voltdb/tree/master/tests/test_apps/txnid-selfcheck2) * [TPC-C implementation](https://github.com/VoltDB/voltdb/tree/master/tests/test_apps/tpcc) ### PingCap (TiDB) * [Use Chaos to test the distributed system linearizability](https://medium.com/@siddontang/use-chaos-to-test-the-distributed-system-linearizability-4e0e778dfc7d) — describes Jepsen-like framework implemented in Go and used at PingCap to test TiDB * [A test framework for linearizability check with Go](https://github.com/siddontang/chaos) — Chaos is a Jepsen-like framework written in Go * [Testing Distributed Systems for Linearizability](http://www.anishathalye.com/2017/06/04/testing-distributed-systems-for-linearizability/) — linearizability testing library used by Chaos framework * [Chaos Tools and Techniques for Testing the TiDB Distributed NewSQL Database](https://thenewstack.io/chaos-tools-and-techniques-for-testing-the-tidb-distributed-newsql-database/) and the same post on company [blog](https://pingcap.com/blog/chaos-practice-in-tidb/) * [Official Jepsen report on TiDB 2.1.7](https://jepsen.io/analyses/tidb-2.1.7) and [companion blog post](https://pingcap.com/blog/tidb-passes-jepsen-test-for-snapshot-isolation-and-single-key-linearizability/) in company blog * [Safety First! Common Safety Pitfalls in Distributed Databases Found by Jepsen Tests](https://pingcap.com/blog/safety-first-common-safety-pitfalls-in-distributed-databases-found-by-jepsen-tests/) — overview of Jepsen approach and tests with quick refresher on results for different databases to date * [https://github.com/pingcap/tla-plus](https://github.com/pingcap/tla-plus) — formal specification in TLA+ of Raft consensus protocol and implementation of distributed transactions in TiDB * [Testing Cloud-Native Databases with Chaos Mesh](https://youtu.be/FIB1qvLHYsw) — talk on Chaos Mesh and how it is used for testing TiDB at PingCap. Blog post with [introduction to Chaos Mesh](https://pingcap.com/blog/chaos-mesh-your-chaos-engineering-solution-for-system-resiliency-on-kubernetes) and how it integrates with Kubernetes. See also Chaos Mesh [source code](https://github.com/chaos-mesh/chaos-mesh) and [chaos engineering](#chaos-engineering) section. See also [formal methods](#formal-methods) section. ### Cloudera * [Quality Assurance at Cloudera: Fault Injection and Elastic Partitioning](https://web.archive.org/web/20190718225437/https://blog.cloudera.com/blog/2016/04/quality-assurance-at-cloudera-fault-injection-and-elastic-partitioning/) — Cloudera describes their approach to fault injection testing * [Quality Assurance at Cloudera: Highly-Controlled Disk Injection](https://web.archive.org/web/20190701102035/http://blog.cloudera.com/blog/2016/08/quality-assurance-at-cloudera-highly-controlled-disk-injection/) ### Wallaroo Labs * [Measuring Correctness of State in a Distributed System](http://web.archive.org/web/20220309161005/https://blog.wallaroolabs.com/2017/10/measuring-correctness-of-state-in-a-distributed-system/) — describes general idea and implementation how to test safety of distributed stream processing system * [Performance testing a low-latency stream processing system](http://web.archive.org/web/20220309180234/https://blog.wallaroolabs.com/2018/03/performance-testing-a-low-latency-stream-processing-system/) — high level overview of what to look at when testing performance of stream processing system * [How We Test the Stateful Autoscaling of Our Stream Processing System](http://web.archive.org/web/20220309173229/https://blog.wallaroolabs.com/2018/03/how-we-test-the-stateful-autoscaling-of-our-stream-processing-system/) — advanced safety tests for autoscaling stateful stream processing * All [posts on testing](http://web.archive.org/web/20220309163659/https://blog.wallaroolabs.com/categories/testing/) from Walaroo engineering blog There is also talk from Sean T. Allen on testing stream processing system at Wallaroo Labs (ex. Sendence) * [Materials on Sean's blog "CodeMeshIO: How Did I Get Here?"](http://www.monkeysnatchbanana.com/2016/11/22/codemeshio-how-did-i-get-here/) * [Video from QCon NY 2016 on InfoQ](https://www.infoq.com/presentations/trust-distributed-systems) * [Video from CodeMeshIO on YouTube](https://www.youtube.com/watch?v=6MsPDtpe2tg) * [Presentation on Speakerdeck](https://speakerdeck.com/seantallen/how-did-i-get-here-building-confidence-in-a-distributed-stream-processor-1) ### YugabyteDB * [Jepsen Testing on YugabyteDB](https://blog.yugabyte.com/jepsen-testing-on-yugabyte-db-database/) — YugabyteDB describes how they use [Jepsen](#jepsen) * [YugabyteDB 1.1.9 analysis by Kyle Kingsbury](https://jepsen.io/analyses/yugabyte-db-1.1.9) — Kyle explores safety of YugabyteDB. Accompanying post in company blog ["YugabyteDB 1.2 Passes Jepsen Testing"](https://blog.yugabyte.com/yugabyte-db-1-2-passes-jepsen-testing/) and ["Wrapping Up: Jepsen Test Results for YugabyteDB 1.2 Webinar"](https://blog.yugabyte.com/wrapping-up-jepsen-test-results-for-yugabyte-db-1-2-webinar/) post with webinar recording by Kyle and Karthik Ranganathan (Yugabyte CTO). * [YugabyteDB 1.3.1](https://jepsen.io/analyses/yugabyte-db-1.3.1) — Jepsen analysis of YugabyteDB support for serializable SQL transactions. Companion [blog post](https://blog.yugabyte.com/yugabyte-db-distributed-sql-api-passes-jepsen-tests/) on the company website. ### FaunaDB * [Verifying Transactional Consistency with Jepsen](https://medium.com/fauna/verifying-transactional-consistency-with-jepsen-and-faunadb-561eddd123c7) — results of internal [Jepsen](#jepsen) testing at FaunaDB * [Jepsen: FaunaDB 2.5.4](https://jepsen.io/analyses/faunadb-2.5.4) — official [Jepsen](#jepsen) test for FaunaDB, write-up in Fauna [blog](https://fauna.com/blog/faunadbs-official-jepsen-results) ### Shopify * [Resiliency Testing with Toxiproxy](https://www.usenix.org/conference/lisa17/conference-program/presentation/pittis) * [Toxiproxy — A TCP proxy to simulate network and system conditions for chaos and resiliency testing](https://github.com/Shopify/toxiproxy) ### Hazelcast * [Testing the CP Subsystem with Jepsen](https://hazelcast.com/blog/testing-the-cp-subsystem-with-jepsen/) — overview of how [Jepsen](#jepsen) is used to test Hazelcast in-memory data grid CP sybsystem ### Basho (Riak) * [Testing Eventual Consistency in Riak](http://www.erlang-factory.com/conference/ErlangUserConference2012/speakers/UlfNorell) — how to model eventually consistent database in [QuickCheck](#quickcheck) and find bugs in it's implementation, video available [on youtube](https://youtu.be/x9mW54GJpG0) * [Modeling Eventual Consistency Databases with QuickCheck](https://vimeo.com/23220830) — another talk on testing Riak eventual consistency guarantees with [QuickCheck](#quickcheck) ### CoreOS (etcd) * [Testing distributed systems in Go](https://web.archive.org/web/20170224103337/https://coreos.com/blog/testing-distributed-systems-in-go.html) — overview of failure injection testing for etcd. Or alternative url for [the same post](https://blog.gopheracademy.com/advent-2016/testing-distributed-systems-in-go/). ### Red Planet Labs * [Where we’re going, we don’t need threads: Simulating Distributed Systems](https://tech.redplanetlabs.com/2021/03/17/where-were-going-we-dont-need-threads-simulating-distributed-systems/) — following [FoundationDB](#foundationdb) steps, Red Planet Labs uses deterministic simulation for testing. Their formula for success is "deterministic simulation = no parallelism + quantized execution + deterministic behavior". ### Atomix Copycat * [A novel implementation of the Raft consensus algorithm](https://github.com/atomix/copycat) * [Jepsen tests for Atomix Copycat](https://github.com/atomix/atomix-jepsen) ### Onyx * [Onyx Straps in For a Jepsening](http://www.onyxplatform.org/jekyll/update/2016/03/15/Onyx-Straps-In-For-A-Jepsening.html) * [Jepsen test Onyx](https://github.com/onyx-platform/onyx-jepsen) ### Druid.io * [Architecting Distributed Databases for Failure](http://www.infoq.com/presentations/data-integrity-distributed-systems) ### TigerBeetle * [Simulation Tests in TigerBeetle](https://github.com/tigerbeetledb/tigerbeetle/blob/main/docs/HACKING.md#simulation-tests) — TigerBeetle is a distributed financial accounting database built in Zig programming language and uses simulation tests inspired by [Dropbox](#dropbox) and [FoundationDB](#foundationdb). ### Convex * [Convex: Life Without a Backend Team](https://youtu.be/iizcidmSwJ4) by [James Cowling](https://twitter.com/jamesacowling) — talks about architecture and features of [Convex](https://www.convex.dev/). At the [end of the talk](https://youtu.be/iizcidmSwJ4?t=2788) James covers testing at Convex. They use approach inspired by [QuickCheck](#quickcheck) and [FoundationDB](#foundationdb) to test end-to-end guarantees with randomized initial state, workload, injected failures and thread interleavings. These tests validate correctness in production similar to [Dropbox](#dropbox) Magic Pocket system on which James worked previously. * [Better Testing With Less Code Using Randomization](https://blog.convex.dev/randomized-testing/) — blog post describing approach Convex uses to develop randomized tests See also [QuickCheck](#quickcheck), [FoundationDB](#foundationdb), [Dropbox](#dropbox), [Jepsen](#jepsen). ## Single node systems These examples are not about distributed systems, but they demostrate testing concurrency and level of sofistication required in distributed systems. ### SQLite SQLite is not a distributed system by any stretch of the imagination, but provides good example of comprehensive testing of a database implementation. * [Finding bugs in SQLite, the easy way](http://lcamtuf.blogspot.ru/2015/04/finding-bugs-in-sqlite-easy-way.html) — how fuzzing used in testing SQLite database * [How SQLite Is Tested](https://www.sqlite.org/testing.html) ### Sled * [Sled simulation guide (jepsen-proof engineering)](http://sled.rs/simulation) — guide on simulation testing (see [FoundationDB](#foundationdb)) in Sled database * [Reliable Systems Series: Model-Based Testing](https://medium.com/@tylerneely/reliable-systems-series-model-based-property-testing-e89a433b360) ### Clickhouse * [Fuzzing ClickHouse](https://clickhouse.com/blog/fuzzing-click-house) — high level overview of query [fuzzing](#fuzzing) at Clickhouse * [ClickHouse Testing](https://clickhouse.com/docs/en/development/tests/) — documentation on various tests for ClickHouse database and how to contribute more tests ## Tools * [Hermitage: Testing transaction isolation levels](https://github.com/ept/hermitage) * [RapidCheck — QuickCheck port to C++](https://github.com/emil-e/rapidcheck) * [faketime](https://manpages.ubuntu.com/manpages/trusty/man1/faketime.1.html) ### Network Simulation * [Comcast — Simulating shitty network connections so you can build better systems](https://github.com/tylertreat/comcast) * [Muxy Simulating real-world distributed system failures](https://github.com/mefellows/muxy) * [Namazu — Programmable fuzzy scheduler for testing distributed systems](https://github.com/osrg/namazu) * [Toxiproxy — A TCP proxy to simulate network and system conditions for chaos and resiliency testing](https://github.com/Shopify/toxiproxy) * [Traffic Control](http://www.funtoo.org/Traffic_Control) * [Python API for Linux Traffic Control](https://github.com/praus/shapy) * [Slow tool](https://github.com/ModusCreateOrg/slow/) * [Blockade is a utility for testing network failures and partitions in distributed applications](https://github.com/dcm-oss/blockade) * [DEMi: Distributed Execution Minimizer for Akka](https://github.com/NetSys/demi) * [Chaos Mesh](https://chaos-mesh.org/) — [chaos engineering](#chaos-engineering) platform for Kubernetes. See also [PingCap](#pingcap-tidb), company behind Chaos Mesh. ### QuickCheck * [PolyConf 14: Testing the Hard Stuff and Staying Sane / John Hughes](https://youtu.be/F6LzB6SdFKA) * [The Joy of Testing](http://www.infoq.com/presentations/The-Joy-of-Testing) * [John Hughes on InfoQ](http://www.infoq.com/author/John-Hughes) * [Hansei: Property-based Development of Concurrent Systems](https://speakerdeck.com/jtuple/hansei-property-based-development-of-concurrent-systems) * [QuickChecking Poolboy for Fun and Profit](http://basho.com/posts/technical/quickchecking-poolboy-for-fun-and-profit/) — from Basho * [Combining Fault-Injection with Property-Based Testing](https://dl.acm.org/doi/10.1145/2559627.2559629) * [Testing Telecoms Software with Quviq QuickCheck](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.148.6554&rep=rep1&type=pdf) * [Fuzz testing distributed systems with QuickCheck](https://making.pusher.com/fuzz-testing-distributed-systems-with-quickcheck/index.html) — using QuickCheck to test Raft protocol implementation in Haskell ### Benchmarking * [OLTP-Bench: An Extensible Testbed for Benchmarking Relational Databases](http://www.vldb.org/pvldb/vol7/p277-difallah.pdf) * [OLTP Benchmark on Github](https://github.com/oltpbenchmark) * [Py-TPCC](https://github.com/apavlo/py-tpcc) * [Netflix Data Benchmark: Benchmarking Cloud Data Stores](https://netflixtechblog.com/netflix-data-benchmark-benchmarking-cloud-data-stores-7266186ded11) ### Linkbench * [LinkBench from Facebook](https://www.facebook.com/notes/facebook-engineering/linkbench-a-database-benchmark-for-the-social-graph/10151391496443920) and [Github.com repo](https://github.com/facebookarchive/linkbench) * [LinkBenchX from Percona](https://www.percona.com/blog/2015/05/01/linkbenchx-benchmark-based-arrival-request-rate/) ### YCSB * [Yahoo! Cloud System Benchmark (YCSB)](https://github.com/brianfrankcooper/YCSB) * [YCSB+T: Benchmarking Web-scale Transactional Databases](http://www.researchgate.net/publication/269306582_YCSBT_Benchmarking_web-scale_transactional_databases) * [YCSB++](http://www.pdl.cmu.edu/ycsb++/) * [Correcting YCSB's Coordinated Omission problem](http://psy-lob-saw.blogspot.ru/2015/03/fixing-ycsb-coordinated-omission.html)

📗🌐 🚢 Comprehensive and exhaustive JavaScript & Node.js testing best practices (December 2022)

Recent Fuzzing Paper

# Recent Papers Related To Fuzzing Remark: This website is only used for collecting and grouping the related paper. If there are any paper need to be updated, you can contribute PR. Main Repo.: [https://github.com/wcventure/FuzzingPaper](https://github.com/wcventure/FuzzingPaper) Mirrors: [https://gitcode.net/mirrors/wcventure/FuzzingPaper](https://gitcode.net/mirrors/wcventure/FuzzingPaper) # All Papers (Classification according to Publication) - **Survey/Review** - [Fuzzing: A Survey for Roadmap](#fuzzing-a-survey-for-roadmap) - [Fuzzing: Challenges and Reflections](#fuzzing-challenges-and-reflections) - [SoK: The Progress, Challenges, and Perspectives of Directed Greybox Fuzzing](#sok-the-progress-challenges-and-perspectives-of-directed-greybox-fuzzing) - [Fuzzing: Hack, Art, and Science](#fuzzing-hack-art-and-science-cacm-2020) - [Survey of Directed Fuzzy Technology](#survey-of-directed-fuzzy-technology) - [A Review of Machine Learning Applications in Fuzzing](#a-review-of-machine-learning-applications-in-fuzzing) - [A systematic review of fuzzing based on machine learning techniques](#a-systematic-review-of-fuzzing-based-on-machine-learning-techniques) - [The Art, Science, and Engineering of Fuzzing: A Survey](#the-art-science-and-engineering-of-fuzzing-a-survey) - [Fuzzing: Art, Science, and Engineering](#fuzzing-art-science-and-engineering) - [Fuzzing: a survey](#fuzzing-a-survey) - [Fuzzing: State of the art](#fuzzing-state-of-the-art) - [Survey of Software Fuzzing Techniques](#survey-of-software-fuzzing-techniques) - [A Review of Fuzzing Tools and Methods](#a-review-of-fuzzing-tools-and-methods) - **ASE 2022** - [Effectively Generating Vulnerable Transaction Sequences in Smart Contracts with Reinforcement Learning-guided Fuzzing] - [Efficient Greybox Fuzzing to Detect Memory Errors] - [FuzzerAid: Grouping Fuzzed Crashes Based On Fault Signatures] - [Fuzzle: Making a Puzzle for Fuzzers] - [Griffin: Grammar-Free DBMS Fuzzing] - [HTFuzz: Heap Operation Sequence Sensitive Fuzzing] - [LawBreaker: An Approach for Specifying Traffic Laws and Fuzzing Autonomous Vehicles] - [QATest: A Uniform Fuzzing Framework for Question Answering Systems] - [So Many Fuzzers, So Little Time - Experience from Evaluating Fuzzers on the Contiki-NG Network (Hay)StackVirt] - **ISSTA 2022** - [sAlmost Correct Invariants: Synthesizing Inductive Invariants by Fuzzing Proof](#almost-correct-invariants-synthesizing-inductive-invariants-by-fuzzing-proofs-issta-2022) - [ocTer: Documentation-Guided Fuzzing for Testing Deep Learning API Functions](#octer-documentation-guided-fuzzing-for-testing-deep-learning-api-functions-issta-2022) - [Efficient Greybox Fuzzing of Applications in Linux-based IoT Devices via Enhanced User-mode Emulation](#efficient-greybox-fuzzing-of-applications-in-linux-based-iot-devices-via-enhanced-user-mode-emulation-issta-2022) - [MDPFuzz: Testing Models Solving Markov Decision Processes](#mdpfuzz-testing-models-solving-markov-decision-processes-issta-2022) - [PrIntFuzz: Fuzzing Linux Drivers via Automated Virtual Device Simulation](#printfuzz-fuzzing-linux-drivers-via-automated-virtual-device-simulation-issta-2022) - [SLIME: Program-sensitive Energy Allocation for Fuzzing](#slime-program-sensitive-energy-allocation-for-fuzzing-issta-2022) - [SnapFuzz: High-Throughput Fuzzing of Network Applications](#snapfuzz-high-throughput-fuzzing-of-network-applications-issta-2022) - [TensileFuzz: Facilitating Seed Input Generation in Fuzzing via String Constraint Solving](#tensilefuzz-facilitating-seed-input-generation-in-fuzzing-via-string-constraint-solving-issta-2022) - [WASAI: Uncovering Vulnerabilities in Wasm Smart Contracts](#wasai-uncovering-vulnerabilities-in-wasm-smart-contracts-issta-2022) - [Unicorn: Detect Runtime Error in Time-Series Databases With Hybrid Input Synthesis](#unicorn-detect-runtime-error-in-time-series-databases-with-hybrid-input-synthesis-issta-2022) - **ESEC/FSE 2022** - [Minerva: Browser API Fuzzing with Dynamic Mod-Ref Analysis](#minerva-browser-api-fuzzing-with-dynamic-mod-ref-analysis-fse-2022) - [RoboFuzz: Fuzzing Robotic Systems over Robot Operating System (ROS) for Finding Correctness Bugs](#robofuzz-fuzzing-robotic-systems-over-robot-operating-system-ros-for-finding-correctness-bugs-fse-2022) - [SEDiff: Scope-Aware Differential Fuzzing to Test Internal Function Models in Symbolic Execution](#sediff-scope-aware-differential-fuzzing-to-test-internal-function-models-in-symbolic-execution-fse-2022) - [Fuzzing Deep-Learning Libraries via Automated Relational API Inference](#fuzzing-deep-learning-libraries-via-automated-relational-api-inference-esec-2022) - **S&P 2022** - [Effective Seed Scheduling for Fuzzing with Graph Centrality Analysis](#effective-seed-scheduling-for-fuzzing-with-graph-centrality-analysis-sp-2022) - [BEACON: Directed Grey-Box Fuzzing with Provable Path Pruning](#beacon-directed-grey-box-fuzzing-with-provable-path-pruning-sp-2022) - [JIGSAW: Efficient and Scalable Path Constraints Fuzzing](#jigsaw-efficient-and-scalable-path-constraints-fuzzing-sp-2022) - [PATA: Fuzzing with Path Aware Taint Analysis](#pata-fuzzing-with-path-aware-taint-analysis-sp-2022) - [FuzzUSB: Hybrid Stateful Fuzzing of USB Gadget Stacks](#fuzzusb-hybrid-stateful-fuzzing-of-usb-gadget-stacks-fse-2022) - **NDSS 2022** - [Cooper: Testing the Binding Code of Scripting Languages with Cooperative Mutation](#cooper-testing-the-binding-code-of-scripting-languages-with-cooperative-mutation-ndss-2022) - [EMS: History-Driven Mutation for Coverage-based Fuzzing](#ems-history-driven-mutation-for-coverage-based-fuzzing-ndss-2022) - [Semantic-Informed Driver Fuzzing Without Both the Hardware Devices and the Emulators](#semantic-informed-driver-fuzzing-without-both-the-hardware-devices-and-the-emulators-icse-2022) - [MobFuzz: Adaptive Multi-objective Optimization in Gray-box Fuzzing](#mobfuzz-adaptive-multi-objective-optimization-in-gray-box-fuzzing-ndss-2022) - [Context-Sensitive and Directional Concurrency Fuzzing for Data-Race Detection](#context-sensitive-and-directional-concurrency-fuzzing-for-data-race-detection-ndss-2022) - [datAFLow: Towards a Data-Flow-Guided Fuzzer](#dataflow-towards-a-data-flow-guided-fuzzer-ndss-2022) - **USENIX SEC 2022** - [SyzScope: Revealing High-Risk Security Impacts of Fuzzer-Exposed Bugs in Linux kernel](#syzscope-revealing-high-risk-security-impacts-of-fuzzer-exposed-bugs-in-linux-kernel-usenix-sec22) - [MundoFuzz: Hypervisor Fuzzing with Statistical Coverage Testing and Grammar Inference] - [TheHuzz: Instruction Fuzzing of Processors Using Golden-Reference Models for Finding Software-Exploitable Vulnerabilities] - [Morphuzz: Bending (Input) Space to Fuzz Virtual Devices] - [Fuzzware: Using Precise MMIO Modeling for Effective Firmware Fuzzing](#fuzzware-using-precise-mmio-modeling-for-effective-firmware-fuzzing) - [FuzzOrigin: Detecting UXSS vulnerabilities in Browsers through Origin Fuzzing] - [Drifuzz: Harvesting Bugs in Device Drivers from Golden Seeds](#drifuzz-harvesting-bugs-in-device-drivers-from-golden-seeds-usenix-sec-2022) - [Fuzzing Hardware Like Software](#fuzzing-hardware-like-software-usenix-sec-2022) - [BrakTooth: Causing Havoc on Bluetooth Link Manager via Directed Fuzzing](#braktooth-causing-havoc-on-bluetooth-link-manager-via-directed-fuzzing-usenix-sec-2022) - [Stateful Greybox Fuzzing](#stateful-greybox-fuzzing-usenix-security-2022) - [AmpFuzz: Fuzzing for Amplification DDoS Vulnerabilities] - [SGXFuzz: Efficiently Synthesizing Nested Structures for SGX Enclave Fuzzing](#sgxfuzz-efficiently-synthesizing-nested-structures-for-sgx-enclave-fuzzing-usenix-security2022) - [FRAMESHIFTER: Manipulating HTTP/2 Frame Sequences with Fuzzing](#frameshifter-manipulating-http2-frame-sequences-with-fuzzing-usenix-security2020) - [FIXREVERTER: A Realistic Bug Injection Methodology for Benchmarking Fuzz Testing](#fixreverter-a-realistic-bug-injection-methodology-for-benchmarking-fuzz-testing-usenix-sec22) - [StateFuzz: System Call-Based State-Aware Linux Driver Fuzzing](#statefuzz-system-call-based-state-aware-linux-driver-fuzzing-usenix-sec-2022) - **ICSE 2022** - [?AFL: Non-intrusive Feedback-driven Fuzzing for Microcontroller Firmware](#?afl-non-intrusive-feedback-driven-fuzzing-for-microcontroller-firmware-icse-2022) - [BeDivFuzz: Integrating Behavioral Diversity into Generator-based Fuzzing](#bedivfuzz-integrating-behavioral-diversity-into-generator-based-fuzzing-icse-2022) - [CONFETTI: Amplifying Concolic Guidance for Fuzzers](#confetti-amplifying-concolic-guidance-for-fuzzers-icse-2022) - [Demystifying the Dependency Challenge in Kernel Fuzzing](#demystifying-the-dependency-challenge-in-kernel-fuzzing-icse-2022) - [Evaluating and Improving Neural Program-Smoothing-based Fuzzing](#evaluating-and-improving-neural-program-smoothing-based-fuzzing-icse-2022) - [Fuzzing Class Specifications](#fuzzing-class-specifications-icse-2022) - [GraphFuzz: Library API Fuzzing with Lifetime-aware Dataflow Graphs](#graphfuzz-library-api-fuzzing-with-lifetime-aware-dataflow-graphs-icse-2022) - [Linear-time Temporal Logic guided Greybox Fuzzing](#linear-time-temporal-logic-guided-greybox-fuzzing-icse-2022) - [Muffin: Testing Deep Learning Libraries via Neural Architecture Fuzzing](#muffin-testing-deep-learning-libraries-via-neural-architecture-fuzzing-icse-2022) - [One Fuzzing Strategy to Rule Them All](#one-fuzzing-strategy-to-rule-them-all-icse-2022) - [On the Reliability of Coverage-Based Fuzzer Benchmarking](#on-the-reliability-of-coverage-based-fuzzer-benchmarking-icse-2022) - [Path Transitions Tell More: Optimizing Fuzzing Schedules via Runtime Program States](#path-transitions-tell-more-optimizing-fuzzing-schedules-via-runtime-program-states-icse-2022) - [R2Z2: Detecting Rendering Regressions in Web Browsers through Differential Fuzz Testing](#r2z2-detecting-rendering-regressions-in-web-browsers-through-differential-fuzz-testing-icse-2022) - [Semantic Image Fuzzing of AI Perception Systems](#semantic-image-fuzzing-of-ai-perception-systems) - [Free Lunch for Testing: Fuzzing Deep-Learning Libraries from Open Source](#free-lunch-for-testing-fuzzing-deep-learning-libraries-from-open-source-icse-2022) - [WindRanger: A Directed Greybox Fuzzer driven by Deviation Basic Block](#windranger-a-directed-greybox-fuzzer-driven-by-deviation-basic-block-icse-2022) - [MOREST: Model-based RESTful API Testing with Execution Feedback](#morest-model-based-restful-api-testing-with-execution-feedback-icse-2022) - [Controlled Concurrency Testing via Periodical Scheduling](#controlled-concurrency-testing-via-periodical-scheduling-icse-2022) - [Combinatorial Testing of RESTful APIs](#combinatorial-testing-of-restful-apis-icse-2022) - [Automated Testing of Software that Uses Machine Learning APIs](#automated-testing-of-software-that-uses-machine-learning-apis-icse-2022) - [FADATest: Fast and Adaptive Performance Regression Testing of Dynamic Binary Translation Systems](#fadatest-fast-and-adaptive-performance-regression-testing-of-dynamic-binary-translation-systems-icse-2022) - [Nessie: Automatically Testing JavaScript APIs with Asynchronous Callbacks](#nessie-automatically-testing-javascript-apis-with-asynchronous-callbacks-icse-2022) - **SANER 2022** - [FuzzingDriver: the Missing Dictionary to Increase Code Coverage in Fuzzers](#fuzzingdriver-the-missing-dictionary-to-increase-code-coverage-in-fuzzers-saner-2022) - **Others 2022** - [UltraFuzz: Towards Resource-saving in Distributed Fuzzing (TSE 2022)](#ultrafuzz-towards-resource-saving-in-distributed-fuzzing-tse-2022) - [Fuzzing with automatically controlled interleavings to detect concurrency bugs (The Journal of Systems & Software)](#fuzzing-with-automatically-controlled-interleavings-to-detect-concurrency-bugs-the-journal-of-systems--software-2022) - [ROZZ: Property-based Fuzzing for Robotic Programs in ROS (ICRA 2022)] - [SnapFuzz: An Efficient Fuzzing Framework for Network Applications (2022)](#snapfuzz-an-efficient-fuzzing-framework-for-network-applications-2022) - [Efficient ECU Analysis Technology through Structure-aware CAN Fuzzing (Access 2022)](#efficient-ecu-analysis-technology-through-structure-aware-can-fuzzing-access-2022) - [Smart Contract Fuzzing for Enterprises: The Language Agnostic Way (COMSNETS 2022)](#smart-contract-fuzzing-for-enterprises-the-language-agnostic-way-comsnets-2022) - [spotFuzzer: Static Instrument and Fuzzing Windows COTs (2022)](#spotfuzzer-static-instrument-and-fuzzing-windows-cots-2022) - [Mutation Analysis: Answering the Fuzzing Challenge (2022)](#mutation-analysis-answering-the-fuzzing-challenge-2022) - [SNPSFuzzer: A Fast Greybox Fuzzer for Stateful Network Protocols using Snapshots (2022)](#snpsfuzzer-a-fast-greybox-fuzzer-for-stateful-network-protocols-using-snapshots-2022) - [Better Pay Attention Whilst Fuzzing (2022)](#better-pay-attention-whilst-fuzzing-2022) - [looking for lacunae in bitcoin cores fuzzing efforts](#looking-for-lacunae-in-bitcoin-cores-fuzzing-efforts-2022) - [FEFuzzer: Hybrid Files Fuzzing Tool (2022)](#fefuzzer-hybrid-files-fuzzing-tool-2022) - **ASE 2021** - [CorbFuzz: Checking Browser Security Policies with Fuzzing](#corbfuzz-checking-browser-security-policies-with-fuzzing-ase-2021) - [Scalable Fuzzing of Program Binaries with E9AFL](#scalable-fuzzing-of-program-binaries-with-e9afl-ase-2021) - [SMARTIAN : Enhancing Smart Contract Fuzzing with Static and Dynamic Data-Flow Analyses](#smartian--enhancing-smart-contract-fuzzing-with-static-and-dynamic-data-flow-analyses-ase-2021) - [Towards Systematic and Dynamic Task Allocation for Collaborative Parallel Fuzzing](#towards-systematic-and-dynamic-task-allocation-for-collaborative-parallel-fuzzing-ase-2021-nier) - [Improving Configurability of Unit-level Continuous Fuzzing: An Industrial Case Study with SAP HANA](#improving-configurability-of-unit-level-continuous-fuzzing-an-industrial-case-study-with-sap-hana-ase-2021-industry) - [Understanding and Detecting Performance Bugs in Markdown Compilers](#understanding-and-detecting-performance-bugs-in-markdown-compilers-ase-2021) - [Rust Library Fuzzing via API Dependency Graph Traversal](#rust-library-fuzzing-via-api-dependency-graph-traversal-ase-2021) - [InstruGuard: Find and Fix Instrumentation Errors for Coverage-based Greybox Fuzzing](#instruguard-find-and-fix-instrumentation-errors-for-coverage-based-greybox-fuzzing-ase-2021) - **ACSAC 2021** - [Westworld: Fuzzing-Assisted Remote Dynamic Symbolic Execution of Smart Apps on IoT Cloud Platforms](#westworld-fuzzing-assisted-remote-dynamic-symbolic-execution-of-smart-apps-on-iot-cloud-platforms-acsac-2021) - [ICS3Fuzzer: A Framework for Discovering Protocol Implementation Bugs in ICS Supervisory Software by Fuzzing](#ics3fuzzer-a-framework-for-discovering-protocol-implementation-bugs-in-ics-supervisory-software-by-fuzzing-acsac-2021) - **SOSP 2021** - [HEALER: Relation Learning Guided Kernel Fuzzing](#healer-relation-learning-guided-kernel-fuzzing-sosp-2021) - **S&P 2021** - [DiFuzzRTL: Differential Fuzz Testing to Find CPU Bugs](#difuzzrtl-differential-fuzz-testing-to-find-cpu-bug-sp-2021) - [STOCHFUZZ: Sound and Cost-effective Fuzzing of Stripped Binaries by Incremental and Stochastic Rewriting](#stochfuzz-sound-and-cost-effective-fuzzing-of-stripped-binaries-by-incremental-and-stochastic-rewriting-sp-2021) - [NTFUZZ: Enabling Type-Aware Kernel Fuzzing on Windows with Static Binary Analysis](#ntfuzz-enabling-type-aware-kernel-fuzzing-on-windows-with-static-binary-analysissp-2021) - [DIANE: Identifying Fuzzing Triggers in Apps to Generate Under-constrained Inputs for IoT Devices](#diane-identifying-fuzzing-triggers-in-apps-to-generate-under-constrained-inputs-for-iot-devices-sp-2020) - [One Engine to Fuzz 'em All: Generic Language Processor Testing with Semantic Validation](#one-engine-to-fuzz-em-all-generic-language-processor-testing-with-semantic-validation-sp-2021) - **ISSTA 2021** - [Fuzzing SMT Solvers via Two-Dimensional Input Space Exploration](#fuzzing-smt-solvers-via-two-dimensional-input-space-exploration-issta-2021) - [Gramatron: Effective Grammar-Aware Fuzzing](#gramatron-effective-grammar-aware-fuzzing-issta-2021) - [QFuzz: Quantitative Fuzzing for Side Channels](#qfuzz-quantitative-fuzzing-for-side-channels-issta-2021) - [Seed Selection for Successful Fuzzing](#seed-selection-for-successful-fuzzing-issta-2021) - [ProFuzzBench - A Benchmark for Stateful Protocol Fuzzing](#profuzzbench---a-benchmark-for-stateful-protocol-fuzzing-issta-2021) - **ESEC/FSE 2021** - [Skeletal Approximation Enumeration for SMT Solver Testing ](#skeletal-approximation-enumeration-for-smt-solver-testing-fse-2021) - [Estimating Residual Risk in Greybox Fuzzing](#estimating-residual-risk-in-greybox-fuzzing-fse-2021) - [HeteroFuzz: Fuzz Testing to Detect Platform Dependent Divergence for Heterogeneous Applications](#heterofuzz-fuzz-testing-to-detect-platform-dependent-divergence-for-heterogeneous-applications-fse-2021) - [FuzzBench: An Open Fuzzer Benchmarking Platform and Service](#fuzzbench-an-open-fuzzer-benchmarking-platform-and-service-fse-2021) - **CCS 2021** - [Snipuzz: Black-box Fuzzing of IoT Firmware via Message Snippet Inference](#snipuzz-black-box-fuzzing-of-iot-firmware-via-message-snippet-inference-ccs-2021) - [Hardware Support to Improve Fuzzing Performance and Precision](#hardware-support-to-improve-fuzzing-performance-and-precision-ccs-2021) - [SoFi: Reflection-Augmented Fuzzing for JavaScript Engines](#sofi-reflection-augmented-fuzzing-for-javascript-engines-ccs-2021) - [T-Reqs: HTTP Request Smuggling with Differential Fuzzing](#t-reqs-http-request-smuggling-with-differential-fuzzing-ccs-2021) - [V-SHUTTLE: Scalable and Semantics-Aware Hypervisor Fuzzing](#v-shuttle-scalable-and-semantics-aware-hypervisor-fuzzing-ccs-2021) - [Same Coverage, Less Bloat: Accelerating Binary-only Fuzzing with Coverage-preserving Coverage-guided Tracing](#same-coverage-less-bloat-accelerating-binary-only-fuzzing-with-coverage-preserving-coverage-guided-tracing-ccs-2021) - [Regression Greybox Fuzzing](#regression-greybox-fuzzing-ccs-2021) - [SyzGen: Automated Generation of Syscall Specification of Closed-Source macOS Drivers](#SyzGen-Automated-Generation-of-Syscall-Specification-of-Closed-Source-macOS-Drivers-ccs-2021) - **OOPSLA 2021** - [Fuzzing Channel-Based Concurrency Runtimes using Types and Effects](#fuzzing-channel-based-concurrency-runtimes-using-types-and-effects-slides-oopsla-2021) - [Fully Automated Functional Fuzzing of Android Apps for Detecting Non-crashing Logic Bugs](#fully-automated-functional-fuzzing-of-android-apps-for-detecting-non-crashing-logic-bugs-oopsla-2021) - **PLDI 2021** - [Automated Conformance Testing for JavaScript Engines via Deep Compiler Fuzzing](#automated-conformance-testing-for-javascript-engines-via-deep-compiler-fuzzing-pldi-2021) - **ICSE 2021** - [Fuzzing Symbolic Expressions](#fuzzing-symbolic-expressions-icse-2021) - [Graph-based Fuzz Testing for Deep Learning Inference Engines](#graph-based-fuzz-testing-for-deep-learning-inference-engines-icse-2021) - [Growing A Test Corpus with Bonsai Fuzzing](#growing-a-test-corpus-with-bonsai-fuzzing-icse-2021) - [Industry Practice of Coverage-Guided Enterprise-Level DBMS Fuzzing](#industry-practice-of-coverage-guided-enterprise-level-dbms-fuzzing--icse-2021) - [IntelliGen: Automatic Driver Synthesis for Fuzz Testing](#intelligen-automatic-driver-synthesis-for-fuzz-testing-icse-2021-seip) - **USENIX ATC 2021** - [RIFF: Reduced Instruction Footprint for Coverage-Guided Fuzzing](#riff-reduced-instruction-footprint-for-coverage-guided-fuzzing-usenix-atc-2021) - [TCP-Fuzz: Detecting Memory and Semantic Bugs in TCP Stacks with Fuzzing](#tcp-fuzz-detecting-memory-and-semantic-bugs-in-tcp-stacks-with-fuzzing-usenix-atc-2021) - **USENIX Security 2021** - [Constraint-guided Directed Greybox Fuzzing](#constraint-guided-directed-greybox-fuzzing-usenix-security2021) - [UNIFUZZ: A Holistic and Pragmatic Metrics-Driven Platform for Evaluating Fuzzers](#unifuzz-a-holistic-and-pragmatic-metrics-driven-platform-for-evaluating-fuzzers-usenix-security2021) - [Nyx: Greybox Hypervisor Fuzzing using Fast Snapshots and Affine Types](#nyx-greybox-hypervisor-fuzzing-using-fast-snapshots-and-affine-types-usenix-security2021) - [Breaking Through Binaries: Compiler-quality Instrumentation for Better Binary-only Fuzzing](#breaking-through-binaries-compiler-quality-instrumentation-for-better-binary-only-fuzzing--usenix-security2021) - [The Use of Likely Invariants as Feedback for Fuzzers](#the-use-of-likely-invariants-as-feedback-for-fuzzers-usenix-security2021) - **NDSS 2021** - [Favocado: Fuzzing the Binding Code of JavaScript Engines Using Semantically Correct Test Cases](#favocado-fuzzing-the-binding-code-of-javascript-engines-using-semantically-correct-test-cases-ndss-2021) - [WINNIE: Fuzzing Windows Applications with Harness Synthesis and Fast Cloning](#winnie-fuzzing-windows-applications-with-harness-synthesis-and-fast-cloning-ndss-2021) - [PGFUZZ: Policy-Guided Fuzzing for Robotic Vehicles](#pgfuzz-policy-guided-fuzzing-for-robotic-vehicles-ndss-2021) - [Reinforcement Learning-based Hierarchical Seed Scheduling for Greybox Fuzzing](#reinforcement-learning-based-hierarchical-seed-scheduling-for-greybox-fuzzing-ndss-2021) - **ICST 2021** - [Industrial Oriented Evaluation of Fuzzing Techniques](#industrial-oriented-evaluation-of-fuzzing-techniques-icst-2021) - [Learning-Based Fuzzing of IoT Message Broker](#learning-based-fuzzing-of-iot-message-brokers-icst-2021) - [RiverFuzzRL - an open-source tool to experiment with reinforcement learning for fuzzing](#riverfuzzrl---an-open-source-tool-to-experiment-with-reinforcement-learning-for-fuzzing-icst-2021) - **SANER 2021** - [OTA: An Operation-oriented Time Allocation Strategy for Greybox Fuzzing](#ota-an-operation-oriented-time-allocation-strategy-for-greybox-fuzzing-saner-2021) - **JFLA 2022** - [Alt-Ergo-Fuzz: A fuzzer for the Alt-Ergo SMT solver](#alt-ergo-fuzz-a-fuzzer-for-the-alt-ergo-smt-solver-jfla-2022) - **Others 2021** - [FuSeBMC v. 4: Smart Seed Generation for Hybrid Fuzzing (2021)](#fusebmc-v-4-smart-seed-generation-for-hybrid-fuzzing-2021) - [REST API Fuzzing by Coverage Level Guided Blackbox Testing (2021)](#rest-api-fuzzing-by-coverage-level-guided-blackbox-testing-2021) - [State Selection Algorithms and Their Impact on The Performance of Stateful Network Protocol Fuzzing (2021)](#state-selection-algorithms-and-their-impact-on-the-performance-of-stateful-network-protocol-fuzzing-2021) - [DIAR: Removing Uninteresting Bytes from Seeds in Software Fuzzing (2021)](#diar-removing-uninteresting-bytes-from-seeds-in-software-fuzzing-2021) - [CatchBackdoor: Backdoor Testing by Critical Trojan Neural Path Identification via Differential Fuzzing (2021)](#catchbackdoor-backdoor-testing-by-critical-trojan-neural-path-identification-via-differential-fuzzing-2021) - [Emmutaler: Fuzzing the iOS Boot Loader (Thesis 2021)](#emmutaler-fuzzing-the-ios-boot-loader-thesis-2021) - [Concolic-Fuzzing of JavaScript Programs using GraalVM and Truffle (SKILL 2021)](#concolic-fuzzing-of-javascript-programs-using-graalvm-and-truffle-skill-2021) - [BanditFuzz: Fuzzing SMT Solvers with Multi-agent Reinforcement Learning (FM 2021)](#banditfuzz-fuzzing-smt-solvers-with-multi-agent-reinforcement-learning-fm-2021) - [My Fuzzer Beats Them All! Developing a Framework for Fair Evaluation and Comparison of Fuzzers (2021)](#my-fuzzer-beats-them-all-developing-a-framework-for-fair-evaluation-and-comparison-of-fuzzers-2021) - [Evaluating Code Coverage for Kernel Fuzzers via Function Call Graph (Access 2021)](#evaluating-code-coverage-for-kernel-fuzzers-via-function-call-graph-access-2021) - [A Tight Integration of Symbolic Execution and Fuzzing (short paper 2021)](#a-tight-integration-of-symbolic-execution-and-fuzzing-short-paper-2021) - [DeltaFuzz: Historical Version Information Guided Fuzz Testing (Journal of Computer Science and Technology 2021)](#deltafuzz-historical-version-information-guided-fuzz-testing-journal-of-computer-science-and-technology-2021) - [ovAFLow: Detecting Memory Corruption Bugs with Fuzzing-based Taint Inference (Journal of Computer Science and Technology 2021)](#ovaflow-detecting-memory-corruption-bugs-with-fuzzing-based-taint-inference-journal-of-computer-science-and-technology-2021) - [Machine Learning Guided Cross-Contract Fuzzing (2021)](#machine-learning-guided-cross-contract-fuzzing-2021) - [SANRAZOR: Reducing Redundant Sanitizer Checks in C/C++ Programs (OSDI 2021)](#sanrazor-reducing-redundant-sanitizer-checks-in-cc-programs-osdi-2021) - [webFuzz: Grey-Box Fuzzing for Web Applications (ESORICS 2021)](#webfuzz-grey-box-fuzzing-for-web-applications-esorics-2021) - [Vulnerability-Oriented Fuzz Testing for Connected Autonomous Vehicle Systems (IEEE Transactions on Reliability 2021)](#vulnerability-oriented-fuzz-testing-for-connected-autonomous-vehicle-systems--ieee-transactions-on-reliability-2021) - [Duo: Differential Fuzzing for Deep Learning Operators (IEEE Transactions on Reliability 2021)](#duo-differential-fuzzing-for-deep-learning-operators-ieee-transactions-on-reliability-2021) - [Rtkaller: State-aware Task Generation for RTOS Fuzzing (EMSOFT 2021)](#rtkaller-state-aware-task-generation-for-rtos-fuzzing-emsoft-2021) - [Neural Network Guided Evolutionary Fuzzing for Finding Traffic Violations of Autonomous Vehicles (arXiv 2021)](#neural-network-guided-evolutionary-fuzzing-for-finding-traffic-violations-of-autonomous-vehicles-arxiv-2021) - [Fuzzing: Cyberphysical System Testing for Security and Dependability (Computer 2021)](#fuzzing-cyberphysical-system-testing-for-security-and-dependability-computer-2021) - [ESRFuzzer: an enhanced fuzzing framework for physical SOHO router devices to discover multi-Type vulnerabilities (Cybersecurity 2021)](#esrfuzzer-an-enhanced-fuzzing-framework-for-physical-soho-router-devices-to-discover-multi-type-vulnerabilities-cybersecurity-2021) - [ICPFuzzer: proprietary communication protocol fuzzing by using machine learning and feedback strategies (Cybersecurity 2021)](#icpfuzzer-proprietary-communication-protocol-fuzzing-by-using-machine-learning-and-feedback-strategies-cybersecurity-2021) - [Hashing Fuzzing: Introducing Input Diversity to Improve Crash Detection (TSE 2021)](#hashing-fuzzing-introducing-input-diversity-to-improve-crash-detection-tse-2021) - [KCFuzz: Directed Fuzzing Based on Keypoint Coverage (ICAIS 2021)](#kcfuzz-directed-fuzzing-based-on-keypoint-coverage-icais-2021) - [Token-Level Fuzzing (WiSec'21)](#token-level-fuzzing-wisec-2021) - [SHFuzz: A hybrid fuzzing method assisted by static analysis for binary programs (China Communications 2021)](#shfuzz-a-hybrid-fuzzing-method-assisted-by-static-analysis-for-binary-programs-china-communications-2021) - [RapidFuzz: Accelerating fuzzing via Generative Adversarial Networks (Neurocomputing 2021)](#rapidfuzz-accelerating-fuzzing-via-generative-adversarial-networks-neurocomputing-2021) - [HFContractFuzzer: Fuzzing Hyperledger Fabric Smart Contracts for Vulnerability Detection (EASE 2021)](#hfcontractfuzzer-fuzzing-hyperledger-fabric-smart-contracts-for-vulnerability-detection-ease-2021) - [Fuzzing With Optimized Grammar-Aware Mutation Strategies (Access 2021)](#fuzzing-with-optimized-grammar-aware-mutation-strategies-access-2021) - [FIRM-COV: High-Coverage Greybox Fuzzing for IoT Firmware via Optimized Process Emulation (Access 2021)](#firm-cov-high-coverage-greybox-fuzzing-for-iot-firmware-via-optimized-process-emulation-access-2021) - [Extended grammar-based fuzzing algorithm for JavaScript Engines (2021)](#extended-grammar-based-fuzzing-algorithm-for-javascript-engines-2021) - [CoCoFuzzing: Testing Neural Code Models with Coverage-Guided Fuzzing (2021)](#cocofuzzing-testing-neural-code-models-with-coverage-guided-fuzzing-2021) - [FUZZOLIC: Mixing fuzzing and concolic execution (Computers&Security 2021)](#fuzzolic-mixing-fuzzing-and-concolic-execution-computerssecurity-2021) - [DirectFuzz: Automated Test Generation for RTL Designs using Directed Graybox Fuzzing (DAC 2021)](#directfuzz-automated-test-generation-for-rtl-designs-using-directed-graybox-fuzzing-dac-2021) - [CollabFuzz: A Framework for Collaborative Fuzzing (EuroSec 2021)](#collabfuzz-a-framework-for-collaborative-fuzzing-eurosec-2021) - [HDR-Fuzz: Detecting Buffer Overruns using AddressSanitizer Instrumentation and Fuzzing (2021)](#hdr-fuzz-detecting-buffer-overruns-using-addresssanitizer-instrumentation-and-fuzzing-2021) - [Unleashing Fuzzing Through Comprehensive, Efficient, and Faithful Exploitable-Bug Exposing (2021)](#unleashing-fuzzing-through-comprehensive-efficient-and-faithful-exploitable-bug-exposing) - [Improving Web Application Vulnerability Detection Leveraging Ensemble Fuzzing (ENASE 2021)](#improving-web-application-vulnerability-detection-leveraging-ensemble-fuzzing-enase-2021) - [Coverage-guided binary fuzzing with rev.ng and llvm libfuzzer](#coverage-guided-binary-fuzzing-with-revng-and-llvm-libfuzzer) - [An Empirical Study of OSS-Fuzz Bugs (MSR 2021)](#an-empirical-study-of-oss-fuzz-bugs-msr-2021) - [MooFuzz: Many-Objective Optimization Seed Schedule for Fuzzer (Mathematics 2021)](#moofuzz-many-objective-optimization-seed-schedule-for-fuzzer-mathematics-2021) - [PMFuzz: Test Case Generation for Persistent Memory Programs (ASPLOS 2021)](#pmfuzz-test-case-generation-for-persistent-memory-programs-asplos-2021) - [A Priority Based Path Searching Method for Improving Hybrid Fuzzing (Computers & Security 2021)](#a-priority-based-path-searching-method-for-improving-hybrid-fuzzing-computers--security-2021) - [CMFuzz: context-aware adaptive mutation for fuzzers (Empirical Software Engineering 2021)](#cmfuzz-context-aware-adaptive-mutation-for-fuzzers-empirical-software-engineering-2021) - [Refined Grey-Box Fuzzing with Sivo (arXiv 2021)](#refined-grey-box-fuzzing-with-sivo-arxiv-2021) - [Constructing More Complete Control Flow Graphs Utilizing Directed Gray-Box Fuzzing (MDPI 2021)](#constructing-more-complete-control-flow-graphs-utilizing-directed-gray-box-fuzzing-mdpi-2021) - [Symbolic Security Predicates: Hunt Program Weaknesses (ISPRAS Open 2021)](#symbolic-security-predicates-hunt-program-weaknesses-ispras-open-2021) - [Towards Symbolic Pointers Reasoning in Dynamic Symbolic Execution (IVMEM 2021)](#towards-symbolic-pointers-reasoning-in-dynamic-symbolic-execution-ivmem-2021) - **CCS 2020** - [FREEDOM: Engineering a State-of-the-Art DOM Fuzzer](#freedom-engineering-a-state-of-the-art-dom-fuzzer-ccs-2020) - [SQUIRREL: Testing Database Management Systems with Language Validity and Coverage Feedback](#squirrel-testing-database-management-systems-with-language-validity-and-coverage-feedback-ccs-2020) - **ASE 2020** - [BigFuzz: Efficient Fuzz Testing for Data Analytics using Framework Abstraction](#bigfuzz-efficient-fuzz-testing-for-data-analytics-using-framework-abstraction-ase-2020) - [MoFuzz: A Fuzzer Suite for Testing Model-Driven Software Engineering Tools](#mofuzz-a-fuzzer-suite-for-testing-model-driven-software-engineering-tools-ase-2020) - [Zeror: Speed Up Fuzzing with Coverage-sensitive Tracing and Scheduling](#zeror-speed-up-fuzzing-with-coverage-sensitive-tracing-and-scheduling-ase-2020) - [Generating Highly-structured Input Data by Combining Search-based Testing and Grammar-based Fuzzing](#generating-highly-structured-input-data-by-combining-search-based-testing-and-grammar-based-fuzzing-ase-2020) - **ISSTA 2020** - [Active Fuzzing for Testing and Securing Cyber-Physical Systems](#active-fuzzing-for-testing-and-securing-cyber-physical-systems-issta-2020) - [Learning Input Tokens for Effective Fuzzing](#learning-input-tokens-for-effective-fuzzing-issta-2020) - [WEIZZ: Automatic Grey-Box Fuzzing for Structured Binary Formats](#weizz-automatic-grey-box-fuzzing-for-structured-binary-formats) - **ESEC/FSE 2020** - [Fuzzing: On the Exponential Cost of Vulnerability Discovery](#fuzzing-on-the-exponential-cost-of-vulnerability-discovery-fse-2020) - [Boosting Fuzzer Efficiency: An Information Theoretic Perspective](#boosting-fuzzer-efficiency-an-information-theoretic-perspective-fse-2020) - [CrFuzz: Fuzzing Multi-purpose Programs through Input Validation](#crfuzz-fuzzing-multi-purpose-programs-through-input-validation-fse-2020) - [Detecting Critical Bugs in SMT Solvers using Blackbox Mutational Fuzzing](#detecting-critical-bugs-in-smt-solvers-using-blackbox-mutational-fuzzing-fse) - [Intelligent REST API Data Fuzzing](#intelligent-rest-api-data-fuzzing-fse-2020) - [MTFuzz: Fuzzing with a Multi-task Neural Network](#mtfuzz-fuzzing-with-a-multi-task-neural-network-fse-2020) - **ACSAC 2020** - [DPIFuzz: A Differential Fuzzing Framework to Detect DPI Elusion Strategies for QUIC](#dpifuzz-a-differential-fuzzing-framework-to-detect-dpi-elusion-strategies-for-quic-acsac-2020) - [Cupid: Automatic Fuzzer Selection for Collaborative Fuzzing](#cupid-automatic-fuzzer-selection-for-collaborative-fuzzing-acsac-2020) - [OmniFuzz: A Flexible Framework for Expediting Bug Finding by Leveraging Past (Mis-)Behavior to Discover New Bugs](#omnifuzz-a-flexible-framework-for-expediting-bug-finding-by-leveraging-past-mis-behavior-to-discover-new-bugs-acsac-2020) - [RUSTY: A Fuzzing Tool for Rust](#rusty-a-fuzzing-tool-for-rust-acsac-2020) - **PLDI 2020** - [Validating SMT Solvers via Semantic Fusion](#validating-smt-solvers-via-semantic-fusion-pldi-2020) - **USENIX Security 2020** - [Analysis of DTLS Implementations Using Protocol State Fuzzing](#analysis-of-dtls-implementations-using-protocol-state-fuzzing-usenix-security2020) - [Frankenstein: Advanced Wireless Fuzzing to Exploit New Bluetooth Escalation Targets](#frankenstein-advanced-wireless-fuzzing-to-exploit-new-bluetooth-escalation-targets-usenix-security2020) - [SpecFuzz: Bringing Spectre-type vulnerabilities to the surface](#specfuzz-bringing-spectre-type-vulnerabilities-to-the-surface-usenix-security2020) - [FuzzGen: Automatic Fuzzer Generation](#fuzzgen-automatic-fuzzer-generation-usenix-security2020) - [MUZZ: Thread-aware Grey-box Fuzzing for Effective Bug Hunting in Multithreaded Programs](#muzz-thread-aware-grey-box-fuzzing-for-effective-bug-hunting-in-multithreaded-programs-usenix-security2020) - [Montage: A Neural Network Language Model-Guided JavaScript Engine Fuzzer](#montage-a-neural-network-language-model-guided-javascript-engine-fuzzer-usenix-security2020) - [GREYONE: Data Flow Sensitive Fuzzing](#greyone-data-flow-sensitive-fuzzing-usenix-security2020) - [FuzzGuard: Filtering out Unreachable Inputs in Directed Grey-box Fuzzing through Deep Learning](#fuzzguard-filtering-out-unreachable-inputs-in-directed-grey-box-fuzzing-through-deep-learning-usenix-security2020) - [ParmeSan: Sanitizer-guided Greybox Fuzzing](#parmesan-sanitizer-guided-greybox-fuzzing-usenix-security2020) - [EcoFuzz: Adaptive Energy-Saving Greybox Fuzzing as a Variant of the Adversarial Multi-Armed Bandit](#ecofuzz-adaptive-energy-saving-greybox-fuzzing-as-a-variant-of-the-adversarial-multi-armed-bandit-usenix-security2020) - [FANS: Fuzzing Android Native System Services via Automated Interface Analysis](#fans-fuzzing-android-native-system-services-via-automated-interface-analysis-usenix-security2020) - [Fuzzing Error Handling Code using Context-Sensitive Software Fault Injection](#fuzzing-error-handling-code-using-context-sensitive-software-fault-injection-usenix-security2020) - [USBFuzz: A Framework for Fuzzing USB Drivers by Device Emulation](#usbfuzz-a-framework-for-fuzzing-usb-drivers-by-device-emulation-usenix-security2020) - [AFL++: Combining Incremental Steps of Fuzzing Research (USENIX Woot2020)](#afl-combining-incremental-steps-of-fuzzing-research-usenix-woot2020) - **ICSE 2020** - [Typestate-Guided Fuzzer for Discovering Use-after-Free Vulnerabilities](#typestate-guided-fuzzer-for-discovering-use-after-free-vulnerabilities-icse-2020) - [MemLock: Memory Usage Guided Fuzzing](#memlock-memory-usage-guided-fuzzing-icse2020) - [Ankou: Guiding Grey-box Fuzzing towards Combinatorial Difference](#ankou-guiding-grey-box-fuzzing-towards-combinatorial-difference-icse-2020) - [JVM Fuzzing for JIT-Induced Side-Channel Detection](#jvm-fuzzing-for-jit-induced-side-channel-detection-icse-2020) - [Targeted Greybox Fuzzing with Static Lookahead Analysis](#targeted-greybox-fuzzing-with-static-lookahead-analysis-icse-2020) - [Fuzz Testing based Data Augmentation to Improve Robustness of Deep Neural Networks](#fuzz-testing-based-data-augmentation-to-improve-robustness-of-deep-neural-networks-icse-2020) - [sFuzz: An Efficient Adaptive Fuzzer for Solidity Smart Contracts](#sfuzz-an-efficient-adaptive-fuzzer-for-solidity-smart-contracts-icse-2020) - [HyDiff: Hybrid Differential Software Analysis](#hydiff-hybrid-differential-software-analysis-icse-2020) - [Automatically Testing String Solvers](#automatically-testing-string-solvers-icse-2020) - **NDSS 2020** - [HYPER-CUBE: High-Dimensional Hypervisor Fuzzing](#hyper-cube-high-dimensional-hypervisor-fuzzing-ndss-2020) - [HotFuzz: Discovering Algorithmic Denial-of-Service Vulnerabilities Through Guided Micro-Fuzzing](#hotfuzz-discovering-algorithmic-denial-of-service-vulnerabilities-through-guided-micro-fuzzing-ndss-2020) - [HFL: Hybrid Fuzzing on the Linux Kernel](#hfl-hybrid-fuzzing-on-the-linux-kernel-ndss-2020) - [Not All Coverage Measurements Are Equal: Fuzzing by Coverage Accounting for Input Prioritization](#not-all-coverage-measurements-are-equal-fuzzing-by-coverage-accounting-for-input-prioritization-ndss-2020) - **S&P 2020** - [SAVIOR: Towards Bug-Driven Hybrid Testing](#savior-towards-bug-driven-hybrid-testing-sp-2020) - [RetroWrite: Statically Instrumenting COTS Binaries for Fuzzing and Sanitization](#retrowrite-statically-instrumenting-cots-binaries-for-fuzzing-and-sanitization-sp-2020) - [IJON: Exploring Deep State Spaces via Fuzzing](#ijon-exploring-deep-state-spaces-via-fuzzing-sp-2020) - [PANGOLIN: Incremental Hybrid Fuzzing with Polyhedral Path Abstraction](#pangolin-incremental-hybrid-fuzzing-with-polyhedral-path-abstraction-sp-2020) - [KRace: Data Race Fuzzing for Kernel File Systems](#krace-data-race-fuzzing-for-kernel-file-systems-sp-2020) - [Fuzzing JavaScript Engines with Aspect-preserving Mutation](#fuzzing-javascript-engines-with-aspect-preserving-mutation-sp-2020) - **SANER 2020** - [ETHPLOIT: From Fuzzing to Efficient Exploit Generation against Smart Contracts](#ethploit-from-fuzzing-to-efficient-exploit-generation-against-smart-contracts-saner2020) - [Sequence directed hybrid fuzzing](#sequence-directed-hybrid-fuzzing-saner-2020) - **ICST 2020** - [Language-Agnostic Generation of Compilable Test Programs](#language-agnostic-generation-of-compilable-test-programs-icst-2020) - [ct-fuzz: Fuzzing for Timing Leaks](#ct-fuzz-fuzzing-for-timing-leaks-icst-2020) - [AFLNET: A Greybox Fuzzer for Network Protocols](#aflnet-a-greybox-fuzzer-for-network-protocols-icst-2020) - **ASIACCS 2020** - [PathAFL: Path-Coverage Assisted Fuzzing](#pathafl-path-coverage-assisted-fuzzing-asia-ccs-2020) - **Others 2020** - [Reproducible Crashes: Fuzzing Pharo by Mutating the Test Methods (IWST20 2020)](#reproducible-crashes-fuzzing-pharo-by-mutating-the-test-methods-iwst20-2020) - [Finding race conditions in Kernels: from fuzzing to symbolic exection (2020)](#finding-race-conditions-in-kernels-from-fuzzing-to-symbolic-exection-2020) - [BanditFuzz: Fuzzing SMT Solvers with Reinforcement Learning (2020)](#banditfuzz-fuzzing-smt-solvers-with-reinforcement-learning-2020) - [Fuzzing Technique in Web Applications and Beyond (MCTE 2020)](#fuzzing-technique-in-web-applications-and-beyond-mcte-2020) - [Vulnerability Detection in SIoT Applications: A Fuzzing Method on their Binaries (IEEE Transactions on Network Science and Engineering 2020)](#vulnerability-detection-in-siot-applications-a-fuzzing-method-on-their-binaries-ieee-transactions-on-network-science-and-engineering-2020) - [MaxAFL: Maximizing Code Coverage with a Gradient-Based Optimization Technique (Electronics 2020)](#maxafl-maximizing-code-coverage-with-a-gradient-based-optimization-technique-electronics-2020) - [CSEFuzz: Fuzz Testing Based on Symbolic Execution (Access 2020)](#csefuzz-fuzz-testing-based-on-symbolic-execution-access-2020) - [A Quantitative Comparison of Covera (AST 2020)](#a-quantitative-comparison-of-covera-ast-2020) - [Finding Bugs in File Systems with an Extensible Fuzzing Framework (TOS 2020)](#finding-bugs-in-file-systems-with-an-extensible-fuzzing-framework-tos-2020) - [ICS Protocol Fuzzing: Coverage Guided Packet Crack and Generation (DAC 2020)](#ics-protocol-fuzzing-coverage-guided-packet-crack-and-generation-dac-2020) - [Finding Security Vulnerabilities in Network Protocol Implementations (Arxiv 2020)](#finding-security-vulnerabilities-in-network-protocol-implementations-arxiv-2020) - [Coverage Guided Differential Adversarial Testing of Deep Learning Systems](#coverage-guided-differential-adversarial-testing-of-deep-learning-systems-tnse-2020) - [Fw‐fuzz: A code coverage‐guided fuzzing framework for network protocols on firmware](#fw%e2%80%90fuzz-a-code-coverage%e2%80%90guided-fuzzing-framework-for-network-protocols-on-firmware-2020) - [Greybox Fuzzing Based on Ant Colony Algorithm](#greybox-fuzzing-based-on-ant-colony-algorithm-aina-2020) - [MEUZZ: Smart Seed Scheduling for Hybrid Fuzzing](#meuzz-smart-seed-scheduling-for-hybrid-fuzzing) - [Binary-level Directed Fuzzing for Use-After-Free Vulnerabilities](#binary-level-directed-fuzzing-for-use-after-free-vulnerabilities-raid-2020) - [Smart seed selection-based effective black box fuzzing for IIoT protocol](#smart-seed-selection-based-effective-black-box-fuzzing-for-iiot-protocol) - [RDFuzz: Accelerating Directed Fuzzing with Intertwined Schedule and Optimized Mutation](#rdfuzz-accelerating-directed-fuzzing-with-intertwined-schedule-and-optimized-mutation-2020) - [A deep convolution generative adversarial networks based fuzzing framework for industry control protocols](#a-deep-convolution-generative-adversarial-networks-based-fuzzing-framework-for-industry-control-protocols) - [TOFU: Target-Oriented FUzzer](#tofu-target-oriented-fuzzer-arxiv-2020) - [BaseSAFE: Baseband SAnitized Fuzzing through Emulation](#basesafe-baseband-sanitized-fuzzing-through-emulation-wisec-2020) - [Sydr: Cutting Edge Dynamic Symbolic Execution (ISPRAS Open 2020)](#sydr-cutting-edge-dynamic-symbolic-execution-ispras-open-2020) - **ACSAC 2019** - [Opening Pandora’s Box through ATFuzzer: Dynamic Analysis of AT Interface for AndroidSmartphones](#Opening-Pandoras-Box-through-ATFuzzer-Dynamic-Analysis-of-AT-Interface-for-Android-Smartphones-ACSAC-2019) - **OOPSLA 2019** - [FuzzFactory: Domain-Specific Fuzzing with Waypoints](#fuzzfactory-domain-specific-fuzzing-with-waypoints-oopsla-2019) - [Compiler Fuzzing: How Much Does It Matter](#compiler-fuzzing-how-much-does-it-matter-oopsla2019) - **TSE 2019** - [The Art, Science, and Engineering of Fuzzing: A Survey](#the-art-science-and-engineering-of-fuzzing-a-survey) - [Smart Greybox Fuzzing](#smart-greybox-fuzzing-tse-2019) - **Access 2019** - [NeuFuzz: Efficient Fuzzing With Deep Neural Network](#neufuzz-efficient-fuzzing-with-deep-neural-network-access-2019) - [LearnAFL: Greybox Fuzzing With Knowledge Enhancement](#learnafl-greybox-fuzzing-with-knowledge-enhancement-access-2019) - **CCS 2019** - [Intriguer: Field-Level Constraint Solving for Hybrid Fuzzing](#intriguer-field-level-constraint-solving-for-hybrid-fuzzing-ccs-2019) - [Learning to Fuzz from Symbolic Execution with Application to Smart Contracts](#learning-to-fuzz-from-symbolic-execution-with-application-to-smart-contracts-ccs-2019) - [Matryoshka: fuzzing deeply nested branches](#matryoshka-fuzzing-deeply-nested-branches-ccs-2019) - [Different is Good: Detecting the Use of Uninitialized Variables through Differential Replay](#different-is-good-detecting-the-use-of-uninitialized-variables-through-differential-replay-ccs-2019) - [Gollum: Modular and Greybox Exploit Generation for Heap Overflows in Interpreters](#gollum-modular-and-greybox-exploit-generation-for-heap-overflows-in-interpreters-ccs-2019) - [Poster: Fuzzing IoT Firmware via Multi-stage Message Generation](#poster-fuzzing-iot-firmware-via-multi-stage-message-generation-ccs-2019) - **S&P 2019** - [NEUZZ: Efficient Fuzzing with Neural Program Smoothing](#neuzz-efficient-fuzzing-with-neural-program-smoothing-sp-2019) - [Fuzzing File Systems via Two-Dimensional Input Space Exploration](#fuzzing-file-systems-via-two-dimensional-input-space-exploration-sp-2019) - [ProFuzzer: On-the-fly Input Type Probing for Better Zero-day Vulnerability Discovery](#profuzzer-on-the-fly-input-type-probing-for-better-zero-day-vulnerability-discovery-sp-2019) - [Razzer: Finding Kernel Race Bugs through Fuzzing](#razzer-finding-kernel-race-bugs-through-fuzzing-sp-2019) - [Full-speed Fuzzing: Reducing Fuzzing Overhead through Coverage-guided Tracing](#full-speed-fuzzing-reducing-fuzzing-overhead-through-coverage-guided-tracing-sp-2019) - **USENIX Security 2019** - [MOPT: Optimize Mutation Scheduling for Fuzzers](#mopt-optimize-mutation-scheduling-for-fuzzers-usenix-security2019) - [Antifuzz: impeding fuzzing audits of binary executables](#antifuzz-impeding-fuzzing-audits-of-binary-executables-usenix-security2019) - [FUZZIFICATION: Anti-Fuzzing Technique](#fuzzification-anti-fuzzing-technique-usenix-security2019) - [EnFuzz: Ensemble Fuzzing with Seed Synchronization among Diverse Fuzzers](#enfuzz-ensemble-fuzzing-with-seed-synchronization-among-diverse-fuzzers-usenix-security2019) - [GRIMOIRE : Synthesizing Structure while Fuzzing](#grimoire-synthesizing-structure-while-fuzzing-usenix-security2019) - [RVFuzzer: Finding Input Validation Bugs in Robotic Vehicles through Control-Guided Random Testing](#rvfuzzer-finding-input-validation-bugs-in-robotic-vehicles-through-control-guided-random-testing-usenix-security2019) - [FIRM-AFL: High-Throughput Greybox Fuzzing of IoT Firmware via Augmented Process Emulation](#firm-afl-high-throughput-greybox-fuzzing-of-iot-firmware-via-augmented-process-emulation-usenix-security2019) - [Unicorefuzz: On the Viability of Emulation for Kernelspace Fuzzing](#unicorefuzz-on-the-viability-of-emulation-for-kernelspace-fuzzing-usenix-woot19) - **ASE 2019** - [Learning-Guided Network Fuzzing for Testing Cyber-Physical System Defences](#learning-guided-network-fuzzing-for-testing-cyber-physical-system-defences-ase-2019) - **NDSS 2019** - [REDQUEEN: Fuzzing with Input-to-State Correspondence](#redqueen-fuzzing-with-input-to-state-correspondence-ndss2019) - [PeriScope: An Effective Probing and Fuzzing Framework for the Hardware-OS Boundary](#periscope-an-effective-probing-and-fuzzing-framework-for-the-hardware-os-boundary-ndss2019) - [Life after Speech Recognition: Fuzzing Semantic Misinterpretation for Voice Assistant Applications](#life-after-speech-recognition-fuzzing-semantic-misinterpretation-for-voice-assistant-applications-ndss-2019) - [Send Hardest Problems My Way: Probabilistic Path Prioritization for Hybrid Fuzzing](#send-hardest-problems-my-way-probabilistic-path-prioritization-for-hybrid-fuzzing-ndss-2019) - [CodeAlchemist: Semantics-Aware Code Generation to Find Vulnerabilities in JavaScript Engines](#codealchemist-semantics-aware-code-generation-to-find-vulnerabilities-in-javascript-engines-ndss-2019) - [NAUTILUS: Fishing for Deep Bugs with Grammars](#nautilus-fishing-for-deep-bugs-with-grammars-ndss-2019) - **ICSE 2019** - [DifFuzz: Differential Fuzzing for Side-Channel Analysis](#diffuzz-differential-fuzzing-for-side-channel-analysis-icse-2019) - [Deep Differential Testing of JVM Implementations](#deep-differential-testing-of-jvm-implementations-icse-2019) - [REST-ler: Stateful REST API Fuzzing](#rest-ler-stateful-rest-api-fuzzing-icse-2019) - [SLF: Fuzzing without Valid Seed Inputs](#slf-fuzzing-without-valid-seed-inputs-icse-2019) - [Superion: Grammar-Aware Greybox Fuzzing](#superion-grammar-aware-greybox-fuzzing-icse-2019) - [Hunting for bugs in code coverage tools via randomized differential testing](#hunting-for-bugs-in-code-coverage-tools-via-randomized-differential-testing-icse-2019) - **ESEC/FSE 2019** - [Cerebro: Context-aware Adaptive Fuzzing for Effective Vulnerability Detection](#cerebro-context-aware-adaptive-fuzzing-for-effective-vulnerability-detection-fse-2019) - [Just Fuzz It: Solving Floating-Point Constraints Using Coverage-guided Fuzzing](#just-fuzz-it-solving-floating-point-constraints-using-coverage-guided-fuzzing-fse-2019) - [FUDGE: Fuzz Driver Generation at Scale](#fudge-fuzz-driver-generation-at-scale-fse-2019) - **ISSTA 2019** - [Semantic Fuzzing with Zest](#semantic-fuzzing-with-zest-issta-2019) - [DeepHunter: A Coverage-Guided Fuzz Testing Framework for Deep Neural Networks](#deephunter-a-coverage-guided-fuzz-testing-framework-for-deep-neural-networks-issta-2019) - [Deferred Concretization in Symbolic Execution via Fuzzing](#deferred-concretization-in-symbolic-execution-via-fuzzing-issta-2019) - **PLDI 2019** - [Parser-Directed Fuzzing](#parser-directed-fuzzing-pldi-2019) - **ASIACCS 2019** - [Ptrix: Efficient Hardware-Assisted Fuzzing for COTS Binary](#ptrix-efficient-hardware-assisted-fuzzing-for-cots-binary-asiaccs-2019) - [A Feature-Oriented Corpus for understanding, Evaluating and Improving Fuzz Testing](#a-feature-oriented-corpus-for-understanding-evaluating-and-improving-fuzz-testing-asiaccs-2019) - **ICST 2019** - [MemFuzz: Using Memory Accesses to Guide Fuzzing](#memfuzz-using-memory-accesses-to-guide-fuzzing-icst-2019) - [SeqFuzzer: An Industrial Protocol Fuzzing Framework in Deep Learning Perspective](#seqfuzzer-an-industrial-protocol-fuzzing-framework-in-deep-learning-perspective-icst-2019) - **ISSRE 2019** - [Engineering a Better Fuzzer with SynergicallyIntegrated Optimizations](#engineering-a-better-fuzzer-with-synergically-integrated-optimizations-issre-2019) - [Fuzzing Error Handling Code in Device Drivers Based on Software Fault Injection](#fuzzing-error-handling-code-in-device-drivers-based-on-software-fault-injection-issre-2019) - **Other 2019** - [Fuzz Testing of Multithreaded Applications Based on Waiting (2019)](#fuzz-testing-of-multithreaded-applications-based-on-waiting-micsecs-2019) - [Leveraging Textual Specifications for Grammar-Based Fuzzing of Network Protocols (AAAI 2019)](#leveraging-textual-specifications-for-grammar-based-fuzzing-of-network-protocols-aaai-2019) - [Fuzzing JavaScript Environment APIs with Interdependent Function Calls (IFM 2019)](#fuzzing-javascript-environment-apis-with-interdependent-function-calls-ifm-2019) - [DeepFuzzer: Accelerated Deep Greybox Fuzzing (TDSC 2019)](#deepfuzzer-accelerated-deep-greybox-fuzzing-tdsc-2019) - [CAGFuzz: Coverage-Guided Adversarial Generative Fuzzing Testing of Deep Learning Systems](#cagfuzz-coverage-guided-adversarial-generative-fuzzing-testing-of-deep-learning-systems-2019) - [Suzzer: A Vulnerability-Guided Fuzzer Based on Deep Learning](#suzzer-a-vulnerability-guided-fuzzer-based-on-deep-learning-inscrypt-2019) - [ConFuz: A Concurrency Fuzzer](#confuzz-a-concurrency-fuzzer-2019) - [INSTRCR: Lightweight instrumentation optimization based on coverage-guided fuzz testing](#instrcr-lightweight-instrumentation-optimization-based-on-coverage-guided-fuzz-testing-ccet-2019) - [HFuzz: Towards automatic fuzzing testing of NB-IoT core network protocols implementations](#hfuzz-towards-automatic-fuzzing-testing-of-nb-iot-core-network-protocols-implementations-fgcs-2019) - [Study and Comparison of General Purpose Fuzzers](#study-and-comparison-of-general-purpose-fuzzers) - [From proof-of-concept to exploitable](#from-proof-of-concept-to-exploitable-cybersecurity-2019) - [Sequence coverage directed greybox fuzzing](#sequence-coverage-directed-greybox-fuzzing-icpc-2019) - [Field-aware Evolutionary Fuzzing Based on Input Specifications and Vulnerability Metrics](#field-aware-evolutionary-fuzzing-based-on-input-specifications-and-vulnerability-metrics-2019) - [Fuzzing IPC with Knowledge Inference](#fuzzing-ipc-with-knowledge-inference-srds-2019) - [Be Sensitive and Collaborative: Analyzing Impact of Coverage Metrics in Greybox Fuzzing](#be-sensitive-and-collaborative-analyzing-impact-of-coverage-metrics-in-greybox-fuzzing-raid-2019) - [Hydra: An Extensible Fuzzing Framework for Finding Semantic Bugs in File Systems](#hydra-an-extensible-fuzzing-framework-for-finding-semantic-bugs-in-file-systems-sosp-2019) - [Exploring Effective Fuzzing Strategies to Analyze Communication Protocols](#exploring-effective-fuzzing-strategies-to-analyze-communication-protocols-feast-2019) - [V-Fuzz: Vulnerability-Oriented Evolutionary Fuzzing](#v-fuzz-vulnerability-oriented-evolutionary-fuzzing-arxiv-2019) - **S&P 2018** - [T-Fuzz: fuzzing by program transformation](#t-fuzz-fuzzing-by-program-transformation-sp-2018) - [Angora: Efficient Fuzzing by Principled Search](#angora-efficient-fuzzing-by-principled-search-sp-2018) - [CollAFL: Path Sensitive Fuzzing](#collafl-path-sensitive-fuzzing-sp-2018) - **USENIX Security 2018** - [FUZE: Towards Facilitating Exploit Generation for Kernel Use-After-Free Vulnerabilities](#fuze-towards-facilitating-exploit-generation-for-kernel-use-after-free-vulnerabilities-usenix-security2018) - [MoonShine: Optimizing OS Fuzzer Seed Selection with Trace Distillation](#moonshine-optimizing-os-fuzzer-seed-selection-with-trace-distillation-usenix-security2018) - [QSYM : A Practical Concolic Execution Engine Tailored for Hybrid Fuzzing](#qsym-a-practical-concolic-execution-engine-tailored-for-hybrid-fuzzing-usenix-security2018) - **CCS 2018** - [Evaluating fuzz testing](#evaluate-fuzzing) - [Hawkeye Towards a Desired Directed Grey-box Fuzzer](#hawkeye-towards-a-desired-directed-grey-box-fuzzer-ccs-2018) - [Revery: From Proof-of-Concept to Exploitable](#revery-from-proof-of-concept-to-exploitable-ccs-2018) - **NDSS 2018** - [IoTFuzzer: Discovering Memory Corruptions in IoT Through App-based Fuzzing](#iotfuzzer-discovering-memory-corruptions-in-iot-through-app-based-fuzzing-ndss-2018) - [What You Corrupt Is Not What You Crash: Challenges in Fuzzing Embedded Devices](#what-you-corrupt-is-not-what-you-crash-challenges-in-fuzzing-embedded-devices-ndss-2018) - [Enhancing Memory Error Detection for Large-Scale Applications and Fuzz Testing](#enhancing-memory-error-detection-for-large-scale-applications-and-fuzz-testing-ndss-2018) - [INSTRIM Lightweight Instrumentation for Coverage-guided Fuzzing](#instrim-lightweight-instrumentation-for-coverage-guided-fuzzing-ndss-2018-workshop) - **ICSE 2018** - [SAFL: increasing and accelerating testing coverage with symbolic execution and guided fuzzing](#safl-increasing-and-accelerating-testing-coverage-with-symbolic-execution-and-guided-fuzzing-icse-2018) - **ESEC/FSE 2018** - [Singularity: Pattern Fuzzing for Worst Case Complexity](#singularity-pattern-fuzzing-for-worst-case-complexity-fse-2018) - [PAFL: Extend Fuzzing Optimizations of Single Mode to Industrial Parallel Mode](#pafl-extend-fuzzingoptimizations-of-single-mode-to-industrial-parallel-mode-esecfse-2018) - [FOT: A Versatile, Configurable, Extensible Fuzzing Framework](#fot-a-versatile-configurable-extensible-fuzzing-framework-fse-2018) - [DLFuzz: Differential Fuzzing Testing of Deep Learning Systems](#dlfuzz-differential-fuzzing-testing-of-deep-learning-systems-fse-2018) - **ASE 2018** - [ContractFuzzer: Fuzzing Smart Contracts for Vulnerability Detection](#contractfuzzer-fuzzing-smart-contracts-for-vulnerability-detection-ase-2018) - [FairFuzz: A Targeted Mutation Strategy for Increasing Greybox Fuzz Testing Coverage](#fairfuzz-a-targeted-mutation-strategy-for-increasing-greybox-fuzz-testing-coverage-ase-2018) - [Differential Program Analysis with Fuzzing and Symbolic Execution](#differential-program-analysis-with-fuzzing-and-symbolic-execution-ase-2018) - **ISSTA 2018** - [Badger: Complexity Analysis with Fuzzing and Symbolic Execution](#badger-complexity-analysis-with-fuzzing-and-symbolic-execution-issta-2018) - [Compiler Fuzzing through Deep Learning](#compiler-fuzzing-through-deep-learning-issta-2018) - [PerfFuzz: Automatically Generating Pathological Inputs](#perffuzz-automatically-generating-pathological-inputs-issta-2018) - **CAV 2018** - [StringFuzz: A fuzzer for string solvers](#stringfuzz-a-fuzzer-for-string-solvers-cav-2018) - **ACSAC 2018** - [TIFF: Using Input Type Inference To Improve Fuzzing](#tiff-using-input-type-inference-to-improve-fuzzing-acsac-2018) - [A Heuristic Framework to Detect Concurrency Vulnerabilities](#a-heuristic-framework-to-detect-concurrency-vulnerabilities-acsac-2018) - **ICCAD 2018** - [RFUZZ: Coverage-Directed Fuzz Testing of RTL on FPGAs](#rfuzz-coverage-directed-fuzz-testing-of-rtl-on-fpgas-iccad-2018) - **Other 2018** - [FuzzerGym: A Competitive Framework for Fuzzing and Learning](#fuzzergym-a-competitive-framework-for-fuzzing-and-learning-arxiv-2018) - [MTF-Storm: a high performance fuzzer for Modbus-TCP](#MTF-Storm-a-high-performance-fuzzer-for-Modbus-TCP-ETFA-2018) - **S&P 2017** - [NEZHA: Efficient Domain-Independent Differential Testing](#nezha-efficient-domain-independent-differential-testing-sp-2017) - [Skyfire: Data-Driven Seed Generation for Fuzzing](#skyfire-data-driven-seed-generation-for-fuzzing-sp-2017) - **USENIX Security 2017** - [kAFL: Hardware-Assisted Feedback Fuzzing for OS Kernels](#kafl-hardware-assisted-feedback-fuzzing-for-os-kernels-usenix-security2017) - [CAB-Fuzz: Practical Concolic Testing Techniques for COTS Operating Systems](#cab-fuzz-practical-concolic-testing-techniques-for-cots-operating-systems-usenix-security2017) - **CCS 2017** - [Directed Greybox Fuzzing](#directed-greybox-fuzzing-ccs-2017) - [Designing New Operating Primitives to Improve Fuzzing Performance](#designing-new-operating-primitives-to-improve-fuzzing-performance-ccs-2017) - [DIFUZE: Interface aware fuzzing for kernel drivers](#difuze-interface-aware-fuzzing-for-kernel-drivers-ccs-2017) - [SemFuzz: Semantics-based Automatic Generation of Proof-of-Concept Exploits](#semfuzz-semantics-based-automatic-generation-of-proof-of-concept-exploits-ccs-2017) - [SlowFuzz: Automated Domain-Independent Detection of Algorithmic Complexity Vulnerabilities](#slowfuzz-automated-domain-independent-detection-of-algorithmic-complexity-vulnerabilities-ccs-2017) - [IMF: Inferred Model-based Fuzzer](#imf-inferred-model-based-fuzzer-ccs-2017) - **NDSS 2017** - [VUzzer: Application-aware Evolutionary Fuzzing](#vuzzer-application-aware-evolutionary-fuzzing-ndss-2017) - **ESEC/FSE 2017** - [Steelix: Program-State Based Binary Fuzzing](#steelix-program-state-based-binary-fuzzing-fse-2017) - **ASE 2017** - [Learn&Fuzz: Machine Learning for Input Fuzzing](#learnfuzz-machine-learning-for-input-fuzzing-ase-2017) - [In-memory fuzzing for binary code similarity analysis](#in-memory-fuzzing-for-binary-code-similarity-analysis-ase-2017) - **ISSRE 2017** - [Chizpurfle: A Gray-Box Android Fuzzer for Vendor Service Customizations](#chizpurfle-a-gray-box-android-fuzzer-for-vendor-service-customizations-issre-2017) - **Other 2017** - [Bbuzz: A Bit-aware Fuzzing Framework for Network Protocol Systematic Reverse Engineering and Analysis](#bbuzz-a-bit-aware-fuzzing-framework-for-network-protocol-systematic-reverse-engineering-and-analysis-mcc-2017) - **CCS 2016** - [Coverage-based Greybox Fuzzing as Markov Chain](#coverage-based-greybox-fuzzing-as-markov-chain-ccs-2016) - [Systematic Fuzzing and Testing of TLS Libraries](#systematic-fuzzing-and-testing-of-tls-libraries-ccs-2016) - **NDSS 2016** - [Driller: Argumenting Fuzzing Through Selective Symbolic Execution](#driller-argumenting-fuzzing-through-selective-symbolic-execution-ndss-2016) - **PLDI 2016** - [Coverage-Directed Differential Testing of JVM Implementations](#coverage-directed-differential-testing-of-jvm-implementations-pldi-2016) - **S&P 2015** - [Program-Adaptive Mutational Fuzzing](#program-adaptive-mutational-fuzzing-sp-2015) - **USENIX Security 2015** - [Protocol State Fuzzing of TLS Implementations](#protocol-state-fuzzing-of-tls-implementations-usenix-security2015) - **Others** - [Test Data Generation for Stateful Network Protocol Fuzzing Using a Rule-Based State Machine](#test-data-generation-for-stateful-network-protocol-fuzzing-using-a-rule-based-state-machine-2016) - [PULSAR: Stateful Black-Box Fuzzing of Proprietary Network Protocols](#pulsar-stateful-black-box-fuzzing-of-proprietary-network-protocols-springer-cham-2015) - [A Modbus-TCP Fuzzer for testing internetworked industrial systems](#A-Modbus-TCP-Fuzzer-for-testing-internetworked-industrial-systems-ETFA-2015) - [SECFUZZ: Fuzz-testing Security Protocols](#secfuzz-fuzz-testing-security-protocols-ast-2012) - [AutoFuzz: Automated Network Protocol Fuzzing Framewor](#autofuzz-automated-network-protocol-fuzzing-framework-ijcsns-2010) # All Papers (Classification according to Subject) - [Recent Papers Related To Fuzzing](#recent-papers-related-to-fuzzing) - [All Papers (Classification according to Publication)](#all-papers-classification-according-to-publication) - [All Papers (Classification according to Subject)](#all-papers-classification-according-to-subject) - [Survey/Review](#surveyreview) - [Fuzzing: Challenges and Reflections](#fuzzing-challenges-and-reflections) - [SoK: The Progress, Challenges, and Perspectives of Directed Greybox Fuzzing](#sok-the-progress-challenges-and-perspectives-of-directed-greybox-fuzzing) - [Fuzzing: Hack, Art, and Science (CACM 2020)](#fuzzing-hack-art-and-science-cacm-2020) - [Survey of Directed Fuzzy Technology](#survey-of-directed-fuzzy-technology) - [A Review of Machine Learning Applications in Fuzzing](#a-review-of-machine-learning-applications-in-fuzzing) - [A systematic review of fuzzing based on machine learning techniques](#a-systematic-review-of-fuzzing-based-on-machine-learning-techniques) - [The Art, Science, and Engineering of Fuzzing: A Survey](#the-art-science-and-engineering-of-fuzzing-a-survey) - [Fuzzing: Art, Science, and Engineering](#fuzzing-art-science-and-engineering) - [Fuzzing: a survey](#fuzzing-a-survey) - [Fuzzing: State of the art](#fuzzing-state-of-the-art) - [Fuzzing: A Survey for Roadmap](#fuzzing-a-survey-for-roadmap) - [Survey of Software Fuzzing Techniques](#survey-of-software-fuzzing-techniques) - [A Review of Fuzzing Tools and Methods](#a-review-of-fuzzing-tools-and-methods) - [Differential Fuzzing](#differential-fuzzing) - [SEDiff: Scope-Aware Differential Fuzzing to Test Internal Function Models in Symbolic Execution (FSE 2022)](#sediff-scope-aware-differential-fuzzing-to-test-internal-function-models-in-symbolic-execution-fse-2022) - [T-Reqs: HTTP Request Smuggling with Differential Fuzzing (CCS 2021)](#t-reqs-http-request-smuggling-with-differential-fuzzing-ccs-2021) - [CatchBackdoor: Backdoor Testing by Critical Trojan Neural Path Identification via Differential Fuzzing (2021)](#catchbackdoor-backdoor-testing-by-critical-trojan-neural-path-identification-via-differential-fuzzing-2021) - [Duo: Differential Fuzzing for Deep Learning Operators (IEEE Transactions on Reliability 2021)](#duo-differential-fuzzing-for-deep-learning-operators-ieee-transactions-on-reliability-2021) - [DiFuzzRTL: Differential Fuzz Testing to Find CPU Bug (S\&P 2021)](#difuzzrtl-differential-fuzz-testing-to-find-cpu-bug-sp-2021) - [DPIFuzz: A Differential Fuzzing Framework to Detect DPI Elusion Strategies for QUIC (ACSAC 2020)](#dpifuzz-a-differential-fuzzing-framework-to-detect-dpi-elusion-strategies-for-quic-acsac-2020) - [DifFuzz: Differential Fuzzing for Side-Channel Analysis (ICSE 2019)](#diffuzz-differential-fuzzing-for-side-channel-analysis-icse-2019) - [Deep Differential Testing of JVM Implementations (ICSE 2019)](#deep-differential-testing-of-jvm-implementations-icse-2019) - [Hunting for bugs in code coverage tools via randomized differential testing (ICSE 2019)](#hunting-for-bugs-in-code-coverage-tools-via-randomized-differential-testing-icse-2019) - [Different is Good: Detecting the Use of Uninitialized Variables through Differential Replay (CCS 2019)](#different-is-good-detecting-the-use-of-uninitialized-variables-through-differential-replay-ccs-2019) - [Differential Program Analysis with Fuzzing and Symbolic Execution (ASE 2018)](#differential-program-analysis-with-fuzzing-and-symbolic-execution-ase-2018) - [NEZHA: Efficient Domain-Independent Differential Testing (S\&P 2017)](#nezha-efficient-domain-independent-differential-testing-sp-2017) - [Coverage-Directed Differential Testing of JVM Implementations (PLDI 2016)](#coverage-directed-differential-testing-of-jvm-implementations-pldi-2016) - [Evaluate Fuzzing](#evaluate-fuzzing) - [FIXREVERTER: A Realistic Bug Injection Methodology for Benchmarking Fuzz Testing (USENIX Security2022)](#fixreverter-a-realistic-bug-injection-methodology-for-benchmarking-fuzz-testing-usenix-security2022) - [On the Reliability of Coverage-Based Fuzzer Benchmarking (ICSE 2022)](#on-the-reliability-of-coverage-based-fuzzer-benchmarking-icse-2022) - [Mutation Analysis: Answering the Fuzzing Challenge (2022)](#mutation-analysis-answering-the-fuzzing-challenge-2022) - [Evaluating Code Coverage for Kernel Fuzzers via Function Call Graph (Access 2021)](#evaluating-code-coverage-for-kernel-fuzzers-via-function-call-graph-access-2021) - [FuzzBench: An Open Fuzzer Benchmarking Platform and Service (FSE 2021)](#fuzzbench-an-open-fuzzer-benchmarking-platform-and-service-fse-2021) - [An Empirical Study of OSS-Fuzz Bugs (MSR 2021)](#an-empirical-study-of-oss-fuzz-bugs-msr-2021) - [Industrial Oriented Evaluation of Fuzzing Techniques (ICST 2021)](#industrial-oriented-evaluation-of-fuzzing-techniques-icst-2021) - [UNIFUZZ: A Holistic and Pragmatic Metrics-Driven Platform for Evaluating Fuzzers (USENIX Security2021)](#unifuzz-a-holistic-and-pragmatic-metrics-driven-platform-for-evaluating-fuzzers-usenix-security2021) - [My Fuzzer Beats Them All! Developing a Framework for Fair Evaluation and Comparison of Fuzzers (2021)](#my-fuzzer-beats-them-all-developing-a-framework-for-fair-evaluation-and-comparison-of-fuzzers-2021) - [A Quantitative Comparison of Covera (AST 2020)](#a-quantitative-comparison-of-covera-ast-2020) - [Fuzzing: On the Exponential Cost of Vulnerability Discovery (FSE 2020)](#fuzzing-on-the-exponential-cost-of-vulnerability-discovery-fse-2020) - [A Feature-Oriented Corpus for understanding, Evaluating and Improving Fuzz Testing (ASIACCS 2019)](#a-feature-oriented-corpus-for-understanding-evaluating-and-improving-fuzz-testing-asiaccs-2019) - [Be Sensitive and Collaborative: Analyzing Impact of Coverage Metrics in Greybox Fuzzing (RAID 2019)](#be-sensitive-and-collaborative-analyzing-impact-of-coverage-metrics-in-greybox-fuzzing-raid-2019) - [Study and Comparison of General Purpose Fuzzers](#study-and-comparison-of-general-purpose-fuzzers) - [Evaluating Fuzz Testing (CCS 2018)](#evaluating-fuzz-testing-ccs-2018) - [Instrumentation](#instrumentation) - [InstruGuard: Find and Fix Instrumentation Errors for Coverage-based Greybox Fuzzing (ASE 2021)](#instruguard-find-and-fix-instrumentation-errors-for-coverage-based-greybox-fuzzing-ase-2021) - [RIFF: Reduced Instruction Footprint for Coverage-Guided Fuzzing (USENIX ATC 2021)](#riff-reduced-instruction-footprint-for-coverage-guided-fuzzing-usenix-atc-2021) - [Hashing Fuzzing: Introducing Input Diversity to Improve Crash Detection (TSE 2021)](#hashing-fuzzing-introducing-input-diversity-to-improve-crash-detection-tse-2021) - [RetroWrite: Statically Instrumenting COTS Binaries for Fuzzing and Sanitization (S\&P 2020)](#retrowrite-statically-instrumenting-cots-binaries-for-fuzzing-and-sanitization-sp-2020) - [INSTRCR: Lightweight instrumentation optimization based on coverage-guided fuzz testing (CCET 2019)](#instrcr-lightweight-instrumentation-optimization-based-on-coverage-guided-fuzz-testing-ccet-2019) - [Full-speed Fuzzing: Reducing Fuzzing Overhead through Coverage-guided Tracing (S\&P 2019)](#full-speed-fuzzing-reducing-fuzzing-overhead-through-coverage-guided-tracing-sp-2019) - [INSTRIM Lightweight Instrumentation for Coverage-guided Fuzzing (NDSS 2018 workshop)](#instrim-lightweight-instrumentation-for-coverage-guided-fuzzing-ndss-2018-workshop) - [SyzGen: Automated Generation of Syscall Specification of Closed-Source macOS Drivers (CCS 2021)](#syzgen-automated-generation-of-syscall-specification-of-closed-source-macos-drivers-ccs-2021) - [IoT or protocols fuzzing](#iot-or-protocols-fuzzing) - [PrIntFuzz: Fuzzing Linux Drivers via Automated Virtual Device Simulation (ISSTA 2022)](#printfuzz-fuzzing-linux-drivers-via-automated-virtual-device-simulation-issta-2022) - [SnapFuzz: High-Throughput Fuzzing of Network Applications (ISSTA 2022)](#snapfuzz-high-throughput-fuzzing-of-network-applications-issta-2022) - [Efficient Greybox Fuzzing of Applications in Linux-based IoT Devices via Enhanced User-mode Emulation (ISSTA 2022)](#efficient-greybox-fuzzing-of-applications-in-linux-based-iot-devices-via-enhanced-user-mode-emulation-issta-2022) - [FuzzUSB: Hybrid Stateful Fuzzing of USB Gadget Stacks (FSE 2022)](#fuzzusb-hybrid-stateful-fuzzing-of-usb-gadget-stacks-fse-2022) - [BrakTooth: Causing Havoc on Bluetooth Link Manager via Directed Fuzzing (USENIX SEC 2022)](#braktooth-causing-havoc-on-bluetooth-link-manager-via-directed-fuzzing-usenix-sec-2022) - [Drifuzz: Harvesting Bugs in Device Drivers from Golden Seeds (USENIX SEC 2022)](#drifuzz-harvesting-bugs-in-device-drivers-from-golden-seeds-usenix-sec-2022) - [StateFuzz: System Call-Based State-Aware Linux Driver Fuzzing (USENIX SEC 2022)](#statefuzz-system-call-based-state-aware-linux-driver-fuzzing-usenix-sec-2022) - [SNPSFuzzer: A Fast Greybox Fuzzer for Stateful Network Protocols using Snapshots (2022)](#snpsfuzzer-a-fast-greybox-fuzzer-for-stateful-network-protocols-using-snapshots-2022) - [SnapFuzz: An Efficient Fuzzing Framework for Network Applications (2022)](#snapfuzz-an-efficient-fuzzing-framework-for-network-applications-2022) - [State Selection Algorithms and Their Impact on The Performance of Stateful Network Protocol Fuzzing (2021)](#state-selection-algorithms-and-their-impact-on-the-performance-of-stateful-network-protocol-fuzzing-2021) - [ICS3Fuzzer: A Framework for Discovering Protocol Implementation Bugs in ICS Supervisory Software by Fuzzing (ACSAC 2021)](#ics3fuzzer-a-framework-for-discovering-protocol-implementation-bugs-in-ics-supervisory-software-by-fuzzing-acsac-2021) - [Westworld: Fuzzing-Assisted Remote Dynamic Symbolic Execution of Smart Apps on IoT Cloud Platforms (ACSAC 2021)](#westworld-fuzzing-assisted-remote-dynamic-symbolic-execution-of-smart-apps-on-iot-cloud-platforms-acsac-2021) - [ProFuzzBench - A Benchmark for Stateful Protocol Fuzzing (ISSTA 2021)](#profuzzbench---a-benchmark-for-stateful-protocol-fuzzing-issta-2021) - [TCP-Fuzz: Detecting Memory and Semantic Bugs in TCP Stacks with Fuzzing (USENIX ATC 2021)](#tcp-fuzz-detecting-memory-and-semantic-bugs-in-tcp-stacks-with-fuzzing-usenix-atc-2021) - [ICPFuzzer: proprietary communication protocol fuzzing by using machine learning and feedback strategies (Cybersecurity 2021)](#icpfuzzer-proprietary-communication-protocol-fuzzing-by-using-machine-learning-and-feedback-strategies-cybersecurity-2021) - [Fuzzing With Optimized Grammar-Aware Mutation Strategies (Access 2021)](#fuzzing-with-optimized-grammar-aware-mutation-strategies-access-2021) - [FIRM-COV: High-Coverage Greybox Fuzzing for IoT Firmware via Optimized Process Emulation (Access 2021)](#firm-cov-high-coverage-greybox-fuzzing-for-iot-firmware-via-optimized-process-emulation-access-2021) - [DIANE: Identifying Fuzzing Triggers in Apps to Generate Under-constrained Inputs for IoT Devices (S\&P 2020)](#diane-identifying-fuzzing-triggers-in-apps-to-generate-under-constrained-inputs-for-iot-devices-sp-2020) - [Snipuzz: Black-box Fuzzing of IoT Firmware via Message Snippet Inference (CCS 2021)](#snipuzz-black-box-fuzzing-of-iot-firmware-via-message-snippet-inference-ccs-2021) - [Learning-Based Fuzzing of IoT Message Brokers (ICST 2021)](#learning-based-fuzzing-of-iot-message-brokers-icst-2021) - [RiverFuzzRL - an open-source tool to experiment with reinforcement learning for fuzzing (ICST 2021)](#riverfuzzrl---an-open-source-tool-to-experiment-with-reinforcement-learning-for-fuzzing-icst-2021) - [Vulnerability Detection in SIoT Applications: A Fuzzing Method on their Binaries (IEEE Transactions on Network Science and Engineering 2020)](#vulnerability-detection-in-siot-applications-a-fuzzing-method-on-their-binaries-ieee-transactions-on-network-science-and-engineering-2020) - [Analysis of DTLS Implementations Using Protocol State Fuzzing (USENIX Security2020)](#analysis-of-dtls-implementations-using-protocol-state-fuzzing-usenix-security2020) - [Frankenstein: Advanced Wireless Fuzzing to Exploit New Bluetooth Escalation Targets (USENIX Security2020)](#frankenstein-advanced-wireless-fuzzing-to-exploit-new-bluetooth-escalation-targets-usenix-security2020) - [A deep convolution generative adversarial networks based fuzzing framework for industry control protocols](#a-deep-convolution-generative-adversarial-networks-based-fuzzing-framework-for-industry-control-protocols) - [ICS Protocol Fuzzing: Coverage Guided Packet Crack and Generation (DAC 2020)](#ics-protocol-fuzzing-coverage-guided-packet-crack-and-generation-dac-2020) - [AFLNET: A Greybox Fuzzer for Network Protocols (ICST 2020)](#aflnet-a-greybox-fuzzer-for-network-protocols-icst-2020) - [Finding Security Vulnerabilities in Network Protocol Implementations (Arxiv 2020)](#finding-security-vulnerabilities-in-network-protocol-implementations-arxiv-2020) - [Smart seed selection-based effective black box fuzzing for IIoT protocol (2020)](#smart-seed-selection-based-effective-black-box-fuzzing-for-iiot-protocol-2020) - [Fw‐fuzz: A code coverage‐guided fuzzing framework for network protocols on firmware (2020)](#fw‐fuzz-a-code-coverage‐guided-fuzzing-framework-for-network-protocols-on-firmware-2020) - [BaseSAFE: Baseband SAnitized Fuzzing through Emulation (WiSec 2020)](#basesafe-baseband-sanitized-fuzzing-through-emulation-wisec-2020) - [Poster: Fuzzing IoT Firmware via Multi-stage Message Generation (CCS 2019)](#poster-fuzzing-iot-firmware-via-multi-stage-message-generation-ccs-2019) - [SeqFuzzer: An Industrial Protocol Fuzzing Framework in Deep Learning Perspective (ICST 2019)](#seqfuzzer-an-industrial-protocol-fuzzing-framework-in-deep-learning-perspective-icst-2019) - [SPFuzz: A Hierarchical Scheduling Framework for Stateful Network Protocol Fuzzing (IEEE Access 2019)](#spfuzz-a-hierarchical-scheduling-framework-for-stateful-network-protocol-fuzzing-ieee-access-2019) - [HFuzz: Towards automatic fuzzing testing of NB-IoT core network protocols implementations (FGCS 2019)](#hfuzz-towards-automatic-fuzzing-testing-of-nb-iot-core-network-protocols-implementations-fgcs-2019) - [FIRM-AFL: High-Throughput Greybox Fuzzing of IoT Firmware via Augmented Process Emulation (USENIX Security2019)](#firm-afl-high-throughput-greybox-fuzzing-of-iot-firmware-via-augmented-process-emulation-usenix-security2019) - [Exploring Effective Fuzzing Strategies to Analyze Communication Protocols (FEAST 2019)](#exploring-effective-fuzzing-strategies-to-analyze-communication-protocols-feast-2019) - [Leveraging Textual Specifications for Grammar-Based Fuzzing of Network Protocols (AAAI 2019)](#leveraging-textual-specifications-for-grammar-based-fuzzing-of-network-protocols-aaai-2019) - [MTF-Storm: a high performance fuzzer for Modbus-TCP (ETFA 2018)](#mtf-storm-a-high-performance-fuzzer-for-modbus-tcp-etfa-2018) - [Advancing Protocol Fuzzing for Industrial Automation and Control Systems (ICISSP 2018)](#advancing-protocol-fuzzing-for-industrial-automation-and-control-systems-icissp-2018) - [IoTFuzzer: Discovering Memory Corruptions in IoT Through App-based Fuzzing (NDSS 2018)](#iotfuzzer-discovering-memory-corruptions-in-iot-through-app-based-fuzzing-ndss-2018) - [Bbuzz: A Bit-aware Fuzzing Framework for Network Protocol Systematic Reverse Engineering and Analysis (MCC 2017)](#bbuzz-a-bit-aware-fuzzing-framework-for-network-protocol-systematic-reverse-engineering-and-analysis-mcc-2017) - [Test Data Generation for Stateful Network Protocol Fuzzing Using a Rule-Based State Machine (2016)](#test-data-generation-for-stateful-network-protocol-fuzzing-using-a-rule-based-state-machine-2016) - [Protocol State Fuzzing of TLS Implementations (USENIX Security2015)](#protocol-state-fuzzing-of-tls-implementations-usenix-security2015) - [A Modbus-TCP Fuzzer for testing internetworked industrial systems (ETFA 2015)](#a-modbus-tcp-fuzzer-for-testing-internetworked-industrial-systems-etfa-2015) - [PULSAR: Stateful Black-Box Fuzzing of Proprietary Network Protocols (Springer, Cham, 2015)](#pulsar-stateful-black-box-fuzzing-of-proprietary-network-protocols-springer-cham-2015) - [SECFUZZ: Fuzz-testing Security Protocols (AST 2012)](#secfuzz-fuzz-testing-security-protocols-ast-2012) - [Extension of SPIKE for Encrypted Protocol Fuzzing (2011)](#extension-of-spike-for-encrypted-protocol-fuzzing-2011) - [AutoFuzz: Automated Network Protocol Fuzzing Framework (IJCSNS 2010)](#autofuzz-automated-network-protocol-fuzzing-framework-ijcsns-2010) - [SMT Fuzzing](#smt-fuzzing) - [Alt-Ergo-Fuzz: A fuzzer for the Alt-Ergo SMT solver (JFLA 2022)](#alt-ergo-fuzz-a-fuzzer-for-the-alt-ergo-smt-solver-jfla-2022) - [BanditFuzz: Fuzzing SMT Solvers with Multi-agent Reinforcement Learning (FM 2021)](#banditfuzz-fuzzing-smt-solvers-with-multi-agent-reinforcement-learning-fm-2021) - [Skeletal Approximation Enumeration for SMT Solver Testing (FSE 2021)](#skeletal-approximation-enumeration-for-smt-solver-testing-fse-2021) - [Fuzzing SMT Solvers via Two-Dimensional Input Space Exploration (ISSTA 2021)](#fuzzing-smt-solvers-via-two-dimensional-input-space-exploration-issta-2021) - [Detecting Critical Bugs in SMT Solvers Using Blackbox Mutational Fuzzing (FSE 2020)](#detecting-critical-bugs-in-smt-solvers-using-blackbox-mutational-fuzzing-fse-2020) - [On the Unusual Effectiveness of Type-aware Mutations for Testing SMT Solvers](#on-the-unusual-effectiveness-of-type-aware-mutations-for-testing-smt-solvers) - [BanditFuzz: Fuzzing SMT Solvers with Reinforcement Learning (2020)](#banditfuzz-fuzzing-smt-solvers-with-reinforcement-learning-2020) - [Validating SMT Solvers via Semantic Fusion (PLDI 2020)](#validating-smt-solvers-via-semantic-fusion-pldi-2020) - [Automatically Testing String Solvers (ICSE 2020)](#automatically-testing-string-solvers-icse-2020) - [StringFuzz: A fuzzer for string solvers (CAV 2018)](#stringfuzz-a-fuzzer-for-string-solvers-cav-2018) - [Anti Fuzzing](#anti-fuzzing) - [Antifuzz: impeding fuzzing audits of binary executables (USENIX Security2019)](#antifuzz-impeding-fuzzing-audits-of-binary-executables-usenix-security2019) - [FUZZIFICATION: Anti-Fuzzing Technique (USENIX Security2019)](#fuzzification-anti-fuzzing-technique-usenix-security2019) - [Kernel Fuzzing](#kernel-fuzzing) - [Demystifying the Dependency Challenge in Kernel Fuzzing (ICSE 2022)](#demystifying-the-dependency-challenge-in-kernel-fuzzing-icse-2022) - [Semantic-Informed Driver Fuzzing Without Both the Hardware Devices and the Emulators (ICSE 2022)](#semantic-informed-driver-fuzzing-without-both-the-hardware-devices-and-the-emulators-icse-2022) - [SyzScope: Revealing High-Risk Security Impacts of Fuzzer-Exposed Bugs in Linux kernel (USENIX SEC'22)](#syzscope-revealing-high-risk-security-impacts-of-fuzzer-exposed-bugs-in-linux-kernel--usenix-sec22) - [HEALER: Relation Learning Guided Kernel Fuzzing (SOSP 2021)](#healer-relation-learning-guided-kernel-fuzzing-sosp-2021) - [NTFUZZ: Enabling Type-Aware Kernel Fuzzing on Windows with Static Binary Analysis(S\&P 2021)](#ntfuzz-enabling-type-aware-kernel-fuzzing-on-windows-with-static-binary-analysissp-2021) - [Finding Bugs in File Systems with an Extensible Fuzzing Framework (TOS 2020)](#finding-bugs-in-file-systems-with-an-extensible-fuzzing-framework-tos-2020) - [Finding race conditions in Kernels: from fuzzing to symbolic exection (2020)](#finding-race-conditions-in-kernels-from-fuzzing-to-symbolic-exection-2020) - [Hydra: An Extensible Fuzzing Framework for Finding Semantic Bugs in File Systems (SOSP 2019)](#hydra-an-extensible-fuzzing-framework-for-finding-semantic-bugs-in-file-systems-sosp-2019) - [Fuzzing File Systems via Two-Dimensional Input Space Exploration (S\&P 2019)](#fuzzing-file-systems-via-two-dimensional-input-space-exploration-sp-2019) - [Unicorefuzz: On the Viability of Emulation for Kernelspace Fuzzing (USENIX WOOT'19)](#unicorefuzz-on-the-viability-of-emulation-for-kernelspace-fuzzing-usenix-woot19) - [Razzer: Finding Kernel Race Bugs through Fuzzing (S\&P 2019)](#razzer-finding-kernel-race-bugs-through-fuzzing-sp-2019) - [MoonShine: Optimizing OS Fuzzer Seed Selection with Trace Distillation (USENIX Security2018)](#moonshine-optimizing-os-fuzzer-seed-selection-with-trace-distillation-usenix-security2018) - [FUZE: Towards Facilitating Exploit Generation for Kernel Use-After-Free Vulnerabilities (USENIX Security2018)](#fuze-towards-facilitating-exploit-generation-for-kernel-use-after-free-vulnerabilities-usenix-security2018) - [kAFL: Hardware-Assisted Feedback Fuzzing for OS Kernels (Usenix Security2017)](#kafl-hardware-assisted-feedback-fuzzing-for-os-kernels-usenix-security2017) - [DIFUZE: Interface aware fuzzing for kernel drivers (CCS 2017)](#difuze-interface-aware-fuzzing-for-kernel-drivers-ccs-2017) - [IMF: Inferred Model-based Fuzzer (CCS 2017)](#imf-inferred-model-based-fuzzer-ccs-2017) - [Hybrid Fuzzing:](#hybrid-fuzzing) - [TensileFuzz: Facilitating Seed Input Generation in Fuzzing via String Constraint Solving (ISSTA 2022)](#tensilefuzz-facilitating-seed-input-generation-in-fuzzing-via-string-constraint-solving-issta-2022) - [CONFETTI: Amplifying Concolic Guidance for Fuzzers (ICSE 2022)](#confetti-amplifying-concolic-guidance-for-fuzzers-icse-2022) - [FuSeBMC v. 4: Smart Seed Generation for Hybrid Fuzzing (2021)](#fusebmc-v-4-smart-seed-generation-for-hybrid-fuzzing-2021) - [A Tight Integration of Symbolic Execution and Fuzzing (short paper 2021)](#a-tight-integration-of-symbolic-execution-and-fuzzing-short-paper-2021) - [Symbolic Security Predicates: Hunt Program Weaknesses (ISPRAS Open 2021)](#symbolic-security-predicates-hunt-program-weaknesses-ispras-open-2021) - [Towards Symbolic Pointers Reasoning in Dynamic Symbolic Execution (IVMEM 2021)](#towards-symbolic-pointers-reasoning-in-dynamic-symbolic-execution-ivmem-2021) - [FUZZOLIC: Mixing fuzzing and concolic execution (Computers\&Security 2021)](#fuzzolic-mixing-fuzzing-and-concolic-execution-computerssecurity-2021) - [Concolic-Fuzzing of JavaScript Programs using GraalVM and Truffle (SKILL 2021)](#concolic-fuzzing-of-javascript-programs-using-graalvm-and-truffle-skill-2021) - [SHFuzz: A hybrid fuzzing method assisted by static analysis for binary programs (China Communications 2021)](#shfuzz-a-hybrid-fuzzing-method-assisted-by-static-analysis-for-binary-programs-china-communications-2021) - [A Priority Based Path Searching Method for Improving Hybrid Fuzzing (Computers \& Security 2021)](#a-priority-based-path-searching-method-for-improving-hybrid-fuzzing-computers--security-2021) - [Sydr: Cutting Edge Dynamic Symbolic Execution (ISPRAS Open 2020)](#sydr-cutting-edge-dynamic-symbolic-execution-ispras-open-2020) - [CSEFuzz: Fuzz Testing Based on Symbolic Execution (Access 2020)](#csefuzz-fuzz-testing-based-on-symbolic-execution-access-2020) - [Sequence directed hybrid fuzzing (SANER 2020)](#sequence-directed-hybrid-fuzzing-saner-2020) - [HFL: Hybrid Fuzzing on the Linux Kernel (NDSS 2020)](#hfl-hybrid-fuzzing-on-the-linux-kernel-ndss-2020) - [PANGOLIN: Incremental Hybrid Fuzzing with Polyhedral Path Abstraction (S\&P 2020)](#pangolin-incremental-hybrid-fuzzing-with-polyhedral-path-abstraction-sp-2020) - [SAVIOR: Towards Bug-Driven Hybrid Testing (S\&P 2020)](#savior-towards-bug-driven-hybrid-testing-sp-2020) - [Deferred Concretization in Symbolic Execution via Fuzzing (ISSTA 2019)](#deferred-concretization-in-symbolic-execution-via-fuzzing-issta-2019) - [Send Hardest Problems My Way: Probabilistic Path Prioritization for Hybrid Fuzzing (NDSS 2019)](#send-hardest-problems-my-way-probabilistic-path-prioritization-for-hybrid-fuzzing-ndss-2019) - [Intriguer: Field-Level Constraint Solving for Hybrid Fuzzing (CCS 2019)](#intriguer-field-level-constraint-solving-for-hybrid-fuzzing-ccs-2019) - [DeepFuzzer: Accelerated Deep Greybox Fuzzing (TDSC 2019)](#deepfuzzer-accelerated-deep-greybox-fuzzing-tdsc-2019) - [QSYM: A Practical Concolic Execution Engine Tailored for Hybrid Fuzzing (USENIX Security2018)](#qsym-a-practical-concolic-execution-engine-tailored-for-hybrid-fuzzing-usenix-security2018) - [Angora: Efficient Fuzzing by Principled Search (S\&P 2018)](#angora-efficient-fuzzing-by-principled-search-sp-2018) - [SAFL: increasing and accelerating testing coverage with symbolic execution and guided fuzzing (ICSE 2018)](#safl-increasing-and-accelerating-testing-coverage-with-symbolic-execution-and-guided-fuzzing-icse-2018) - [CAB-Fuzz: Practical Concolic Testing Techniques for COTS Operating Systems (Usenix Security2017)](#cab-fuzz-practical-concolic-testing-techniques-for-cots-operating-systems-usenix-security2017) - [Driller: Argumenting Fuzzing Through Selective Symbolic Execution (NDSS 2016)](#driller-argumenting-fuzzing-through-selective-symbolic-execution-ndss-2016) - [Hybrid Fuzz Testing - Discovering Software Bugs via Fuzzing and Symbolic Execution (2012)](#hybrid-fuzz-testing---discovering-software-bugs-via-fuzzing-and-symbolic-execution-2012) - [Hybrid concolic testing (2007)](#hybrid-concolic-testing-2007) - [Mutation\\Coverage\\Path](#mutationcoveragepath) - [One Fuzzing Strategy to Rule Them All (ICSE 2022)](#one-fuzzing-strategy-to-rule-them-all-icse-2022) - [BeDivFuzz: Integrating Behavioral Diversity into Generator-based Fuzzing (ICSE 2022)](#bedivfuzz-integrating-behavioral-diversity-into-generator-based-fuzzing-icse-2022) - [FuzzingDriver: the Missing Dictionary to Increase Code Coverage in Fuzzers (SANER 2022)](#fuzzingdriver-the-missing-dictionary-to-increase-code-coverage-in-fuzzers-saner-2022) - [EMS: History-Driven Mutation for Coverage-based Fuzzing (NDSS 2022)](#ems-history-driven-mutation-for-coverage-based-fuzzing-ndss-2022) - [OTA: An Operation-oriented Time Allocation Strategy for Greybox Fuzzing (SANER 2021)](#ota-an-operation-oriented-time-allocation-strategy-for-greybox-fuzzing-saner-2021) - [MaxAFL: Maximizing Code Coverage with a Gradient-Based Optimization Technique (Electronics 2020)](#maxafl-maximizing-code-coverage-with-a-gradient-based-optimization-technique-electronics-2020) - [PathAFL: Path-Coverage Assisted Fuzzing (ASIA CCS 2020)](#pathafl-path-coverage-assisted-fuzzing-asia-ccs-2020) - [Zeror: Speed Up Fuzzing with Coverage-sensitive Tracing and Scheduling (ASE 2020)](#zeror-speed-up-fuzzing-with-coverage-sensitive-tracing-and-scheduling-ase-2020) - [Not All Coverage Measurements Are Equal: Fuzzing by Coverage Accounting for Input Prioritization (NDSS 2020)](#not-all-coverage-measurements-are-equal-fuzzing-by-coverage-accounting-for-input-prioritization-ndss-2020) - [Matryoshka: fuzzing deeply nested branches (CCS 2019)](#matryoshka-fuzzing-deeply-nested-branches-ccs-2019) - [REDQUEEN: Fuzzing with Input-to-State Correspondence (NDSS2019)](#redqueen-fuzzing-with-input-to-state-correspondence-ndss2019) - [T-Fuzz: fuzzing by program transformation (S\&P 2018)](#t-fuzz-fuzzing-by-program-transformation-sp-2018) - [FairFuzz: A Targeted Mutation Strategy for Increasing Greybox Fuzz Testing Coverage (ASE 2018)](#fairfuzz-a-targeted-mutation-strategy-for-increasing-greybox-fuzz-testing-coverage-ase-2018) - [VUzzer: Application-aware Evolutionary Fuzzing (NDSS 2017)](#vuzzer-application-aware-evolutionary-fuzzing-ndss-2017) - [Grammars \\ Semantic \\ Context-aware Fuzzing](#grammars--semantic--context-aware-fuzzing) - [FRAMESHIFTER: Manipulating HTTP/2 Frame Sequences with Fuzzing (Usenix Security2020)](#frameshifter-manipulating-http2-frame-sequences-with-fuzzing-usenix-security2020) - [SGXFuzz: Efficiently Synthesizing Nested Structures for SGX Enclave Fuzzing (Usenix Security2022)](#sgxfuzz-efficiently-synthesizing-nested-structures-for-sgx-enclave-fuzzing-usenix-security2022) - [Unicorn: Detect Runtime Error in Time-Series Databases With Hybrid Input Synthesis (ISSTA 2022)](#unicorn-detect-runtime-error-in-time-series-databases-with-hybrid-input-synthesis-issta-2022) - [Cooper: Testing the Binding Code of Scripting Languages with Cooperative Mutation (NDSS 2022)](#cooper-testing-the-binding-code-of-scripting-languages-with-cooperative-mutation-ndss-2022) - [Fuzzing Class Specifications (ICSE 2022)](#fuzzing-class-specifications-icse-2022) - [Efficient ECU Analysis Technology through Structure-aware CAN Fuzzing (Access 2022)](#efficient-ecu-analysis-technology-through-structure-aware-can-fuzzing-access-2022) - [Semantic Image Fuzzing of AI Perception Systems](#semantic-image-fuzzing-of-ai-perception-systems) - [SoFi: Reflection-Augmented Fuzzing for JavaScript Engines (CCS 2021)](#sofi-reflection-augmented-fuzzing-for-javascript-engines-ccs-2021) - [V-SHUTTLE: Scalable and Semantics-Aware Hypervisor Fuzzing (CCS 2021)](#v-shuttle-scalable-and-semantics-aware-hypervisor-fuzzing-ccs-2021) - [Token-Level Fuzzing (WiSec 2021)](#token-level-fuzzing-wisec-2021) - [Extended grammar-based fuzzing algorithm for JavaScript Engines (2021)](#extended-grammar-based-fuzzing-algorithm-for-javascript-engines-2021) - [Gramatron: Effective Grammar-Aware Fuzzing (ISSTA 2021)](#gramatron-effective-grammar-aware-fuzzing-issta-2021) - [One Engine to Fuzz 'em All: Generic Language Processor Testing with Semantic Validation (S\&P 2021)](#one-engine-to-fuzz-em-all-generic-language-processor-testing-with-semantic-validation-sp-2021) - [Growing A Test Corpus with Bonsai Fuzzing (ICSE 2021)](#growing-a-test-corpus-with-bonsai-fuzzing-icse-2021) - [Favocado: Fuzzing the Binding Code of JavaScript Engines Using Semantically Correct Test Cases (NDSS 2021)](#favocado-fuzzing-the-binding-code-of-javascript-engines-using-semantically-correct-test-cases-ndss-2021) - [CMFuzz: context-aware adaptive mutation for fuzzers (Empirical Software Engineering 2021)](#cmfuzz-context-aware-adaptive-mutation-for-fuzzers-empirical-software-engineering-2021) - [Generating Highly-structured Input Data by Combining Search-based Testing and Grammar-based Fuzzing (ASE 2020)](#generating-highly-structured-input-data-by-combining-search-based-testing-and-grammar-based-fuzzing-ase-2020) - [Montage: A Neural Network Language Model-Guided JavaScript Engine Fuzzer (Usenix Security2020)](#montage-a-neural-network-language-model-guided-javascript-engine-fuzzer-usenix-security2020) - [Fuzzing JavaScript Engines with Aspect-preserving Mutation (S\&P 2020)](#fuzzing-javascript-engines-with-aspect-preserving-mutation-sp-2020) - [Language-Agnostic Generation of Compilable Test Programs (ICST 2020)](#language-agnostic-generation-of-compilable-test-programs-icst-2020) - [Smart Greybox Fuzzing (TSE 2019)](#smart-greybox-fuzzing-tse-2019) - [Semantic Fuzzing with Zest (ISSTA 2019)](#semantic-fuzzing-with-zest-issta-2019) - [Field-aware Evolutionary Fuzzing Based on Input Specifications and Vulnerability Metrics (2019)](#field-aware-evolutionary-fuzzing-based-on-input-specifications-and-vulnerability-metrics-2019) - [Parser-Directed Fuzzing (PLDI 2019)](#parser-directed-fuzzing-pldi-2019) - [GRIMOIRE: Synthesizing Structure while Fuzzing (USENIX Security2019)](#grimoire-synthesizing-structure-while-fuzzing-usenix-security2019) - [Life after Speech Recognition: Fuzzing Semantic Misinterpretation for Voice Assistant Applications (NDSS 2019)](#life-after-speech-recognition-fuzzing-semantic-misinterpretation-for-voice-assistant-applications-ndss-2019) - [SLF: Fuzzing without Valid Seed Inputs (ICSE 2019)](#slf-fuzzing-without-valid-seed-inputs-icse-2019) - [Superion: Grammar-Aware Greybox Fuzzing (ICSE 2019)](#superion-grammar-aware-greybox-fuzzing-icse-2019) - [ProFuzzer: On-the-fly Input Type Probing for Better Zero-day Vulnerability Discovery (S\&P 2019)](#profuzzer-on-the-fly-input-type-probing-for-better-zero-day-vulnerability-discovery-sp-2019) - [CodeAlchemist: Semantics-Aware Code Generation to Find Vulnerabilities in JavaScript Engines (NDSS 2019)](#codealchemist-semantics-aware-code-generation-to-find-vulnerabilities-in-javascript-engines-ndss-2019) - [NAUTILUS: Fishing for Deep Bugs with Grammars (NDSS 2019)](#nautilus-fishing-for-deep-bugs-with-grammars-ndss-2019) - [TIFF: Using Input Type Inference To Improve Fuzzing (ACSAC 2018)](#tiff-using-input-type-inference-to-improve-fuzzing-acsac-2018) - [Skyfire: Data-Driven Seed Generation for Fuzzing (S\&P 2017)](#skyfire-data-driven-seed-generation-for-fuzzing-sp-2017) - [Exploit Generation](#exploit-generation) - [ETHPLOIT: From Fuzzing to Efficient Exploit Generation against Smart Contracts (SANER2020)](#ethploit-from-fuzzing-to-efficient-exploit-generation-against-smart-contracts-saner2020) - [Gollum: Modular and Greybox Exploit Generation for Heap Overflows in Interpreters (CCS 2019)](#gollum-modular-and-greybox-exploit-generation-for-heap-overflows-in-interpreters-ccs-2019) - [From proof-of-concept to exploitable (Cybersecurity 2019)](#from-proof-of-concept-to-exploitable-cybersecurity-2019) - [Revery: From Proof-of-Concept to Exploitable (CCS 2018)](#revery-from-proof-of-concept-to-exploitable-ccs-2018) - [SemFuzz: Semantics-based Automatic Generation of Proof-of-Concept Exploits (CCS 2017)](#semfuzz-semantics-based-automatic-generation-of-proof-of-concept-exploits-ccs-2017) - [ExploitMeter: Combining Fuzzing with Machine Learning for Automated Evaluation of Software Exploitability (PAC 2017)](#exploitmeter-combining-fuzzing-with-machine-learning-for-automated-evaluation-of-software-exploitability-pac-2017) - [Parallel / Ensemble Fuzzing](#parallel--ensemble-fuzzing) - [UltraFuzz: Towards Resource-saving in Distributed Fuzzing (TSE 2022)](#ultrafuzz-towards-resource-saving-in-distributed-fuzzing-tse-2022) - [Towards Systematic and Dynamic Task Allocation for Collaborative Parallel Fuzzing (ASE 2021 NIER)](#towards-systematic-and-dynamic-task-allocation-for-collaborative-parallel-fuzzing-ase-2021-nier) - [CollabFuzz: A Framework for Collaborative Fuzzing (EuroSec 2021)](#collabfuzz-a-framework-for-collaborative-fuzzing-eurosec-2021) - [Improving Web Application Vulnerability Detection Leveraging Ensemble Fuzzing (ENASE 2021)](#improving-web-application-vulnerability-detection-leveraging-ensemble-fuzzing-enase-2021) - [Cupid: Automatic Fuzzer Selection for Collaborative Fuzzing (ACSAC 2020)](#cupid-automatic-fuzzer-selection-for-collaborative-fuzzing-acsac-2020) - [EnFuzz: Ensemble Fuzzing with Seed Synchronization among Diverse Fuzzers (USENIX Security2019)](#enfuzz-ensemble-fuzzing-with-seed-synchronization-among-diverse-fuzzers-usenix-security2019) - [PAFL: Extend FuzzingOptimizations of Single Mode to Industrial Parallel Mode (ESEC/FSE 2018)](#pafl-extend-fuzzingoptimizations-of-single-mode-to-industrial-parallel-mode-esecfse-2018) - [Sanitizer-guided Fuzzing](#sanitizer-guided-fuzzing) - [ParmeSan: Sanitizer-guided Greybox Fuzzing (USENIX Security2020)](#parmesan-sanitizer-guided-greybox-fuzzing-usenix-security2020) - [State / Sequence Guided Fuzzing](#state--sequence-guided-fuzzing) - [Stateful Greybox Fuzzing (USENIX Security 2022)](#stateful-greybox-fuzzing-usenix-security-2022) - [Linear-time Temporal Logic guided Greybox Fuzzing (ICSE 2022)](#linear-time-temporal-logic-guided-greybox-fuzzing-icse-2022) - [Rtkaller: State-aware Task Generation for RTOS Fuzzing (EMSOFT 2021)](#rtkaller-state-aware-task-generation-for-rtos-fuzzing-emsoft-2021) - [Typestate-Guided Fuzzer for Discovering Use-after-Free Vulnerabilities (ICSE 2020)](#typestate-guided-fuzzer-for-discovering-use-after-free-vulnerabilities-icse-2020) - [IJON: Exploring Deep State Spaces via Fuzzing (S\&P 2020)](#ijon-exploring-deep-state-spaces-via-fuzzing-sp-2020) - [MemFuzz: Using Memory Accesses to Guide Fuzzing (ICST 2019)](#memfuzz-using-memory-accesses-to-guide-fuzzing-icst-2019) - [Rust Fuzzing](#rust-fuzzing) - [Rust Library Fuzzing via API Dependency Graph Traversal (ASE 2021)](#rust-library-fuzzing-via-api-dependency-graph-traversal-ase-2021) - [RUSTY: A Fuzzing Tool for Rust (ACSAC 2020)](#rusty-a-fuzzing-tool-for-rust-acsac-2020) - [Regression Fuzzing](#regression-fuzzing) - [R2Z2: Detecting Rendering Regressions in Web Browsers through Differential Fuzz Testing (ICSE 2022)](#r2z2-detecting-rendering-regressions-in-web-browsers-through-differential-fuzz-testing-icse-2022) - [FADATest: Fast and Adaptive Performance Regression Testing of Dynamic Binary Translation Systems (ICSE 2022)](#fadatest-fast-and-adaptive-performance-regression-testing-of-dynamic-binary-translation-systems-icse-2022) - [Regression Greybox Fuzzing (CCS 2021)](#regression-greybox-fuzzing-ccs-2021) - [DeltaFuzz: Historical Version Information Guided Fuzz Testing (Journal of Computer Science and Technology 2021)](#deltafuzz-historical-version-information-guided-fuzz-testing-journal-of-computer-science-and-technology-2021) - [HyDiff: Hybrid Differential Software Analysis (ICSE 2020)](#hydiff-hybrid-differential-software-analysis-icse-2020) - [Directed Fuzzing](#directed-fuzzing) - [WindRanger: A Directed Greybox Fuzzer driven by Deviation Basic Block (ICSE 2022)](#windranger-a-directed-greybox-fuzzer-driven-by-deviation-basic-block-icse-2022) - [BEACON: Directed Grey-Box Fuzzing with Provable Path Pruning (S\&P 2022)](#beacon-directed-grey-box-fuzzing-with-provable-path-pruning-sp-2022) - [Improving Configurability of Unit-level Continuous Fuzzing: An Industrial Case Study with SAP HANA (ASE 2021 Industry)](#improving-configurability-of-unit-level-continuous-fuzzing-an-industrial-case-study-with-sap-hana-ase-2021-industry) - [KCFuzz: Directed Fuzzing Based on Keypoint Coverage (ICAIS 2021)](#kcfuzz-directed-fuzzing-based-on-keypoint-coverage-icais-2021) - [Constraint-guided Directed Greybox Fuzzing (USENIX Security2021)](#constraint-guided-directed-greybox-fuzzing-usenix-security2021) - [Constructing More Complete Control Flow Graphs Utilizing Directed Gray-Box Fuzzing (MDPI 2021)](#constructing-more-complete-control-flow-graphs-utilizing-directed-gray-box-fuzzing-mdpi-2021) - [Binary-level Directed Fuzzing for Use-After-Free Vulnerabilities (RAID 2020)](#binary-level-directed-fuzzing-for-use-after-free-vulnerabilities-raid-2020) - [Ankou: Guiding Grey-box Fuzzing towards Combinatorial Difference (ICSE 2020)](#ankou-guiding-grey-box-fuzzing-towards-combinatorial-difference-icse-2020) - [RDFuzz: Accelerating Directed Fuzzing with Intertwined Schedule and Optimized Mutation (2020)](#rdfuzz-accelerating-directed-fuzzing-with-intertwined-schedule-and-optimized-mutation-2020) - [TOFU: Target-Oriented FUzzer (Arxiv 2020)](#tofu-target-oriented-fuzzer-arxiv-2020) - [Sequence coverage directed greybox fuzzing (ICPC 2019)](#sequence-coverage-directed-greybox-fuzzing-icpc-2019) - [Hawkeye: Towards a Desired Directed Grey-box Fuzzer (CCS 2018)](#hawkeye-towards-a-desired-directed-grey-box-fuzzer-ccs-2018) - [RFUZZ: Coverage-Directed Fuzz Testing of RTL on FPGAs (ICCAD 2018)](#rfuzz-coverage-directed-fuzz-testing-of-rtl-on-fpgas-iccad-2018) - [Directed Greybox Fuzzing (CCS 2017)](#directed-greybox-fuzzing-ccs-2017) - [Addressing Collision:](#addressing-collision) - [CollAFL: Path Sensitive Fuzzing (S\&P 2018)](#collafl-path-sensitive-fuzzing-sp-2018) - [Performance Fuzzing](#performance-fuzzing) - [Understanding and Detecting Performance Bugs in Markdown Compilers (ASE 2021)](#understanding-and-detecting-performance-bugs-in-markdown-compilers-ase-2021) - [HotFuzz: Discovering Algorithmic Denial-of-Service Vulnerabilities Through Guided Micro-Fuzzing (NDSS 2020)](#hotfuzz-discovering-algorithmic-denial-of-service-vulnerabilities-through-guided-micro-fuzzing-ndss-2020) - [MemLock: Memory Usage Guided Fuzzing (ICSE2020)](#memlock-memory-usage-guided-fuzzing-icse2020) - [Singularity: Pattern Fuzzing for Worst Case Complexity (FSE 2018)](#singularity-pattern-fuzzing-for-worst-case-complexity-fse-2018) - [PerfFuzz: Automatically Generating Pathological Inputs (ISSTA 2018)](#perffuzz-automatically-generating-pathological-inputs-issta-2018) - [Badger: Complexity Analysis with Fuzzing and Symbolic Execution (ISSTA 2018)](#badger-complexity-analysis-with-fuzzing-and-symbolic-execution-issta-2018) - [SlowFuzz: Automated Domain-Independent Detection of Algorithmic Complexity Vulnerabilities (CCS 2017)](#slowfuzz-automated-domain-independent-detection-of-algorithmic-complexity-vulnerabilities-ccs-2017) - [Enhancing Memory Error:](#enhancing-memory-error) - [SANRAZOR: Reducing Redundant Sanitizer Checks in C/C++ Programs (OSDI 2021)](#sanrazor-reducing-redundant-sanitizer-checks-in-cc-programs-osdi-2021) - [Unleashing Fuzzing Through Comprehensive, Efficient, and Faithful Exploitable-Bug Exposing](#unleashing-fuzzing-through-comprehensive-efficient-and-faithful-exploitable-bug-exposing) - [HDR-Fuzz: Detecting Buffer Overruns using AddressSanitizer Instrumentation and Fuzzing (2021)](#hdr-fuzz-detecting-buffer-overruns-using-addresssanitizer-instrumentation-and-fuzzing-2021) - [Enhancing Memory Error Detection for Large-Scale Applications and Fuzz Testing (NDSS 2018)](#enhancing-memory-error-detection-for-large-scale-applications-and-fuzz-testing-ndss-2018) - [AddressSanitizer: A Fast Address Sanity Checker (USENIX Security2012)](#addresssanitizer-a-fast-address-sanity-checker--usenix-security2012) - [Schedule (Power \& Mutation)](#schedule-power--mutation) - [SLIME: Program-sensitive Energy Allocation for Fuzzing (ISSTA 2022)](#slime-program-sensitive-energy-allocation-for-fuzzing-issta-2022) - [MobFuzz: Adaptive Multi-objective Optimization in Gray-box Fuzzing (NDSS 2022)](#mobfuzz-adaptive-multi-objective-optimization-in-gray-box-fuzzing-ndss-2022) - [Effective Seed Scheduling for Fuzzing with Graph Centrality Analysis (S\&P 2022)](#effective-seed-scheduling-for-fuzzing-with-graph-centrality-analysis-sp-2022) - [Path Transitions Tell More: Optimizing Fuzzing Schedules via Runtime Program States (ICSE 2022)](#path-transitions-tell-more-optimizing-fuzzing-schedules-via-runtime-program-states-icse-2022) - [FEFuzzer: Hybrid Files Fuzzing Tool (2022)](#fefuzzer-hybrid-files-fuzzing-tool-2022) - [Seed Selection for Successful Fuzzing (ISSTA 2021)](#seed-selection-for-successful-fuzzing-issta-2021) - [MooFuzz: Many-Objective Optimization Seed Schedule for Fuzzer (Mathematics 2021)](#moofuzz-many-objective-optimization-seed-schedule-for-fuzzer-mathematics-2021) - [EcoFuzz: Adaptive Energy-Saving Greybox Fuzzing as a Variant of the Adversarial Multi-Armed Bandit (USENIX Security2020)](#ecofuzz-adaptive-energy-saving-greybox-fuzzing-as-a-variant-of-the-adversarial-multi-armed-bandit-usenix-security2020) - [MEUZZ: Smart Seed Scheduling for Hybrid Fuzzing (2020)](#meuzz-smart-seed-scheduling-for-hybrid-fuzzing-2020) - [Greybox Fuzzing Based on Ant Colony Algorithm (AINA 2020)](#greybox-fuzzing-based-on-ant-colony-algorithm-aina-2020) - [Suzzer: A Vulnerability-Guided Fuzzer Based on Deep Learning (Inscrypt 2019)](#suzzer-a-vulnerability-guided-fuzzer-based-on-deep-learning-inscrypt-2019) - [MOPT: Optimize Mutation Scheduling for Fuzzers (USENIX Security2019)](#mopt-optimize-mutation-scheduling-for-fuzzers-usenix-security2019) - [Cerebro: Context-aware Adaptive Fuzzing for Effective Vulnerability Detection (FSE 2019)](#cerebro-context-aware-adaptive-fuzzing-for-effective-vulnerability-detection-fse-2019) - [Coverage-based Greybox Fuzzing as Markov Chain (CCS 2016)](#coverage-based-greybox-fuzzing-as-markov-chain-ccs-2016) - [Program-Adaptive Mutational Fuzzing (S\&P 2015)](#program-adaptive-mutational-fuzzing-sp-2015) - [Learning-based Fuzzing](#learning-based-fuzzing) - [Evaluating and Improving Neural Program-Smoothing-based Fuzzing (ICSE 2022)](#evaluating-and-improving-neural-program-smoothing-based-fuzzing-icse-2022) - [Better Pay Attention Whilst Fuzzing (2022)](#better-pay-attention-whilst-fuzzing-2022) - [Automated Conformance Testing for JavaScript Engines via Deep Compiler Fuzzing (PLDI 2021)](#automated-conformance-testing-for-javascript-engines-via-deep-compiler-fuzzing-pldi-2021) - [Reinforcement Learning-based Hierarchical Seed Scheduling for Greybox Fuzzing (NDSS 2021)](#reinforcement-learning-based-hierarchical-seed-scheduling-for-greybox-fuzzing-ndss-2021) - [Neural Network Guided Evolutionary Fuzzing for Finding Traffic Violations of Autonomous Vehicles (arXiv 2021)](#neural-network-guided-evolutionary-fuzzing-for-finding-traffic-violations-of-autonomous-vehicles-arxiv-2021) - [OmniFuzz: A Flexible Framework for Expediting Bug Finding by Leveraging Past (Mis-)Behavior to Discover New Bugs (ACSAC 2020)](#omnifuzz-a-flexible-framework-for-expediting-bug-finding-by-leveraging-past-mis-behavior-to-discover-new-bugs-acsac-2020) - [Learning Input Tokens for Effective Fuzzing (ISSTA 2020)](#learning-input-tokens-for-effective-fuzzing-issta-2020) - [MTFuzz: Fuzzing with a Multi-task Neural Network (FSE 2020)](#mtfuzz-fuzzing-with-a-multi-task-neural-network-fse-2020) - [FuzzGuard: Filtering out Unreachable Inputs in Directed Grey-box Fuzzing through Deep Learning (USENIX Security2020)](#fuzzguard-filtering-out-unreachable-inputs-in-directed-grey-box-fuzzing-through-deep-learning-usenix-security2020) - [LearnAFL: Greybox Fuzzing With Knowledge Enhancement (Access 2019)](#learnafl-greybox-fuzzing-with-knowledge-enhancement-access-2019) - [NeuFuzz: Efficient Fuzzing With Deep Neural Network (Access 2019)](#neufuzz-efficient-fuzzing-with-deep-neural-network-access-2019) - [Learning-Guided Network Fuzzing for Testing Cyber-Physical System Defences (ASE 2019)](#learning-guided-network-fuzzing-for-testing-cyber-physical-system-defences-ase-2019) - [NEUZZ: Efficient Fuzzing with Neural Program Smoothing (S\&P 2019)](#neuzz-efficient-fuzzing-with-neural-program-smoothing-sp-2019) - [V-Fuzz: Vulnerability-Oriented Evolutionary Fuzzing (Arxiv 2019)](#v-fuzz-vulnerability-oriented-evolutionary-fuzzing-arxiv-2019) - [Compiler Fuzzing through Deep Learning (ISSTA 2018)](#compiler-fuzzing-through-deep-learning-issta-2018) - [Deep Reinforcement Fuzzing (SPW 2018)](#deep-reinforcement-fuzzing-spw-2018) - [FuzzerGym: A Competitive Framework for Fuzzing and Learning (arxiv 2018)](#fuzzergym-a-competitive-framework-for-fuzzing-and-learning-arxiv-2018) - [Learn\&Fuzz: Machine Learning for Input Fuzzing (ASE 2017)](#learnfuzz-machine-learning-for-input-fuzzing-ase-2017) - [Fuzzing Machine Learning Model](#fuzzing-machine-learning-model) - [MDPFuzz: Testing Models Solving Markov Decision Processes (ISSTA 2022)](#mdpfuzz-testing-models-solving-markov-decision-processes-issta-2022) - [ocTer: Documentation-Guided Fuzzing for Testing Deep Learning API Functions (ISSTA 2022)](#octer-documentation-guided-fuzzing-for-testing-deep-learning-api-functions-issta-2022) - [Fuzzing Deep-Learning Libraries via Automated Relational API Inference (ESEC/FSE 2022)](#fuzzing-deep-learning-libraries-via-automated-relational-api-inference-esecfse-2022) - [Free Lunch for Testing: Fuzzing Deep-Learning Libraries from Open Source (ICSE 2022)](#free-lunch-for-testing-fuzzing-deep-learning-libraries-from-open-source-icse-2022) - [Muffin: Testing Deep Learning Libraries via Neural Architecture Fuzzing (ICSE 2022)](#muffin-testing-deep-learning-libraries-via-neural-architecture-fuzzing-icse-2022) - [RapidFuzz: Accelerating fuzzing via Generative Adversarial Networks (Neurocomputing 2021)](#rapidfuzz-accelerating-fuzzing-via-generative-adversarial-networks-neurocomputing-2021) - [CoCoFuzzing: Testing Neural Code Models with Coverage-Guided Fuzzing (2021)](#cocofuzzing-testing-neural-code-models-with-coverage-guided-fuzzing-2021) - [Graph-based Fuzz Testing for Deep Learning Inference Engines (ICSE 2021)](#graph-based-fuzz-testing-for-deep-learning-inference-engines-icse-2021) - [Fuzz Testing based Data Augmentation to Improve Robustness of Deep Neural Networks (ICSE 2020)](#fuzz-testing-based-data-augmentation-to-improve-robustness-of-deep-neural-networks-icse-2020) - [Coverage Guided Differential Adversarial Testing of Deep Learning Systems (TNSE 2020)](#coverage-guided-differential-adversarial-testing-of-deep-learning-systems-tnse-2020) - [CAGFuzz: Coverage-Guided Adversarial Generative Fuzzing Testing of Deep Learning Systems (2019)](#cagfuzz-coverage-guided-adversarial-generative-fuzzing-testing-of-deep-learning-systems-2019) - [DeepHunter: A Coverage-Guided Fuzz Testing Framework for Deep Neural Networks (ISSTA 2019)](#deephunter-a-coverage-guided-fuzz-testing-framework-for-deep-neural-networks-issta-2019) - [TensorFuzz: Debugging Neural Networks with Coverage-Guided Fuzzing (ICML 2019)](#tensorfuzz-debugging-neural-networks-with-coverage-guided-fuzzing-icml-2019) - [DLFuzz: Differential Fuzzing Testing of Deep Learning Systems (FSE 2018)](#dlfuzz-differential-fuzzing-testing-of-deep-learning-systems-fse-2018) - [Data Flow Sensitive Fuzzing](#data-flow-sensitive-fuzzing) - [PATA: Fuzzing with Path Aware Taint Analysis (S\&P 2022)](#pata-fuzzing-with-path-aware-taint-analysis-sp-2022) - [datAFLow: Towards a Data-Flow-Guided Fuzzer (NDSS 2022)](#dataflow-towards-a-data-flow-guided-fuzzer-ndss-2022) - [ovAFLow: Detecting Memory Corruption Bugs with Fuzzing-based Taint Inference (Journal of Computer Science and Technology 2021)](#ovaflow-detecting-memory-corruption-bugs-with-fuzzing-based-taint-inference-journal-of-computer-science-and-technology-2021) - [DIAR: Removing Uninteresting Bytes from Seeds in Software Fuzzing (2021)](#diar-removing-uninteresting-bytes-from-seeds-in-software-fuzzing-2021) - [GREYONE: Data Flow Sensitive Fuzzing (USENIX Security2020)](#greyone-data-flow-sensitive-fuzzing-usenix-security2020) - [Binary Fuzzing](#binary-fuzzing) - [spotFuzzer: Static Instrument and Fuzzing Windows COTs (2022)](#spotfuzzer-static-instrument-and-fuzzing-windows-cots-2022) - [Emmutaler: Fuzzing the iOS Boot Loader (Thesis 2021)](#emmutaler-fuzzing-the-ios-boot-loader-thesis-2021) - [Same Coverage, Less Bloat: Accelerating Binary-only Fuzzing with Coverage-preserving Coverage-guided Tracing (CCS 2021)](#same-coverage-less-bloat-accelerating-binary-only-fuzzing-with-coverage-preserving-coverage-guided-tracing-ccs-2021) - [Scalable Fuzzing of Program Binaries with E9AFL (ASE 2021)](#scalable-fuzzing-of-program-binaries-with-e9afl-ase-2021) - [STOCHFUZZ: Sound and Cost-effective Fuzzing of Stripped Binaries by Incremental and Stochastic Rewriting (S\&P 2021)](#stochfuzz-sound-and-cost-effective-fuzzing-of-stripped-binaries-by-incremental-and-stochastic-rewriting-sp-2021) - [Coverage-guided binary fuzzing with rev.ng and llvm libfuzzer](#coverage-guided-binary-fuzzing-with-revng-and-llvm-libfuzzer) - [Breaking Through Binaries: Compiler-quality Instrumentation for Better Binary-only Fuzzing (USENIX Security2021)](#breaking-through-binaries-compiler-quality-instrumentation-for-better-binary-only-fuzzing--usenix-security2021) - [WEIZZ: Automatic Grey-box Fuzzing for Structured Binary Formats](#weizz-automatic-grey-box-fuzzing-for-structured-binary-formats) - [Ptrix: Efficient Hardware-Assisted Fuzzing for COTS Binary (ASIACCS 2019)](#ptrix-efficient-hardware-assisted-fuzzing-for-cots-binary-asiaccs-2019) - [Steelix: Program-State Based Binary Fuzzing (FSE 2017)](#steelix-program-state-based-binary-fuzzing-fse-2017) - [In-memory fuzzing for binary code similarity analysis (ASE 2017)](#in-memory-fuzzing-for-binary-code-similarity-analysis-ase-2017) - [Smart Contracts](#smart-contracts) - [WASAI: Uncovering Vulnerabilities in Wasm Smart Contracts (ISSTA 2022)](#wasai-uncovering-vulnerabilities-in-wasm-smart-contracts-issta-2022) - [Smart Contract Fuzzing for Enterprises: The Language Agnostic Way (COMSNETS 2022)](#smart-contract-fuzzing-for-enterprises-the-language-agnostic-way-comsnets-2022) - [looking for lacunae in bitcoin cores fuzzing efforts (2022)](#looking-for-lacunae-in-bitcoin-cores-fuzzing-efforts-2022) - [Machine Learning Guided Cross-Contract Fuzzing (2021)](#machine-learning-guided-cross-contract-fuzzing-2021) - [SMARTIAN : Enhancing Smart Contract Fuzzing with Static and Dynamic Data-Flow Analyses (ASE 2021)](#smartian--enhancing-smart-contract-fuzzing-with-static-and-dynamic-data-flow-analyses-ase-2021) - [HFContractFuzzer: Fuzzing Hyperledger Fabric Smart Contracts for Vulnerability Detection (EASE 2021)](#hfcontractfuzzer-fuzzing-hyperledger-fabric-smart-contracts-for-vulnerability-detection-ease-2021) - [sFuzz: An Efficient Adaptive Fuzzer for Solidity Smart Contracts (ICSE 2020)](#sfuzz-an-efficient-adaptive-fuzzer-for-solidity-smart-contracts-icse-2020) - [Targeted Greybox Fuzzing with Static Lookahead Analysis (ICSE 2020)](#targeted-greybox-fuzzing-with-static-lookahead-analysis-icse-2020) - [Learning to Fuzz from Symbolic Execution with Application to Smart Contracts (CCS 2019)](#learning-to-fuzz-from-symbolic-execution-with-application-to-smart-contracts-ccs-2019) - [ContractFuzzer: Fuzzing Smart Contracts for Vulnerability Detection (ASE 2018)](#contractfuzzer-fuzzing-smart-contracts-for-vulnerability-detection-ase-2018) - [Constraint Solving](#constraint-solving) - [JIGSAW: Efficient and Scalable Path Constraints Fuzzing (S\&P 2022)](#jigsaw-efficient-and-scalable-path-constraints-fuzzing-sp-2022) - [Fuzzing Symbolic Expressions (ICSE 2021)](#fuzzing-symbolic-expressions-icse-2021) - [Just Fuzz It: Solving Floating-Point Constraints Using Coverage-guided Fuzzing (FSE 2019)](#just-fuzz-it-solving-floating-point-constraints-using-coverage-guided-fuzzing-fse-2019) - [Side-Channel Detection](#side-channel-detection) - [QFuzz: Quantitative Fuzzing for Side Channels (ISSTA 2021)](#qfuzz-quantitative-fuzzing-for-side-channels-issta-2021) - [JVM Fuzzing for JIT-Induced Side-Channel Detection (ICSE 2020)](#jvm-fuzzing-for-jit-induced-side-channel-detection-icse-2020) - [ct-fuzz: Fuzzing for Timing Leaks (ICST 2020)](#ct-fuzz-fuzzing-for-timing-leaks-icst-2020) - [Concurrency Fuzzing](#concurrency-fuzzing) - [Context-Sensitive and Directional Concurrency Fuzzing for Data-Race Detection (NDSS 2022)](#context-sensitive-and-directional-concurrency-fuzzing-for-data-race-detection-ndss-2022) - [Fuzzing with automatically controlled interleavings to detect concurrency bugs (The Journal of Systems \& Software 2022)](#fuzzing-with-automatically-controlled-interleavings-to-detect-concurrency-bugs-the-journal-of-systems--software-2022) - [Controlled Concurrency Testing via Periodical Scheduling (ICSE 2022)](#controlled-concurrency-testing-via-periodical-scheduling-icse-2022) - [Fuzzing Channel-Based Concurrency Runtimes using Types and Effects Slides (OOPSLA 2021)](#fuzzing-channel-based-concurrency-runtimes-using-types-and-effects-slides-oopsla-2021) - [MUZZ: Thread-aware Grey-box Fuzzing for Effective Bug Hunting in Multithreaded Programs (USENIX Security2020)](#muzz-thread-aware-grey-box-fuzzing-for-effective-bug-hunting-in-multithreaded-programs-usenix-security2020) - [KRace: Data Race Fuzzing for Kernel File Systems (S\&P 2020)](#krace-data-race-fuzzing-for-kernel-file-systems-sp-2020) - [ConFuzz: A Concurrency Fuzzer (2019)](#confuzz-a-concurrency-fuzzer-2019) - [Fuzz Testing of Multithreaded Applications Based on Waiting (MICSECS 2019)](#fuzz-testing-of-multithreaded-applications-based-on-waiting-micsecs-2019) - [A Heuristic Framework to Detect Concurrency Vulnerabilities (ACSAC 2018)](#a-heuristic-framework-to-detect-concurrency-vulnerabilities-acsac-2018) - [API Testing/Fuzzing](#api-testingfuzzing) - [Minerva: Browser API Fuzzing with Dynamic Mod-Ref Analysis (FSE 2022)](#minerva-browser-api-fuzzing-with-dynamic-mod-ref-analysis-fse-2022) - [Combinatorial Testing of RESTful APIs (ICSE 2022)](#combinatorial-testing-of-restful-apis-icse-2022) - [GraphFuzz: Library API Fuzzing with Lifetime-aware Dataflow Graphs (ICSE 2022)](#graphfuzz-library-api-fuzzing-with-lifetime-aware-dataflow-graphs-icse-2022) - [MOREST: Model-based RESTful API Testing with Execution Feedback (ICSE 2022)](#morest-model-based-restful-api-testing-with-execution-feedback-icse-2022) - [Automated Testing of Software that Uses Machine Learning APIs (ICSE 2022)](#automated-testing-of-software-that-uses-machine-learning-apis-icse-2022) - [Nessie: Automatically Testing JavaScript APIs with Asynchronous Callbacks (ICSE 2022)](#nessie-automatically-testing-javascript-apis-with-asynchronous-callbacks-icse-2022) - [REST API Fuzzing by Coverage Level Guided Blackbox Testing (2021)](#rest-api-fuzzing-by-coverage-level-guided-blackbox-testing-2021) - [FuzzGen: Automatic Fuzzer Generation (USENIX Security2020)](#fuzzgen-automatic-fuzzer-generation-usenix-security2020) - [Intelligent REST API Data Fuzzing (FSE 2020)](#intelligent-rest-api-data-fuzzing-fse-2020) - [FUDGE: Fuzz Driver Generation at Scale (FSE 2019)](#fudge-fuzz-driver-generation-at-scale-fse-2019) - [REST-ler: Stateful REST API Fuzzing (ICSE 2019)](#rest-ler-stateful-rest-api-fuzzing-icse-2019) - [Fuzzing JavaScript Environment APIs with Interdependent Function Calls (IFM 2019)](#fuzzing-javascript-environment-apis-with-interdependent-function-calls-ifm-2019) - [Systematic Fuzzing and Testing of TLS Libraries (CCS 2016)](#systematic-fuzzing-and-testing-of-tls-libraries-ccs-2016) - [Hardware Fuzzing](#hardware-fuzzing) - [CPU Fuzzing for Discovering Hardware-caused Information Leakage (2022)](#cpu-fuzzing-for-discovering-hardware-caused-information-leakage-2022) - [Fuzzing Hardware Like Software (USENIX SEC 2022)](#fuzzing-hardware-like-software-usenix-sec-2022) - [PeriScope: An Effective Probing and Fuzzing Framework for the Hardware-OS Boundary (NDSS2019)](#periscope-an-effective-probing-and-fuzzing-framework-for-the-hardware-os-boundary-ndss2019) - [Other Interesting Fuzzing](#other-interesting-fuzzing) - [RoboFuzz: Fuzzing Robotic Systems over Robot Operating System (ROS) for Finding Correctness Bugs (FSE 2022)](#robofuzz-fuzzing-robotic-systems-over-robot-operating-system-ros-for-finding-correctness-bugs-fse-2022) - [Almost Correct Invariants: Synthesizing Inductive Invariants by Fuzzing Proofs (ISSTA 2022)](#almost-correct-invariants-synthesizing-inductive-invariants-by-fuzzing-proofs-issta-2022) - [?AFL: Non-intrusive Feedback-driven Fuzzing for Microcontroller Firmware (ICSE 2022)](#afl-non-intrusive-feedback-driven-fuzzing-for-microcontroller-firmware-icse-2022) - [CorbFuzz: Checking Browser Security Policies with Fuzzing (ASE 2021)](#corbfuzz-checking-browser-security-policies-with-fuzzing-ase-2021) - [Fully Automated Functional Fuzzing of Android Apps for Detecting Non-crashing Logic Bugs (OOPSLA 2021)](#fully-automated-functional-fuzzing-of-android-apps-for-detecting-non-crashing-logic-bugs-oopsla-2021) - [webFuzz: Grey-Box Fuzzing for Web Applications (ESORICS 2021)](#webfuzz-grey-box-fuzzing-for-web-applications-esorics-2021) - [Vulnerability-Oriented Fuzz Testing for Connected Autonomous Vehicle Systems ( IEEE Transactions on Reliability 2021)](#vulnerability-oriented-fuzz-testing-for-connected-autonomous-vehicle-systems--ieee-transactions-on-reliability-2021) - [Hardware Support to Improve Fuzzing Performance and Precision (CCS 2021)](#hardware-support-to-improve-fuzzing-performance-and-precision-ccs-2021) - [Fuzzing: Cyberphysical System Testing for Security and Dependability (Computer 2021)](#fuzzing-cyberphysical-system-testing-for-security-and-dependability-computer-2021) - [ESRFuzzer: an enhanced fuzzing framework for physical SOHO router devices to discover multi-Type vulnerabilities (Cybersecurity 2021)](#esrfuzzer-an-enhanced-fuzzing-framework-for-physical-soho-router-devices-to-discover-multi-type-vulnerabilities-cybersecurity-2021) - [Estimating Residual Risk in Greybox Fuzzing (FSE 2021)](#estimating-residual-risk-in-greybox-fuzzing-fse-2021) - [HeteroFuzz: Fuzz Testing to Detect Platform Dependent Divergence for Heterogeneous Applications (FSE 2021)](#heterofuzz-fuzz-testing-to-detect-platform-dependent-divergence-for-heterogeneous-applications-fse-2021) - [DirectFuzz: Automated Test Generation for RTL Designs using Directed Graybox Fuzzing (DAC 2021)](#directfuzz-automated-test-generation-for-rtl-designs-using-directed-graybox-fuzzing-dac-2021) - [PMFuzz: Test Case Generation for Persistent Memory Programs (ASPLOS 2021)](#pmfuzz-test-case-generation-for-persistent-memory-programs-asplos-2021) - [PGFUZZ: Policy-Guided Fuzzing for Robotic Vehicles (NDSS 2021)](#pgfuzz-policy-guided-fuzzing-for-robotic-vehicles-ndss-2021) - [IntelliGen: Automatic Driver Synthesis for Fuzz Testing (ICSE 2021 SEIP)](#intelligen-automatic-driver-synthesis-for-fuzz-testing-icse-2021-seip) - [WINNIE: Fuzzing Windows Applications with Harness Synthesis and Fast Cloning (NDSS 2021)](#winnie-fuzzing-windows-applications-with-harness-synthesis-and-fast-cloning-ndss-2021) - [Industry Practice of Coverage-Guided Enterprise-Level DBMS Fuzzing (ICSE 2021)](#industry-practice-of-coverage-guided-enterprise-level-dbms-fuzzing--icse-2021) - [Refined Grey-Box Fuzzing with Sivo (arXiv 2021)](#refined-grey-box-fuzzing-with-sivo-arxiv-2021) - [Fuzzing Technique in Web Applications and Beyond (MCTE 2020)](#fuzzing-technique-in-web-applications-and-beyond-mcte-2020) - [Nyx: Greybox Hypervisor Fuzzing using Fast Snapshots and Affine Types (USENIX Security2021)](#nyx-greybox-hypervisor-fuzzing-using-fast-snapshots-and-affine-types-usenix-security2021) - [The Use of Likely Invariants as Feedback for Fuzzers (USENIX Security2021)](#the-use-of-likely-invariants-as-feedback-for-fuzzers-usenix-security2021) - [FREEDOM: Engineering a State-of-the-Art DOM Fuzzer (CCS 2020)](#freedom-engineering-a-state-of-the-art-dom-fuzzer-ccs-2020) - [SQUIRREL: Testing Database Management Systems with Language Validity and Coverage Feedback (CCS 2020)](#squirrel-testing-database-management-systems-with-language-validity-and-coverage-feedback-ccs-2020) - [BigFuzz: Efficient Fuzz Testing for Data Analytics using Framework Abstraction (ASE 2020)](#bigfuzz-efficient-fuzz-testing-for-data-analytics-using-framework-abstraction-ase-2020) - [MoFuzz: A Fuzzer Suite for Testing Model-Driven Software Engineering Tools (ASE 2020)](#mofuzz-a-fuzzer-suite-for-testing-model-driven-software-engineering-tools-ase-2020) - [AFL++: Combining Incremental Steps of Fuzzing Research (USENIX Woot2020)](#afl-combining-incremental-steps-of-fuzzing-research-usenix-woot2020) - [Active Fuzzing for Testing and Securing Cyber-Physical Systems (ISSTA 2020)](#active-fuzzing-for-testing-and-securing-cyber-physical-systems-issta-2020) - [CrFuzz: Fuzzing Multi-purpose Programs through Input Validation (FSE 2020)](#crfuzz-fuzzing-multi-purpose-programs-through-input-validation-fse-2020) - [SpecFuzz: Bringing Spectre-type vulnerabilities to the surface (USENIX Security2020)](#specfuzz-bringing-spectre-type-vulnerabilities-to-the-surface-usenix-security2020) - [USBFuzz: A Framework for Fuzzing USB Drivers by Device Emulation (USENIX Security2020)](#usbfuzz-a-framework-for-fuzzing-usb-drivers-by-device-emulation-usenix-security2020) - [Boosting Fuzzer Efficiency: An Information Theoretic Perspective (FSE 2020)](#boosting-fuzzer-efficiency-an-information-theoretic-perspective-fse-2020) - [Fuzzing Error Handling Code using Context-Sensitive Software Fault Injection (USENIX Security2020)](#fuzzing-error-handling-code-using-context-sensitive-software-fault-injection-usenix-security2020) - [FANS: Fuzzing Android Native System Services via Automated Interface Analysis (USENIX Security2020)](#fans-fuzzing-android-native-system-services-via-automated-interface-analysis-usenix-security2020) - [Fuzzing IPC with Knowledge Inference (SRDS 2019)](#fuzzing-ipc-with-knowledge-inference-srds-2019) - [HYPER-CUBE: High-Dimensional Hypervisor Fuzzing (NDSS 2020)](#hyper-cube-high-dimensional-hypervisor-fuzzing-ndss-2020) - [Reproducible Crashes: Fuzzing Pharo by Mutating the Test Methods (IWST20 2020)](#reproducible-crashes-fuzzing-pharo-by-mutating-the-test-methods-iwst20-2020) - [Opening Pandora’s Box through ATFuzzer: Dynamic Analysis of AT Interface for Android Smartphones (ACSAC 2019)](#opening-pandora’s-box-through-atfuzzer-dynamic-analysis-of-at-interface-for-android-smartphones-acsac-2019) - [FuzzFactory: Domain-Specific Fuzzing with Waypoints (OOPSLA 2019)](#fuzzfactory-domain-specific-fuzzing-with-waypoints-oopsla-2019) - [Compiler Fuzzing: How Much Does It Matter (OOPSLA2019)](#compiler-fuzzing-how-much-does-it-matter-oopsla2019) - [RVFuzzer: Finding Input Validation Bugs in Robotic Vehicles through Control-Guided Random Testing (USENIX Security2019)](#rvfuzzer-finding-input-validation-bugs-in-robotic-vehicles-through-control-guided-random-testing-usenix-security2019) - [Engineering a Better Fuzzer with Synergically Integrated Optimizations (ISSRE 2019)](#engineering-a-better-fuzzer-with-synergically-integrated-optimizations-issre-2019) - [Fuzzing Error Handling Code in Device Drivers Based on Software Fault Injection (ISSRE 2019)](#fuzzing-error-handling-code-in-device-drivers-based-on-software-fault-injection-issre-2019) - [What You Corrupt Is Not What You Crash: Challenges in Fuzzing Embedded Devices (NDSS 2018)](#what-you-corrupt-is-not-what-you-crash-challenges-in-fuzzing-embedded-devices-ndss-2018) - [FOT: A Versatile, Configurable, Extensible Fuzzing Framework (FSE 2018)](#fot-a-versatile-configurable-extensible-fuzzing-framework-fse-2018) - [Designing New Operating Primitives to Improve Fuzzing Performance (CCS 2017)](#designing-new-operating-primitives-to-improve-fuzzing-performance-ccs-2017) - [Chizpurfle: A Gray-Box Android Fuzzer for Vendor Service Customizations (ISSRE 2017)](#chizpurfle-a-gray-box-android-fuzzer-for-vendor-service-customizations-issre-2017) - [Fuzzware: Using Precise MMIO Modeling for Effective Firmware Fuzzing (USENIX Security2022)](#fuzzware-using-precise-mmio-modeling-for-effective-firmware-fuzzing-usenix-security2022) - [Page Traffic Analysis](#page-traffic-analysis) # Survey/Review ### Fuzzing: Challenges and Reflections * <img src="image/pdf_24px.png">[Paper](https://www.comp.nus.edu.sg/~abhik/pdf/IEEE-SW-Fuzzing.pdf) **Abstract:** Fuzzing is a method to discover software bugs and vulnerabilities by automatic test input generation which has found tremendous recent interest in both academia and industry. Fuzzing comes in the form of several techniques. On one hand, we have symbolic execution, which enables a particularly effective approach to fuzzing by systematically enumerating the paths of a program. On the other hand, we have random input generation, which generates large amounts of inputs per second with none or minimal program analysis overhead. In this article, we summarize the open challenges and opportunities for fuzzing and symbolic execution as they emerged in discussions among researchers and practitioners in a Shonan Meeting, and were validated in a subsequent survey. We take a forward-looking view of the software vulnerability discovery technologies and provide concrete directions for future research. ### SoK: The Progress, Challenges, and Perspectives of Directed Greybox Fuzzing * <img src="image/wechat_24px.png">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/zpibe5) * * <img src="image/pdf_24px.png">[Paper](./Paper/Arxiv20_SoK.pdf) **Abstract:** Greybox fuzzing has been the most scalable and practical approach to software testing. Most greybox fuzzing tools are coverage guided as code coverage is strongly correlated with bug coverage. However, since most covered codes may not containbugs, blindly extending code coverage is less efficient, especially for corner cases. Unlike coverage-based fuzzers who extend the code coverage in an undirected manner, a directed fuzzer spends most of its time budget on reaching specific target locations (e.g.,the bug-prone zone) without wasting resources stressing unrelated parts. Thus, directed greybox fuzzing is particularly suitable for scenarios such as patch testing, bug reproduction, and special bug hunting. In this paper, we conduct the first in-depth study of directed greybox fuzzing. We investigate 28 state-of-the-artfuzzers (82% are published after 2019) closely related to DGF, which have various directed types and optimization techniques. Based on the feature of DGF, we extract 15 metrics to conducta thorough assessment of the collected tools and systemize the knowledge of this field. Finally, we summarize the challenges and provide perspectives of this field, aiming to facilitate and boost future research on this topic. ### Fuzzing: Hack, Art, and Science (CACM 2020) * <img src="image/pdf_24px.png">[Paper](./Paper/CACM20_Fuzzing.pdf) **Abstract:** Fuzzing, or fuzz testing, is the process of finding security vulnerabilities in input-parsing code by repeatedly testing the parser with modified, or fuzzed, inputs.35 Since the early 2000s, fuzzing has become a mainstream practice in assessing software security. Thousands of security vulnerabilities have been found while fuzzing all kinds of software applications for processing documents, images, sounds, videos, network packets, Web pages, among others. These applications must deal with untrusted inputs encoded in complex data formats. For example, the Microsoft Windows operating system supports over 360 file formats and includes millions of lines of code just to handle all of these. ### Survey of Directed Fuzzy Technology * <img src="image/pdf_24px.png">[Paper](./Paper/ICSESS19_Survey.pdf) **Abstract:** The fuzzy testing technology can effectively detect vulnerabilities. Based on Directed Symbolic Execution (DSE) fuzzing and Directed Grey Box Fuzzing (DGF), which can reach the specified target locations and scan the vulnerability quickly and efficiently. This paper introduces the theoretical knowledge of directed fuzzy testing technology, and several state-of-the-art fuzzy testing tools to elaborate the principle, advantages, disadvantages and the prospect of directed fuzzy technology. ### A Review of Machine Learning Applications in Fuzzing * <img src="image/pdf_24px.png">[Paper](./Paper/Arxiv19_Machine.pdf) **Abstract:** Fuzzing has played an important role in improving software development and testing over the course of several decades. Recent research in fuzzing has focused on applications of machine learning (ML), offering useful tools to overcome challenges in the fuzzing process. This review surveys the current research in applying ML to fuzzing. Specifically, this review discusses successful applications of ML to fuzzing, briefly explores challenges encountered, and motivates future research to address fuzzing bottlenecks. ### A systematic review of fuzzing based on machine learning techniques * <img src="image/pdf_24px.png">[Paper](./Paper/Arxiv19_Machine2.pdf) **Abstract:** Security vulnerabilities play a vital role in network security system. Fuzzing technology is widely used as a vulnerability discovery technology to reduce damage in advance. However, traditional fuzzing techniques have many challenges, such as how to mutate input seed files, how to increase code coverage, and how to effectively bypass verification. Machine learning technology has been introduced as a new method into fuzzing test to alleviate these challenges. This paper reviews the research progress of using machine learning technology for fuzzing test in recent years, analyzes how machine learning improve the fuzz process and results, and sheds light on future work in fuzzing. Firstly, this paper discusses the reasons why machine learning techniques can be used for fuzzing scenarios and identifies six different stages in which machine learning have been used. Then this paper systematically study the machine learning based fuzzing models from selection of machine learning algorithm, pre-processing methods, datasets, evaluation metrics, and hyperparameters setting. Next, this paper assesses the performance of the machine learning models based on the frequently used evaluation metrics. The results of the evaluation prove that machine learning technology has an acceptable capability of categorize predictive for fuzzing. Finally, the comparison on capability of discovering vulnerabilities between traditional fuzzing tools and machine learning based fuzzing tools is analyzed. The results depict that the introduction of machine learning technology can improve the performance of fuzzing. However, there are still some limitations, such as unbalanced training samples and difficult to extract the characteristics related to vulnerabilities. ### The Art, Science, and Engineering of Fuzzing: A Survey * <img src="image/csdn_24px.png">[Reading Note1](https://blog.csdn.net/qq_32505207/article/details/104303840) * <img src="image/csdn_24px.png">[Reading Note2](https://blog.csdn.net/qq_40398985/article/details/103585735) * <img src="image/pdf_24px.png">[Paper](./Paper/TSE19_Survey.pdf) **Abstract:** Among the many software testing techniques available today, fuzzing has remained highly popular due to its conceptual simplicity, its low barrier to deployment, and its vast amount of empirical evidence in discovering real-world software vulnerabilities. At a high level, fuzzing refers to a process of repeatedly running a program with generated inputs that may be syntactically or semantically malformed. While researchers and practitioners alike have invested a large and diverse effort towards improving fuzzing in recent years, this surge of work has also made it difficult to gain a comprehensive and coherent view of fuzzing. To help preserve and bring coherence to the vast literature of fuzzing, this paper presents a unified, general-purpose model of fuzzing together with a taxonomy of the current fuzzing literature. We methodically explore the design decisions at every stage of our model fuzzer by surveying the related literature and innovations in the art, science, and engineering that make modern-day fuzzers effective. ### Fuzzing: Art, Science, and Engineering * <img src="image/pdf_24px.png">[Paper](./Paper/Arxiv18_Fuzzing.pdf) **Abstract:** Among the many software vulnerability discovery techniques available today, fuzzing has remained highly popular due to its conceptual simplicity, its low barrier to deployment, and its vast amount of empirical evidence in discovering real-world software vulnerabilities. At a high level, fuzzing refers to a process of repeatedly running a program with generated inputs that may be syntactically or semantically malformed. While researchers and practitioners alike have invested a large and diverse effort towards improving fuzzing in recent years, this surge of work has also made it difficult to gain a comprehensive and coherent view of fuzzing. To help preserve and bring coherence to the vast literature of fuzzing, this paper presents a unified, general-purpose model of fuzzing together with a taxonomy of the current fuzzing literature. We methodically explore the design decisions at every stage of our model fuzzer by surveying the related literature and innovations in the art, science, and engineering that make modern-day fuzzers effective. ### Fuzzing: a survey * <img src="image/zhihu.png">[Reading Note1](https://zhuanlan.zhihu.com/p/99099607) * <img src="image/csdn_24px.png">[Reading Note2](https://blog.csdn.net/u014578266/article/details/89042508) * <img src="image/pdf_24px.png">[Paper](./Paper/Cybersecurity18_Fuzzing.pdf) **Abstract:** Security vulnerability is one of the root causes of cyber-security threats. To discover vulnerabilities and fix them in advance, researchers have proposed several techniques, among which fuzzing is the most widely used one. In recent years, fuzzing solutions, like AFL, have made great improvements in vulnerability discovery. This paper presents a summary of the recent advances, analyzes how they improve the fuzzing process, and sheds light on future work in fuzzing. Firstly, we discuss the reason why fuzzing is popular, by comparing different commonly used vulnerability discovery techniques. Then we present an overview of fuzzing solutions, and discuss in detail one of the most popular type of fuzzing, i.e., coverage-based fuzzing. Then we present other techniques that could make fuzzing process smarter and more efficient. Finally, we show some applications of fuzzing, and discuss new trends of fuzzing and potential future directions. ### Fuzzing: State of the art * <img src="image/because.png">[Reading Note](https://github.com/bsauce/Some-Papers-About-Fuzzing/blob/master/xmind_picture/fuzz%E7%BB%BC%E8%BF%B0%E2%80%94Fuzzing%EF%BC%9AState%20of%20the%20Art.png) * <img src="image/pdf_24px.png">[Paper](./Paper/TRel18_Fuzzing.pdf) **Abstract:** As one of the most popular software testing techniques, fuzzing can find a variety of weaknesses in a program, such as software bugs and vulnerabilities, by generating numerous test inputs. Due to its effectiveness, fuzzing is regarded as a valuable bug hunting method. In this paper, we present an overview of fuzzing that concentrates on its general process, as well as classifications, followed by detailed discussion of the key obstacles and some state-of-the-art technologies which aim to overcome or mitigate these obstacles. We further investigate and classify several widely used fuzzing tools. Our primary goal is to equip the stakeholder with a better understanding of fuzzing and the potential solutions for improving fuzzing methods in the spectrum of software testing and security. To inspire future research, we also predict some future directions with regard to fuzzing. ### Fuzzing: A Survey for Roadmap * <img src="image/pdf_24px.png">[Paper](https://dl.acm.org/doi/abs/10.1145/3512345) **Abstract:** Fuzz testing (fuzzing) has witnessed its prosperity in detecting security flaws recently. It generates a large number of test cases and monitors the executions for defects. Fuzzing has detected thousands of bugs and vulnerabilities in various applications. Although effective, there lacks systematic analysis of gaps faced by fuzzing. As a technique of defect detection, fuzzing is required to narrow down the gaps between the entire input space and the defect space. Without limitation on the generated inputs, the input space is infinite. However, defects are sparse in an application, which indicates that the defect space is much smaller than the entire input space. Besides, because fuzzing generates numerous test cases to repeatedly examine targets, it requires fuzzing to perform in an automatic manner. Due to the complexity of applications and defects, it is challenging to automatize the execution of diverse applications. In this paper, we systematically review and analyze the gaps as well as their solutions, considering both breadth and depth. This survey can be a roadmap for both beginners and advanced developers to better understand fuzzing. ### Survey of Software Fuzzing Techniques * <img src="image/pdf_24px.png">[Paper](https://www.researchgate.net/publication/356980212_Survey_of_Software_Fuzzing_Techniques) **Abstract:** As cybersecurity becomes more than an afterthought and receives the attention it deserves, it is critical to use tools that examine and understand the flaws within programs. One such tool is fuzzing, a testing process which subjects a system or program to a stream of input data, where the goal of the test is to check for exploitable edge cases. This testing is vital, since a hacker may bombard a system with a variety of inputs and scan the system for weaknesses after causing the system to fail. As the security landscape is constantly shifting, there is a need for an up to date review of the state of literature so readers can make informed decisions about the current state of their systems and software. This survey does that by summarizing current state-of-the art fuzzing approaches, classifying these approaches, and highlighting key insights into the current state of research. The paper also identifies current challenges and suggests future research directions in this area. ### A Review of Fuzzing Tools and Methods * <img src="image/pdf_24px.png">[Paper](./Paper/2017_review.pdf) **Abstract:** This paper reviewed some of the most noteworthy academic literature and practical work that has been produced in the field of fuzzing. We first examined how vulnerabilities come to exist in software and how security researchers find them. After a brief overview of common vulnerability types and methods of static analysis, we looked in depth at the field of fuzzing. Competing approaches to fuzzing were examined, from simple random inputs all the way to using genetic algorithms and taint analysis. The importance of measuring code coverage to evaluate the completeness of a fuzzing campaign was examined. Finally, the focus was placed on the fuzz testing of web browsers and the specific tools and techniques related to that. # Differential Fuzzing ### SEDiff: Scope-Aware Differential Fuzzing to Test Internal Function Models in Symbolic Execution (FSE 2022) * <img src="image/pdf_24px.png">[Paper](https://www.cse.cuhk.edu.hk/~wei/papers/fse22_sediff.pdf) **Abstract:** Symbolic execution has become a foundational program analysis technique. Performing symbolic execution unavoidably encounters internal functions (e.g., library functions) that provide basic operations such as string processing. Many symbolic execution engines construct internal function models that abstract function behaviors for scalability and compatibility concerns. Due to the high complexity of constructing the models, developers intentionally summarize only partial behaviors of a function, namely modeled functionalities, in the models. The correctness of the internal function models is critical because it would impact all applications of symbolic execution, e.g., bug detection and model checking. A naive solution to testing the correctness of internal function models is to cross-check whether the behaviors of the models comply with their corresponding original function implementations. However, such a solution would mostly detect overwhelming inconsistencies concerning the unmodeled functionalities, which are out of the scope of models and thus considered false reports. We argue that a reasonable testing approach should target only the functionalities that developers intend to model. While being necessary, automatically identifying the modeled functionalities, i.e., the scope, is a significant challenge. In this paper, we propose a scope-aware differential testing framework, SEDiff, to tackle this problem. We design a novel algorithm to automatically map the modeled functionalities to the code in the original implementations. SEDiff then applies scope-aware grey-box differential fuzzing to relevant code in the original implementations. It also equips a new scope-aware input generator and a tailored bug checker that efficiently and correctly detect erroneous inconsistencies. We extensively evaluated SEDiff on several popular real-world symbolic execution engines targeting binary, web and kernel. Our manual investigation shows that SEDiff precisely identifies the modeled functionalities and detects 46 new bugs in the internal function models used in the symbolic execution engines. ### T-Reqs: HTTP Request Smuggling with Differential Fuzzing (CCS 2021) * <img src="image/pdf_24px.png">[Paper](https://seclab.nu/static/publications/ccs2021treqs.pdf) **Abstract:** HTTP Request Smuggling (HRS) is an attack that exploits the HTTP processing discrepancies between two servers deployed in a proxy-origin configuration, allowing attackers to smuggle hidden requests through the proxy. While this idea is not new, HRS is soaring in popularity due to recently revealed novel exploitation techniques and real-life abuse scenarios. In this work, we step back from the highly-specific exploits hogging the spotlight, and present the first work that systematically explores HRS within a scientific framework. We design an experiment infrastructure powered by a novel grammar-based differential fuzzer, test 10 popular server/proxy/CDN technologies in combinations, identify pairs that result in processing discrepancies, and discover exploits that lead to HRS. Our experiment reveals previously unknown ways to manipulate HTTP requests for exploitation, and for the first time documents the server pairs prone to HRS. ### CatchBackdoor: Backdoor Testing by Critical Trojan Neural Path Identification via Differential Fuzzing (2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/abs/2112.13064) **Abstract:** The success of deep neural networks (DNNs) in real-world applications has benefited from abundant pre-trained models. However, the backdoored pre-trained models can pose a significant trojan threat to the deployment of downstream DNNs. Existing DNN testing methods are mainly designed to find incorrect corner case behaviors in adversarial settings but fail to discover the backdoors crafted by strong trojan attacks. Observing the trojan network behaviors shows that they are not just reflected by a single compromised neuron as proposed by previous work but attributed to the critical neural paths in the activation intensity and frequency of multiple neurons. This work formulates the DNN backdoor testing and proposes the CatchBackdoor framework. Via differential fuzzing of critical neurons from a small number of benign examples, we identify the trojan paths and particularly the critical ones, and generate backdoor testing examples by simulating the critical neurons in the identified paths. Extensive experiments demonstrate the superiority of CatchBackdoor, with higher detection performance than existing methods. CatchBackdoor works better on detecting backdoors by stealthy blending and adaptive attacks, which existing methods fail to detect. Moreover, our experiments show that CatchBackdoor may reveal the potential backdoors of models in Model Zoo. ### Duo: Differential Fuzzing for Deep Learning Operators (IEEE Transactions on Reliability 2021) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9536229) **Abstract:** Deep learning (DL) libraries reduce the barriers to the DL model construction. In DL libraries, various building blocks are DL operators with different functionality, responsible for processing high-dimensional tensors during training and inference. Thus, the quality of operators could directly impact the quality of models. However, existing DL testing techniques mainly focus on robustness testing of trained neural network models and cannot locate DL operatorsâ€? defects. The insufficient test input and undetermined test output in operator testing have become challenging for DL library developers. In this article, we propose an approach, namely Duo, which combines fuzzing techniques and differential testing techniques to generate input and evaluate corresponding output. It implements mutation-based fuzzing to produce tensor inputs by employing nine mutation operators derived from genetic algorithms and differential testing to evaluate outputsâ€? correctness from multiple operator instances. Duo is implemented in a tool and used to evaluate seven operators from TensorFlow, PyTorch, MNN, and MXNet in an experiment. The result shows that Duo can expose defects of DL operators and realize multidimension evaluation for DL operators from different DL libraries. ### DiFuzzRTL: Differential Fuzz Testing to Find CPU Bug (S&P 2021) * <img src="image/github_24px.png">[Code](https://github.com/yannicnoller/hydiff) **Abstract:** DifuzzRTL is a differential fuzz testing approach for CPU verification. We introduce new coverage metric, register-coverage, which comprehensively captures the states of an RTL design and correctly guides the input generation. DifuzzRTL automatically instruments register-coverage, randomly generates and mutates instructions defined in ISA, then cross-check against an ISA simulator to detect bugs. ### DPIFuzz: A Differential Fuzzing Framework to Detect DPI Elusion Strategies for QUIC (ACSAC 2020) * <img src="image/pdf_24px.png">[Paper](https://cispa.de/en/research/publications/3220-dpifuzz-a-differential-fuzzing-frameworkto-detect-dpi-elusion-strategies-for-quic) **Abstract:** QUIC is an emerging transport protocol that has the potential to replace TCP in the near future. As such, QUIC will become an important target for Deep Packet Inspection (DPI). Reliable DPI is essential, e.g., for corporate environments, to monitor traffic entering and leaving their networks. However, elusion strategies threaten the validity of DPI systems, as they allow attackers to carefully design traffic to fool and thus evade on-path DPI systems. While such elusion strategies for TCP are well documented, it is unclear if attackers will be able to elude QUIC-based DPI systems. In this paper, we systematically explore elusion methodologies for QUIC. To this end, we present DPIFuzz: a differential fuzzing framework which can automatically detect strategies to elude stateful DPI systems for QUIC. We use DPIFuzz to generate and mutate QUIC streams in order to compare (and find differences in) the server-side interpretations of five popular open-source QUIC implementations. We show that DPIFuzz successfully reveals DPI elusion strategies, such as using packets with duplicate packet numbers or exploiting the diverging handling of overlapping stream offsets by QUIC implementations. DPIFuzz additionally finds four security-critical vulnerabilities in these QUIC implementations. ### DifFuzz: Differential Fuzzing for Side-Channel Analysis (ICSE 2019) * <img src="image/youdao_note_24px.png">[Reading Note](https://zhuanlan.zhihu.com/p/132466004) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE19_DIFFUZZ.pdf) * <img src="image/ppt_24px.png">[Slides](./Paper/ICSE19_DIFFUZZ_Slides.pdf) **Abstract:** Side-channel attacks allow an adversary to uncover secret program data by observing the behavior of a program with respect to a resource, such as execution time, consumed memory or response size. Side-channel vulnerabilities are difficult to reason about as they involve analyzing the correlations between resource usage over multiple program paths. We present DifFuzz, a fuzzing-based approach for detecting side-channel vulnerabilities related to time and space. DifFuzz automatically detects these vulnerabilities by analyzing two versions of the program and using resource-guided heuristics to find inputs that maximize the difference in resource consumption between secret-dependent paths. The methodology of DifFuzz is general and can be applied to programs written in any language. For this paper, we present an implementation that targets analysis of Java programs, and uses and extends the Kelinci and AFL fuzzers. We evaluate DifFuzz on a large number of Java programs and demonstrate that it can reveal unknown side-channel vulnerabilities in popular applications. We also show that DifFuzz compares favorably against Blazer and Themis, two state-of-the-art analysis tools for finding side-channels in Java programs. ### Deep Differential Testing of JVM Implementations (ICSE 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE19_Deep.pdf) **Abstract:** The Java Virtual Machine (JVM) is the cornerstone of the widely-used Java platform. Thus, it is critical to ensure the reliability and robustness of popular JVM implementations. However, little research exists on validating production JVMs. One notable effort is classfuzz, which mutates Java bytecode syntactically to stress-test different JVMs. It is shown that classfuzz mainly produces illegal bytecode files and uncovers defects in JVMs' startup processes. It remains a challenge to effectively test JVMs' bytecode verifiers and execution engines to expose deeper bugs. This paper tackles this challenge by introducing classming, a novel, effective approach to performing deep, differential JVM testing. The key of classming is a technique, live bytecode mutation, to generate, from a seed bytecode file f, likely valid, executable (live) bytecode files: (1) capture the seed f's live bytecode, the sequence of its executed bytecode instructions; (2) repeatedly manipulate the control- and data-flow in f's live bytecode to generate semantically different mutants; and (3) selectively accept the generated mutants to steer the mutation process toward live, diverse mutants. The generated mutants are then employed to differentially test JVMs. We have evaluated classming on mainstream JVM implementations, including OpenJDK's HotSpot and IBM's J9, by mutating the DaCapo benchmarks. Our results show that classming is very effective in uncovering deep JVM differences. More than 1,800 of the generated classes exposed JVM differences, and more than 30 triggered JVM crashes. We analyzed and reported the JVM runtime differences and crashes, of which 14 have already been confirmed/fixed, including a highly critical security vulnerability in J9 that allowed untrusted code to disable the security manager and elevate its privileges (CVE-2017-1376). ### Hunting for bugs in code coverage tools via randomized differential testing (ICSE 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#9tQHI) * <img src="image/zhihu.png">[Reading Note](https://zhuanlan.zhihu.com/p/125157536) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE19_Difftest.pdf) **Abstract:** Reliable code coverage tools are critically important as it is heavily used to facilitate many quality assurance activities, such as software testing, fuzzing, and debugging. However, little attention has been devoted to assessing the reliability of code coverage tools. In this study, we propose a randomized differential testing approach to hunting for bugs in the most widely used C code coverage tools. Specifically, by generating random input programs, our approach seeks for inconsistencies in code coverage reports produced by different code coverage tools, and then identifies inconsistencies as potential code coverage bugs. To effectively report code coverage bugs, we addressed three specific challenges: (1) How to filter out duplicate test programs as many of them triggering the same bugs in code coverage tools; (2) how to automatically reduce large test programs to much smaller ones that have the same properties; and (3) how to determine which code coverage tools have bugs? The extensive evaluations validate the effectiveness of our approach, resulting in 42 and 28 confirmed/fixed bugs for gcov and llvm-cov, respectively. This case study indicates that code coverage tools are not as reliable as it might have been envisaged. It not only demonstrates the effectiveness of our approach, but also highlights the need to continue improving the reliability of code coverage tools. This work opens up a new direction in code coverage validation which calls for more attention in this area. ### Different is Good: Detecting the Use of Uninitialized Variables through Differential Replay (CCS 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#COkNh) * <img src="image/zhihu.png">[Reading Note](https://zhuanlan.zhihu.com/p/131312498) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS19_Different.pdf) **Abstract:** The use of uninitialized variables is a common issue. It could cause kernel information leak, which defeats the widely deployed security defense, i.e., kernel address space layout randomization (KASLR). Though a recent system called Bochspwn Reloaded reported multiple memory leaks in Windows kernels, how to effectively detect this issue is still largely behind. In this paper, we propose a new technique, i.e., differential replay, that could effectively detect the use of uninitialized variables. Specifically, it records and replays a program's execution in multiple instances. One instance is with the vanilla memory, the other one changes (or poisons) values of variables allocated from the stack and the heap. Then it compares program states to find references to uninitialized variables. The idea is that if a variable is properly initialized, it will overwrite the poisoned value and program states in two running instances should be the same. After detecting the differences, our system leverages the symbolic taint analysis to further identify the location where the variable was allocated. This helps us to identify the root cause and facilitate the development of real exploits. We have implemented a prototype called TimePlayer. After applying it to both Windows 7 and Windows 10 kernels (x86/x64), it successfully identified 34 new issues and another 85 ones that had been patched (some of them were publicly unknown.) Among 34 new issues, 17 of them have been confirmed as zero-day vulnerabilities by Microsoft. ### Differential Program Analysis with Fuzzing and Symbolic Execution (ASE 2018) * <img src="image/pdf_24px.png">[Paper](./Paper/ASE18_Differential.pdf) **Abstract:** Differential program analysis means to identify the behavioral divergences in one or multiple programs, and it can be classified into two categories: identify the behavioral divergences (1) between two program versions for the same input (aka regression analysis), and (2) for the same program with two different inputs (e.g, side-channel analysis). Most of the existent approaches for both subproblems try to solve it with single techniques, which suffer from its weaknesses like scalability issues or imprecision. This research proposes to combine two very strong techniques, namely fuzzing and symbolic execution to tackle these problems and provide scalable solutions for real-world applications. The proposed approaches will be implemented on top of state-of-the-art tools like AFL and Symbolic PathFinder to evaluate them against existent work. ### NEZHA: Efficient Domain-Independent Differential Testing (S&P 2017) * <img src="image/youdao_note_24px.png">[Reading Note](http://note.youdao.com/noteshare?id=7e602068c641217947c97b287291c9c7&sub=32BD04EB8C00424E87FA7B948D38EC96) * <img src="image/pdf_24px.png">[Paper](./Paper/SP17_NEZHA.pdf) * <img src="image/ppt_24px.png">[Slides](./Paper/SP17_NEZHA_Slides.pdf) * <img src="image/github_24px.png">[Code](https://github.com/nezha-dt/nezha) **Abstract:** Differential testing uses similar programs as cross-referencing oracles to find semantic bugs that do not exhibit explicit erroneous behaviors like crashes or assertion failures. Unfortunately, existing differential testing tools are domain-specific and inefficient, requiring large numbers of test inputs to find a single bug. In this paper, we address these issues by designing and implementing NEZHA, an efficient input-format-agnostic differential testing framework. The key insight behind NEZHA's design is that current tools generate inputs by simply borrowing techniques designed for finding crash or memory corruption bugs in individual programs (e.g., maximizing code coverage). By contrast, NEZHA exploits the behavioral asymmetries between multiple test programs to focus on inputs that are more likely to trigger semantic bugs. We introduce the notion of δ-diversity, which summarizes the observed asymmetries between the behaviors of multiple test applications. Based on δ-diversity, we design two efficient domain-independent input generation mechanisms for differential testing, one gray-box and one black-box. We demonstrate that both of these input generation schemes are significantly more efficient than existing tools at finding semantic bugs in real-world, complex software. ### Coverage-Directed Differential Testing of JVM Implementations (PLDI 2016) * <img src="image/pdf_24px.png">[Paper](./Paper/PLDI16_JVM.pdf) * <img src="image/ppt_24px.png">[Slides](./Paper/PLDI16_JVM.pptx) Java virtual machine (JVM) is a core technology, whose reliability is critical. Testing JVM implementations requires painstaking effort in designing test classfiles (*.class) along with their test oracles. An alternative is to employ binary fuzzing to differentially test JVMs by blindly mutating seeding classfiles and executing the resulting mutants on different JVMs for revealing inconsistent behaviors. However, this blind approach is not cost effective in practice because (1) most of the mutants are invalid and redundant, and (2) the discovered JVM discrepancies, if any, mostly only concern compatibility issues, rather than actual defects. This paper tackles this challenge by introducing classfuzz, a coverage-directed fuzzing approach that focuses on representative classfiles for differential JVM testing. Our core insight is to (1) mutate seeding classfiles using a set of predefined mutation operators and employ Markov Chain Monte Carlo (MCMC) sampling to guide mutator selection, and (2) execute the mutants on a reference JVM implementation and use coverage uniqueness as a discipline for accepting representative ones. The accepted classfiles are used as inputs to differentially test JVMs and find defects. We have implemented classfuzz and conducted an extensive evaluation of it against existing fuzz testing algorithms. Our evaluation results show that classfuzz can enhance the ratio of discrepancy-triggering classfiles from 1.7% to 11.9%. We have also reported 62 defect-indicative discrepancies, along with the test classfiles, to JVM developers. A number of our reported issues have already been confirmed as JVM defects, and some even match recent clarifications and changes to the JVM specification, Java SE 8 Edition. # Evaluate Fuzzing ### FIXREVERTER: A Realistic Bug Injection Methodology for Benchmarking Fuzz Testing (USENIX Security2022) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec22-zhang-zenong.pdf) * <img src="image/github_24px.png">[Code](https://github.com/SlaterLatiao/RevBugBench) **Abstract:** Fuzz testing is an active area of research with proposed improvements published at a rapid pace. Such proposals are assessed empirically: Can they be shown to perform better than the status quo? Such an assessment requires a benchmark of target programs with well-identified, realistic bugs. To ease the construction of such a benchmark, this paper presents FIXREVERTER, a tool that automatically injects realistic bugs in a program. FIXREVERTER takes as input a bugfix pattern which contains both code syntax and semantic conditions. Any code site that matches the specified syntax is undone if the semantic conditions are satisfied, as checked by static analysis, thus (re)introducing a likely bug. This paper focuses on three bugfix patterns, which we call conditional-abort, conditional-execute, and conditional-assign, based on a study of fixes in a corpus of Common Vulnerabilities and Exposures (CVEs). Using FIXREVERTER we have built REVBUGBENCH, which consists of 10 programs into which we have injected nearly 8,000 bugs; the programs are taken from FuzzBench and Binutils, and represent common targets of fuzzing evaluations. We have integrated REVBUGBENCH into the FuzzBench service, and used it to evaluate five fuzzers. Fuzzing performance varies by fuzzer and program, as desired/expected. Overall, 219 unique bugs were reported, 19% of which were detected by just one fuzzer. ### On the Reliability of Coverage-Based Fuzzer Benchmarking (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://mboehme.github.io/paper/ICSE22.pdf) **Abstract:** In one of the largest studies of measures of fuzzer effectiveness, involving over 13 million lines of code, 10 fuzzers, and 24 CPU years worth of fuzzing campaigns, we identify a \emph{very strong correlation} between the coverage achieved and the number of bugs found by a fuzzer: A fuzzer that covers more code also finds more bugs. Because bug-based benchmarking is expensive and subject to several threats to validity, it might seem reasonable to compare fuzzers in terms of the coverage achieved, and from that derive empirical claims about a fuzzer’s superiority at finding bugs. Curiously enough, however, we find \emph{no strong agreement} on which fuzzer is superior if we compared multiple fuzzers in terms of coverage achieved instead of the number of bugs found. The fuzzer best at achieving coverage, may \emph{not} be best at finding bugs. ### Mutation Analysis: Answering the Fuzzing Challenge (2022) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/abs/2201.11303) **Abstract:** Fuzzing is one of the fastest growing fields in software testing. The idea behind fuzzing is to check the behavior of software against a large number of randomly generated inputs, trying to cover all interesting parts of the input space, while observing the tested software for anomalous behaviour. One of the biggest challenges facing fuzzer users is how to validate software behavior, and how to improve the quality of oracles used. While mutation analysis is the premier technique for evaluating the quality of software test oracles, mutation score is rarely used as a metric for evaluating fuzzer quality. Unless mutation analysis researchers can solve multiple problems that make applying mutation analysis to fuzzing challenging, mutation analysis may be permanently sidelined in one of the most important areas of testing and security research. This paper attempts to understand the main challenges in applying mutation analysis for evaluating fuzzers, so that researchers can focus on solving these challenges. ### Evaluating Code Coverage for Kernel Fuzzers via Function Call Graph (Access 2021) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9618942) **Abstract:** The OS kernel, which has full system privileges, is an attractive attack surface. A kernel fuzzer that targets system calls in fuzzing is a popular tool for discovering kernel bugs that can induce kernel privilege escalation attacks. To the best of our knowledge, the relevance of code coverage, which is obtained by fuzzing, to the system call has not been studied yet. For instance, modern coverage-guided kernel fuzzers, such as Syzkaller, estimate code coverage by comparing the entire set of executed basic blocks (or edges) regardless of the system call relevancy. Our insight is that the system call relevancy could be an essential performance indicator for realizing kernel fuzzing. In this regard, this study aims to assess the system call-related code coverage of kernel fuzzers. For this purpose, we have developed a practical assessment system that leverages the Intel PT and KCOV and assessed the Linux kernel fuzzers, such as Syzkaller, Trinity, and ext4 fuzzer. The experiments on different kernel versions demonstrated that approximately 32,000â€?47,000 functions are implemented in the Linux kernel, and approximately 9.7â€?15.2% are related to the system call. Our finding is that fuzzers that achieve higher code coverage in conventional metrics do not execute more basic blocks related to system calls. Thus, we recommend that kernel fuzzers use both system call-related functions and regular basic blocks in coverage metrics to assess fuzzing performance or to improve coverage feedback. ### FuzzBench: An Open Fuzzer Benchmarking Platform and Service (FSE 2021) * <img src="image/pdf_24px.png">[Paper](https://storage.googleapis.com/pub-tools-public-publication-data/pdf/64574e1a7cfc9456c273ce03574dacfcd6ad9d54.pdf) **Abstract:** Fuzzing is a key tool used to reduce bugs in production software. At Google, fuzzing has uncovered tens of thousands of bugs. Fuzzing is also a popular subject of academic research. In 2020 alone, over 120 papers were published on the topic of improving, developing, and evaluating fuzzers and fuzzing techniques. Yet, proper evaluation of fuzzing techniques remains elusive. The community has struggled to converge on methodology and standard tools for fuzzer evaluation. To address this problem, we introduce FuzzBench as an opensource turnkey platform and free service for evaluating fuzzers. It aims to be easy to use, fast, reliable, and provides reproducible experiments. Since its release in March 2020, FuzzBench has been widely used both in industry and academia, carrying out more than 150 experiments for external users. It has been used by several published and in-the-work papers from academic groups, and has had real impact on the most widely used fuzzing tools in industry. The presented case studies suggest that FuzzBench is on its way to becoming a standard fuzzer benchmarking platform. ### An Empirical Study of OSS-Fuzz Bugs (MSR 2021) * <img src="image/pdf_24px.png">[Paper](https://squareslab.github.io/materials/DingOSSFuzz21.pdf) **Abstract:** Continuous fuzzing is an increasingly popular technique for automated quality and security assurance. Google maintains OSS-Fuzz: a continuous fuzzing service for open source software. We conduct the first empirical study of OSS-Fuzz, analyzing 23,907 bugs found in 316 projects. We examine the characteristics of fuzzer-found faults, the lifecycles of such faults, and the evolution of fuzzing campaigns over time. We find that OSS-Fuzz is often effective at quickly finding bugs, and developers are often quick to patch them. However, flaky bugs, timeouts, and out of memory errors are problematic, people rarely file CVEs for security vulnerabilities, and fuzzing campaigns often exhibit punctuated equilibria, where developers might be surprised by large spikes in bugs found. Our findings have implications on future fuzzing research and practice. ### Industrial Oriented Evaluation of Fuzzing Techniques (ICST 2021) * <img src="image/pdf_24px.png">[Paper](http://www.wingtecher.com/themes/WingTecherResearch/assets/papers/icst21.pdf) **Abstract:** Fuzzing is a promising method for discovering vulnerabilities. Recently, various techniques are developed to improve the efficiency of fuzzing, and impressive gains are observed in evaluation results. However, evaluation is complex, as many factors affect the results, for example, test suites, baseline and metrics. Even more, most experiment setups are lab-oriented, lacking industrial settings such as large code-base and parallel runs. The correlation between the academic evaluation results and the bug-finding ability in real industrial settings has not been sufficiently studied. In this paper, we test representative fuzzing techniques to reveal their efficiency in industrial settings. First, we apply typical fuzzers on academic widely used small projects from LAVAM suite. We also apply the same fuzzers on large practical projects from Google’s fuzzer-test-suite, which is rarely used in academic settings. Both experiments are performed in both single and parallel run. By analyzing the results, we found that most optimizations working well on LAVA-M suite fail to achieve satisfying results on Google’s fuzzer-test-suite (e.g. compared to AFL, QSYM detects 82x more synthesized bugs in LAVA-M, but only detects 26% real bugs in Google’s fuzzer-test-suite), and the original AFL even outperforms most academic optimization variants in industry widely used parallel runs (e.g. AFL covers 13% more paths than AFLFast). Then, we summarize common pitfalls of those optimizations, analyze the corresponding root causes, and propose potential directions such as orchestrations and synchronization to overcome the problems. For example, when running in parallel on those large practical projects, the proposed horizontal orchestration could cover 36%-82% more paths, and discover 46%-150% more unique crashes or bugs, compared to fuzzers such as AFL, FairFuzz and QSYM. ### UNIFUZZ: A Holistic and Pragmatic Metrics-Driven Platform for Evaluating Fuzzers (USENIX Security2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2010.01785.pdf) **Abstract:** A flurry of fuzzing tools (fuzzers) have been proposed in the literature, aiming at detecting software vulnerabilities effectively and efficiently. To date, it is however still challenging to compare fuzzers due to the inconsistency of the benchmarks, performance metrics, and/or environments for evaluation, which buries the useful insights and thus impedes the discovery of promising fuzzing primitives. In this paper, we design and develop UNIFUZZ, an open-source and metrics-driven platform for assessing fuzzers in a comprehensive and quantitative manner. Specifically, UNIFUZZ to date has incorporated 35 usable fuzzers, a benchmark of 20 real-world programs, and six categories of performance metrics. We first systematically study the usability of existing fuzzers, find and fix a number of flaws, and integrate them into UNIFUZZ. Based on the study, we propose a collection of pragmatic performance metrics to evaluate fuzzers from six complementary perspectives. Using UNIFUZZ, we conduct in-depth evaluations of several prominent fuzzers including AFL [1], AFLFast [2], Angora [3], Honggfuzz [4], MOPT [5], QSYM [6], T-Fuzz [7] and VUzzer64 [8]. We find that none of them outperforms the others across all the target programs, and that using a single metric to assess the performance of a fuzzer may lead to unilateral conclusions, which demonstrates the significance of comprehensive metrics. Moreover, we identify and investigate previously overlooked factors that may significantly affect a fuzzer's performance, including instrumentation methods and crash analysis tools. Our empirical results show that they are critical to the evaluation of a fuzzer. We hope that our findings can shed light on reliable fuzzing evaluation, so that we can discover promising fuzzing primitives to effectively facilitate fuzzer designs in the future. ### My Fuzzer Beats Them All! Developing a Framework for Fair Evaluation and Comparison of Fuzzers (2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/abs/2108.07076) **Abstract:** Fuzzing has become one of the most popular techniques to identify bugs in software. To improve the fuzzing process, a plethora of techniques have recently appeared in academic literature. However, evaluating and comparing these techniques is challenging as fuzzers depend on randomness when generating test inputs. Commonly, existing evaluations only partially follow best practices for fuzzing evaluations. We argue that the reason for this are twofold. First, it is unclear if the proposed guidelines are necessary due to the lack of comprehensive empirical data in the case of fuzz testing. Second, there does not yet exist a framework that integrates statistical evaluation techniques to enable fair comparison of fuzzers. To address these limitations, we introduce a novel fuzzing evaluation framework called SENF (Statistical EvaluatioN of Fuzzers). We demonstrate the practical applicability of our framework by utilizing the most wide-spread fuzzer AFL as our baseline fuzzer and exploring the impact of different evaluation parameters (e.g., the number of repetitions or run-time), compilers, seeds, and fuzzing strategies. Using our evaluation framework, we show that supposedly small changes of the parameters can have a major influence on the measured performance of a fuzzer. ### A Quantitative Comparison of Covera (AST 2020) * <img src="image/pdf_24px.png">[Paper](https://sites.google.com/site/yoshidaatnu/TsuzukiAST2020.pdf) **Abstract:** In recent years, many tools have been developed for fuzz testing that generates and executes test cases repeatedly. However, many studies use different fuzzing targets and evaluation criteria and then it is difficult to compare the performance of the existing tools for fuzz testing. Therefore, we prepared a unified collection of fuzzing targets and then compared 8 fuzzers with the benchmark. In comparison, we compared the fuzzers based on the number of execution paths and branch coverage. The result shows that the number of execution paths is significantly different between the fuzzers. On the other hand, the statistical difference is not confirmed between the branch converges of the fuzzers. ### Fuzzing: On the Exponential Cost of Vulnerability Discovery (FSE 2020) * <img src="image/pdf_24px.png">[Paper](https://mboehme.github.io/paper/FSE20.EmpiricalLaw.pdf) **Abstract:** We present counterintuitive results for the scalability of fuzzing. Given the same non-deterministic fuzzer, finding the same bugs linearly faster requires linearly more machines. Yet, finding linearly more bugs in the same time requires exponentially more machines. Similarly, with exponentially more machines, we can cover the same code exponentially faster, but uncovered code only linearly faster. In other words, re-discovering the same vulnerabilities (or achieving the same coverage) is cheap but finding new vulnerabilities (or achieving more coverage) is expensive. This holds even under the simplifying assumption of no parallelization overhead. We derive these observations from over four CPU years worth of fuzzing campaigns involving almost three hundred open source programs, two state-of-the-art greybox fuzzers, four measures of code coverage, and two measures of vulnerability discovery. We provide a probabilistic analysis and conduct simulation experiments to explain this phenomenon. ### A Feature-Oriented Corpus for understanding, Evaluating and Improving Fuzz Testing (ASIACCS 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/ASIACCS19_Feature-Oriented.pdf) **Abstract:** Fuzzing is a promising technique for detecting security vulnerabilities. Newly developed fuzzers are typically evaluated in terms of the number of bugs found on vulnerable programs/binaries. However,existing corpora usually do not capture the features that prevent fuzzers from finding bugs, leading to ambiguous conclusions on the pros and cons of the fuzzers evaluated. A typical example is that Driller detects more bugs than AFL, but its evaluation cannot establish if the advancement of Driller stems from the concolic execution or not, since, for example, its ability in resolving a dataset`s magic values is unclear. In this paper, we propose to address the above problem by generating corpora based on search-hampering features. As a proof-of-concept, we have designed FEData, a prototype corpus that currently focuses on four search-hampering features to generate vulnerable programs for fuzz testing. Unlike existing corpora that can only answer "how", FEData can also further answer "why" by exposing (or understanding) the reasons for the identified weaknesses in a fuzzer. The "why" information serves as the key to the improvement of fuzzers. ### Be Sensitive and Collaborative: Analyzing Impact of Coverage Metrics in Greybox Fuzzing (RAID 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/RAID19_Coverage.pdf) **Abstract:** Coverage-guided greybox fuzzing has become one of the most common techniques for finding software bugs. Coverage metric, which decides how a fuzzer selects new seeds, is an essential parameter of fuzzing and can significantly affect the results. While there are many existing works on the effectiveness of different coverage metrics on software testing, little is known about how different coverage metrics could actually affect the fuzzing results in practice. More importantly, it is unclear whether there exists one coverage metric that is superior to all the other metrics. In this paper, we report the first systematic study on the impact of different coverage metrics in fuzzing. To this end, we formally define and discuss the concept of sensitivity, which can be used to theoretically compare different coverage metrics. We then present several coverage metrics with their variants. We conduct a study on these metrics with the DARPA CGC dataset, the LAVA-M dataset, and a set of real-world applications (a total of 221 binaries). We find that because each fuzzing instance has limited resources (time and computation power), (1) each metric has its unique merit in terms of flipping certain types of branches (thus vulnerability finding) and (2) there is no grand slam coverage metric that defeats all the others. We also explore combining different coverage metrics through cross-seeding, and the result is very encouraging: this pure fuzzing based approach can crash at least the same numbers of binaries in the CGC dataset as a previous approach (Driller) that combines fuzzing and concolic execution. At the same time, our approach uses fewer computing resources. ### Study and Comparison of General Purpose Fuzzers * <img src="image/pdf_24px.png">[Paper](./Paper/J19_Study.pdf) **Abstract:** Fuzz testing is a widely used technique for the detection of vulnerabilities whose popularity has led to the development of various tools that do fuzz testing. General-purpose fuzzers work in all domains while some other fuzzers are targeted towards some specific domain. Evaluation of these tools is not an easy task since different fuzzing tools excel in dierent domains. In this paper, we evaluate 3 such general-purpose fuzzing tools namely libFuzzer, American Fuzzy Lop(AFL) and honggfuzz on 2 metrics, i.e. their bug finding capability and their code coverage. We use the google fuzzer-test-suite which has 24 applications spanning several domains. libFuzzer performs best out of the three in finding memory leaks and out-of-memory related bugs but for other kinds of bugs, all three perform at par. honggfuzz seems to be the best in terms of coverage, though libFuzzer is not far behind, which we believe is because of our runs being of short duration. ### Evaluating Fuzz Testing (CCS 2018) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS18_Evaluating.pdf) **Abstract:** Fuzz testing has enjoyed great success at discovering security critical bugs in real software. Recently, researchers have devoted significant effort to devising new fuzzing techniques, strategies, and algorithms. Such new ideas are primarily evaluated experimentally so an important question is: What experimental setup is needed to produce trustworthy results? We surveyed the recent research literature and assessed the experimental evaluations carried out by 32 fuzzing papers. We found problems in every evaluation we considered. We then performed our own extensive experimental evaluation using an existing fuzzer. Our results showed that the general problems we found in existing experimental evaluations can indeed translate to actual wrong or misleading assessments. We conclude with some guidelines that we hope will help improve experimental evaluations of fuzz testing algorithms, making reported results more robust. # Instrumentation ### InstruGuard: Find and Fix Instrumentation Errors for Coverage-based Greybox Fuzzing (ASE 2021) * <img src="image/pdf_24px.png">[Paper](https://ajax4sec.github.io/papers/ASE_2021.pdf) * <img src="image/github_24px.png">[Code](https://github.com/Marsman1996/instruguard) **Abstract:** As one of the most successful methods at vulnerability discovery, coverage-based greybox fuzzing relies on the lightweight compiler-level instrumentation to achieve the finegrained coverage feedback of the target program. Researchers improve it by optimizing the coverage metrics without questioning the correctness of the instrumentation. However, instrumentation errors, including missed instrumentation locations and redundant instrumentation locations, harm the ability of fuzzers. According to our experiments, it is a common and severe problem in various coverage-based greybox fuzzers and at different compiler optimization levels. In this paper, we design and implement InstruGuard, an open-source and pragmatic platform to find and fix instrumentation errors. It detects instrumentation errors by static analysis on target binaries, and fixes them with a general solution based on binary rewriting. To study the impact of instrumentation errors and test our solutions, we built a dataset of 15 real-world rograms and selected 6 representative fuzzers as targets. We used InstruGuard to check and repair the instrumented binaries with different fuzzers and different compiler optimization options. To evaluate the effectiveness of the repair, we ran the fuzzers with original instrumented programs and the repaired ones, and compared the fuzzing results from aspects of execution paths, line coverage, and real bug findings. The results showed that InstruGuard had corrected the instrumentation errors of different fuzzers and helped to find more bugs in the dataset. Moreover, we discovered one new zero-day vulnerability missed by other fuzzers with fixed instrumentation but without any changes to the fuzzers. ### RIFF: Reduced Instruction Footprint for Coverage-Guided Fuzzing (USENIX ATC 2021) * <img src="image/youtube.png">[Video](https://youtu.be/x3KQjjlteL8) * <img src="image/ppt_24px.png">[Slides](https://www.usenix.org/system/files/atc21_slides_wang-mingzhe.pdf) * <img src="image/pdf_24px.png">[Paper](http://www.wingtecher.com/themes/WingTecherResearch/assets/papers/atc21.pdf) **Abstract:** Coverage-guided fuzzers use program coverage measurements to explore different program paths efficiently. The coverage pipeline consists of runtime collection and post-execution processing procedures. First, the target program executes instrumentation code to collect coverage information. Then the fuzzer performs an expensive analysis on the collected data, yet most program executions lead to no increases in coverage. Inefficient implementations of these steps significantly reduce the fuzzer's overall throughput. In this paper, we propose RIFF, a highly efficient program coverage measurement mechanism to reduce fuzzing overhead. For the target program, RIFF moves computations originally done at runtime to instrumentation-time through static program analysis, thus reducing instrumentation code to a bare minimum. For the fuzzer, RIFF processes coverage with different levels of granularity and utilizes vector instructions to improve throughput. We implement RIFF in state-of-the-art fuzzers such as AFL and MOpt and evaluate its performance on real-world programs in Google's FuzzBench and fuzzer-test-suite. The results show that RIFF improves coverage measurement efficiency of fuzzers by 23× and 6× during runtime collection and post-execution processing, respectively. As a result, the fuzzers complete 147% more executions, and use only 6.53 hours to reach the 24-hour coverage of baseline fuzzers on average. ### Hashing Fuzzing: Introducing Input Diversity to Improve Crash Detection (TSE 2021) * <img src="image/pdf_24px.png">[Paper](./Paper/SP20_RetroWrite.pdf) **Abstract:** The utility of a test set of program inputs is strongly influenced by its diversity and its size. Syntax coverage has become a standard proxy for diversity. Although more sophisticated measures exist, such as proximity of a sample to a uniform distribution, methods to use them tend to be type dependent. We use r-wise hash functions to create a novel, semantics preserving, testability transformation for C programs that we call HashFuzz. Use of HashFuzz improves the diversity of test sets produced by instrumentation-based fuzzers. We evaluate the effect of the HashFuzz transformation on eight programs from the Google Fuzzer Test Suite using four state-of-the-art fuzzers that have been widely used in previous research. We demonstrate pronounced improvements in the performance of the test sets for the transformed programs across all the fuzzers that we used. These include strong improvements in diversity in every case, maintenance or small improvement in branch coverage -- up to 4.8% improvement in the best case, and significant improvement in unique crash detection numbers -- between 28% to 97% increases compared to test sets for untransformed programs. ### RetroWrite: Statically Instrumenting COTS Binaries for Fuzzing and Sanitization (S&P 2020) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2019/11/05/retrowrite-statically-instrumenting-cots-binaries-for-fuzzing-and-sanitization/) * <img src="image/pdf_24px.png">[Paper](./Paper/SP20_RetroWrite.pdf) **Abstract:** Analyzing the security of closed source binaries is currently impractical for end-users, or even developers who rely on third-party libraries. Such analysis relies on automatic vulnerability discovery techniques, most notably fuzzing with sanitizers enabled. The current state of the art for applying fuzzing or sanitization to binaries is a dynamic binary translation, which has a prohibitive performance overhead. The alternate technique, static binary rewriting, cannot fully recover symbolization information and hence has difficulty modifying binaries to track code coverage for fuzzing or to add security checks for sanitizers. The ideal solution for binary security analysis would be a static rewriter that can intelligently add the required instrumentation as if it were inserted at compile time. Such instrumentation requires an analysis to statically disambiguate between references and scalars, a problem known to be undecidable in the general case. We show that recovering this information is possible in practice for the most common class of software and libraries: 64-bit, position-independent code. Based on this observation, we develop RetroWrite, binary-rewriting instrumentation to support American Fuzzy Lop (AFL) and Address Sanitizer (ASan), and show that it can achieve compiler-level performance while retaining precision. Binaries rewritten for coverage guided fuzzing using RetroWrite are identical in performance to compiler-instrumented binaries and outperform the default QEMU-based instrumentation by 4.5x while triggering more bugs. Our implementation of binary-only Address Sanitizer is 3x faster than Valgrind’s memcheck, the state-of-the-art binary-only memory checker, and detects 80% more bugs in our evaluation. ### INSTRCR: Lightweight instrumentation optimization based on coverage-guided fuzz testing (CCET 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/CCET19_INSTRCR.pdf) **Abstract:** In Fuzzing facing binary coverage, the main role of instrumentation is feedback code coverage (in the case of Fuzz for binary, instrumentation can provide coverage information, which plays an important role in guiding the operation of seeds in Fuzz) . The current instrumentation optimization technique mainly relies on the control flow graph (CFG) to select key basic blocks at the basic block level, but the accuracy of this method is not high enough. Considering that the actual path in the actual operation of the binary may be different from the CFG generated in advance, this paper is based on the indirect jump that cannot be accurately analyzed in the CFG, and some of the basic blocks that can be optimized for high-frequency interpolation. According to the algorithm proposed in this paper, The combination of static analysis and dynamic analysis is used to continuously adjust and select key basic block nodes for instrumentation. It is verified by experiments that this kind of instrumentation method can effectively improve the coverage rate and reduce the overhead, and provide effective guidance for Fuzzing, which can effectively reduce the Fuzzer’s false negatives. ### Full-speed Fuzzing: Reducing Fuzzing Overhead through Coverage-guided Tracing (S&P 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#PouZd) * <img src="image/wechat_24px.png">[Reading Note](https://mp.weixin.qq.com/s/Cf_0F2bPmK8Gmp5JWnPOiA) * <img src="image/pdf_24px.png">[Paper](./Paper/SP19_Full-speed.pdf) * <img src="image/github_24px.png">[Code](https://github.com/FoRTE-Research/UnTracer-AFL) **Abstract:** Coverage-guided fuzzing is one of the most successful approaches for discovering software bugs and security vulnerabilities. Of its three main components: (1) test case generation, (2) code coverage tracing, and (3) crash triage, code coverage tracing is a dominant source of overhead. Coverage-guided fuzzers trace every test case's code coverage through either static or dynamic binary instrumentation, or more recently, using hardware support. Unfortunately, tracing all test cases incurs significant performance penalties--even when the overwhelming majority of test cases and their coverage information are discarded because they do not increase code coverage. To eliminate needless tracing by coverage-guided fuzzers, we introduce the notion of coverage-guided tracing. Coverage-guided tracing leverages two observations: (1) only a fraction of generated test cases increase coverage, and thus require tracing; and (2) coverage-increasing test cases become less frequent over time. Coverage-guided tracing encodes the current frontier of coverage in the target binary so that it self-reports when a test case produces new coverage--without tracing. This acts as a filter for tracing; restricting the expense of tracing to only coverage-increasing test cases. Thus, coverage-guided tracing trades increased time handling coverage-increasing test cases for decreased time handling non-coverage-increasing test cases. To show the potential of coverage-guided tracing, we create an implementation based on the static binary instrumentor Dyninst called UnTracer. We evaluate UnTracer using eight real-world binaries commonly used by the fuzzing community. Experiments show that after only an hour of fuzzing, UnTracer's average overhead is below 1%, and after 24-hours of fuzzing, UnTracer approaches 0% overhead, while tracing every test case with popular white- and black-box-binary tracers AFL-Clang, AFL-QEMU, and AFL-Dyninst incurs overheads of 36%, 612%, and 518%, respectively. We further integrate UnTracer with the state-of-the-art hybrid fuzzer QSYM and show that in 24-hours of fuzzing, QSYM-UnTracer executes 79% and 616% more test cases than QSYM-Clang and QSYM-QEMU, respectively. ### INSTRIM Lightweight Instrumentation for Coverage-guided Fuzzing (NDSS 2018 workshop) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS18_INSTRIM.pdf) * <img src="image/github_24px.png">[Code](https://github.com/csienslab/instrim) **Abstract:** Empowered by instrumentation, coverage-guided fuzzing monitors the program execution path taken by an input, and prioritizes inputs based on their contribution to code coverage. Although instrumenting every basic block ensures full visibility, it slows down the fuzzer and thus the speed of vulnerability discovery. This paper shows that thanks to common program structures (e.g., directed acyclic subgraphs and simple loops) and compiler optimization (e.g., knowledge of incoming edges), it is possible to accurately reconstruct coverage information by instrumenting only a small fraction of basic blocks. Specifically, we formulate the problem as a path differentiation problem on the control flow graph, and propose an efficient algorithm to select basic blocks that need to be instrumented so that different execution paths remain differentiable. We extend AFL to support such CFG-aware instrumentation. Our experiment results confirm that, compared with full instrumentation, our CFG-aware instrumentation only needs to instrument about 20% of basic blocks while offering 1.04â€?1.78x speedup during fuzzing. Finally, we highlight several technical challenges and promising research directions to further improve instrumentation for fuzzing. ### SyzGen: Automated Generation of Syscall Specification of Closed-Source macOS Drivers (CCS 2021) * <img src="image/pdf_24px.png">[Paper](./Paper/ccs21_syzgen.pdf) **Abstract:** Kernel drivers are a critical part of the attack surface since they constitute a large fraction of kernel codebase and oftentimes lack proper vetting, especially for those closed-source ones. Unfortunately, the complex input structure and unknown relationships/dependencies among interfaces make them very challenging to understand. Thus, security analysts primarily rely on manual audit for interface recovery to generate meaningful fuzzing test cases. In this paper, we present SyzGen, a first attempt to automate the generation ofbsyscall specifications for closed-source macOS drivers and facilitate interface-aware fuzzing. We leverage two insights to overcome the challenges of binary analysis: (1) iterative refinement of syscall knowledge and (2) extraction and extrapolation of ependencies from a small number of execution traces. We evaluated our approach on 25 targets. The results show that SyzGen can effectively produce high-quality specifications, leading to 34 bugs, including one that attackers can exploit to escalate privilege, and 2 CVEs to date. # IoT or protocols fuzzing ### PrIntFuzz: Fuzzing Linux Drivers via Automated Virtual Device Simulation (ISSTA 2022) * <img src="image/pdf_24px.png">[Paper](https://doi.org/10.1145/3533767.3534226) **Abstract:** Linux drivers share the same address space and privilege with the core of the kernel but have a much larger code base and attack surface. The Linux drivers are not well tested and have weaker security guarantees than the kernel. Missing support from hardware devices, existing fuzzing solutions fail to cover a large portion of the driver code, e.g., the initialization code and interrupt handlers. In this paper, we present PrIntFuzz, an efficient and universal fuzzing framework that can test the overlooked driver code, including the PRobing code and INTerrupt handlers. PrIntFuzz first extracts knowledge from the driver through inter-procedural field-sensitive, path-sensitive, and flow-sensitive static analysis. Then it utilizes the information to build a flexible and efficient simulator, which supports device probing, hardware interrupts emulation and device I/O interception. Lastly, PrIntFuzz applies a multi-dimension fuzzing strategy to explore the overlooked code. We have developed a prototype of PrIntFuzz and successfully simulated 311 virtual PCI (Peripheral Component Interconnect) devices, 472 virtual I2C (Inter-Integrated Circuit) devices, 169 virtual USB (Universal Serial Bus) devices, and found 150 bugs in the corresponding device drivers. We have submitted patches for these bugs to the Linux kernel community, and 59 patches have been merged so far. In a control experiment of Linux 5.10-rc6, PrIntFuzz found 99 bugs, while the state-of-the-art fuzzer only found 50. PrIntFuzz covers 11,968 basic blocks on the latest Linux kernel, while the state-of-the-art fuzzer Syzkaller only covers 2,353 basic blocks. ### SnapFuzz: High-Throughput Fuzzing of Network Applications (ISSTA 2022) * <img src="image/pdf_24px.png">[Paper](https://doi.org/10.1145/3533767.3534376) **Abstract:** In recent years, fuzz testing has benefited from increased computational power and important algorithmic advances, leading to systems that have discovered many critical bugs and vulnerabilities in production software. Despite these successes, not all applications can be fuzzed efficiently. In particular, stateful applications such as network protocol implementations are constrained by their low fuzzing throughput and the need to develop fuzzing harnesses that reset their state and isolate their side effects. In this paper, we present SnapFuzz, a novel fuzzing framework for network applications. SnapFuzz offers a robust architecture that transforms slow asynchronous network communication into fast synchronous communication, snapshots the target at the latest point at which it is safe to do so, speeds up all file operations by redirecting them to a custom in-memory filesystem, and removes the need for many fragile modifications, such as configuring time delays or writing clean-up scripts, together with several other improvements. Using SnapFuzz, we fuzzed five popular networking applications: LightFTP, TinyDTLS, Dnsmasq, LIVE555 and Dcmqrscp. We report impressive performance speedups of 62.8x, 41.2x, 30.6x, 24.6x, and 8.4x, respectively, with significantly simpler fuzzing harnesses in all cases. Through its performance advantage, SnapFuzz has also found 12 extra crashes compared to AFLNet in these applications. ### Efficient Greybox Fuzzing of Applications in Linux-based IoT Devices via Enhanced User-mode Emulation (ISSTA 2022) * <img src="image/youtube.png">[Video](https://youtu.be/BFXH9uTbr5M) * <img src="image/blog_24px.jpg">[Reading Note](https://hackmd.io/@Zero871015/EQUAFL) * <img src="image/pdf_24px.png">[Paper](https://doi.org/10.1145/3533767.3534414) **Abstract:** Greybox fuzzing has become one of the most effective vulnerability discovery techniques. However, greybox fuzzing techniques cannot be directly applied to applications in IoT devices. The main reason is that executing these applications highly relies on specific system environments and hardware. To execute the applications in Linux based IoT devices, most existing fuzzing techniques use full-system emulation for the purpose of maximizing compatibility. However, compared with user-mode emulation, full-system emulation suffers from great overhead. Therefore, some previous works, such as Firm-AFL, propose to combine full-system emulation and user-mode emulation to speed up the fuzzing process. Despite the attempts of trying to shift the application towards user-mode emulation, no existing technique supports to execute these applications fully in the user-mode emulation. To address this issue, we propose EQUAFL, which can automatically setup the execution environment to execute embedded application under user-mode emulation. EQUAFL first executes the application under full-system emulation and observe for the key points where the program may get stuck or even crash during user-mode emulation. With the observed information, EQUAFL can migrate the needed environment for user-mode emulation. Then, EQUAFL uses an enhanced user-mode emulation to replay system calls of network, and resource management behaviors to fulfill the needs of the embedded application during its execution. We evaluate EQUAFL on 70 network applications from different series of IoT devices. The result shows EQUAFL outperforms the state-of-the-arts in fuzzing efficiency (on average, 26 times faster than AFL-QEMU with full-system emulation, 14 times than Firm-AFL). We have also discovered ten vulnerabilities including six CVEs from the tested firmware images. ### FuzzUSB: Hybrid Stateful Fuzzing of USB Gadget Stacks (FSE 2022) * <img src="image/youtube.png">[Video](https://youtu.be/nSt-XSsOycE) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/document/9833593) **Abstract:** Universal Serial Bus (USB) is the de facto protocol supported by peripherals and mobile devices, such as USB thumb drives and smart phones. For many devices, USB Type-C ports are the primary interface for charging, file transfer, audio, video, etc. Accordingly, attackers have exploited different vulnerabilities within USB stacks, compromising host machines via BadUSB attacks or jailbreaking iPhones from USB connections. While there exist fuzzing frameworks dedicated to USB vulnerability discovery, all of them focus on USB host stacks and ignore USB gadget stacks, which enable all the features within modern peripherals and smart devices. In this paper, we propose FuzzUSB, the first fuzzing framework for the USB gadget stack within commodity OS kernels, leveraging static analysis, symbolic execution, and stateful fuzzing. FuzzUSB combines static analysis and symbolic execution to extract internal state machines from USB gadget drivers, and uses them to achieve state-guided fuzzing through multi-channel inputs. We have implemented FuzzUSB upon the syzkaller kernel fuzzer and applied it to the most recent mainline Linux, Android, and FreeBSD kernels. As a result, we have found 34 previously unknown bugs within the Linux and Android kernels, and opened 8 CVEs. Furthermore, compared to the baseline, FuzzUSB has also demonstrated different improvements, including 3× higher code coverage, 50× improved bug-finding efficiency for Linux USB gadget stacks, 2× higher code coverage for FreeBSD USB gadget stacks, and reproducing known bugs that could not be detected by the baseline fuzzers. We believe FuzzUSB provides developers a powerful tool to thwart USB-related vulnerabilities within modern devices and complete the current USB fuzzing scope. ### BrakTooth: Causing Havoc on Bluetooth Link Manager via Directed Fuzzing (USENIX SEC 2022) * <img src="image/ppt_24px.png">[Slides](https://www.usenix.org/system/files/sec22_slides-garbelini.pdf) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec22-garbelini.pdf) **Abstract:** In this paper we propose, design and evaluate a systematic directed fuzzing framework to automatically discover implementation bugs in arbitrary Bluetooth Classic (BT) devices. The core of our fuzzer is the first over-the-air approach that takes full control of the BT controller baseband from the host. This enables us to intercept and modify arbitrary packets, as well as to inject packets out-of-order in lower layers of closed-source BT stack, i.e., Link Manager Protocol (LMP) and Baseband. To systematically guide our fuzzing process, we propose an extensible and novel rule-based approach to automatically construct the protocol state machine during normal over-the-air communication. In particular, by writing a simple set of rules to identify protocol messages, we can dynamically construct an abstracted protocol state machine, fuzz packets resulting from a state and validate responses from target devices. As of today, we have fuzzed 13 BT devices from 11 vendors and we have discovered a total of 18 unknown implementation flaws, with 24 common vulnerability exposures (CVEs) assigned. Furthermore, our discoveries were awarded with six bug bounties from certain vendors. Finally, to show the broader applicability of our framework beyond BT, we have extended our approach to fuzz other wireless protocols, which additionally revealed 6 unknown bugs in certain Wi-Fi and BLE Host stacks. ### Drifuzz: Harvesting Bugs in Device Drivers from Golden Seeds (USENIX SEC 2022) * <img src="image/ppt_24px.png">[Slides](https://www.usenix.org/system/files/sec22_slides-shen_zekun.pdf) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec22-shen-zekun.pdf) **Abstract:** Peripheral hardware in modern computers is typically assumed to be secure and not malicious, and device drivers are implemented in a way that trusts inputs from hardware. However, recent vulnerabilities such as Broadpwn have demonstrated that attackers can exploit hosts through vulnerable peripherals, highlighting the importance of securing the OS-peripheral boundary. In this paper, we propose a hardware-free concolic-augmented fuzzer targeting WiFi and Ethernet drivers, and a technique for generating high-quality initial seeds, which we call golden seeds, that allow fuzzing to bypass difficult code constructs during driver initialization. Compared to prior work using symbolic execution or greybox fuzzing, Drifuzz is more successful at automatically finding inputs that allow network interfaces to be fully initialized, and improves fuzzing coverage by 214% (3.1¡Á) in WiFi drivers and 60% (1.6¡Á) for Ethernet drivers. During our experiments with fourteen PCI and USB network drivers, we find twelve previously unknown bugs, two of which were assigned CVEs. ### StateFuzz: System Call-Based State-Aware Linux Driver Fuzzing (USENIX SEC 2022) * <img src="image/ppt_24px.png">[Slides](https://www.usenix.org/system/files/sec22_slides-zhao_bodong.pdf) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec22-zhao-bodong.pdf) **Abstract:** Coverage-guided fuzzing has achieved great success in finding software vulnerabilities. Existing coverage-guided fuzzers generally favor test cases that hit new code, and discard ones that exercise the same code. However, such a strategy is not optimum. A new test case exercising the same code could be better than a previous test case, as it may trigger new program states useful for code exploration and bug discovery. In this paper, we assessed the limitation of coverage-guided fuzzing solutions and proposed a state-aware fuzzing solution StateFuzz to address this issue. First, we model program states with values of state-variables and utilize static analysis to recognize such variables. Then, we instrument target programs to track such variables' values and infer program state transition at runtime. Lastly, we utilize state information to prioritize test cases that can trigger new states, and apply a three-dimension feedback mechanism to fine-tune the evolutionary direction of coverage-guided fuzzers. We have implemented a prototype of StateFuzz, and evaluated it on Linux upstream drivers and Android drivers. Evaluation results show that StateFuzz is effective at discovering both new code and vulnerabilities. It finds 18 unknown vulnerabilities and 2 known but unpatched vulnerabilities, and reaches 19% higher code coverage and 32% higher state coverage than the state-of-the-art fuzzer Syzkaller. ### SNPSFuzzer: A Fast Greybox Fuzzer for Stateful Network Protocols using Snapshots (2022) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/abs/2201.04048) **Abstract:** Greybox fuzzing has been widely used in stateless programs and has achieved great success. However, most state-of-the-art greybox fuzzers generally have the problems of slow speed and shallow state depth coverage in the process of fuzzing stateful network protocol programs which are able to remember and store details of the interactions. The existing greybox fuzzers for network protocol programs send a series of well-defined prefix sequences of input messages first and then send mutated messages to test the target state of a stateful network protocol. The process mentioned above causes a high time cost. In this paper, we propose SNPSFuzzer, a fast greybox fuzzer for stateful network protocol using snapshots. SNPSFuzzer dumps the context information when the network protocol program is under a specific state and restores it when the state needs to be fuzzed. Furthermore, we design a message chain analysis algorithm to explore more and deeper network protocol states. Our evaluation shows that, compared with the state-of-the-art network protocol greybox fuzzer AFLNET, SNPSFuzzer increases the speed of network protocol fuzzing by 112.0%-168.9% and improves path coverage by 21.4%-27.5% within 24 hours. Moreover, SNPSFuzzer exposes a previously unreported vulnerability in program Tinydtls. ### SnapFuzz: An Efficient Fuzzing Framework for Network Applications (2022) * <img src="image/pdf_24px.png">[Paper]() **Abstract:** In recent years, fuzz testing has benefited from increased computational power and important algorithmic advances, leading to systems that have discovered many critical bugs and vulnerabilities in production software. Despite these successes, not all applications can be fuzzed efficiently. In particular, stateful applications such as network protocol implementations are constrained by their low fuzzing throughput and the need to develop fuzzing harnesses that reset their state and isolate their side effects. In this paper, we present SnapFuzz, a novel fuzzing framework for network applications. SnapFuzz offers a robust architecture that transforms slow asynchronous network communication into fast synchronous communication based on UNIX domain sockets, speeds up all file operations by redirecting them to an in-memory filesystem, and removes the need for many fragile modifications, such as configuring time delays or writing cleanup scripts, together with several other improvements. Using SnapFuzz, we fuzzed five popular networking applications: LightFTP, Dnsmasq, LIVE555, TinyDTLS and Dcmqrscp. We report impressive performance speedups of 72.4x, 49.7x, 24.8x, 23.9x, and 8.5x, respectively, with significantly simpler fuzzing harnesses in all cases. Through its performance advantage, SnapFuzz has also found 12 previously-unknown crashes in these applications. ### State Selection Algorithms and Their Impact on The Performance of Stateful Network Protocol Fuzzing (2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/abs/2112.15498) **Abstract:** The statefulness property of network protocol implementations poses a unique challenge for testing and verification techniques, including Fuzzing. Stateful fuzzers tackle this challenge by leveraging state models to partition the state space and assist the test generation process. Since not all states are equally important and fuzzing campaigns have time limits, fuzzers need effective state selection algorithms to prioritize progressive states over others. Several state selection algorithms have been proposed but they were implemented and evaluated separately on different platforms, making it hard to achieve conclusive findings. In this work, we evaluate an extensive set of state selection algorithms on the same fuzzing platform that is AFLNet, a state-of-the-art fuzzer for network servers. The algorithm set includes existing ones supported by AFLNet and our novel and principled algorithm called AFLNetLegion. The experimental results on the ProFuzzBench benchmark show that (i) the existing state selection algorithms of AFLNet achieve very similar code coverage, (ii) AFLNetLegion clearly outperforms these algorithms in selected case studies, but (iii) the overall improvement appears insignificant. These are unexpected yet interesting findings. We identify problems and share insights that could open opportunities for future research on this topic. ### ICS3Fuzzer: A Framework for Discovering Protocol Implementation Bugs in ICS Supervisory Software by Fuzzing (ACSAC 2021) * <img src="image/pdf_24px.png">[Paper](https://dl.acm.org/doi/10.1145/3485832.3488028) **Abstract:** The supervisory software is widely used in industrial control systems (ICSs) to manage field devices such as PLC controllers. Once compromised, it could be misused to control or manipulate these physical devices maliciously, endangering manufacturing process or even human lives. Therefore, extensive security testing of supervisory software is crucial for the safe operation of ICS. However, fuzzing ICS supervisory software is challenging due to the prevalent use of proprietary protocols. Without the knowledge of the program states and packet formats, it is difficult to enter the deep states for effective fuzzing. In this work, we present a fuzzing framework to automatically discover implementation bugs residing in the communication protocols between the supervisory software and the field devices. To avoid heavy human efforts in reverse-engineering the proprietary protocols, the proposed approach constructs a state-book based on the readily-available execution trace of the supervisory software and the corresponding inputs. Then, we propose a state selection algorithm to find the protocol states that are more likely to have bugs. Our fuzzer distributes more budget on those interesting states. To quickly reach the interesting states, traditional snapshot-based method does not work since the communication protocols are time sensitive. We address this issue by synchronously managing external events (GUI operations and network traffic) during the fuzzing loop. We have implemented a prototype and used it to fuzz the supervisory software of four popular ICS platforms. We have found 13 bugs and received 3 CVEs, 2 are classified as critical (CVSS3.x score CRITICAL 9.8) and affected 40 different products. ### Westworld: Fuzzing-Assisted Remote Dynamic Symbolic Execution of Smart Apps on IoT Cloud Platforms (ACSAC 2021) * <img src="image/pdf_24px.png">[Paper](https://dl.acm.org/doi/abs/10.1145/3485832.3488022) **Abstract:** Existing symbolic execution typically assumes the analyzer can control the I/O environment and/or access the library code, which, however, is not the case when programs run on a remote proprietary execution environment managed by another party. For example, SmartThings, one of the most popular IoT platforms, is such a cloud-based execution environment. For programmers who write automation applications to be deployed on IoT cloud platforms, it raises significant challenges when they want to systematically test their code and find bugs. We propose fuzzing-assisted remote dynamic symbolic execution, which uses dynamic symbolic execution as backbone and utilizes fuzzing when necessary to automatically test programs running in a remote proprietary execution environment over which the analyzer has little control. As a case study, we enable it for analyzing smart apps running on SmartThings. We have developed a prototype and the evaluation shows that it is effective in testing smart apps and finding bugs. ### ProFuzzBench - A Benchmark for Stateful Protocol Fuzzing (ISSTA 2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2101.05102.pdf) * <img src="image/github_24px.png">[Code](https://github.com/profuzzbench/profuzzbench) **Abstract:** We present a new benchmark (ProFuzzBench) for stateful fuzzing of network protocols. The benchmark includes a suite of representative open-source network servers for popular protocols, and tools to automate experimentation. We discuss challenges and potential directions for future research based on this benchmark. ### TCP-Fuzz: Detecting Memory and Semantic Bugs in TCP Stacks with Fuzzing (USENIX ATC 2021) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/atc21-zou.pdf) * <img src="image/ppt_24px.png">[Slides](https://www.usenix.org/system/files/atc21_slides_zou.pdf) **Abstract:** TCP stacks provide reliable data transmission in network, and thus they should be correctly implemented and well tested to ensure reliability and security. However, testing TCP stacks is difficult. First, a TCP stack accepts packets and system calls that have dependencies between each other, and thus generating effective test cases is challenging. Second, a TCP stack has various complex state transitions, but existing testing approaches target covering states instead of covering state transitions, and thus their testing coverage is limited. Finally, our study of TCP stack commits shows that 87% of bug-fixing commits are related to semantic bugs (such as RFC violations), but existing bug sanitizers can detect only memory bugs not semantic bugs. In this paper, we design a novel fuzzing framework named TCP-Fuzz, to effectively test TCP stacks and detect bugs. TCP-Fuzz consists of three key techniques: (1) a dependency-based strategy that considers dependencies between packets and system calls, to generate effective test cases; (2) a transition-guided fuzzing approach that uses a new coverage metric named branch transition as program feedback, to improve the coverage of state transitions; (3) a differential checker that compares the outputs of multiple TCP stacks for the same inputs, to detect semantic bugs. We have evaluated TCP-Fuzz on five widely-used TCP stacks (TLDK, F-Stack, mTCP, FreeBSD TCP and Linux TCP), and find 56 real bugs (including 8 memory bugs and 48 semantic bugs). 40 of these bugs have been confirmed by related developers. ### ICPFuzzer: proprietary communication protocol fuzzing by using machine learning and feedback strategies (Cybersecurity 2021) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9489311) **Abstract:** The fuzzing test is able to discover various vulnerabilities and has more chances to hit the zero-day targets. And ICS(Industrial control system) is currently facing huge security threats and requires security standards, like ISO 62443, to ensure the quality of the device. However, some industrial proprietary communication protocols can be customized and have complicated structures, the fuzzing system cannot quickly generate test data that adapt to various protocols. It also struggles to define the mutation field without having prior knowledge of the protocols. Therefore, we propose a fuzzing system named ICPFuzzer that uses LSTM(Long short-term memory) to learn the features of a protocol and generates mutated test data automatically. We also use the responses of testing and adjust the weight strategies to further test the device under testing (DUT) to find more data that cause unusual connection status. We verified the effectiveness of the approach by comparing with the open-source and commercial fuzzers. Furthermore, in a real case, we experimented with the DLMS/COSEM for a smart meter and found that the test data can cause a unusual response. In summary, ICPFuzzer is a black-box fuzzing system that can automatically execute the testing process and reveal vulnerabilities that interrupt and crash industrial control communication. Not only improves the quality of ICS but also improves safety. ### Fuzzing With Optimized Grammar-Aware Mutation Strategies (Access 2021) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9489311) **Abstract:** Fuzzing is a widely used technique to discover vulnerabilities in software. However, for programs requiring highly structured inputs, the byte-based mutation strategies in existing fuzzers have difficulties in generating valid inputs. To resolve this challenge, Grammar-Based Fuzzing (GBF) utilizes existing grammar specifications to generate new inputs. Some GBFs perform mutation based on Abstract Syntax Trees (ASTs), which can generate inputs conforming to grammars. However, the existing GBFs neglect using feedback to optimize mutation strategies, and blindly generate inputs without considering the effectiveness of those inputs. In this paper, we use the power schedule and the subtree pool to optimize mutation strategies. Specifically, we first translate input files into ASTs, and extract subtrees from ASTs into a subtree pool. Then, we optimize the power schedule on AST nodes based on a probabilistic model. That is, we adaptively determine the time budget for mutating an AST node. Finally, we replace AST nodes along with their subtrees using the ones we select from the subtree pool. We implement a fuzzing tool to demonstrate our strategies. The experiment results show that our method outperforms the state-of-the-art methods in fuzzing efficiency. ### FIRM-COV: High-Coverage Greybox Fuzzing for IoT Firmware via Optimized Process Emulation (Access 2021) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9489311) **Abstract:** With the growing prevalence of the Internet of Things (IoT), related security threats have kept pace. The need to dynamically detect vulnerabilities in IoT devices cannot be overstated. In this work, we present FIRM-COV, the first high coverage-oriented greybox fuzzer for IoT firmware. FIRM-COV leverages newly optimized process emulation by targeting IoT programs and mining real-world vulnerabilities. FIRM-COV focuses on solving problems of IoT fuzzing based on empirical analyses, using the required structured input, the inaccuracy and instability of emulation, and the required high code coverage. By optimizing the existing emulation technique, FIRM-COV always maintains a stable state and achieves high accuracy when detecting vulnerabilities. We also implement a dictionary generation algorithm to provide structured input values and synergy scheduling to achieve high coverage and throughput. We compare FIRM-COV with other IoT fuzzing frameworks for eight real-world IoT devices. As a result, FIRM-COV achieves the highest coverage and throughput, finding the fastest and most 1-day vulnerabilities with almost no false-positives. It also found two 0-day vulnerabilities in real-world IoT devices within 24 h. ### DIANE: Identifying Fuzzing Triggers in Apps to Generate Under-constrained Inputs for IoT Devices (S&P 2020) * <img src="image/youtube.png">[Video](https://youtu.be/mLyFoGIPFUY) * <img src="image/pdf_24px.png">[Paper](https://conand.me/publications/redini-diane-2021.pdf) * <img src="image/github_24px.png">[Code](https://github.com/ucsb-seclab/diane) **Abstract:** Internet of Things (IoT) devices have rooted themselves in the everyday life of billions of people. Thus, researchers have applied automated bug finding techniques to improve their overall security. However, due to the difficulties in extracting and emulating custom firmware, black-box fuzzing is often the only viable analysis option. Unfortunately, this solution mostly produces invalid inputs, which are quickly discarded by the targeted IoT device and do not penetrate its code. Another proposed approach is to leverage the companion app (i.e., the mobile app typically used to control an IoT device) to generate well-structured fuzzing inputs. Unfortunately, the existing solutions produce fuzzing inputs that are constrained by app-side validation code, thus significantly limiting the range of discovered vulnerabilities. In this paper, we propose a novel approach that overcomes these limitations. Our key observation is that there exist functions inside the companion app that can be used to generate optimal (i.e., valid yet under-constrained) fuzzing inputs. Such functions, which we call fuzzing triggers, are executed before any data-transforming functions (e.g., network serialization), but after the input validation code. Consequently, they generate inputs that are not constrained by app-side sanitization code, and, at the same time, are not discarded by the analyzed IoT device due to their invalid format. We design and develop Diane, a tool that combines static and dynamic analysis to find fuzzing triggers in Android companion apps, and then uses them to fuzz IoT devices automatically. We use Diane to analyze 11 popular IoT devices, and identify 11 bugs, 9 of which are zero days. Our results also show that without using fuzzing triggers, it is not possible to generate bug-triggering inputs for many devices. ### Snipuzz: Black-box Fuzzing of IoT Firmware via Message Snippet Inference (CCS 2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2105.05445.pdf) **Abstract:** The proliferation of Internet of Things (IoT) devices has made people's lives more convenient, but it has also raised many security concerns. Due to the difficulty of obtaining and emulating IoT firmware, the black-box fuzzing of IoT devices has become a viable option. However, existing black-box fuzzers cannot form effective mutation optimization mechanisms to guide their testing processes, mainly due to the lack of feedback. It is difficult or even impossible to apply existing grammar-based fuzzing strategies. Therefore, an efficient fuzzing approach with syntax inference is required in the IoT fuzzing domain. To address these critical problems, we propose a novel automatic black-box fuzzing for IoT firmware, termed Snipuzz. Snipuzz runs as a client communicating with the devices and infers message snippets for mutation based on the responses. Each snippet refers to a block of consecutive bytes that reflect the approximate code coverage in fuzzing. This mutation strategy based on message snippets considerably narrows down the search space to change the probing messages. We compared Snipuzz with four state-of-the-art IoT fuzzing approaches, i.e., IoTFuzzer, BooFuzz, Doona, and Nemesys. Snipuzz not only inherits the advantages of app-based fuzzing (e.g., IoTFuzzer, but also utilizes communication responses to perform efficient mutation. Furthermore, Snipuzz is lightweight as its execution does not rely on any prerequisite operations, such as reverse engineering of apps. We also evaluated Snipuzz on 20 popular real-world IoT devices. Our results show that Snipuzz could identify 5 zero-day vulnerabilities, and 3 of them could be exposed only by Snipuzz. All the newly discovered vulnerabilities have been confirmed by their vendors. ### Learning-Based Fuzzing of IoT Message Brokers (ICST 2021) * <img src="image/pdf_24px.png">[Paper](https://graz.pure.elsevier.com/en/publications/learning-based-fuzzing-of-iot-message-brokers) **Abstract:** The number of devices in the Internet of Things (IoT) immensely grew in recent years. A frequent challenge in the assurance of the dependability of IoT systems is that components of the system appear as a black box. This paper presents a semi-automatic testing methodology for black-box systems that combines automata learning and fuzz testing. Our testing technique uses stateful fuzzing based on a model that is automatically inferred by automata learning. Applying this technique, we can simultaneously test multiple implementations for unexpected behavior and possible security vulnerabilities.We show the effectiveness of our learning-based fuzzing technique in a case study on the MQTT protocol. MQTT is a widely used publish/subscribe protocol in the IoT. Our case study reveals several inconsistencies between five different MQTT brokers. The found inconsistencies expose possible security vulnerabilities and violations of the MQTT specification. ### RiverFuzzRL - an open-source tool to experiment with reinforcement learning for fuzzing (ICST 2021) * <img src="image/pdf_24px.png">[Paper](http://scholar.google.com.sg/scholar_url?url=https://www.researchgate.net/profile/Alin-Stefanescu/publication/350789915_RiverFuzzRL_-_an_open-source_tool_to_experiment_with_reinforcement_learning_for_fuzzing/links/607213bc299bf1c911c1f61e/RiverFuzzRL-an-open-source-tool-to-experiment-with-reinforcement-learning-for-fuzzing.pdf&hl=en&sa=X&d=8691306607121847918&ei=vKd-YN6rHJD_mAGorriYDA&scisig=AAGBfm1x8hqCl6MSOMq2nNmzMdKU89-8aQ&nossl=1&oi=scholaralrt&hist=5D-EiWoAAAAJ:11619674075933241424:AAGBfm2WuunMRs1akVK27Fttx6PhkTPyfg&html=&folt=rel&fols=) **Abstract:** Combining fuzzing techniques and reinforcement learning could be an important direction in software testing. However, there is a gap in support for experimentation in this field, as there are no open-source tools to let academia and industry to perform experiments easily. The purpose of this paper is to fill this gap by introducing a new framework, named RiverFuzzRL, on top of our already mature framework for AI-guided fuzzing, River. We provide out-of-the-box implementations for users to choose from or customize for their test target. The work presented here is performed on testing binaries and does not require access to the source code, but it can be easily adapted to other types of software testing as well. We also discuss the challenges faced, opportunities, and factors that are important for performance, as seen in the evaluation. ### Vulnerability Detection in SIoT Applications: A Fuzzing Method on their Binaries (IEEE Transactions on Network Science and Engineering 2020) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=9259242) **Abstract:** SIoT enables devices to communicate with each other automatically, which is not reliable when applications in SIoT are vulnerable. To improve the security of SIoT, different techniques have been employed so far, mainly to detect vulnerabilities in SIoT applications. Among the detection techniques, fuzzing is one of the most effective ones that can significantly improve the security of SIoT applications. However, the existing fuzzing methods have three problems. First of all, the schemes to instrument target binaries cause high memory overhead because they instrument at all edges to obtain the coverage information. Moreover, they introduce a severe problem called edge collision, i.e., two different edges are deemed the same during fuzzing. Thirdly, none of the existing fuzzers conduct fuzzing using path coverage because path coverage has high memory overhead. In this paper, we propose BECFuzz to resolve the above three problems. BECFuzz instruments at specific edges, and conducts fuzzing based on both edge coverage and path coverage, which greatly improves its effectiveness. We implement our BECFuzz based on two typical fuzzers which are widely recognised as baselines, AFL and AFLFast, and run experiments on 18 real-world programs. The results demonstrate that our method suppresses the state-of-art fuzzers in performance. ### Analysis of DTLS Implementations Using Protocol State Fuzzing (USENIX Security2020) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec20fall_fiterau-brostean_prepub.pdf) **Abstract:** Recent years have witnessed an increasing number of protocols relying on UDP. Compared to TCP, UDP offers performance advantages such as simplicity and lower latency. This has motivated its adoption in Voice over IP, tunneling technologies, IoT, and novel Web protocols. To protect sensitive data exchange in these scenarios, the DTLS protocol has been developed as a cryptographic variation of TLS. DTLS’s main challenge is to support the stateless and unreliable transport of UDP. This has forced protocol designers to make choices that affect the complexity of DTLS, and to incorporate features that need not be addressed in the numerous TLS analyses. We present the first comprehensive analysis of DTLS implementations using protocol state fuzzing. To that end, we extend TLS-Attacker, an open source framework for analyzing TLS implementations, with support for DTLS tailored to the stateless and unreliable nature of the underlying UDP layer. We build a framework for applying protocol state fuzzing on DTLS servers, and use it to learn state machine models for thirteen DTLS implementations. Analysis of the learned state models reveals four serious security vulnerabilities, including a full client authentication bypass in the latest JSSE version, as well as several functional bugs and non-conformance issues. It also uncovers considerable differences between the models, confirming the complexity of DTLS state machines. ### Frankenstein: Advanced Wireless Fuzzing to Exploit New Bluetooth Escalation Targets (USENIX Security2020) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2006.09809.pdf) **Abstract:** Wireless communication standards and implementations have a troubled history regarding security. Since most implementations and firmwares are closed-source, fuzzing remains one of the main methods to uncover Remote Code Execution (RCE) vulnerabilities in deployed systems. Generic over-the-air fuzzing suffers from several shortcomings, such as constrained speed, limited repeatability, and restricted ability to debug. In this paper, we present Frankenstein, a fuzzing framework based on advanced firmware emulation, which addresses these shortcomings. Frankenstein brings firmware dumps "back to life", and provides fuzzed input to the chip's virtual modem. The speed-up of our new fuzzing method is sufficient to maintain interoperability with the attached operating system, hence triggering realistic full-stack behavior. We demonstrate the potential of Frankenstein by finding three zero-click vulnerabilities in the Broadcom and Cypress Bluetooth stack, which is used in most Apple devices, many Samsung smartphones, the Raspberry Pis, and many others. Given RCE on a Bluetooth chip, attackers may escalate their privileges beyond the chip's boundary. We uncover a Wi-Fi/Bluetooth coexistence issue that crashes multiple operating system kernels and a design flaw in the Bluetooth 5.2 specification that allows link key extraction from the host. Turning off Bluetooth will not fully disable the chip, making it hard to defend against RCE attacks. Moreover, when testing our chip-based vulnerabilities on those devices, we find BlueFrag, a chip-independent Android RCE. ### A deep convolution generative adversarial networks based fuzzing framework for industry control protocols * <img src="image/pdf_24px.png">[Paper](https://link.springer.com/content/pdf/10.1007/s10845-020-01584-z.pdf) **Abstract:** A growing awareness is brought that the safety and security of industrial control systems cannot be dealt with in isolation, and the safety and security of industrial control protocols (ICPs) should be considered jointly. Fuzz testing (fuzzing) for the ICP is a common way to discover whether the ICP itself is designed and implemented with flaws and network security vulnerability. Traditional fuzzing methods promote the safety and security testing of ICPs, and many of them have practical applications. However, most traditional fuzzing methods rely heavily on the specification of ICPs, which makes the test process a costly, time-consuming, troublesome and boring task. And the task is hard to repeat if the specification does not exist. In this study, we propose a smart and automated protocol fuzzing methodology based on improved deep convolution generative adversarial network and give a series of performance metrics. An automated and intelligent fuzzing framework BLSTM-DCNNFuzz for application is designed. Several typical ICPs, including Modbus and EtherCAT, are applied to test the effectiveness and efficiency of our framework. Experiment results show that our methodology outperforms the existing ones like General Purpose Fuzzer and other deep learning based fuzzing methods in convenience, effectiveness, and efficiency. ### ICS Protocol Fuzzing: Coverage Guided Packet Crack and Generation (DAC 2020) * <img src="image/pdf_24px.png">[Paper](./Paper/DAC20_ICSProtocol.pdf) **Abstract:** Industrial Control System (ICS) protocols play an essential role in building communications among system components. Recently, many severe vulnerabilities, such as Stuxnet and DragonFly, exposed in ICS protocols have affected a wide distribution of devices. Therefore, it is of vital importance to ensure their correctness. However, the vulnerability detection efficiency of traditional techniques such as fuzzing is challenged by the complexity and diversity of the protocols. In this paper, we propose to equip the traditional protocol fuzzing with coverage-guided packet crack and generation. We collect the coverage information during testing procedure, save those valuable packets that trigger new path coverage and crack them into pieces, based on which, we can construct higher quality new packets for further testing. For evaluation, we build Peach* on top of Peach, which is one of the most widely used protocol fuzzers, and conduct experiments on several ICS protocols such as Modbus and DNP3. Results show that, compared with the original Peach, Peach* achieves the same code coverage and bug detection numbers at the speed of 1.2X-25X. It also gains final increase with 8.35%-36.84% more paths within 24 hours, and has exposed 9 previously unknown vulnerabilities. ### AFLNET: A Greybox Fuzzer for Network Protocols (ICST 2020) * <img src="image/pdf_24px.png">[Paper](./Paper/ICST20_AFLNet.pdf) * <img src="image/github_24px.png">[Code](https://github.com/aflnet/aflnet) **Abstract:** Server fuzzing is difficult. Unlike simple command-line tools, servers feature a massive state space that can be traversed effectively only with well-defined sequences of input messages. Valid sequences are specified in a protocol. In this paper, we present AFLNET, the first grey-box fuzzer for protocol implementations. Unlike existing protocol fuzzers, AFLNET takes a mutational approach and uses state-feedback to guide the fuzzing process. AFLNET is seeded with a corpus of recorded message exchanges between the server and an actual client. No protocol specification or message grammars are required. AFLNET acts as a client and replays variations of the original sequence of messages sent to the server and retains those variations that were effective at increasing the coverage of the code or state space. To identify the server states that are exercised by a message sequence, AFLNET uses the server’s response codes. From this feedback, AFLNET identifies progressive regions in the state space, and systematically steers towards such regions. The case studies with AFLNET on two popular protocol implementations demonstrate a substantial performance boost over the state-of-the-art. AFLNET discovered two new CVEs that are classified as critical (CVSS score CRITICAL 9.8). ### Finding Security Vulnerabilities in Network Protocol Implementations (Arxiv 2020) * <img src="image/pdf_24px.png">[Paper](./Paper/Arxiv20_Protocols.pdf) **Abstract:** Implementations of network protocols are often prone to vulnerabilities caused by developersâ€? mistakes when accessing memory regions and dealing with arithmetic operations. Finding practical approaches for checking the security of network protocol implementations has proven to be a challenging problem. The main reason is that the protocol software state-space is too large to be explored. Here we propose a novel verification approach that combines fuzzing with symbolic execution to verify intricate properties in network protocol implementations. We use fuzzing for an initial exploration of the network protocol, while symbolic execution explores both the program paths and protocol states, which were uncovered by fuzzing. From this combination, we automatically generate high-coverage test input packets for a network protocol implementation.We surveyed various approaches based on fuzzing and symbolic execution to understand how these techniques can be effectively combined and then choose a suitable tool to develop further our model on top of it. In our preliminary evaluation, we used ESBMC, Map2Check, and KLEE as software verifiers and SPIKE as fuzzer to check their suitability to verify our network protocol implementations. Our experimental results show that ESBMC can be further developed within our verification framework called FuSeBMC, to efficiently and effectively detect intricate security vulnerabilities in network protocol implementations. ### Smart seed selection-based effective black box fuzzing for IIoT protocol (2020) * <img src="image/pdf_24px.png">[Paper](./Paper/20_SmartSeedSelection.pdf) **Abstract:** Connections of cyber-physical system (CPS) components are gradually increasing owing to the introduction of the Industrial Internet of Things (IIoT). IIoT vulnerability analysis has become a major issue because complex skillful cyber-attacks on CPS systems exploit their zero-day vulnerabilities. However, current white box techniques for vulnerability analysis are difficult to use in real heterogeneous environments, where devices supplied by various manufacturers and diverse firmware versions are used. Therefore, we herein propose a novel protocol fuzzing test technique that can be applied in a heterogeneous environment. As seed configuration can significantly influence the test result in a black box test, we update the seed pool using test cases that travel different program paths compared to the seed. The input, output, and Delta times are used to determine if a new program area has been searched in the black box environment. We experimentally verified the effectiveness of the proposed. ### Fw‐fuzz: A code coverage‐guided fuzzing framework for network protocols on firmware (2020) * <img src="image/pdf_24px.png">[Paper](https://onlinelibrary.wiley.com/doi/abs/10.1002/cpe.5756) **Abstract:** Fuzzing is an effective approach to detect software vulnerabilities utilizing changeable generated inputs. However, fuzzing the network protocol on the firmware of IoT devices is limited by inefficiency of test case generation, cross‐architecture instrumentation, and fault detection. In this article, we propose the Fw‐fuzz, a coverage‐guided and crossplatform framework for fuzzing network services running in the context of firmware on embedded architectures, which can generate more valuable test cases by introspecting program runtime information and using a genetic algorithm model. Specifically, we propose novel dynamic instrumentation in Fw‐fuzz to collect the running state of the firmware program. Then Fw‐fuzz adopts a genetic algorithm model to guide the generation of inputs with high code coverage. We fully implement the prototype system of Fw‐fuzz and conduct evaluations on network service programs of various architectures in MIPS, ARM, and PPC. By comparing with the protocol fuzzers Boofuzz and Peach in metrics of edge coverage, our prototype system achieves an average growth of 33.7% and 38.4%, respectively. We further verify six known vulnerabilities and discover 5 0‐day vulnerabilities with the Fw‐fuzz, which prove the validity and utility of our framework. The overhead of our system expressed as an additional 5% of memory growth. ### BaseSAFE: Baseband SAnitized Fuzzing through Emulation (WiSec 2020) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2005.07797.pdf) * <img src="image/github_24px.png">[Code](https://github.com/fgsect/BaseSAFE) **Abstract:** Rogue base stations are an effective attack vector. Cellular basebands represent a critical part of the smartphone’s security: they parse large amounts of data even before authentication. They can, therefore, grant an attacker a very stealthy way to gather information about calls placed and even to escalate to the main operating system, over-the-air. In this paper, we discuss a novel cellular fuzzing framework that aims to help security researchers find critical bugs in cellular basebands and similar embedded systems. BaseSAFE allows partial rehosting of cellular basebands for fast instrumented fuzzing off-device, even for closed-source firmware blobs. BaseSAFE’s sanitizing drop-in allocator, enables spotting heap-based buffer-overflows quickly. Using our proof-of-concept harness, we fuzzed various parsers of the Nucleus RTOS-based MediaTek cellular baseband that are accessible from rogue base stations. The emulator instrumentation is highly optimized, reaching hundreds of executions per second on each core for our complex test case, around 15k test-cases per second in total. Furthermore, we discuss attack vectors for baseband modems. To the best of our knowledge, this is the first use of emulation-based fuzzing for security testing of commercial cellular basebands. Most of the tooling and approaches of BaseSAFE are also applicable for other low-level kernels and firmware. Using BaseSAFE, we were able to find memory corruptions including heap out-of-bounds writes using our proof-of-concept fuzzing harness in the MediaTek cellular baseband. BaseSAFE, the harness, and a large collection of LTE signaling message test cases will be released open-source upon publication of this paper. ### Poster: Fuzzing IoT Firmware via Multi-stage Message Generation (CCS 2019) * <img src="image/pdf_24px.png">[Paper](https://wpengfei.github.io/iothunter-final.pdf) **Abstract:** In this work, we present IoTHunter, the first grey-box fuzzer for fuzzing stateful protocols in IoT firmware. IoTHunter addresses the state scheduling problem based on a multi-stage message generation mechanism on runtime monitoring of IoT firmware. We evaluate IoTHunter with a set of real-world programs, and the result shows that IoTHunter outperforms black-box fuzzer boofuzz, which has a 2.2x, 2.0x, and 2.5x increase for function coverage, block coverage, and edge coverage, respectively. IoTHunter also found five new vulnerabilities in the firmware of home router Mikrotik, which have been reported to the vendor. ### SeqFuzzer: An Industrial Protocol Fuzzing Framework in Deep Learning Perspective (ICST 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/ICST19_SeqFuzzer.pdf) **Abstract:** Industrial networks are the cornerstone of modern industrial control systems. Performing security checks of industrial communication processes help detect unknown risks and vulnerabilities. Fuzz testing is a widely used method for performing security checks that takes advantage of automation. However, there is a big challenge to carry out security checks on the industrial networks due to the increasing variety and complexity of industrial communication protocols. In this case, existing approaches usually take a long time to model the protocol for generating test cases, which is labor-intensive and timeconsuming. This becomes even worse when the target protocol is stateful. To help in addressing this problem, we employed a deep learning model to learn the structures of protocol frames and deal with the temporal features of stateful protocols. We propose a fuzzing framework named SeqFuzzer which automatically learns the protocol frame structures from communication traffic and generates fake but plausible messages as test cases. For proving the usability of our approach, we applied SeqFuzzer to widelyused Ethernet for Control Automation Technology (EtherCAT) devices and successfully detected several security vulnerabilities ### SPFuzz: A Hierarchical Scheduling Framework for Stateful Network Protocol Fuzzing (IEEE Access 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/.pdf) **Abstract:** In recent years, the fuzzing technology is widely used to detect the software vulnerabilities owing to the coverage improvement in the target program and the easiness of use. However, it is less efficient to fuzz the stateful protocols due to the difficulties like maintaining states and dependencies of messages. To address these challenges, we present SPFuzz, a framework for building flexible, coverage guided stateful protocol fuzzing. We define a language in SPFuzz to describe the protocol specifications, protocol states transitions and dependencies for generating valuable test cases, maintaining correct messages in session states and handling protocol dependencies by updating message data in time. The SPFuzz adopts a three-level mutation strategy, namely head, content, and sequence mutation strategy to drive the fuzzing process to cover more paths, in conjunction with the method to randomly assign weights to messages and strategies. We use the following metrics to evaluate the performance of SPFuzz and other frameworks upon three protocol implementations, i.e., Proftpd, Oftpd, and OpenSSL, which are three-granularity coverages specifically function, basic block, and edge. In experiments, the SPFuzz framework outperforms the existing stateful protocol fuzzing tool Boofuzz by an average of 69.12% in three granularities coverage tests. This demonstrates that the SPFuzz has the ability to explore more and deeper paths of the target program. We further triggered CVE-2015-0291 in OpenSSL 1.0.2 with the SPFuzz, which proves the validity and utility of our framework. ### HFuzz: Towards automatic fuzzing testing of NB-IoT core network protocols implementations (FGCS 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/FGCS19_HFuzz.pdf) **Abstract:** Narrowband Internet of Things (NB-loT) is widely deployed in the cellular network of operators, yet implementations of its core network protocols are suffering from bugs. Due to the complexity of the frame structure of NB-IoT core network protocols, testing the protocols in this field is notoriously difficult. In this paper, we propose a novel fuzzing framework, named HFuzz, to generate a great many high-quality test inputs automatically. HFuzz is an automatic hierarchy-aware fuzzing framework and can allocate computing resources efficiently. We put forward the concept of Message Structure Tree to transform the seed file and generate mutated data of the tested protocols and optimize the resource allocation for each hierarchy of the transformed structure by a novel scheduling algorithm. Therefore HFuzz can get a balance between breadth and depth in finding new paths. Compared to traditional fuzzing tools, HFuzz can easily pass the early verification and induce a better coverage of the target implementations by taking full advantage of format information of NB-IoT core network protocols. Our framework applies to various protocols, and we evaluate the performance of HFuzz on GPRS Tunnelling Protocol version 2(GTPv2) in this paper and conduct experiments with two protocol implementations, Open Air Interface (OAI) and B*(a development system). The experimental results show HFuzz yields higher coverage than American Fuzzy Lop (AFL) and Peach, and we further find a real implementation bug in OAI. ### FIRM-AFL: High-Throughput Greybox Fuzzing of IoT Firmware via Augmented Process Emulation (USENIX Security2019) * <img src="image/youtube.png">[Video](https://youtu.be/0ychOUFoDbM) * <img src="image/csdn_24px.png">[Reading Note](https://blog.csdn.net/weixin_39945679/article/details/111370554) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX19_FirmAFL.pdf) * <img src="image/github_24px.png">[Code](https://github.com/zyw-200/FirmAFL) **Abstract:** Cyber attacks against IoT devices are a severe threat. These attacks exploit software vulnerabilities in IoT firmware. Fuzzing is an effective software testing technique for vulnerability discovery. In this work, we present FIRM-AFL, the first high-throughput grey box fuzzer for IoT firmware. FIRMAFL addresses two fundamental problems in IoT fuzzing. First, it addresses compatibility issues by enabling fuzzing for POSIX-compatible firmware that can be emulated in a system emulator. Second, it addresses the performance bottleneck caused by system-mode emulation with a novel technique called augmented process emulation. By combining system mode emulation and user-mode emulation in a novel way, augmented process emulation provides high compatibility as system-mode emulation and high throughput as user-mode emulation. Our evaluation results show that (1) FIRM-AFL is fully functional and capable of finding real-world vulnerabilities in IoT programs; (2) the throughput of FIRM-AFL is on average 8.2 times higher than system-mode emulation based fuzzing; and (3) FIRM-AFL is able to find 1-day vulnerabilities much faster than system-mode emulation based fuzzing, and is able to find 0-day vulnerabilities. ### Exploring Effective Fuzzing Strategies to Analyze Communication Protocols (FEAST 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/FEAST19_Exploring.pdf) **Abstract:** In recent years, coverage-based greybox fuzzing has become popular forvulnerability detection due to its simplicity and efficiency. However, it is less powerful when applied directly to protocol fuzzing due to the unique challenges involved in fuzzing communication protocols. In particular, the communication among multiple ends contains more than one packet, which are not necessarily dependent upon each other, i.e., fuzzing single (usually the first) packet can only achieve extremely limited code coverage. In this paper, we study such challenges and demonstrate the limitation of current non-stateful greybox fuzzer. In order to achieve higher code coverage, we design stateful protocol fuzzing strategies for communication protocols to explore the code related to different protocol states. Our approach contains a state switching engine, together with a multi-state forkserver to consistently and flexibly fuzz different states of an compiler-instrumented protocol program. Our experimental results on OpenSSL show that our approach achieves an improvement of 73% more code coverage and 2× unique crashes when comparing against fuzzing the first packet during a protocol handshake. ### Leveraging Textual Specifications for Grammar-Based Fuzzing of Network Protocols (AAAI 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/AAAi19_Leveraging.pdf) **Abstract:** Grammar-based fuzzing is a technique used to find software vulnerabilities by injecting well-formed inputs generated following rules that encode application semantics. Most grammar-based fuzzers for network protocols rely on human experts to manually specify these rules. In this work we study automated learning of protocol rules from textual specifications (i.e. RFCs). We evaluate the automatically extracted protocol rules by applying them to a state-of-the-art fuzzer for transport protocols and show that it leads to a smaller number of test cases while finding the same attacks as the system that uses manually specified rules. ### MTF-Storm: a high performance fuzzer for Modbus-TCP (ETFA 2018) * <img src="image/pdf_24px.png">[Paper](https://doi.org/10.1109/ETFA.2018.8502600) * <img src="image/github_24px.png">[Code](https://github.com/ntinosk-mtf/etfa2018) **Abstract:** MTF-Storm is a highly effective fuzzer for industrial systems employing Modbus/TCP connectivity. It achieves high fault coverage, while offering high performance and quick testing of the System-Under-Test (SUT). Analogously to its predecessor MTF, MTF-Storm operates in 3 phases: a) reconnaissance b) fuzz testing and failure detection. Reconnaissance identifies the memory organization of the SUT and the supported functionality, enabling selection and synthesis of fuzz testing sequences that are effective for the specific SUT. MTF-Storm develops its test sequences systematically, starting with single field tests and proceeding with combined field tests, adopting techniques for automated combinatorial software testing and reducing the test space through partitioning field value ranges. MTF-Storm has been used to evaluate 9 different Modbus/TCP implementations and has identified issues with all of them, ranging from out-of-spec responses to successful denial-of-service attacks and crashes. ### Advancing Protocol Fuzzing for Industrial Automation and Control Systems (ICISSP 2018) * <img src="image/pdf_24px.png">[Paper](./Paper/ICISSP18_Advancing.pdf) **Abstract:** Testing for security vulnerabilities is playing an important role in the changing domain of industrial automation and control systems. These systems are increasingly connected to each other via networking technology and are faced with new cyber threats. To improve the security properties of such systems, their robustness must be ensured. Security testing frameworks aim at enabling the assurance of robustness even at the time of development and can play a key role in bringing security into the industrial domain. Fuzzing describes a technique to discover vulnerabilities in technical systems and is best known from its usage in IT security testing. It uses randomly altered data to provoke unexpected behaviour and can be used in combination with regular unit testing. Combined with the power of fuzzing, the effectiveness of security testing frameworks can be increased. In this work, different fuzzing tools were evaluated for their properties and then compared with the requirements for an application in the industrial domain. As no fuzzer was fully satisfying these requirements, a new fuzzer, combining the strength of different others, was designed and implemented, and then evaluated. The evaluation includes a real-world application where multiple vulnerabilities in industrial automation components could be identified. ### IoTFuzzer: Discovering Memory Corruptions in IoT Through App-based Fuzzing (NDSS 2018) * <img src="image/GoSSIP_note.jpg">[Reading Note](https://securitygossip.com/blog/2018/06/15/iotfuzzer-discovering-memory-corruptions-in-iot-through-app-based-fuzzing/) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS18_IoTfuzzer.pdf) * <img src="image/ppt_24px.png">[Slides](./Paper/NDSS18_IoTFuzzer_Slides.pdf) **Abstract:** With more IoT devices entering the consumer market, it becomes imperative to detect their security vulnerabilities before an attacker does. Existing binary analysis based approaches only work on firmware, which is less accessible except for those equipped with special tools for extracting the code from the device. To address this challenge in IoT security analysis, we present in this paper a novel automatic fuzzing framework, called IOTFUZZER, which aims at finding memory corruption vulnerabilities in IoT devices without access to their firmware images. The key idea is based upon the observation that most IoT devices are controlled through their official mobile apps, and such an app often contains rich information about the protocol it uses to communicate with its device. Therefore, by identifying and reusing program-specific logic (e.g., encryption) to mutate the test case (particularly message fields), we are able to effectively probe IoT targets without relying on any knowledge about its protocol specifications. In our research, we implemented IOTFUZZER and evaluated 17 real-world IoT devices running on different protocols, and our approach successfully identified 15 memory corruption vulnerabilities (including 8 previously unknown ones). ### Bbuzz: A Bit-aware Fuzzing Framework for Network Protocol Systematic Reverse Engineering and Analysis (MCC 2017) * <img src="image/pdf_24px.png">[Paper](./Paper/MCC17-Binfuzz.pdf) **Abstract:** Fuzzing is a critical part of secure software development life-cycle, for finding vulnerabilities, developing exploits, and reverse engineering. This relies on appropriate approaches, tools and frameworks. File and protocol fuzzing is well covered, multiple approaches and implementations exist. Unfortunately, assessed tools do not posses the required capabilities for working with protocols, where constructing bit groups are not byte aligned. In this paper, a systematic approach is proposed and tool prototype developed for the cyber red teaming purposes. In a case study, the developed Bbuzz tool is used to reverse engineer a proprietary NATO Link-1 network protocol allowing to inject rogue airplane tracks into air operations command and control system. ### Test Data Generation for Stateful Network Protocol Fuzzing Using a Rule-Based State Machine (2016) * <img src="image/pdf_24px.png">[Paper](./Paper/2016_Protocol.pdf) **Abstract:** To improve the efficiency and coverage of stateful network protocol fuzzing, this paper proposes a new method, using a rule-based state machine and a stateful rule tree to guide the generation of fuzz testing data. The method first builds a rule-based state machine model as a formal description of the states of a network protocol. This removes safety paths, to cut down the scale of the state space. Then it uses a stateful rule tree to describe the relationship between states and messages, and then remove useless items from it. According to the message sequence obtained by the analysis of paths using the stateful rule tree and the protocol specification, an abstract data model of test case generation is defined. The fuzz testing data is produced by various generation algorithms through filling data in the fields of the data model. Using the rule-based state machine and the stateful rule tree, the quantity of test data can be reduced. Experimental results indicate that our method can discover the same vulnerabilities as traditional approaches, using less test data, while optimizing test data generation and improving test efficiency. ### Protocol State Fuzzing of TLS Implementations (USENIX Security2015) * <img src="image/youdao_note_24px.png">[Reading Note](http://note.youdao.com/noteshare?id=eb0ec80133498dd0b2e073a5174c5f0d&sub=F972E69029854C398925A5F8D5E91484) * <img src="image/pdf_24px.png">[Slides](./Paper/USENIX15_Protocol_Slides.pdf) * <img src="image/ppt_24px.png">[Paper](./Paper/USENIX15_Protocol.pdf) **Abstract:** We describe a largely automated and systematic analysis of TLS implementations by what we call ‘protocol state fuzzingâ€?: we use state machine learning to infer state machines from protocol implementations, using only blackbox testing, and then inspect the inferred state machines to look for spurious behaviour which might be an indication of flaws in the program logic. For detecting the presence of spurious behaviour the approach is almost fully automatic: we automatically obtain state machines and any spurious behaviour is then trivial to see. Detecting whether the spurious behaviour introduces exploitable security weaknesses does require manual investigation. Still, we take the point of view that any spurious functionality in a security protocol implementation is dangerous and should be removed. We analysed both server- and client-side implementations with a test harness that supports several key exchange algorithms and the option of client certificate authentication. We show that this approach can catch an interesting class of implementation flaws that is apparently common in security protocol implementations: in three of the TLS implementations analysed new security flaws were found (in GnuTLS, the Java Secure Socket Extension, and OpenSSL). This shows that protocol state fuzzing is a useful technique to systematically analyse security protocol implementations. As our analysis of different TLS implementations resulted in different and unique state machines for each one, the technique can also be used for fingerprinting TLS implementations. ### A Modbus-TCP Fuzzer for testing internetworked industrial systems (ETFA 2015) * <img src="image/pdf_24px.png">[Paper](https://doi.org/10.1109/ETFA.2015.7301400) * <img src="image/github_24px.png">[Code](https://github.com/artemiosv/etfa2015) **Abstract:** Modbus/TCP is a network protocol for industrial communications encapsulated in TCP/IP network packets. There is an increasing need to test existing Modbus protocol implementations for security vulnerabilities, as devices become accessible even from the Internet. Fuzz testing can be used to discover implementation bugs in a fast and economical way. We present the design and implementation of MTF, a Modbus/TCP Fuzzer. The MTF incorporates a reconnaissance phase in the testing procedure so as to assist mapping the capabilities of the tested device and to adjust the attack vectors towards a more guided and informed testing rather than plain random testing. The MTF was used to test eight implementations of the Modbus protocol and revealed bugs and vulnerabilities that crash the execution, effectively resulting in denial of service attacks using only a few network packets. ### PULSAR: Stateful Black-Box Fuzzing of Proprietary Network Protocols (Springer, Cham, 2015) * <img src="image/pdf_24px.png">[Paper](./Paper/Springer15_PULSAR.pdf) **Abstract:** The security of network services and their protocols critically depends on minimizing their attack surface. A single flaw in an implementation can suffice to compromise a service and expose sensitive data to an attacker. The discovery of vulnerabilities in protocol implementations, however, is a challenging task: While for standard protocols this process can be conducted with regular techniques for auditing, the situation becomes difficult for proprietary protocols if neither the program code nor the specification of the protocol are easily accessible. As a result, vulnerabilities in closed-source implementations can often remain undiscovered for a longer period of time. In this paper, we present PULSAR, a method for stateful black-box fuzzing of proprietary network protocols. Our method combines concepts from fuzz testing with techniques for automatic protocol reverse engineering and simulation. It proceeds by observing the traffic of a proprietary protocol and inferring a generative model for message formats and protocol states that can not only analyze but also simulate communication. During fuzzing this simulation can effectively explore the protocol state space and thereby enables uncovering vulnerabilities deep inside the protocol implementation. We demonstrate the efficacy of PULSAR in two case studies, where it identifies known as well as unknown vulnerabilities. ### SECFUZZ: Fuzz-testing Security Protocols (AST 2012) * <img src="image/pdf_24px.png">[Paper](./Paper/AST12_SECFUZZ.pdf) **Abstract:** We propose a light-weight, yet effective, technique for fuzz-testing security protocols. Our technique is modular, it exercises (stateful) protocol implementations in depth, and handles encrypted traffic. We use a concrete implementation of the protocol to generate valid inputs, and mutate the inputs using a set of fuzz operators. A dynamic memory analysis tool monitors the execution as an oracle to detect he vulnerabilities exposed by fuzz-testing. We provide the fuzzer with the necessary keys and cryptographic algorithms in order to properly mutate encrypted messages. We present a case study on two widely used, mature implementations of the Internet Key Exchange (IKE) protocol and report on two new vulnerabilities discovered by our fuzz-testing tool. We also compare the effectiveness of our technique to two existing model-based fuzz-testing tools for IKE. ### Extension of SPIKE for Encrypted Protocol Fuzzing (2011) * <img src="image/pdf_24px.png">[Paper](./Paper/IEEE2011_protocol.pdf) **Abstract:** A fuzzer is a program that attempts to find security vulnerabilities in an application by sending random or semi-random input. Fuzzers have been widely used to find vulnerabilities in protocol implementations. The implementations may conform to the design of the protocol, but most of the times some glitches might remain. As a result vulnerabilities might remain unnoticed. Consequently, different implementations of the same protocol may be vulnerable to different kind of attacks. Fuzzers help us discover such implementation flaws. Among the currently available and popular ones, SPIKE is one recognized open-source fuzzing framework. However, SPIKE has a limitation of fuzzing only non-encrypted protocols. This paper presents the extension of SPIKE, called ESPIKE, for fuzzing of encrypted protocols. ESPIKE will facilitate testing implementations of SSL encrypted protocols. As a proof of concept for efficiency of ESPIKE we demonstrate its usage on sftp and https protocol. ### AutoFuzz: Automated Network Protocol Fuzzing Framework (IJCSNS 2010) * <img src="image/pdf_24px.png">[Paper](./Paper/IJCSNS10_Autofuzz.pdf) **Abstract:** Assessing software security involves steps such as code review, risk analysis, penetration testing and fuzzing. During the fuzzing phase, the tester‟s goal is to find flaws in software by sending unexpected input to the target application and monitoring its behavior. In this paper we introduce the AutoFuzz [1] - extendable, open source framework used for testing network protocol implementations. AutoFuzz is a „smartâ€?, man-in-the-middle, semi deterministic network protocol fuzzing framework. AutoFuzz learns a protocol implementation by constructing a Finite State Automaton (FSA) which captures the observed communications between a client and a server [5]. In addition, AutoFuzz learns individual message syntax, including fields and probable types, by applying the bioinformatics techniques of [2]. Finally, AutoFuzz can fuzz client or server protocol implementations by intelligently modifying the communication sessions between them using the FSA as a guide. AutoFuzz was applied to a variety of File Transfer Protocol (FTP) server implementations, confirming old and discovering new vulnerabilities. # SMT Fuzzing ### Alt-Ergo-Fuzz: A fuzzer for the Alt-Ergo SMT solver (JFLA 2022) * <img src="image/pdf_24px.png">[Paper](https://hal.inria.fr/hal-03626861/) * <img src="image/github_24px.png">[Code](https://github.com/hra687261/alt-ergo-fuzz) Alt-Ergo is an open source Satisfiability Modulo Theories (SMT) solver programmed in OCaml. It was designed for program verification and it’s used as a back end by other software verification tools such as Frama-C, SPARK, Why3, Atelier-B and Caveat, the reliability of which depends on the soundness of Alt-Ergo’s answers and the absence of bugs in it. Fuzzing is an efficient technique to test programs and find bugs. It works by quickly and automatically generating input data with which to test the software. American Fuzzy Lop (AFL) is one of the most well-known and most used fuzzers in both academia and the industry. It has managed to find many bugs in various programs thanks to its grey box fuzzing technique that uses genetic algorithms and program instrumentation to generate test data that maximizes code and execution path coverage in the targeted software. In this paper we present Alt-Ergo-Fuzz, a fuzzer for Alt-Ergo that we developed with the aim of finding faults and unsoundness bugs to solve and improve its reliability. By using AFL as a back end, the Crowbar OCaml library for test case generation and the CVC5 SMT solver as a reference solver of which the answers will be used to determine whether or not Alt-Ergo’s answers are correct, we managed to develop Alt-Ergo-Fuzz, which even as a work in progress and in only twenty days of testing managed to find four never found before bugs in Alt-Ergo. ### BanditFuzz: Fuzzing SMT Solvers with Multi-agent Reinforcement Learning (FM 2021) * <img src="image/pdf_24px.png">[Paper](https://link.springer.com/chapter/10.1007/978-3-030-90870-6_6) **Abstract:** We present BanditFuzz, a multi-agent reinforcement learning (RL) guided performance fuzzer for state-of-the-art Satisfiability Modulo Theories (SMT) solvers. BanditFuzz constructs inputs that expose performance issues in a set of target solvers relative to a set of reference solvers, and is the first performance fuzzer that supports the entirety of the theories in the SMT-LIB initiative. Another useful feature of BanditFuzz is that users can specify the size of inputs they want, thus enabling developers to construct very small inputs that zero-in on a performance problem in their SMT solver relative to other competitive solvers. We evaluate BanditFuzz across 52 logics from SMT-COMP â€?20 targeting competition-winning solvers against runner-ups. We baseline BanditFuzz against random fuzzing and a single agent algorithm and observe a significant improvement, with up to a 82.6% improvement in the margin of PAR-2 scores across baselines on their respective benchmarks. Furthermore, we reached out to developers and contributors of the CVC4, Z3, and Bitwuzla solvers and provide case studies of how BanditFuzz was able to expose surprising performance deficiencies in each of these tools. ### Skeletal Approximation Enumeration for SMT Solver Testing (FSE 2021) * <img src="image/pdf_24px.png">[Paper](https://dl.acm.org/doi/abs/10.1145/3468264.3468540) **Abstract:** Ensuring the equality of SMT solvers is critical due to its broad spectrum of applications in academia and industry, such as symbolic execution and program verification. Existing approaches to testing SMT solvers are either too costly or find difficulties generalizing to different solvers and theories, due to the test oracle problem. To complement existing approaches and overcome their weaknesses, this paper introduces skeletal approximation enumeration (SAE), a novel lightweight and general testing technique for all first-order theories. To demonstrate its practical utility, we have applied the SAE technique to test Z3 and CVC4, two comprehensively tested, state-of-the-art SMT solvers. By the time of writing, our approach had found 71 confirmed bugs in Z3 and CVC4,55 of which had already been fixed. ### Fuzzing SMT Solvers via Two-Dimensional Input Space Exploration (ISSTA 2021) * <img src="image/pdf_24px.png">[Paper](https://dl.acm.org/doi/10.1145/3460319.3464803) **Abstract:** Satisfiability Modulo Theories (SMT) solvers serve as the core engine of many techniques, such as symbolic execution. Therefore, ensuring the robustness and correctness of SMT solvers is critical. While fuzzing is an efficient and effective method for validating the quality of SMT solvers, we observe that prior fuzzing work only focused on generating various first-order formulas as the inputs but neglected the algorithmic configuration space of an SMT solver, which leads to under-reporting many deeply-hidden bugs. In this paper, we present Falcon, a fuzzing technique that explores both the formula space and the configuration space. Combining the two spaces significantly enlarges the search space and makes it challenging to detect bugs efficiently. We solve this problem by utilizing the correlations between the two spaces to reduce the search space, and introducing an adaptive mutation strategy to boost the search efficiency. During six months of extensive testing, Falcon finds 518 confirmed bugs in CVC4 and Z3, two state-of-the-art SMT solvers, 469 of which have already been fixed. Compared to two state-of-the-art fuzzers, Falcon detects 38 and 44 more bugs and improves the coverage by a large margin in 24 hours of testing. ### Detecting Critical Bugs in SMT Solvers Using Blackbox Mutational Fuzzing (FSE 2020) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2004.05934.pdf) **Abstract:** Formal methods use SMT solvers extensively for deciding formula satisfiability, for instance, in software verification, systematic test generation, and program synthesis. However, due to their complex implementations, solvers may contain critical bugs that lead to unsound results. Given the wide applicability of solvers in software reliability, relying on such unsound results may have detrimental consequences. In this paper, we present STORM, a novel blackbox mutational fuzzing technique for detecting critical bugs in SMT solvers. We run our fuzzer on seven mature solvers and find 29 previously unknown critical bugs. STORM is already being used in testing new features of popular solvers before deployment. ### On the Unusual Effectiveness of Type-aware Mutations for Testing SMT Solvers * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2004.08799.pdf) **Abstract:** We propose type-aware operator mutation, a simple, but unusually effective approach for testing SMT solvers. The key idea is to mutate operators of conforming types within the seed formulas to generate well-typed mutant formulas. These mutant formulas are then used as the test cases for SMT solvers. We realized typeaware operator mutation within the OpFuzz tool and used it to stress-test Z3 and CVC4, two state-of-the-art SMT solvers. Type-aware operator mutations are unusually effective: During nine months of extensive testing with OpFuzz, we reported 909 bugs in Z3 and CVC4,1 out of which 632 bugs were confirmed and 531 of the confirmed bugs were fixed by the developers. The detected bugs are highly diverse â€? we found bugs of many different types (soundness bugs, invalid model bugs, crashes, etc.), logics and solver configurations. We have further conducted an in-depth study on the bugs found by OpFuzz. The study results show that the bugs found by OpFuzz are of high quality. Many of them affect core components of the SMT solversâ€? codebases, and some required major changes for the developers to fix. Among the 909 bugs found by OpFuzz, 130 were soundness bugs, the most critical bugs in SMT solvers, and 501 were in the default modes of the solvers. Notably, OpFuzz found 16 critical soundness bugs in CVC4, which has proved to be a very stable SMT solver ### BanditFuzz: Fuzzing SMT Solvers with Reinforcement Learning (2020) * <img src="image/pdf_24px.png">[Paper](https://uwspace.uwaterloo.ca/handle/10012/15753) Satisfiability Modulo Theories (SMT) solvers are fundamental tools in the broad context of software engineering and security research. If SMT solvers are to continue to have an impact, it is imperative we develop efficient and systematic testing methods for them. To this end, we present a reinforcement learning driven fuzzing system BanditFuzz that zeroes in on the grammatical constructs of well-formed solver inputs that are the root cause of performance or correctness issues in solvers-under-test. To the best of our knowledge, BanditFuzz is the first machine-learning based fuzzer for SMT solvers. BanditFuzz takes as input a grammar G describing the well-formed inputs to a set of distinct solvers (say, P_1 and P_2) that implement the same specification and a fuzzing objective (e.g., maximize the relative performance difference between P_1 and P_2), and outputs a ranked list of grammatical constructs that are likely to maximize performance differences between P_1 and P_2 or are root causes of errors in these solvers. Typically, mutation fuzzing is implemented as a set of random mutations applied to a given input. By contrast, the key innovation behind BanditFuzz is the modeling of a grammar-preserving fuzzing mutator as a reinforcement learning (RL) agent that, via blackbox interactions with programs-under-test, learns which grammatical constructs are most likely the cause of an error or performance issue. Using BanditFuzz, we discovered 1700 syntactically unique inputs resulting in inconsistent answers across state-of-the-art SMT solvers Z3, CVC4, Colibri, MathSAT, and Z3str3 over the floating-point and string SMT theories. Further, using BanditFuzz, we constructed two benchmark suites (with 400 floating-point and 110 string instances) that expose performance issues in all considered solvers. We also performed a comparison of BanditFuzz against random, mutation, and evolutionary fuzzing methods. We observed up to a 31% improvement in performance fuzzing and up to 81% improvement in the number of bugs found by BanditFuzz relative to these other methods for the same amount of time provided to all methods. ### Validating SMT Solvers via Semantic Fusion (PLDI 2020) * <img src="image/youtube.png">[Video](https://youtu.be/hEWpbO5yXPw) * <img src="image/pdf_24px.png">[Paper](https://wintered.github.io/papers/winterer-zhang-su-pldi20.pdf) * <img src="image/pdf_24px.png">[Slides](https://testsmt.github.io/slides/pldi20-semantic-fusion.pdf) * <img src="image/github_24px.png">[Code](https://github.com/testsmt/yinyang) **Abstract:** We introduce Semantic Fusion, a general, effective methodology for validating Satisfiability Modulo Theory (SMT) solvers. Our key idea is to fuse two existing equisatisfiable (i.e., both satisfiable or unsatisfiable) formulas into a new formula that combines the structures of its ancestors in a novel manner and preserves the satisfiability by construction. This fused formula is then used for validating SMT solvers. We realized Semantic Fusion as YinYang, a practical SMT solver testing tool. During four months of extensive testing, YinYang has found 45 confirmed, unique bugs in the default arithmetic and string solvers of Z3 and CVC4, the two state-of-the-art SMT solvers. Among these, 41 have already been fixed by the developers. The majority (29/45) of these bugs expose critical soundness issues. Our bug reports and testing effort have been well-appreciated by SMT solver developers. ### Automatically Testing String Solvers (ICSE 2020) * <img src="image/pdf_24px.png">[Paper](https://www.research-collection.ethz.ch/bitstream/handle/20.500.11850/397450/paper.pdf?sequence=1&isAllowed=y) **Abstract:** SMT solvers are at the basis of many applications, such as program verification, program synthesis, and test case generation. For all these applications to provide reliable results, SMT solvers must answer queries correctly. However, since they are complex, highly-optimized software systems, ensuring their correctness is challenging. In particular, state-of-the-art testing techniques do not reliably detect when an SMT solver is unsound. In this paper, we present an automatic approach for generating test cases that reveal soundness errors in the implementations of string solvers, as well as potential completeness and performance issues. We synthesize input formulas that are satisfiable or unsatisfiable by construction and use this ground truth as test oracle. We automatically apply satisfiability-preserving transformations to generate increasingly-complex formulas, which allows us to detect many errors with simple inputs and, thus, facilitates debugging. The experimental evaluation shows that our technique effectively reveals bugs in the implementation of widely-used SMT solvers and applies also to other types of solvers, such as automata-based solvers. We focus on strings here, but our approach carries over to other theories and their combinations. ### StringFuzz: A fuzzer for string solvers (CAV 2018) * <img src="image/pdf_24px.png">[Paper](https://uwspace.uwaterloo.ca/bitstream/handle/10012/13564/Blotsky_Dmitry.pdf?sequence=6&isAllowed=y) **Abstract:** In this paper, we introduce StringFuzz: a modular SMT-LIB problem instance transformer and generator for string solvers. We supply a repository of instances generated by StringFuzz in SMT-LIB 2.0/2.5 format. We systematically compare Z3str3, CVC4, Z3str2, and Norn on groups of such instances, and identify those that are particularly challenging for some solvers. We briefly explain our observations and show how StringFuzz helped discover causes of performance degradations in Z3str3. # Anti Fuzzing ### Antifuzz: impeding fuzzing audits of binary executables (USENIX Security2019) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX19_Antifuzz.pdf) * <img src="image/github_24px.png">[Code](https://github.com/RUB-SysSec/antifuzz) **Abstract:** A general defense strategy in computer security is to increase the cost of successful attacks in both computational resources as well as human time. In the area of binary security, this is commonly done by using obfuscation methods to hinder reverse engineering and the search for software vulnerabilities. However, recent trends in automated bug finding changed the modus operandi. Nowadays it is very common for bugs to be found by various fuzzing tools. Due to ever-increasing amounts of automation and research on better fuzzing strategies, large-scale, dragnet-style fuzzing of many hundreds of targets becomes viable. As we show, current obfuscation techniques are aimed at increasing the cost of human understanding and do little to slow down fuzzing. In this paper, we introduce several techniques to protect a binary executable against an analysis with automated bug finding approaches that are based on fuzzing, symbolic/concolic execution, and taint-assisted fuzzing (commonly known as hybrid fuzzing). More specifically, we perform a systematic analysis of the fundamental assumptions of bug finding tools and develop general countermeasures for each assumption. Note that these techniques are not designed to target specific implementations of fuzzing tools, but address general assumptions that bug finding tools necessarily depend on. Our evaluation demonstrates that these techniques effectively impede fuzzing audits, while introducing a negligible performance overhead. Just as obfuscation techniques increase the amount of human labor needed to find a vulnerability, our techniques render automated fuzzing-based approaches futile. ### FUZZIFICATION: Anti-Fuzzing Technique (USENIX Security2019) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2019/11/08/fuzzification-anti-fuzzing-techniques/) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX19_FUZZIFICATION.pdf) * <img src="image/github_24px.png">[Code](https://github.com/sslab-gatech/fuzzification) **Abstract:** Fuzzing is a software testing technique that quickly and automatically explores the input space of a program without knowing its internals. Therefore, developers commonly use fuzzing as part of test integration throughout the software development process. Unfortunately, it also means that such a blackbox and the automatic natures of fuzzing are appealing to adversaries who are looking for zero-day vulnerabilities. To solve this problem, we propose a new mitigation approach, called Fuzzification , that helps developers protect the released, binary-only software from attackers who are capable of applying state-of-the-art fuzzing techniques. Given a performance budget, this approach aims to hinder the fuzzing process from adversaries as much as possible. We propose three Fuzzification techniques: 1) SpeedBump, which amplifies the slowdown in normal executions by hundreds of times to the fuzzed execution, 2) BranchTrap, interfering with feedback logic by hiding paths and polluting coverage maps, and 3) AntiHybrid, hindering taint-analysis and symbolic execution. Each technique is designed with best-effort, defensive measures that attempt to hinder adversaries from bypassing Fuzzification. Our evaluation on popular fuzzers and real-world applications shows that Fuzzification effectively reduces the number of discovered paths by 70.3% and decreases the number of identified crashes by 93.0% from real-world binaries, and decreases the number of detected bugs by 67.5% from LAVA-M dataset while under user-specified overheads for common workloads. We discuss the robustness of Fuzzification techniques against adversarial analysis techniques. We open-source our Fuzzification system to foster future research. # Kernel Fuzzing ### Demystifying the Dependency Challenge in Kernel Fuzzing (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/89/Demystifying-the-Dependency-Challenge-in-Kernel-Fuzzing) **Abstract:** Fuzz testing operating system kernels remains a daunting task to date. One known challenge is that much of the kernel code is locked under specific kernel states and current kernel fuzzers are not effective in exploring such an enormous state space. We refer to this problem as the dependency challenge. Though there are some efforts trying to address the dependency challenge, the prevalence and categorization of dependencies have never been studied. Most prior work simply attempted to recover dependencies opportunistically whenever they are relatively easy to recognize. In this paper, we undertake a substantial measurement study to systematically understand the real challenge behind dependencies. To our surprise, we show that even for well-fuzzed kernel modules, unresolved dependencies still account for 59% - 88% of the uncovered branches. Furthermore, we show that the dependency challenge is only a symptom rather than the root cause of failing to achieve more coverage. By distilling and summarizing our findings, we believe the research provides valuable guidance to future research in kernel fuzzing. Finally, we propose a number of novel research directions directly based on the insights gained from the measurement study. ### Semantic-Informed Driver Fuzzing Without Both the Hardware Devices and the Emulators (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://www-users.cse.umn.edu/~kjlu/papers/drfuzz.pdf) **Abstract:** Device drivers are security-critical. In monolithic kernels like Linux, there are hundreds of thousands of drivers which run in the same privilege as the core kernel. Consequently, a bug in a driver can compromise the whole system. More critically, drivers are particularly buggy. First, drivers receive complex and untrusted inputs from not only the user space but also the hardware. Second, the driver code can be developed by less-experienced third parties, and is less tested because running a driver requires the corresponding hardware device or the emulator. Therefore, existing studies show that drivers tend to have a higher bug density and have become a major security threat. Existing testing techniques have to focus the fuzzing on a limited number of drivers that have the corresponding devices or the emulators, thus cannot scale. In this paper, we propose a device-free driver fuzzing system, DR. FUZZ, that does not require hardware devices to fuzztest drivers. The core of DR. FUZZ is a semantic-informed mechanism that efficiently generates inputs to properly construct relevant data structures to pass the “validation chainâ€? in driving initialization, which enables subsequent device-free driver fuzzing. The elimination of the needs for the hardware devices and the emulators removes the bottleneck in driver testing. The semanticinformed mechanism incorporates multiple new techniques to make device-free driver fuzzing practical: inferring valid input values for passing the validation chain in initialization, inferring the temporal usage order of input bytes to minimize mutation space, and employing error states as a feedback to direct the fuzzing going through the validation chain. Moreover, the semantic-informed mechanism is generic; we can also instruct it to generate semi-malformed inputs for a higher code coverage. We evaluate DR. FUZZ on 214 Linux drivers. With an only 24-hour time budget, DR. FUZZ can successfully initialize and enable most of the drivers without the corresponding devices, whereas existing fuzzers like syzkaller cannot succeed in any case. DR. FUZZ also significantly outperforms existing driver fuzzers that are even equipped with the device or emulator in other aspects: it increases the code coverage by 70% and the throughput by 18%. With DR. FUZZ, we also find 46 new bugs in these Linux drivers. ### SyzScope: Revealing High-Risk Security Impacts of Fuzzer-Exposed Bugs in Linux kernel (USENIX SEC'22) * <img src="image/youtube.png">[Video](https://youtu.be/MJbqeo5qtQ0) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec22summer_zou.pdf) **Abstract:** Fuzzing has become one of the most effective bug finding approach for software. In recent years, 24*7 continuous fuzzing platforms have emerged to test critical pieces of software, e.g., Linux kernel. Though capable of discovering many bugs and providing reproducers (e.g., proof-of-concepts), a major problem is that they neglect a critical function that should have been built-in, i.e., evaluation of a bug’s security impact. It is well-known that the lack of understanding of security impact can lead to delayed bug fixes as well as patch propagation. In this paper, we develop SyzScope, a system that can automatically uncover new “high-riskâ€? impacts given a bug with seemingly “low-riskâ€? impacts. From analyzing over a thousand low-risk bugs on syzbot, SyzScope successfully determined that 183 low-risk bugs (more than 15%) in fact contain high-risk impacts, e.g., control flow hijack and arbitrary memory write, some of which still do not have patches available yet. ### HEALER: Relation Learning Guided Kernel Fuzzing (SOSP 2021) * <img src="image/youtube.png">[Video](https://www.youtube.com/watch?v=2jZkBxNrIGg) * <img src="image/pdf_24px.png">[Paper](http://www.wingtecher.com/themes/WingTecherResearch/assets/papers/healer-sosp21.pdf) **Abstract:** Modern operating system kernels are too complex to be free of bugs. Fuzzing is a promising approach for vulnerability detection and has been applied to kernel testing. However, existing work does not consider the influence relations between system calls when generating and mutating inputs, resulting in difficulties when trying to reach into the kernel’s deeper logic effectively. In this paper, we propose HEALER, a kernel fuzzer that improves fuzzing’s effectiveness by utilizing system call relation learning. HEALER learns the influence relations between system calls by dynamically analyzing minimized test cases. Then, HEALER utilizes the learned relations to guide input generation and mutation, which improves the quality of test cases and the effectiveness of fuzzing. We implemented HEALER and evaluated its performance on recent versions of the Linux kernel. Compared to state-of-the-art kernel fuzzers such as Syzkaller and Moonshine, HEALER improves branch coverage by 28% and 21%, while achieving a speedup of 2.2× and 1.8×, respectively. In addition, HEALER detected 218 vulnerabilities, 33 of which are previously unknown and have been confirmed by the corresponding kernel maintainers. ### NTFUZZ: Enabling Type-Aware Kernel Fuzzing on Windows with Static Binary Analysis(S&P 2021) * <img src="image/youtube.png">[Video](https://youtu.be/3zYzuRJlIdw) * <img src="image/blog_24px.jpg">[Reading Note](https://ycdxsb.cn/84f38a6d.html) * <img src="image/pdf_24px.png">[Paper](https://softsec.kaist.ac.kr/~jschoi/data/oakland2021.pdf) **Abstract:** Although it is common practice for kernel fuzzers to leverage type information of system calls, current Windows kernel fuzzers do not follow the practice as most system calls are private and largely undocumented. In this paper, we present a practical static binary analyzer that automatically infers system call types on Windows at scale. We incorporate our analyzer to NTFUZZ, a type-aware Windows kernel fuzzing framework. To our knowledge, this is the first practical fuzzing system that utilizes scalable binary analysis on a COTS OS. With NTFUZZ, we found 11 previously unknown kernel bugs, and earned $25,000 through the bug bounty program offered by Microsoft. All these results confirm the practicality of our system as a kernel fuzzer. ### Finding Bugs in File Systems with an Extensible Fuzzing Framework (TOS 2020) * <img src="image/pdf_24px.png">[Paper](./Paper/TOS20_FileSys.pdf) **Abstract:** File systems are too large to be bug free. Although handwritten test suites have been widely used to stress file systems, they can hardly keep up with the rapid increase in file system size and complexity, leading to new bugs being introduced. These bugs come in various flavors: buffer overflows to complicated semantic bugs. Although bug-specific checkers exist, they generally lack a way to explore file system states thoroughly. More importantly, no turnkey solution exists that unifies the checking effort of various aspects of a file system under one umbrella. In this article, to highlight the potential of applying fuzzing to find any type of file system bugs in a generic way, we propose Hydra, an extensible fuzzing framework. Hydra provides building blocks for file system fuzzing, including input mutators, feedback engines, test executors, and bug post-processors. As a result, developers only need to focus on building the core logic for finding bugs of their interests. We showcase the effectiveness of Hydra with four checkers that hunt crash inconsistency, POSIX violations, logic assertion failures, and memory errors. So far, Hydra has discovered 157 new bugs in Linux file systems, including three in verified file systems (FSCQ and Yxv6). ### Finding race conditions in Kernels: from fuzzing to symbolic exection (2020) * <img src="image/pdf_24px.png">[Paper](https://smartech.gatech.edu/bitstream/handle/1853/63668/XU-DISSERTATION-2020.pdf) **Abstract:** The scale and pervasiveness of concurrent software pose challenges for security researchers: race conditions are more prevalent than ever, and the growing software complexity keeps exacerbating the situation â€? expanding the arms race between security practitioners and attackers beyond memory errors. As a consequence, we need a new generation of bug hunting tools that not only scale well with increasingly larger codebases but also catch up with the growing importance of race conditions. In this thesis, two complementary race detection frameworks for OS kernels are presented: multi-dimensional fuzz testing and symbolic checking. Fuzz testing turns bug finding into a probabilistic search, but current practices restrict themselves to one dimension only (sequential executions). This thesis illustrates how to explore the concurrency dimension and extend the bug scope beyond memory errors to the broad spectrum of concurrency bugs. On the other hand, conventional symbolic executors face challenges when applied to OS kernels, such as path explosions due to branching and loops. They also lack a systematic way of modeling and tracking constraints in the concurrency dimension (e.g., to enforce a particular schedule for thread interleavings) The gap can be partially filled with novel techniques for symbolic execution in this thesis. ### Hydra: An Extensible Fuzzing Framework for Finding Semantic Bugs in File Systems (SOSP 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/SOSP19_Hydra.pdf) * <img src="image/github_24px.png">[Code](https://github.com/sslab-gatech/hydra) * <img src="image/ppt_24px.png">[Slides](https://squizz617.github.io/slides/hydra-sosp19-slides.pdf) **Abstract:** File systems are too large to be bug free. Although handwritten test suites have been widely used to stress file systems, they can hardly keep up with the rapid increase in file system size and complexity, leading to new bugs being introduced and reported regularly. These bugs come in various flavors: simple buffer overflows to sophisticated semantic bugs. Although bug-specific checkers exist, they generally lack a way to explore file system states thoroughly. More importantly, no turnkey solution exists that unifies the checking effort of various aspects of a file system under one umbrella. In this paper, we highlight the potential of applying fuzzing to find not just memory errors but, in theory, any type of file system bugs with an extensible fuzzing framework: Hydra. Hydra provides building blocks for file system fuzzing, including input mutators, feedback engines, a libOS-based executor, and a bug reproducer with test case minimization. As a result, developers only need to focus on building the core logic for finding bugs of their own interests. We showcase the effectiveness of Hydra with four checkers that hunt crash inconsistency, POSIX violations, logic assertion failures, and memory errors. So far, Hydra has discovered 91 new bugs in Linux file systems, including one in a verified file system (FSCQ), as well as four POSIX violations. ### Fuzzing File Systems via Two-Dimensional Input Space Exploration (S&P 2019) * <img src="image/zhihu.png">[Reading Note](https://zhuanlan.zhihu.com/p/113426778) * <img src="image/wechat_24px.png">[Reading Note From BAIZE](https://mp.weixin.qq.com/s/d2VEQTLtHV5Z-li6M3KBFA) * <img src="image/pdf_24px.png">[Paper](./Paper/SP19_Fuzzing_File.pdf) * <img src="image/ppt_24px.png">[Slides](https://taesoo.kim/pubs/2019/xu:janus-slides.pdf) **Abstract:** File systems, a basic building block of an OS, are too big and too complex to be bug free. Nevertheless, file systems rely on regular stress-testing tools and formal checkers to find bugs, which are limited due to the ever-increasing complexity of both file systems and OSes. Thus, fuzzing, proven to be an effective and a practical approach, becomes a preferable choice, as it does not need much knowledge about a target. However, three main challenges exist in fuzzing file systems: mutating a large image blob that degrades overall performance, generating image-dependent file operations, and reproducing found bugs, which is difficult for existing OS fuzzers. Hence, we present JANUS, the first feedback-driven fuzzer that explores the two-dimensional input space of a file system, i.e., mutating metadata on a large image, while emitting image-directed file operations. In addition, JANUS relies on a library OS rather than on traditional VMs for fuzzing, which enables JANUS to load a fresh copy of the OS, thereby leading to better reproducibility of bugs. We evaluate JANUS on eight file systems and found 90 bugs in the upstream Linux kernel, 62 of which have been acknowledged. Forty-three bugs have been fixed with 32 CVEs assigned. In addition, JANUS achieves higher code coverage on all the file systems after fuzzing 12 hours, when compared with the state-of-the-art fuzzer Syzkaller for fuzzing file systems. JANUS visits 4.19x and 2.01x more code paths in Btrfs and ext4, respectively. Moreover, JANUS is able to reproduce 88-100% of the crashes, while Syzkaller fails on all of them. ### Unicorefuzz: On the Viability of Emulation for Kernelspace Fuzzing (USENIX WOOT'19) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/woot19-paper_maier.pdf) * <img src="image/ppt_24px.png">[Slides](https://www.usenix.org/sites/default/files/conference/protected-files/woot19_slides_maier.pdf) * <img src="image/github_24px.png">[Code](https://github.com/fgsect/unicorefuzz) **Abstract:** Fuzzing uncovers an ever-growing number of critical vulnerabilities. Despite the simple concept—execute the target until it crashes—setting up fuzz tests can pose complex challenges. This is especially true for code that cannot run as part of a userland process on desktop operating systems—for example device drivers and kernel components. In this paper, we explore the use of CPU emulation to fuzz arbitrary parsers in kernelspace with coverage-based feedback. We propose and open-source Unicorefuzz and explain merits and pitfalls of emulation-based fuzzing approaches. The viability of the approach is evaluated against artificial Linux kernel modules, the Open vSwitch network virtualization component as well as bugs originally uncovered by syzcaller. Emulator-based fuzzing of kernel code is not very complex to set up and can even be used to fuzz operating systems and devices for which no source code is available. ### Razzer: Finding Kernel Race Bugs through Fuzzing (S&P 2019) * <img src="image/wechat_24px.png">[Reading Note From BAIZE](https://mp.weixin.qq.com/s/nq1A12Dra2vUiQWbtLXctg) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2019/03/06/razzer-finding-kernel-race-bugs-through-fuzzing/) * <img src="image/blog_24px.jpg">[Reading Note](https://www.jianshu.com/p/43ced9660257) * <img src="image/pdf_24px.png">[Paper](./Paper/SP19_Razzer.pdf) * <img src="image/because.png">[Reading Note](https://github.com/bsauce/Some-Papers-About-Fuzzing/blob/master/xmind_picture/Razzer%EF%BC%9AFinding%20Kernel%20Race%20Bugs%20through%20Fuzzing-SP-2019.png) * <img src="image/ppt_24px.png">[Slides](https://lifeasageek.github.io/papers/jeong-razzer-slides.pdf) * <img src="image/github_24px.png">[Code](https://github.com/compsec-snu/razzer) **Abstract:** A data race in a kernel is an important class of bugs, critically impacting the reliability and security of the associated system. As a result of a race, the kernel may become unresponsive. Even worse, an attacker may launch a privilege escalation attack to acquire root privileges. In this paper, we propose Razzer, a tool to find race bugs in kernels. The core of Razzer is in guiding fuzz testing towards potential data race spots in the kernel. Razzer employs two techniques to find races efficiently: a static analysis and a deterministic thread interleaving technique. Using a static analysis, Razzer identifies over-approximated potential data race spots, guiding the fuzzer to search for data races in the kernel more efficiently. Using the deterministic thread interleaving technique implemented at the hypervisor, Razzer tames the non-deterministic behavior of the kernel such that it can deterministically trigger a race. We implemented a prototype of Razzer and ran the latest Linux kernel (from v4.16-rc3 to v4.18-rc3) using Razzer. As a result, Razzer discovered 30 new races in the kernel, with 16 subsequently confirmed and accordingly patched by kernel developers after they were reported. ### MoonShine: Optimizing OS Fuzzer Seed Selection with Trace Distillation (USENIX Security2018) * <img src="image/wechat_24px.png">[Reading Note](https://mp.weixin.qq.com/s/L2XgaQB7BZzcptvOrhMvXg) * <img src="image/blog_24px.jpg">[Reading Note](https://www.jianshu.com/p/7e90ad222acf) * <img src="image/because.png">[Reading Note](https://github.com/bsauce/Some-Papers-About-Fuzzing/blob/master/xmind_picture/MoonShine%EF%BC%9AOptimizing%20OS%20Fuzzer%20Seed%20Selection%20with%20Trace%20Distillation-USENUX2018.png) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX18_MoonShine.pdf) **Abstract:** OS fuzzers primarily test the system call interface between the OS kernel and user-level applications for security vulnerabilities. The effectiveness of evolutionary OS fuzzers depends heavily on the quality and diversity of their seed system call sequences. However, generating good seeds for OS fuzzing is a hard problem as the behavior of each system call depends heavily on the OS kernel state created by the previously executed system calls. Therefore, popular evolutionary OS fuzzers often rely on hand-coded rules for generating valid seed sequences of system calls that can bootstrap the fuzzing process. Unfortunately, this approach severely restricts the diversity of the seed system call sequences and therefore limits the effectiveness of the fuzzers. In this paper, we develop MoonShine, a novel strategy for distilling seeds for OS fuzzers from system call traces of real-world programs while still maintaining the dependencies across the system calls. MoonShine leverages light-weight static analysis for efficiently detecting dependencies across different system calls. We designed and implemented MoonShine as an extension to Syzkaller, a state-of-the-art evolutionary fuzzer for the Linux kernel. Starting from traces containing 2.8 million system calls gathered from 3,220 real-world programs, MoonShine distilled down to just over 14,000 calls while preserving 86% of the original code coverage. Using these distilled seed system call sequences, MoonShine was able to improve Syzkaller's achieved code coverage for the Linux kernel by 13% on average. MoonShine also found 14 new vulnerabilities in the Linux kernel that were not found by Syzkaller. ### FUZE: Towards Facilitating Exploit Generation for Kernel Use-After-Free Vulnerabilities (USENIX Security2018) * <img src="image/because.png">[Reading Note](https://www.jianshu.com/p/cfe7c9f7e852?utm_campaign=hugo) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/conference/usenixsecurity18/sec18-wu_0.pdf) * <img src="image/ppt_24px.png">[Slides](https://www.usenix.org/sites/default/files/conference/protected-files/security18_slides_wu.pdf) * <img src="image/github_24px.png">[Code](https://github.com/ww9210/Linux_kernel_exploits) **Abstract:** Software vendors usually prioritize their bug remediation based on ease of their exploitation. However, accurately determining exploitability typically takes tremendous hours and requires significant manual efforts. To address this issue, automated exploit generation techniques can be adopted. In practice, they however exhibit an insufficient ability to evaluate exploitability particularly for the kernel Use-After-Free (UAF) vulnerabilities. This is mainly because of the complexity of UAF exploitation as well as the scalability of an OS kernel. In this paper, we therefore propose FUZE, a new framework to facilitate the process of kernel UAF exploitation. The design principle behind this technique is that we expect the ease of crafting an exploit could augment a security analyst with the ability to expedite exploitability evaluation. Technically, FUZE utilizes kernel fuzzing along with symbolic execution to identify, analyze and evaluate the system calls valuable and useful for kernel UAF exploitation. To demonstrate the utility of FUZE, we implement FUZE on a 64-bit Linux system by extending a binary analysis framework and a kernel fuzzer. Using 15 real-world kernel UAF vulnerabilities on Linux systems, we then demonstrate FUZE could not only escalate kernel UAF exploitability and but also diversify working exploits. In addition, we show that FUZE could facilitate security mitigation bypassing, making exploitability evaluation less labor-intensive and more efficient. ### kAFL: Hardware-Assisted Feedback Fuzzing for OS Kernels (Usenix Security2017) * <img src="image/wechat_24px.png">[Reading Note From BAIZE](https://mp.weixin.qq.com/s/46J-kU37SerZd2H3L2GiTw) * <img src="image/blog_24px.jpg">[Reading Note](https://www.anquanke.com/post/id/188783#h3-12) * <img src="image/because.png">[Reading Note](https://github.com/bsauce/Some-Papers-About-Fuzzing/blob/master/xmind_picture/kAFL-%20Hardware-Assisted%20Feedback%20Fuzzing%20for%20OS%20Kernels-USENIX-2017.png) * <img src="image/youdao_note_24px.png">[Reading Note](https://github.com/ckxckx/aos_course/blob/f146e1f2091c0e8c4916da4b935423903aa4831f/review_kafl.md) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX18_Kafl.pdf) * <img src="image/ppt_24px.png">[Slides](./Paper/USENIX18_Kafl_Slides.pdf) * <img src="image/github_24px.png">[Code](https://github.com/RUB-SysSec/kAFL) **Abstract:** Many kinds of memory safety vulnerabilities have been endangering software systems for decades. Amongst other approaches, fuzzing is a promising technique to unveil various software faults. Recently, feedback-guided fuzzing demonstrated its power, producing a steady stream of security-critical software bugs. Most fuzzing efforts—especially feedback fuzzing—are limited to user space components of an operating system (OS), although bugs in kernel components are more severe, because they allow an attacker to gain access to a system with full privileges. Unfortunately, kernel components are difficult to fuzz as feedback mechanisms (i.e., guided code coverage) cannot be easily applied. Additionally, non-determinism due to interrupts, kernel threads, statefulness, and similar mechanisms poses problems. Furthermore, if a process fuzzes its own kernel, a kernel crash highly impacts the performance of the fuzzer as the OS needs to reboot. In this paper, we approach the problem of coverage-guided kernel fuzzing in an OS-independent and hardware-assisted way: We utilize a hypervisor and Intel’s Processor Trace (PT) technology. This allows us to remain independent of the target OS as we just require a small user space component that interacts with the targeted OS. As a result, our approach introduces almost no performance overhead, even in cases where the OS crashes, and performs up to 17,000 executions per second on an off-the-shelf laptop. We developed a framework called kernel-AFL (kAFL) to assess the security of Linux, macOS, and Windows kernel components. Among many crashes, we uncovered several flaws in the ext4 driver for Linux, the HFS and APFS file system of macOS, and the NTFS driver of Windows. ### DIFUZE: Interface aware fuzzing for kernel drivers (CCS 2017) * <img src="image/wechat_24px.png">[Reading Note From BAIZE](https://mp.weixin.qq.com/s/5-2PDBlRSW_kTJb1SW1spQ) * <img src="image/blog_24px.jpg">[Reading Note](https://www.anquanke.com/post/id/188783#h3-11) * <img src="image/because.png">[Reading Note](https://github.com/bsauce/Some-Papers-About-Fuzzing/blob/master/xmind_picture/DIFUZE-%20Interface%20Aware%20Fuzzing%20for%20Kernel%20Drivers-CCS-2017.png) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS17_DIFUZE.pdf) * <img src="image/github_24px.png">[Code](https://github.com/ucsb-seclab/difuze) **Abstract:** Device drivers are an essential part in modern Unix-like systems to handle operations on physical devices, from hard disks and printers to digital cameras and Bluetooth speakers. The surge of new hardware, particularly on mobile devices, introduces an explosive growth of device drivers in system kernels. Many such drivers are provided by third-party developers, which are susceptible to security vulnerabilities and lack proper vetting. Unfortunately, the complex input data structures for device drivers render traditional analysis tools, such as fuzz testing, less effective, and so far, research on kernel driver security is comparatively sparse. In this paper, we present DIFUZE, an interface-aware fuzzing tool to automatically generate valid inputs and trigger the execution of the kernel drivers. We leverage static analysis to compose correctly-structured input in the userspace to explore kernel drivers. DIFUZE is fully automatic, ranging from identifying driver handlers, to mapping to device file names, to constructing complex argument instances. We evaluate our approach on seven modern Android smartphones. The results showthat DIFUZE can effectively identify kernel driver bugs, and reports 32 previously unknown vulnerabilities, including flaws that lead to arbitrary code execution. ### IMF: Inferred Model-based Fuzzer (CCS 2017) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS17_IMF.pdf) * <img src="image/github_24px.png">[Code](https://github.com/SoftSec-KAIST/IMF) **Abstract:** Kernel vulnerabilities are critical in security because they naturally allow attackers to gain unprivileged root access. Although there has been much research on finding kernel vulnerabilities from source code, there are relatively few research on kernel fuzzing, which is a practical bug finding technique that does not require any source code. Existing kernel fuzzing techniques involve feeding in random input values to kernel API functions. However, such a simple approach does not reveal latent bugs deep in the kernel code, because many API functions are dependent on each other, and they can quickly reject arbitrary parameter values based on their calling context. In this paper, we propose a novel fuzzing technique for commodity OS kernels that leverages inferred dependence model between API function calls to discover deep kernel bugs. We implement our technique on a fuzzing system, called IMF. IMF has already found 32 previously unknown kernel vulnerabilities on the latest macOS version 10.12.3 (16D32) at the time of this writing. # Hybrid Fuzzing: ### TensileFuzz: Facilitating Seed Input Generation in Fuzzing via String Constraint Solving (ISSTA 2022) * <img src="image/pdf_24px.png">[Paper](https://doi.org/10.1145/3533767.3534403) **Abstract** Seed inputs are critical to the performance of mutation based fuzzers. Existing techniques make use of symbolic execution and gradient descent to generate seed inputs. However, these techniques are not particular suitable for input growth (i.e., making input longer and longer), a key step in seed input generation. Symbolic execution models very low level constraints and prefer fix-sized inputs whereas gradient descent only handles cases where path conditions are arithmetic functions of inputs. We observe that growing an input requires considering a number of relations: length, offset, and count, in which a field is the length of another field, the offset of another field, and the count of some pattern in another field, respective. Theory of string solver is particularly suitable for addressing these relations. We hence propose a novel technique called TensileFuzz, in which we identify input fields and denote them as string variables such that a seed input is the concatenation of these string variables. Additional padding string variables are inserted in between field variables. The aforementioned relations are reverse-engineered and lead to string constraints, solving which instantiates the padding variables and hence grows the input. Our technique also integrates linear regression and gradient descent to ensure the grown inputs satisfy path constraints that lead to path exploration. Our comparison with AFL, and a number of state-of-the-art fuzzers that have similar target applications, including Qsym, Angora, and SLF, shows that TensileFuzz substantially outperforms the others, by 39% - 98% in terms of path coverage. ### CONFETTI: Amplifying Concolic Guidance for Fuzzers (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/190/CONFETTI-Amplifying-Concolic-Guidance-for-Fuzzers) **Abstract** Fuzz testing (fuzzing) allows developers to detect bugs and vulnerabilities in code by automatically generating defect-revealing inputs. Most fuzzers operate by generating inputs for applications and mutating the bytes of those inputs, guiding the fuzzing process with branch coverage feedback via instrumentation. Whitebox guidance (e.g., taint tracking or concolic execution) is sometimes integrated with coverage-guided fuzzing to help cover tricky-to-reach branches that are guarded by complex conditions (so-called magic values). This integration typically takes the form of a targeted input mutation, eg placing particular byte values at a specific offset of some input in order to cover a branch. However, these dynamic analysis techniques are not perfect in practice, which can result in the loss of important relationships between input bytes and branch predicates, thus reducing the effective power of the technique. We introduce a new, surprisingly simple, but effective technique, global hinting, which allows the fuzzer to insert these interesting bytes not only at a targeted position, but in any position of any input. We implemented this idea in Java, creating CONFETTI, which uses both targeted and global hints for fuzzing. In an empirical comparison with two baseline approaches, a state-of-the-art greybox Java fuzzer and a version of CONFETTI without global hinting, we found that CONFETTI covers more branches and finds 15 previously unreported bugs, including 9 that neither baseline could find. By conducting a forensic analysis of CONFETTI’s execution, we determined that global hinting was at least as effective at revealing new coverage as traditional, targeted hinting. ### FuSeBMC v. 4: Smart Seed Generation for Hybrid Fuzzing (2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/abs/2112.10627) **Abstract** FuSeBMC is a test generator for finding security vulnerabilities in C programs. In earlier work [4], we described a previous version that incrementally injected labels to guide Bounded Model Checking (BMC) and Evolutionary Fuzzing engines to produce test cases for code coverage and bug finding. This paper introduces a new version of FuSeBMC that utilizes both engines to produce smart seeds. First, the engines are run with a short time limit on a lightly instrumented version of the program to produce the seeds. The BMC engine is particularly useful in producing seeds that can pass through complex mathematical guards. Then, FuSeBMC runs its engines with more extended time limits using the smart seeds created in the previous round. FuSeBMC manages this process in two main ways using its Tracer subsystem. Firstly, it uses shared memory to record the labels covered by each test case. Secondly, it evaluates test cases, and those of high impact are turned into seeds for subsequent test fuzzing. As a result, we significantly increased our code coverage score from last year, outperforming all tools that participated in this year's competition in every single category. ### A Tight Integration of Symbolic Execution and Fuzzing (short paper 2021) * <img src="image/pdf_24px.png">[Paper](https://binsec.github.io/assets/publications/papers/2021-fps.pdf) **Abstract** Most bug finding tools rely on either fuzzing or symbolic execution. While they both work well in some situations, fuzzing struggles with complex conditions and symbolic execution suffers from path explosion and high constraint solving costs. In order to enjoy the advantages from both techniques, we propose a new approach called Lightweight Symbolic Execution (LSE) that integrates well with fuzzing. Especially, LSE does not require any call to a constraint solver and allows for quickly enumerating inputs. In this short paper, we present the basic concepts of LSE together with promising preliminary experiments. ### Symbolic Security Predicates: Hunt Program Weaknesses (ISPRAS Open 2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2111.05770.pdf) * <img src="image/ppt_24px.png">[Slides](https://vishnya.xyz/vishnyakov-isprasopen2021.pdf) **Abstract** Dynamic symbolic execution (DSE) is a powerful method for path exploration during hybrid fuzzing and automatic bug detection. We propose security predicates to effectively detect undefined behavior and memory access violation errors. Initially, we symbolically execute program on paths that don't trigger any errors (hybrid fuzzing may explore these paths). Then we construct a symbolic security predicate to verify some error condition. Thus, we may change the program data flow to entail null pointer dereference, division by zero, out-of-bounds access, or integer overflow weaknesses. Unlike static analysis, dynamic symbolic execution does not only report errors but also generates new input data to reproduce them. Furthermore, we introduce function semantics modeling for common C/C++ standard library functions. We aim to model the control flow inside a function with a single symbolic formula. This assists bug detection, speeds up path exploration, and overcomes overconstraints in path predicate. We implement the proposed techniques in our dynamic symbolic execution tool Sydr. Thus, we utilize powerful methods from Sydr such as path predicate slicing that eliminates irrelevant constraints. We present Juliet Dynamic to measure dynamic bug detection tools accuracy. The testing system also verifies that generated inputs trigger sanitizers. We evaluate Sydr accuracy for 11 CWEs from Juliet test suite. Sydr shows 95.59% overall accuracy. We make Sydr evaluation artifacts publicly available to facilitate results reproducibility. ### Towards Symbolic Pointers Reasoning in Dynamic Symbolic Execution (IVMEM 2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2109.03698.pdf) * <img src="image/ppt_24px.png">[Slides](https://vishnya.xyz/mirror/kuts-ivmem2021.pdf) **Abstract** Dynamic symbolic execution is a widely used technique for automated software testing, designed for execution paths exploration and program errors detection. A hybrid approach has recently become widespread, when the main goal of symbolic execution is helping fuzzer increase program coverage. The more branches symbolic executor can invert, the more useful it is for fuzzer. A program control flow often depends on memory values, which are obtained by computing address indexes from user input. However, most DSE tools don't support such dependencies, so they miss some desired program branches. We implement symbolic addresses reasoning on memory reads in our dynamic symbolic execution tool Sydr. Possible memory access regions are determined by either analyzing memory address symbolic expressions, or binary searching with SMT-solver. We propose an enhanced linearization technique to model memory accesses. Different memory modeling methods are compared on the set of programs. Our evaluation shows that symbolic addresses handling allows to discover new symbolic branches and increase the program coverage. ### FUZZOLIC: Mixing fuzzing and concolic execution (Computers&Security 2021) * <img src="image/pdf_24px.png">[Paper](https://www.sciencedirect.com/science/article/pii/S0167404821001929) **Abstract:** In the last few years, a large variety of approaches and methodologies have been explored in the context of software testing, ranging from black-box techniques, such as fuzzing, to white-box techniques, such as concolic execution, with a full spectrum of instances in between. Using these techniques, developers and security researchers have been able to identify in the last decade a large number of critical vulnerabilities in thousands of software projects. In this article, we investigate how to improve the performance and effectiveness of concolic execution, proposing two main enhancements to the original approach. On one side, we devise a novel concolic executor that can analyze complex binary programs while running under QEMU and efficiently produce symbolic queries, which could generate valuable program inputs when solved. On the other side, we investigate whether techniques borrowed from the fuzzing domain can be applied to solve the symbolic queries generated by concolic execution, providing a viable alternative to accurate but expensive SMT solving techniques. We show that the combination of our concolic engine, Fuzzolic, and our approximate solver, Fuzzy-Sat, can perform better in terms of code coverage than popular state-of-the-art fuzzers on a variety of complex programs and can identify different unknown bugs in several real-world applications. ### Concolic-Fuzzing of JavaScript Programs using GraalVM and Truffle (SKILL 2021) * <img src="image/pdf_24px.png">[Paper](https://dl.gi.de/bitstream/handle/20.500.12116/37771/A1-1.pdf?sequence=1&isAllowed=y) **Abstract:** The scripting language JavaScript has established itself as a central component of the modern internet. However, the dynamic execution model of the language limits the support for source-code analysis, which leaves a developer without essential tools to maintain safety and security requirements. This paper describes a concolic-fuzzer based on the GraalVM to automatically test JavaScript programs. The fuzzer shows promising results in both code coverage and runtime evaluations and provides developers with additional features such as special analysis targets. ### SHFuzz: A hybrid fuzzing method assisted by static analysis for binary programs (China Communications 2021) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9521142) **Abstract:** Fuzzing is an effective technique to find security bugs in programs by quickly exploring the input space of programs. To further discover vulnerabilities hidden in deep execution paths, the hybrid fuzzing combines fuzzing and concolic execution for going through complex branch conditions. In general, we observe that the execution path which comes across more and complex basic blocks may have a higher chance of containing a security bug. Based on this observation, we propose a hybrid fuzzing method assisted by static analysis for binary programs. The basic idea of our method is to prioritize seed inputs according to the complexity of their associated execution paths. For this purpose, we utilize static analysis to evaluate the complexity of each basic block and employ the hardware trace mechanism to dynamically extract the execution path for calculating the seed inputs' weights. The key advantage of our method is that our system can test binary programs efficiently by using the hardware trace and hybrid fuzzing. To evaluate the effectiveness of our method, we design and implement a prototype system, namely SHFuzz. The evaluation results show SHFuzz discovers more unique crashes on several real-world applications and the LAVA-M dataset when compared to the previous solutions. ### A Priority Based Path Searching Method for Improving Hybrid Fuzzing (Computers & Security 2021) * <img src="image/pdf_24px.png">[Paper](https://www.sciencedirect.com/science/article/pii/S0167404821000663?casa_token=OUEFq5TSDv0AAAAA:jDit2FK_0vPqynepfWH__-mPOAQwfZaRP7Qv9G19x_t22z20N6C293JaNz2I16W2djytcOEFHrGM) **Abstract:** Hybrid fuzzing which combines classical fuzzing with concolic execution to produce effective test suites is an advanced software vulnerability detection technique. Because fuzzing and concolic execution are complementary in nature, some researchers propose “optimal strategyâ€? and “discriminative dispatch strategyâ€? to improve the performance of hybrid fuzzing. Although the ideas are interesting and useful, they have some limitations, such as high time overhead and difficulties in implementation. In this paper, we propose a Priority Based Path Searching method (PBPS) to utilize the capability of concolic execution better. PBPS evaluates each path's solving cost and solving demand, and prioritizes them based on two path characteristics, which are path lengths and sample-hits for concolic execution. The rationale is to keep the pipeline full by readily feeding the concolic engine with paths whose constraints are simpler to solve and are less likely to be explored by fuzz testing. We implement PBPS in Driller, which is a popular hybrid fuzzer and we evaluate our system “QuickFuzzâ€? with the CQE dataset. Experimental results show that compared with DigFuzz and the original Driller, “QuickFuzzâ€? discovers more vulnerabilities and achieves higher code coverage on the CQE dataset. ### Sydr: Cutting Edge Dynamic Symbolic Execution (ISPRAS Open 2020) * <img src="image/youtube.png">[Video](https://www.ispras.ru/conf/2020/video/compiler-technology-11-december.mp4#t=6021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2011.09269.pdf) * <img src="image/ppt_24px.png">[Slides](https://vishnya.xyz/vishnyakov-isprasopen2020.pdf) **Abstract** The security development lifecycle (SDL) is becoming an industry standard. Dynamic symbolic execution (DSE) has enormous amount of applications in computer security (fuzzing, vulnerability discovery, reverse-engineering, etc.). We propose several performance and accuracy improvements for dynamic symbolic execution. Skipping non-symbolic instructions allows to build a path predicate 1.2--3.5 times faster. Symbolic engine simplifies formulas during symbolic execution. Path predicate slicing eliminates irrelevant conjuncts from solver queries. We handle each jump table (switch statement) as multiple branches and describe the method for symbolic execution of multi-threaded programs. The proposed solutions were implemented in Sydr tool. Sydr performs inversion of branches in path predicate. Sydr combines DynamoRIO dynamic binary instrumentation tool with Triton symbolic engine. We evaluated Sydr features on 64-bit Linux executables. ### CSEFuzz: Fuzz Testing Based on Symbolic Execution (Access 2020) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=9222017) **Abstract:** Fuzz testing has been successful in finding defects of various software packages. These defects include file parsing, image processing, Internet browsers, and network protocols. However, the quality of the initial seed test cases greatly influences the coverage and defect detection capability of fuzz testing. To address this issue, we propose CSEFuzz, a fuzz testing approach based on symbolic execution for defect detection. First, CSEFuzz generates candidate test cases by symbolic execution and collects coverage information of the test cases. Then, CSEFuzz extracts the test-case templates of the test cases and selects a set of test-case templates according to specific coverage criteria. Finally, CSEFuzz selects test cases according to the selected test-case templates, and the selected test cases are used as initial seed test cases for fuzz testing. Experiments are conducted on 11 open-source programs. The results show that in comparison with afl-cmin, which is the test-case selection command of Kelinci, CSEFuzz with a path coverage criterion reduces the time costs of the initial seed test selection and verification by 94.26%. In addition, compared with afl-cmin, 32 more paths are covered and 16 more defects are detected by CSEFuzz ### Sequence directed hybrid fuzzing (SANER 2020) * <img src="image/pdf_24px.png">[Paper](./Paper/SANER20_Sequence.pdf) **Abstract:** Existing directed grey-box fuzzers are effective compared with coverage-based fuzzers. However, they fail to achieve a balance between effectiveness and efficiency, and it is difficult to cover complex paths due to random mutation. To mitigate the issue, we propose a novel approach, sequence directed hybrid fuzzing (SDHF), which leverages a sequence-directed strategy and concolic execution technique to enhance the effectiveness of fuzzing. Given a set of target statement sequences of a program, SDHF aims to generate inputs that can reach the statements in each sequence in order and trigger potential bugs in the program. We implement the proposed approach in a tool called Berry and evaluate its capability on crash reproduction, true positive verification, and vulnerability detection. Experimental results demonstrate that Berry outperforms four state-of-the-art fuzzers, including directed fuzzers BugRedux, AFLGo and Lolly, and undirected hybrid fuzzer QSYM. Moreover, Berry found 7 new vulnerabilities in real-world programs such as UPX and GNU Libextractor, and 3 new CVEs were assigned. ### HFL: Hybrid Fuzzing on the Linux Kernel (NDSS 2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#FalkC) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2020/05/09/hfl-hybrid-fuzzing-on-the-linux-kernel/) * <img src="image/zhihu.png">[Reading Note](https://zhuanlan.zhihu.com/p/123373175) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS20_HFL.pdf) * <img src="image/ppt_24px.png">[Slides](https://lifeasageek.github.io/papers/kim-hfl-slides.pdf) **Abstract:** Hybrid fuzzing, combining symbolic execution and fuzzing, is a promising approach for vulnerability discovery because each approach can complement the other. However, we observe that applying hybrid fuzzing to kernel testing is challenging because the following unique characteristics of the kernel make a naive adoption of hybrid fuzzing inefficient: 1) having many implicit control transfers determined by syscall arguments, 2) controlling and matching internal system state via system calls, and 3) inferring nested argument type for invoking system calls. Failure to handling such challenges will render both fuzzing and symbolic execution inefficient, and thereby, will result in an inefficient hybrid fuzzing. Although these challenges are essential to both fuzzing and symbolic execution, however, to the best of our knowledge, existing kernel testing approaches either naively use each technique separately without handling such challenges or imprecisely handle a part of challenges only by static analysis. To this end, this paper proposes HFL, which not only combines fuzzing with symbolic execution for hybrid fuzzing but also addresses kernel-specific fuzzing challenges via three distinct features: 1) converting implicit control transfers to explicit transfers, 2) inferring system call sequence to build a consistent system state, and 3) identifying nested arguments types of system calls. As a result, HFL found 24 previously unknown vulnerabilities in recent Linux kernels. Additionally, HFL achieves 14% higher code coverage than Syzkaller, and over S2E/TriforceAFL, achieving even eight times better coverage, using the same amount of resource (CPU, time, etc.). Regarding vulnerability discovery performance, HFL found 13 known vulnerabilities more than three times faster than Syzkaller. ### PANGOLIN: Incremental Hybrid Fuzzing with Polyhedral Path Abstraction (S&P 2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#iztcu) * <img src="image/pdf_24px.png">[Paper](./Paper/SP20_PANGOLIN.pdf) **Abstract:** Hybrid fuzzing, which combines the merits of both fuzzing and concolic execution, has become one of the most important trends in coverage-guided fuzzing techniques. Despite the tremendous research on hybrid fuzzers, we observe that existing techniques are still inefficient. One important reason is that these techniques, which we refer to as non-incremental fuzzers, cache and reuse few computation results and, thus, lose many optimization opportunities. To be incremental, we propose “polyhedral path abstractionâ€?, which preserves the exploration state in the concolic execution stage and allows more effective mutation and constraint solving over existing techniques. We have implemented our idea as a tool, namely PANGOLIN, and evaluated it using LAVA-M as well as nine real-world programs. The evaluation results showed that PANGOLIN outperforms the state-of-the-art fuzzing techniques with the improvement of coverage rate ranging from 10% to 30%. Moreover, PANGOLIN found 400 more bugs in LAVA-M and discovered 41 unseen bugs with 8 of them assigned with the CVE IDs. ### SAVIOR: Towards Bug-Driven Hybrid Testing (S&P 2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#VwAnn) * <img src="image/pdf_24px.png">[Paper](./Paper/SP20_SAVIOR.pdf) **Abstract:** Hybrid testing combines fuzz testing and concolic execution. It leverages fuzz testing to test easy-to-reach code regions and uses concolic execution to explore code blocks guarded by complex branch conditions. As a result, hybrid testing is able to reach deeper into program state space than fuzz testing or concolic execution alone. Recently, hybrid testing has seen significant advancement. However, its code coveragecentric design is inefficient in vulnerability detection. First, it blindly selects seeds for concolic execution and aims to explore new code continuously. However, as statistics shows, a large portion of the explored code is often invulnerable. Therefore, giving equal attention to every part of the code during hybrid testing is a non-optimal strategy. It also slows down the detection of real vulnerabilities by over 43%. Second, classic hybrid testing quickly moves on after reaching a chunk of code, rather than examining the hidden defects inside. It may frequently miss subtle yet exploitable vulnerabilities despite that it has already explored the vulnerable code paths. We propose SAVIOR, a new hybrid testing framework pioneering a bug-driven principle. Unlike the existing hybrid testing tools, SAVIOR prioritizes the concolic execution of the seeds that are likely to uncover more vulnerabilities. Moreover, SAVIOR verifies all vulnerable program locations along the executing program path. By modeling faulty situations using SMT constraints, SAVIOR reasons the feasibility of vulnerabilities and generates concrete test cases as proofs. Our evaluation shows that the bugdriven approach outperforms the mainstream automated testing techniques, including the state-of-the-art hybrid testing driven by code coverage. On average, SAVIOR detects vulnerabilities 43.4% faster than DRILLER and 44.3% faster than QSYM, leading to the discovery of 88 and 76 more security violations, respectively. According to the experimental result on 11 well-fuzzed benchmark programs, SAVIOR triggers 481 unique security violations within the first 24 hours. ### Deferred Concretization in Symbolic Execution via Fuzzing (ISSTA 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/ISSTA19_Deferred.pdf) **Abstract:** Concretization is an effective weapon in the armory of symbolic execution engines. However, concretization can lead to loss in coverage, path divergence, and generation of test-cases on which the intended bugs are not reproduced. In this paper, we propose an algorithm, Deferred Concretization, that uses a new category for values within symbolic execution (referred to as the symcrete values) to pend concretization till they are actually needed. Our tool, COLOSSUS, built around these ideas, was able to gain an average coverage improvement of 66.94% and reduce divergence by more than 55% relative to the state-of-the-art symbolic execution engine, KLEE. Moreover, we found that KLEE loses about 38.60% of the states in the symbolic execution tree that COLOSSUS is able to recover, showing that COLOSSUS is capable of covering a much larger coverage space. ### Send Hardest Problems My Way: Probabilistic Path Prioritization for Hybrid Fuzzing (NDSS 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#NHtzS) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS19_Probabilistic.pdf) **Abstract:** Hybrid fuzzing which combines fuzzing and concolic execution has become an advanced technique for software vulnerability detection. Based on the observation that fuzzing and concolic execution are complementary in nature, the state-of-the-art hybrid fuzzing systems deploy "demand launch" and "optimal switch" strategies. Although these ideas sound intriguing, we point out several fundamental limitations in them, due to oversimplified assumptions. We then propose a novel "discriminative dispatch" strategy to better utilize the capability of concolic execution. We design a novel Monte Carlo based probabilistic path prioritization model to quantify each path's difficulty and prioritize them for concolic execution. This model treats fuzzing as a random sampling process. It calculates each path's probability based on the sampling information. Finally, our model prioritizes and assigns the most difficult paths to concolic execution. We implement a prototype system DigFuzz and evaluate our system with two representative datasets. Results show that the concolic execution in DigFuzz outperforms than that in a state-of-the-art hybrid fuzzing system Driller in every major aspect. In particular, the concolic execution in DigFuzz contributes to discovering more vulnerabilities (12 vs. 5) and producing more code coverage (18.9% vs. 3.8%) on the CQE dataset than the concolic execution in Driller. ### Intriguer: Field-Level Constraint Solving for Hybrid Fuzzing (CCS 2019) * <img src="image/wechat_24px.png">[Reading Note From BAIZE](https://mp.weixin.qq.com/s/gYqamT3WXiyj79mjBQYRiA) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS19_Intriguer.pdf) **Abstract:** Hybrid fuzzing, which combines fuzzing and concolic execution, is promising in light of the recent performance improvements in concolic engines. We have observed that there is room for further improvement: symbolic emulation is still slow, unnecessary constraints dominate solving time, resources are overly allocated, and hard-to-trigger bugs are missed. To address these problems, we present a new hybrid fuzzer named Intriguer. The key idea of Intriguer is field-level constraint solving, which optimizes symbolic execution with field-level knowledge. Intriguer performs instruction-level taint analysis and records execution traces without data transfer instructions like mov. Intriguer then reduces the execution traces for tainted instructions that accessed a wide range of input bytes, and infers input fields to build field transition trees. With these optimizations, Intriguer can efficiently perform symbolic emulation for more relevant instructions and invoke a solver for complicated constraints only. Our evaluation results indicate that Intriguer outperforms the state-of-the-art fuzzers: Intriguer found all the bugs in the LAVA-M(5h) benchmark dataset for ground truth performance, and also discovered 43 new security bugs in seven real-world programs. We reported the bugs and received 23 new CVEs. ### DeepFuzzer: Accelerated Deep Greybox Fuzzing (TDSC 2019) * <img src="image/pdf_24px.png">[Paper](http://wingtecher.com/themes/WingTecherResearch/assets/papers/TDSC19.pdf) **Abstract:** Fuzzing is one of the most effective vulnerability detection techniques, widely used in practice. However, the performance of fuzzers may be limited by their inability to pass complicated checks, inappropriate mutation frequency, arbitrary mutation strategy, or the variability of the environment. In this paper, we present DeepFuzzer, an enhanced greybox fuzzer with qualified seed generation, balanced seed selection, and hybrid seed mutation. First, we use symbolic execution in a lightweight approach to generate qualified initial seeds which then guide the fuzzer through complex checks. Second, we apply a statistical seed selection algorithm to balance the mutation frequency between different seeds. Further, we develop a hybrid mutation strategy. The random and restricted mutation strategies are combined to maintain a dynamic balance between global exploration and deep search. We evaluate DeepFuzzer on the widely used benchmark Google fuzzer-test-suite which consists of real-world programs. Compared with AFL, AFLFast, FairFuzz, QSYM, and MOPT in the 24-hour experiment, DeepFuzzer discovers 30%, 240%, 102%, 147%, and 257% more unique crashes, executes 40%, 36%, 36%, 98%, and 15% more paths, and covers 37%, 34%, 34%, 101%, and 11% more branches, respectively. Furthermore, we present the practice of fuzzing a message middleware from Huawei with DeepFuzzer, and 9 new vulnerabilities are reported. ### QSYM: A Practical Concolic Execution Engine Tailored for Hybrid Fuzzing (USENIX Security2018) * <img src="image/youdao_note_24px.png">[Reading Note](http://note.youdao.com/noteshare?id=f086faa409a5c6dfabb382e6747381c5&sub=AD1D3F4E3EBC4DCD85694DCAC43EA32B) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX18_QSYM.pdf) * <img src="image/github_24px.png">[Code](https://github.com/sslab-gatech/qsym) **Abstract:** Recently, hybrid fuzzing has been proposed to address the limitations of fuzzing and concolic execution by combining both approaches. The hybrid approach has shown its effectiveness in various synthetic benchmarks such as DARPA Cyber Grand Challenge (CGC) binaries, but it still suffers from scaling to find bugs in complex, real-world software. We observed that the performance bottleneck of the existing concolic executor is the main limiting factor for its adoption beyond a small-scale study. To overcome this problem, we design a fast concolic execution engine, called QSYM, to support hybrid fuzzing. The key idea is to tightly integrate the symbolic emulation with the native execution using dynamic binary translation, making it possible to implement more fine-grained, so faster, instruction-level symbolic emulation. Additionally, QSYM loosens the strict soundness requirements of conventional concolic executors for better performance, yet takes advantage of a faster fuzzer for validation, providing unprecedented opportunities for performance optimizations, e.g., optimistically solving constraints and pruning uninteresting basic blocks. Our evaluation shows that QSYM does not just outperform state-of-the-art fuzzers (i.e., found 14× more bugs than VUzzer in the LAVA-M dataset, and outperformed Driller in 104 binaries out of 126), but also found 13 previously unknown security bugs in eight real-world programs like Dropbox Lepton, ffmpeg, and OpenJPEG, which have already been intensively tested by the state-of-the-art fuzzers, AFL and OSS-Fuzz. ### Angora: Efficient Fuzzing by Principled Search (S&P 2018) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#A4ojR) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2019/01/03/angora-efficient-fuzzing-by-principled-search/) * <img src="image/because.png">[Reading Note](https://github.com/bsauce/Some-Papers-About-Fuzzing/blob/master/xmind_picture/Angora%EF%BC%9AEfficient%20Fuzzing%20by%20principled%20Search.png) * <img src="image/pdf_24px.png">[Paper](./Paper/SP18_Angora.pdf) * <img src="image/github_24px.png">[Code](https://github.com/AngoraFuzzer/Angora) **Abstract:** Abstract-Fuzzing is a popular technique for finding software bugs. However, the performance of the state-of-the-art fuzzers leaves a lot to be desired. Fuzzers based on symbolic execution produce quality inputs but run slow, while fuzzers based on random mutation run fast but have difficulty producing quality inputs. We propose Angora, a new mutation-based fuzzer that outperforms the state-of-the-art fuzzers by a wide margin. The main goal of Angora is to increase branch coverage by solving path constraints without symbolic execution. To solve path constraints efficiently, we introduce several key techniques: scalable byte-level taint tracking, context-sensitive branch count, search based on gradient descent, and input length exploration. On the LAVA-M data set, Angora found almost all the injected bugs, found more bugs than any other fuzzer that we compared with, and found eight times as many bugs as the second-best fuzzer in the program who. Angora also found 103 bugs that the LAVA authors injected but could not trigger. We also tested Angora on eight popular, mature open source programs. Angora found 6, 52, 29, 40 and 48 new bugs in file, jhead, nm, objdump and size, respectively. We measured the coverage of Angora and evaluated how its key techniques contribute to its impressive performance. ### SAFL: increasing and accelerating testing coverage with symbolic execution and guided fuzzing (ICSE 2018) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE18_SAFL.pdf) **Abstract:** Mutation-based fuzzing is a widely used software testing technique for bug and vulnerability detection, and the testing performance is greatly affected by the quality of initial seeds and the effectiveness of mutation strategy. In this paper, we present SAFL¹, an efficient fuzzing testing tool augmented with qualified seed generation and efficient coverage-directed mutation. First, symbolic execution is used in a lightweight approach to generate qualified initial seeds. Valuable explore directions are learned from the seeds, thus the later fuzzing process can reach deep paths in program state space earlier and easier. Moreover, we implement a fair and fast coverage-directed mutation algorithm. It helps the fuzzing process to exercise rare and deep paths with higher probability. We implement SAFL based on KLEE and AFL and conduct thoroughly repeated evaluations on real-world program benchmarks against state-of-the-art versions of AFL. After 24 hours, compared to AFL and AFLFast, it discovers 214% and 133% more unique crashes, covers 109% and 63% more paths and achieves 279% and 180% more covered branches. Video link: https://youtu.be/LkiFLNMBhVE ### CAB-Fuzz: Practical Concolic Testing Techniques for COTS Operating Systems (Usenix Security2017) * <img src="image/pdf_24px.png">[Paper](https://lifeasageek.github.io/papers/kim-cab-fuzz.pdf) * <img src="image/ppt_24px.png">[Slides](https://lifeasageek.github.io/papers/kim-cab-fuzz-slides.pdf) **Abstract:** Discovering the security vulnerabilities of commercial off-the-shelf (COTS) operating systems (OSes) is challenging because they not only are huge and complex, but also lack detailed debug information. Concolic testing, which generates all feasible inputs of a program by using symbolic execution and tests the program with the generated inputs, is one of the most promising approaches to solve this problem. Unfortunately, the state-of-the-art concolic testing tools do not scale well for testing COTS OSes because of state explosion. Indeed, they often fail to find a single bug (or crash) in COTS OSes despite their long execution time. In this paper, we propose CAB-FUZZ (Context-Aware and Boundary-focused), a practical concolic testing tool to quickly explore interesting paths that are highly likely triggering real bugs without debug information. First, CAB-FUZZ prioritizes the boundary states of arrays and loops, inspired by the fact that many vulnerabilities originate from a lack of proper boundary checks. Second, CAB-FUZZ exploits real programs interacting with COTS OSes to construct proper contexts to explore deep and complex kernel states without debug information. We applied CAB-FUZZ to Windows 7 and Windows Server 2008 and found 21 undisclosed unique crashes, including two local privilege escalation vulnerabilities (CVE2015-6098 and CVE-2016-0040) and one information disclosure vulnerability in a cryptography driver (CVE2016-7219). CAB-FUZZ found vulnerabilities that are non-trivial to discover; five vulnerabilities have existed for 14 years, and we could trigger them even in the initial version of Windows XP (August 2001). ### Driller: Argumenting Fuzzing Through Selective Symbolic Execution (NDSS 2016) * <img src="image/blog_24px.jpg">[Reading Note 1](https://firmianay.github.io/2018/06/13/driller.html) * <img src="image/blog_24px.jpg">[Reading Note 2](https://cgnail.github.io/notes/driller/) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS16_Driller.pdf) * <img src="image/github_24px.png">[Code](https://github.com/shellphish/driller) **Abstract:** Memory corruption vulnerabilities are an everpresent risk in software, which attackers can exploit to obtain unauthorized access to confidential information. As products with access to sensitive data are becoming more prevalent, the number of potentially exploitable systems is also increasing, resulting in a greater need for automated software vetting tools. DARPA recently funded a competition, with millions of dollars in prize money, to further research focusing on automated vulnerability finding and patching, showing the importance of research in this area. Current techniques for finding potential bugs include static, dynamic, and concolic analysis systems, which each having their own advantages and disadvantages. A common limitation of systems designed to create inputs which trigger vulnerabilities is that they only find shallow bugs and struggle to exercise deeper paths in executables. We present Driller, a hybrid vulnerability excavation tool which leverages fuzzing and selective concolic execution in a complementary manner, to find deeper bugs. Inexpensive fuzzing is used to exercise compartments of an application, while concolic execution is used to generate inputs which satisfy the complex checks separating the compartments. By combining the strengths of the two techniques, we mitigate their weaknesses, avoiding the path explosion inherent in concolic analysis and the incompleteness of fuzzing. Driller uses selective concolic execution to explore only the paths deemed interesting by the fuzzer and to generate inputs for conditions that the fuzzer cannot satisfy. We evaluate Driller on 126 applications released in the qualifying event of the DARPA Cyber Grand Challenge and show its efficacy by identifying the same number of vulnerabilities, in the same time, as the top-scoring team of the qualifying event. ### Hybrid Fuzz Testing - Discovering Software Bugs via Fuzzing and Symbolic Execution (2012) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE07_Hybrid.pdf) **Abstract:** Random mutational fuzz testing (fuzzing) and symbolic executions are program testing techniques that have been gaining popularity in the security research community. Fuzzing finds bugs in a target program by natively executing it with random inputs while monitoring the execution for abnormal behaviors such as crashes. While fuzzing may have a reputation of being able to explore deep into a program’s state space efficiently, na¨ıve fuzzers usually have limited code coverage for typical programs since unconstrained random inputs are unlikely to drive the execution down many different paths. In contrast, symbolic execution tests a program by treating the program’s input as symbols and interpreting the program over such symbolic inputs. Although in theory symbolic execution is guaranteed to be effective in achieving code coverage if we explore all possible paths, this generally requires exponential resource and is thus not practical for many real-world programs. This thesis presents our attempt to attain the best of both worlds by combining fuzzing with symbolic execution in a novel manner. Our technique, called hybrid fuzzing, first uses symbolic execution to discover frontier nodes that represent unique paths in the program. After collecting as many frontier nodes as possible under a user-specifiable resource constraint, it transits to fuzz the program with preconditioned random inputs, which are provably random inputs that respect the path predicate leading to each frontier node. Our current implementation supports programs with linear path predicates and can automatically generate preconditioned random inputs from a polytope model of the input space extracted from binaries. These preconditioned random inputs can then be used with any fuzzer. Experiments show that our implementation is efficient in both time and space, and the inputs generated by it are able to gain extra breadth and depth over previous approaches. ### Hybrid concolic testing (2007) * <img src="image/pdf_24px.png">[Paper](./Paper/Thesis12_Hybrid.pdf) **Abstract:** We present hybrid concolic testing, an algorithm that interleaves random testing with concolic execution to obtain both a deep and a wide exploration of program state space. Our algorithm generates test inputs automatically by interleaving random testing until saturation with bounded exhaustive symbolic exploration of program points. It thus combines the ability of random search to reach deep program states quickly together with the ability of concolic testing to explore states in a neighborhood exhaustively. We have implemented our algorithm on top of CUTE and applied it to obtain better branch coverage for an editor implementation (VIM 5.7, 150K lines of code) as well as a data structure implementation in C. Our experiments suggest that hybrid concolic testing can handle large programs and provide, for the same testing budget, almost 4× the branch coverage than random testing and almost 2× that of concolic testing. # Mutation\Coverage\Path ### One Fuzzing Strategy to Rule Them All (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://shadowmydx.github.io/papers/icse22-main-1314.pdf) **Abstract:** Coverage-guided fuzzing has become mainstream in fuzzing to automatically expose program vulnerabilities. Recently, a group of fuzzers are proposed to adopt a random search mechanism namely Havoc, explicitly or implicitly, to augment their edge exploration. However, they only tend to adopt the default setup of Havoc as an implementation option while none of them attempts to explore its power under diverse setups or inspect its rationale for potential improvement. In this paper, to address such issues, we conduct the first empirical study on Havoc to enhance the understanding of its characteristics. Specifically, we first find that applying the default setup of Havoc to fuzzers can significantly improve their edge coverage performance. Interestingly, we further observe that even simply executing Havoc itself without appending it to any fuzzer can lead to strong edge coverage performance and outperform most of our studied fuzzers. Moreover, we also extend the execution time of Havoc and find that most fuzzers can not only achieve significantly higher edge coverage, but also tend to perform similarly (i.e., their performance gaps get largely bridged). Inspired by the findings, we further propose Havoc𝑀𝐴𝐵, which models the Havoc mutation strategy as a multi-armed bandit problem to be solved by dynamically adjusting the mutation strategy. The evaluation result presents that Havoc𝑀𝐴𝐵 can significantly increase the edge coverage by 11.1% on average for all the benchmark projects compared with Havoc and even slightly outperform state-of-the-art QSYM which augments its computing resource by adopting three parallel threads. We further execute Havoc𝑀𝐴𝐵 with three parallel threads and result in 9% higher average edge coverage over QSYM upon all the benchmark projects. ### BeDivFuzz: Integrating Behavioral Diversity into Generator-based Fuzzing (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/144/BeDivFuzz-Integrating-Behavioral-Diversity-into-Generator-based-Fuzzing) **Abstract:** A popular metric to evaluate the performance of fuzzers is branch coverage. However, we argue that focusing solely on covering many different branches (i.e., the richness) is not sufficient, since the majority of the covered branches may have been exercised only once, which does not inspire a high confidence in the reliability of the covered code. Instead, the distribution of the executed branches (i.e., the evenness) should be considered as well. That is, behavioral diversity is only given if the generated inputs not only trigger many different branches, but also trigger them evenly often with diverse inputs. We introduce BeDivFuzz, a feedback-driven fuzzing technique for generator-based fuzzers. BeDivFuzz distinguishes between structure-preserving and structure-changing mutations in the space of syntactically valid inputs, and biases its mutation strategy towards behavioral diversity based on the received program feedback. We have evaluated BeDivFuzz on Ant, Maven, Closure, Rhino, and Nashorn. The results show that BeDivFuzz achieves better behavioral diversity compared to the state of the art, measured by established biodiversity metrics from the field of ecology. ### FuzzingDriver: the Missing Dictionary to Increase Code Coverage in Fuzzers (SANER 2022) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/abs/2201.04853) **Abstract:** We propose a tool, called FuzzingDriver, to generate dictionary tokens for coverage-based greybox fuzzers (CGF) from the codebase of any target program. FuzzingDriver does not add any overhead to the fuzzing job as it is run beforehand. We compared FuzzingDriver to Google dictionaries by fuzzing six open-source targets, and we found that FuzzingDriver consistently achieves higher code coverage in all tests. We also executed eight benchmarks on FuzzBench to demonstrate how utilizing FuzzingDriver's dictionaries can outperform six widely-used CGF fuzzers. In future work, investigating the impact of FuzzingDriver's dictionaries on improving bug coverage might prove important. ### EMS: History-Driven Mutation for Coverage-based Fuzzing (NDSS 2022) * <img src="image/github_24px.png">[Code](https://github.com/puppet-meteor/EMS) * <img src="image/pdf_24px.png">[Paper](https://nesa.zju.edu.cn/download/lcy_pdf_ems_ndss22.pdf) **Abstract:** Mutation-based fuzzing is one of the most popular approaches to discover vulnerabilities in a program. To alleviate the inefficiency of mutation-based fuzzing incurred by high randomness in the mutation process, multiple solutions are developed in recent years, especially coverage-based fuzzing. They mainly employ adaptive mutation strategies or integrate constraint-solving techniques to make a good exploration of the test cases which trigger unique paths and crashes. However, they lack a fine-grained reusing of fuzzing history to construct these interesting test cases, i.e., they largely fail to properly utilize fuzzing history across different fuzzing trials. In fact, we discover that test cases in fuzzing history contain rich knowledge of the key mutation strategies that lead to the discovery of unique paths and crashes. Specifically, partial path constraint solutions implicitly carried in these mutation strategies can be reused to accelerate the discovery of new paths and crashes that share similar partial path constraints. Therefore, we first propose a lightweight and efficient Probabilistic Byte Orientation Model (PBOM) that properly captures the byte-level mutation strategies from intra- and inter-trial history and thus can effectively trigger unique paths and crashes. We then present a novel history-driven mutation framework named EMS that employs PBOM as one of the mutation operators to probabilistically provide desired mutation byte values according to the input ones. We evaluate EMS against state-of-the-art fuzzers including AFL, QSYM, MOPT, MOPT-dict, EcoFuzz, and AFL++ on 9 real world programs. The results show that EMS discovers up to 4.91× more unique vulnerabilities than the baseline, and finds more line coverage than other fuzzers on most programs. We report all of the discovered new vulnerabilities to vendors and will open source the prototype of EMS on GitHub. ### OTA: An Operation-oriented Time Allocation Strategy for Greybox Fuzzing (SANER 2021) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9425969) **Abstract:** Coverage-based greybox fuzzing (CGF) has been widely studied and commonly used for software vulnerability detection. Existing CGF fuzzers fairly allocate execution time for each mutation operation to generate test cases. However, the fair-time-allocation strategy is revealed to be inefficient by our significant experimental observation that different operations have heterogeneous effectiveness on coverage. Those ineffective operations with vast test cases thus occupy the majority of limited runtime, reducing the opportunities for effective operations to explore more paths and find potential vulnerabilities.In this paper, we propose a novel operation-oriented time allocation strategy OTA, which dynamically allocates operation execution time in real time to cope with the effectiveness variation per operation. OTA has three distinguishing advantages: (1) the execution time per operation is novelly initialized on demand and program-dependent; (2) the execution time for each operation is dynamically weighted by its real-time effectiveness on exploring new coverage; (3) the determination of the execution time per operation is well controlled to achieve a quick convergence. Extensive experiments based on real-world programs and the LAVA-M dataset have been conducted to evaluate the path discovery and vulnerability detection abilities of OTA, which substantially outperforms 5 state-of-the-art fuzzers. In addition, OTA exposes 18 previously unknown vulnerabilities in 6 well-tested programs with 13 confirmed with new CVE IDs. ### MaxAFL: Maximizing Code Coverage with a Gradient-Based Optimization Technique (Electronics 2020) * <img src="image/pdf_24px.png">[Paper](https://www.mdpi.com/2079-9292/10/1/11/pdf) **Abstract:** Evolutionary fuzzers generally work well with typical software programs because of their simple algorithm. However, there is a limitation that some paths with complex constraints cannot be tested even after long execution. Fuzzers based on concolic execution have emerged to address this issue. The concolic execution fuzzers also have limitations in scalability. Recently, the gradient-based fuzzers that use a gradient to mutate inputs have been introduced. Gradient-based fuzzers can be applied to real-world programs and achieve high code coverage. However, there is a problem that the existing gradient-based fuzzers require heavyweight analysis or sufficient learning time. In this paper, we propose a new type of gradient-based fuzzer, MaxAFL, to overcome the limitations of existing gradient-based fuzzers. Our approach constructs an objective function through fine-grained static analysis. After constructing a well-made objective function, we can apply the gradient-based optimization algorithm. We use a modified gradient-descent algorithm to minimize our objective function and propose some probabilistic techniques to escape local optimum. We introduce an adaptive objective function which aims to explore various paths in the program. We implemented MaxAFL based on the original AFL. MaxAFL achieved increase of code coverage per time compared with three other fuzzers in six open-source Linux binaries. We also measured cumulative code coverage per total execution, and MaxAFL outperformed the other fuzzers in this metric. Finally, MaxAFL can also find more bugs than the other fuzzers. ### PathAFL: Path-Coverage Assisted Fuzzing (ASIA CCS 2020) * <img src="image/pdf_24px.png">[Paper](https://dl.acm.org/doi/pdf/10.1145/3320269.3384736) **Abstract:** Fuzzing is an effective method to find software bugs and vulnerabilities. One of the most useful techniques is the coverage-guided fuzzing, whose key element is the tracing code coverage information. Existing coverage-guided fuzzers generally use the the number of basic blocks or edges explored to measure code coverage. Path-coverage can provide more accurate coverage information than basic block and edge coverage. However, the number of paths grows exponentially as the size of a program increases. It is almost impossible to trace all the paths of a real-world application. In this paper, we propose a fuzzing solution named PathAFL, which assists a fuzzer by path identification. It can effectively identify and utilize the important h-path, which is a new path but whose edges have all been touched previously. First, PathAFL only inserts one assembly instruction to AFL's original code to calculate the path hash, and uses a selective instrumentation strategy to reduce the tracing granularity of an execution path. Second, we design a fast filtering algorithm to choose higher weight paths from a large number of h-paths and add them to the seed queue. Third, both the seed selection algorithm and the power schedule are implemented based on the path weight. Finally we implemented PathAFL based on the popular fuzzer AFL and evaluated it on 10 well-fuzzed benchmark programs. In 24 hours, PathAFL explored 38% more paths and 9.3% more edges than AFL. Compared with CollAFL-x, the number is 25% and 5.9% correspondingly. Moreover, PathAFL found the more bugs on the LAVA-M dataset, even four unlisted bugs. The results show that PathAFL outperforms the previous fuzzers in terms of both code coverage and bug discovery. In well-tested programs, PathAFL found 8 new security bugs with 6 CVEs assigned. ### Zeror: Speed Up Fuzzing with Coverage-sensitive Tracing and Scheduling (ASE 2020) * <img src="image/pdf_24px.png">[Paper](http://www.wingtecher.com/themes/WingTecherResearch/assets/papers/ase20.pdf) **Abstract:** Coverage-guided fuzzing is one of the most popular software testing techniques for vulnerability detection. While effective, current fuzzing methods suffer from significant performance penalty due to instrumentation overhead, which limits its practical use. Existing solutions improve the fuzzing speed by decreasing instrumentation overheads but sacrificing coverage accuracy, which results in unstable performance of vulnerability detection. In this paper, we propose a coverage-sensitive tracing and scheduling framework Zeror that can improve the performance of existing fuzzers, especially in their speed and vulnerability detection. The Zeror is mainly made up of two parts: (1) a self-modifying tracing mechanism to provide a zero-overhead instrumentation for more effective coverage collection, and (2) a real-time scheduling mechanism to support adaptive switch between the zero-overhead instrumented binary and the fully instrumented binary for better vulnerability detection. In this way, Zeror is able to decrease collection overhead and preserve fine-grained coverage for guidance. For evaluation, we implement a prototype of Zeror and evaluate it on Google fuzzer-test-suite, which consists of 24 widely-used applications. The results show that Zeror performs better than existing fuzzing speed-up frameworks such as Untracer and INSTRIM, improves the execution speed of the state-of-the-art fuzzers such as AFL and MOPT by 159.80%, helps them achieve better coverage (averagely 10.14% for AFL, 6.91% for MOPT) and detect vulnerabilities faster (averagely 29.00% for AFL, 46.99% for MOPT) ### Not All Coverage Measurements Are Equal: Fuzzing by Coverage Accounting for Input Prioritization (NDSS 2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#kNyMv) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS20_Prioritization.pdf) **Abstract:** Coverage-based fuzzing has been actively studied and widely adopted for finding vulnerabilities in real-world software applications. With code coverage, such as statement coverage and transition coverage, as the guidance of input mutation, coverage-based fuzzing can generate inputs that cover more code and thus find more vulnerabilities without prerequisite information such as input format. Current coverage-based fuzzing tools treat covered code equally. All inputs that contribute to new statements or transitions are kept for future mutation no matter what the statements or transitions are and how much they impact security. Although this design is reasonable from the perspective of software testing, which aims to full code coverage, it is inefficient for vulnerability discovery since that 1) current techniques are still inadequate to reach full coverage within a reasonable amount of time, and that 2) we always want to discover vulnerabilities early so that it can be patched promptly. Even worse, due to the non-discriminative code coverage treatment, current fuzzing tools suffer from recent anti-fuzzing techniques and become much less effective in finding real-world vulnerabilities. To resolve the issue, we propose coverage accounting, an innovative approach that evaluates code coverage by security impacts. Based on the proposed metrics, we design a new scheme to prioritize fuzzing inputs and develop TortoiseFuzz, a greybox fuzzer for memory corruption vulnerabilities. We evaluated TortoiseFuzz on 30 real-world applications and compared it with 5 state-of-the-art greybox and hybrid fuzzers (AFL, AFLFast, FairFuzz, QSYM, and Angora). TortoiseFuzz outperformed all greybox fuzzers and most hybrid fuzzers. It also had comparative results for other hybrid fuzzers yet consumed much fewer resources. Additionally, TortoiseFuzz found 18 new real-world vulnerabilities and has got 8 new CVEs so far. We will open source TortoiseFuzz to foster future research. ### Matryoshka: fuzzing deeply nested branches (CCS 2019) * <img src="image/wechat_24px.png">[Reading Note From BAIZE](https://mp.weixin.qq.com/s/gYqamT3WXiyj79mjBQYRiA) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS19_Matryoshka.pdf) **Abstract:** Greybox fuzzing has made impressive progress in recent years, evolving from heuristics-based random mutation to approaches for solving individual path constraints. However, they have difficulty solving path constraints that involve deeply nested conditional statements, which are common in image and video decoders, network packet analyzers, and checksum tools. We propose an approach for addressing this problem. First, we identify all the control flow-dependent conditional statements of the target conditional statement. Next, we select the data flow-dependent conditional statements. Finally, we use three strategies to find an input that satisfies all conditional statements simultaneously. We implemented this approach in a tool called Matryoshka and compared its effectiveness on 13 open source programs against other state-of-the-art fuzzers. Matryoshka found significantly more unique crashes than AFL, QSYM, and Angora. We manually classified those crashes into 41 unique new bugs, and obtained 12 CVEs. Our evaluation also uncovered the key technique contributing to Matryoshka's impressive performance: it collects only the nesting constraints that may cause the target conditional statements unreachable, which greatly simplifies the constraints that it has to solve. ### REDQUEEN: Fuzzing with Input-to-State Correspondence (NDSS2019) * <img src="image/youdao_note_24px.png">[Reading Note](http://note.youdao.com/noteshare?id=6a4b00d912eab145d1c1f32f11bde3e0&sub=7DADC02169A14B33979BCCB2556E4526) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2019/06/05/redqueen-fuzzing-with-input-to-state-correspondence/) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS19_REDQUEEN.pdf) **Abstract:** Automated software testing based on fuzzing has experienced a revival in recent years. Especially feedback-driven fuzzing has become well-known for its ability to efficiently perform randomized testing with limited input corpora. Despite a lot of progress, two common problems are magic numbers and (nested) checksums. Computationally expensive methods such as taint tracking and symbolic execution are typically used to overcome such roadblocks. Unfortunately, such methods often require access to source code, a rather precise description of the environment (e.g., behavior of library calls or the underlying OS), or the exact semantics of the platform's instruction set. In this paper, we introduce a lightweight, yet very effective alternative to taint tracking and symbolic execution to facilitate and optimize state-of-the-art feedback fuzzing that easily scales to large binary applications and unknown environments. We observe that during the execution of a given program, parts of the input often end up directly (i.e., nearly unmodified) in the program state. This input-to-state correspondence can be exploited to create a robust method to overcome common fuzzing roadblocks in a highly effective and efficient manner. Our prototype implementation, called REDQUEEN, is able to solve magic bytes and (nested) checksum tests automatically for a given binary executable. Additionally, we show that our techniques outperform various state-of-the-art tools on a wide variety of targets across different privilege levels (kernel-space and userland) with no platform-specific code. REDQUEEN is the first method to find more than 100% of the bugs planted in LAVA-M across all targets. Furthermore, we were able to discover 65 new bugs and obtained 16 CVEs in multiple programs and OS kernel drivers. Finally, our evaluation demonstrates that REDQUEEN is fast, widely applicable and outperforms concurrent approaches by up to three orders of magnitude. ### T-Fuzz: fuzzing by program transformation (S&P 2018) * <img src="image/csdn_24px.png">[Reading Note](https://blog.csdn.net/Chen_zju/article/details/80934710) * <img src="image/blog_24px.jpg">[Reading Note from dawuge](https://dawuge.github.io/2019/10/31/CodeAlchemistandT-Fuzz/) * <img src="image/pdf_24px.png">[Paper](./Paper/SP18_T-Fuzz.pdf) * <img src="image/github_24px.png">[Code](https://github.com/HexHive/T-Fuzz) **Abstract:** Fuzzing is a simple yet effective approach to discover software bugs utilizing randomly generated inputs. However, it is limited by coverage and cannot find bugs hidden in deep execution paths of the program because the randomly generated inputs fail complex sanity checks, e.g., checks on magic values, checksums, or hashes. To improve coverage, existing approaches rely on imprecise heuristics or complex input mutation techniques (e.g., symbolic execution or taint analysis) to bypass sanity checks. Our novel method tackles coverage from a different angle: by removing sanity checks in the target program. T-Fuzz leverages a coverage-guided fuzzer to generate inputs. Whenever the fuzzer can no longer trigger new code paths, a light-weight, dynamic tracing based technique detects the input checks that the fuzzer-generated inputs fail. These checks are then removed from the target program. Fuzzing then continues on the transformed program, allowing the code protected by the removed checks to be triggered and potential bugs discovered. Fuzzing transformed programs to find bugs poses two challenges: (1) removal of checks leads to over-approximation and false positives, and (2) even for true bugs, the crashing input on the transformed program may not trigger the bug in the original program. As an auxiliary post-processing step, T-Fuzz leverages a symbolic execution-based approach to filter out false positives and reproduce true bugs in the original program. By transforming the program as well as mutating the input, T-Fuzz covers more code and finds more true bugs than any existing technique. We have evaluated T-Fuzz on the DARPA Cyber Grand Challenge dataset, LAVA-M dataset and 4 real-world programs (pngfix, tiffinfo, magick and pdftohtml). For the CGC dataset, T-Fuzz finds bugs in 166 binaries, Driller in 121, and AFL in 105. In addition, found 3 new bugs in previously-fuzzed programs and libraries. ### FairFuzz: A Targeted Mutation Strategy for Increasing Greybox Fuzz Testing Coverage (ASE 2018) * <img src="image/youdao_note_24px.png">[Reading Note](http://note.youdao.com/noteshare?id=5525c7a18e8681302229e9466290aac2&sub=C4769EA799584C5D89994FE397F76981) * <img src="image/pdf_24px.png">[Paper](./Paper/ASE18_Fairfuzz.pdf) * <img src="image/github_24px.png">[Code](https://github.com/carolemieux/afl-rb) **Abstract:** In recent years, fuzz testing has proven itself to be one of the most effective techniques for finding correctness bugs and security vulnerabilities in practice. One particular fuzz testing tool, American Fuzzy Lop (AFL), has become popular thanks to its ease-of-use and bug-finding power. However, AFL remains limited in the bugs it can find since it simply does not cover large regions of code. If it does not cover parts of the code, it will not find bugs there. We propose a two-pronged approach to increase the coverage achieved by AFL. First, the approach automatically identifies branches exercised by few AFL-produced inputs (rare branches), which often guard code that is empirically hard to cover by naively mutating inputs. The second part of the approach is a novel mutation mask creation algorithm, which allows mutations to be biased towards producing inputs hitting a given rare branch. This mask is dynamically computed during fuzz testing and can be adapted to other testing targets. We implement this approach on top of AFL in a tool named FairFuzz. We conduct evaluation on real-world programs against state-of-the-art versions of AFL. We find that on these programs FairFuzz achieves high branch coverage at a faster rate that state-of-the-art versions of AFL. In addition, on programs with nested conditional structure, it achieves sustained increases in branch coverage after 24 hours (average 10.6% increase). In qualitative analysis, we find that FairFuzz has an increased capacity to automatically discover keywords. ### VUzzer: Application-aware Evolutionary Fuzzing (NDSS 2017) * <img src="image/youdao_note_24px.png">[Reading Note](http://note.youdao.com/noteshare?id=b0505524143c5f9439c6a5d9dcff9b1d&sub=D8A73723348B4976BA191B235EB13307) * <img src="image/csdn_24px.jpg">[Reading Note](https://blog.csdn.net/qq_32505207/article/details/104690747) * <img src="image/because.png">[Reading Note](https://github.com/bsauce/Some-Papers-About-Fuzzing/blob/master/xmind_picture/VUzzer%20Application-aware%20Evolutionary%20Fuzzing-ndss2017.png) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS17_Vuzzer.pdf) * <img src="image/github_24px.png">[Code](https://github.com/vusec/vuzzer) **Abstract:** Fuzzing is an effective software testing technique to find bugs. Given the size and complexity of real-world applications, modern fuzzers tend to be either scalable, but not effective in exploring bugs that lie deeper in the execution, or capable of penetrating deeper in the application, but not scalable. In this paper, we present an application-aware evolutionary fuzzing strategy that does not require any prior knowledge of the application or input format. In order to maximize coverage and explore deeper paths, we leverage control- and data-flow features based on static and dynamic analysis to infer fundamental properties of the application. This enables much faster generation of interesting inputs compared to an application-agnostic approach. We implement our fuzzing strategy in VUzzer and evaluate it on three different datasets: DARPA Grand Challenge binaries (CGC), a set of real-world applications (binary input parsers), and the recently released LAVA dataset. On all of these datasets, VUzzer yields significantly better results than state-of-the-art fuzzers, by quickly finding several existing and new bugs. # Grammars \ Semantic \ Context-aware Fuzzing ### FRAMESHIFTER: Manipulating HTTP/2 Frame Sequences with Fuzzing (Usenix Security2020) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec22-jabiyev.pdf) **Abstract:** HTTP/2 adoption is rapidly climbing. However, in practice, Internet communications still rarely happen over end-to-end HTTP/2 channels. This is due to Content Delivery Networks and other reverse proxies, ubiquitous and necessary components of the Internet ecosystem, which only support HTTP/2 on the client's end, but not the forward connection to the origin server. Instead, proxy technologies predominantly rely on HTTP/2-to-HTTP/1 protocol conversion between the two legs of the connection. We present the first systematic exploration of HTTP/2-to-HTTP/1 protocol conversion anomalies and their security implications. We develop a novel grammar-based fuzzer for HTTP/2, experiment with 12 popular reverse proxy technologies & CDNs through HTTP/2 frame sequence and content manipulation, and discover a plethora of novel web application attack vectors that lead to Request Blackholing, Denial-of-Service, Query-of-Death, and Request Smuggling attacks. ### SGXFuzz: Efficiently Synthesizing Nested Structures for SGX Enclave Fuzzing (Usenix Security2022) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/conference/usenixsecurity22/presentation/cloosters) **Abstract:** Intel's Software Guard Extensions (SGX) provide a nonintrospectable trusted execution environment (TEE) to protect security-critical code from a potentially malicious OS. This protection can only be effective if the individual enclaves are secure, which is already challenging in regular software, and this becomes even more difficult for enclaves as the entire environment is potentially malicious. As such, many enclaves expose common vulnerabilities, e.g., memory corruption and SGXspecific vulnerabilities like null-pointer dereferences. While fuzzing is a popular technique to assess the security of software, dynamically analyzing enclaves is challenging as enclaves are meant to be non-introspectable. Further, they expect an allocated multi-pointer structure as input instead of a plain buffer. In this paper, we present SGXFUZZ, a coverage-guided fuzzer that introduces a novel binary input structure synthesis method to expose enclave vulnerabilities even without source-code access. To obtain code coverage feedback from enclaves, we show how to extract enclave code from distribution formats. We also present an enclave runner that allows execution of the extracted enclave code as a user-space application at native speed, while emulating all relevant environment interactions of the enclave. We use this setup to fuzz enclaves using a state-of-the-art snapshot fuzzing engine that deploys our novel structure synthesis stage. This stage synthesizes multi-layer pointer structures and size fields incrementally on-the-fly based on fault signals. Furthermore, it matches the expected input format of the enclave without any prior knowledge. We evaluate our approach on 30 open- and closed-source enclaves and found a total of 79 new bugs and vulnerabilities. ### Unicorn: Detect Runtime Error in Time-Series Databases With Hybrid Input Synthesis (ISSTA 2022) * <img src="image/pdf_24px.png">[Paper](http://www.wingtecher.com/themes/WingTecherResearch/assets/papers/issta22.pdf) **Abstract:** The ubiquitous use of time-series databases in the safety-critical Internet of Things domain demands strict security and correctness. One successful approach in database bug detection is fuzzing, where hundreds of bugs have been detected automatically in relational databases. However, it cannot be easily applied to time-series databases: the bulk of time-series logic is unreachable because of mismatched query specifications, and serious bugs are undetectable because of implicitly handled exceptions. In this paper, we propose Unicorn to secure time-series databases with automated fuzzing. First, we design hybrid input synthesis to generate high-quality queries which not only cover time-series features but also ensure grammar correctness. Then, Unicorn uses proactive exception detection to discover minuscule-symptom bugs which hide behind implicit exception handling. With the specialized design oriented to time-series databases, Unicorn outperforms the state-of-the-art database fuzzers in terms of coverage and bugs. Specifically, Unicorn outperforms SQLsmith and SQLancer on widely used time-series databases IoTDB, KairosDB, TimescaleDB, TDEngine, QuestDB, and GridDB in the number of basic blocks by 21%-199% and 34%-693%, respectively. More importantly, Unicorn has discovered 42 previously unknown bugs. ### Cooper: Testing the Binding Code of Scripting Languages with Cooperative Mutation (NDSS 2022) * <img src="image/pdf_24px.png">[Paper](https://huhong789.github.io/papers/xu:cooper.pdf) * <img src="image/github_24px.png">[Code](https://github.com/TCA-ISCAS/Cooper) **Abstract:** Scripting languages like JavaScript are being integrated into commercial software to support easy file modification. For example, Adobe Acrobat accepts JavaScript to dynamically manipulate PDF files. To bridge the gap between the high-level scripts and the low-level languages (like C/C++) used to implement the software, a binding layer is necessary to transfer data and transform representations. However, due to the complexity of two sides, the binding code is prone to inconsistent semantics and security holes, which lead to severe vulnerabilities. Existing efforts for testing binding code merely focus on the script side, and thus miss bugs that require special program native inputs. In this paper, we propose cooperative mutation, which modifies both the script code and the program native input to trigger bugs in binding code. Our insight is that many bugs are due to the interplay between the program initial state and the dynamic operations, which can only be triggered through two-dimensional mutations. We develop three novel techniques to enable practical cooperative mutation on popular scripting languages: we first cluster objects into semantics similar classes to reduce the mutation space of native inputs; then, we statistically infer the relationship between script code and object classes based on a large number of executions; at last, we use the inferred relationship to select proper objects and related script code for targeted mutation. We applied our tool, COOPER, on three popular systems that integrate scripting languages, including Adobe Acrobat, Foxit Reader and Microsoft Word. COOPER successfully found 134 previously unknown bugs. We have reported all of them to the developers. At the time of paper publishing, 59 bugs have been fixed and 33 of them are assigned CVE numbers. We are awarded totally 22K dollars bounty for 17 out of all reported bugs. ### Fuzzing Class Specifications (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/83/Fuzzing-Class-Specifications) **Abstract:** Expressing class specifications via executable constraints is important for various software engineering tasks such as test generation, bug finding and automated debugging, but developers rarely write them. Techniques that infer specifications from code exist to fill this gap, but they are designed to support specific kinds of assertions and are difficult to adapt to support different assertion languages, e.g., to add support for quantification, or additional comparison operators, such as membership or containment. To address the above issue, we present SpecFuzzer, a novel technique that combines grammar-based fuzzing, dynamic invariant detection, and mutation analysis, to automatically produce class specifications. SpecFuzzer uses: \emph{(i)} a fuzzer as a generator of candidate assertions derived from a grammar that is automatically obtained from the class definition; \emph{(ii)} a dynamic invariant detector –Daikonâ€? to filter out assertions invalidated by a test suite; and \emph{(iii)} a mutation-based mechanism to cluster and rank assertions, so that similar constraints are grouped and then the stronger prioritized. Grammar-based fuzzing enables SpecFuzzer to be straightforwardly adapted to support different specification languages, by manipulating the fuzzing grammar, e.g., to include additional operators. We evaluate our technique on a benchmark of 43 Java methods employed in the evaluation of the state-of-the-art techniques GAssert and EvoSpex. Our results show that SpecFuzzer can easily support a more expressive assertion language, over which is more effective than GAssert and EvoSpex in inferring specifications, according to standard performance metrics. ### Efficient ECU Analysis Technology through Structure-aware CAN Fuzzing (Access 2022) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9713864) **Abstract:** Modern vehicles are equipped with a number of electronic control units (ECUs), which control vehicles efficiently by communicating with each other through the controller area network (CAN). However, the CAN is known to be vulnerable to cyber attacks because it does not have any security mechanisms. To find vulnerable CAN messages that can control safety-critical functions in ECUs, researchers have studied CAN fuzzing methods. In existing CAN fuzzing methods, fuzzing input values are generally generated at random without considering the structure of CAN messages, resulting in non-negligible CAN fuzzing time. In addition, existing fuzzing solutions have limited monitoring capabilities of the fuzzing results. In this paper, we propose a Structure-aware CAN Fuzzing protocol, in which the structure of CAN messages is considered and fuzzing input values are systematically generated to locate vulnerable functions in ECUs. Our proposed Structure-aware CAN Fuzzing system takes less time to run than existing solutions, meaning that problematic CAN messages that may have originated from SW implementation errors or CAN DBC (database CAN) design errors can be found quickly and, subsequently, appropriate action can be taken. Finally, we evaluated the performance of our Structure-aware CAN Fuzzing system on two real vehicles. We proved that our proposed method can find CAN messages that control safety-critical functions in ECUs faster than existing fuzzing solutions. ### Semantic Image Fuzzing of AI Perception Systems * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/172/Semantic-Image-Fuzzing-of-AI-Perception-Systems) **Abstract:** Perception systems enable autonomous systems to interpret sensor readings obtained from the physical world. Testing of such systems aims to uncover misinterpretations that can severely impact an autonomous system’s behavior. Current testing methods for perception systems, however, are inadequate: (1) when testing on real-world input data, the cost of human interpretation and annotation is very high, so test suites tend to be small; (2) the simulation-reality gap reduces the validity of test results based on simulated worlds; and (3) methods for synthesizing test cases with realistic inputs are limited in scope and lack semantic interpretations. To address these limitations, we developed a novel approach to fuzz testing perception systems based on semantic mutation of real-world sensor readings and their corresponding ground-truth interpretations. This enables mutations like adding a car driving on the street to an existing image while providing an oracle that accounts for that semantic change. We implemented our approach and evaluated its performance by generating 150,000 semantically mutated image inputs for five state-of-the-art perception systems. Our approach produced novel image inputs not found in the original test suite, and uncovered inputs that lead to significant issues in the analyzed systems at a very low cost. ### SoFi: Reflection-Augmented Fuzzing for JavaScript Engines (CCS 2021) * <img src="image/pdf_24px.png">[Paper](https://dl.acm.org/doi/10.1145/3460120.3484823) **Abstract:** JavaScript engines have been shown prone to security vulnerabilities, which can lead to serious consequences due to their popularity. Fuzzing is an effective testing technique to discover vulnerabilities. The main challenge of fuzzing JavaScript engines is to generate syntactically and semantically valid inputs such that deep functionalities can be explored. However, due to the dynamic nature of JavaScript and the special features of different engines, it is quite challenging to generate semantically meaningful test inputs. We observed that state-of-the-art semantic-aware JavaScript fuzzers usually require manually written rules to analyze the semantics for a JavaScript engine, which is labor-intensive, incomplete and engine-specific. Moreover, the error rate of generated test cases is still high. Another challenge is that existing fuzzers cannot generate new method calls that are not included in the initial seed corpus or pre-defined rules, which limits the bug-finding capability. To this end, we propose a novel semantic-aware fuzzing technique named SoFi. To guarantee the validity of the generated test cases, SoFi adopts a fine-grained program analysis to identify available variables and infer types of these variables for the mutation. Moreover, an automatic repair strategy is proposed to repair syntax/semantic errors in invalid test cases. To improve the exploration capability of SoFi, we propose a reflection-based analysis to identify unseen attributes and methods of objects, which are further used in the mutation. With fine-grained analysis and reflection-based augmentation, SoFi can generate more valid and diverse test cases. Besides, SoFi is general in different JavaScript engines without any manual configuration (e.g., the grammar rules). The evaluation results have shown that SoFi outperforms state-of-the-art techniques in generating semantically valid inputs, improving code coverage and detecting more bugs. SoFi discovered 51 bugs in popular JavaScript engines, 28 of which have been confirmed or fixed by the developers and 10 CVE IDs have been assigned. ### V-SHUTTLE: Scalable and Semantics-Aware Hypervisor Fuzzing (CCS 2021) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec21-salls.pdf) **Abstract:** With the wide application and deployment of cloud computing in enterprises, virtualization developers and security researchers are paying more attention to cloud computing security. The core component of cloud computing products is the hypervisor, which is also known as the virtual machine monitor (VMM) that can isolate multiple virtual machines in one host machine. However, compromising the hypervisor can lead to virtual machine escape and the elevation of privilege, allowing attackers to gain the permission of code execution in the host. Therefore, the security analysis and vulnerability detection of the hypervisor are critical for cloud computing enterprises. Importantly, virtual devices expose many interfaces to a guest user for communication, making virtual devices the most vulnerable part of a hypervisor. However, applying fuzzing to the virtual devices of a hypervisor is challenging because the data structures transferred by DMA are constructed in a nested form according to protocol specifications. Failure to understand the protocol of the virtual devices will make the fuzzing process stuck in the initial fuzzing stage, resulting in inefficient fuzzing. In this paper, we propose a new framework called V-Shuttle to conduct hypervisor fuzzing, which performs scalable and semanticsaware hypervisor fuzzing. To address the above challenges, we first design a DMA redirection mechanism to significantly reduce the manual efforts to reconstruct virtual devicesâ€? protocol structures and make the fuzzing environment setup automated and scalable. Furthermore, we put forward a new fuzzing mutation scheduling mechanism called seedpool to make the virtual device fuzzing process semantics-aware and speed up the fuzzing process to achieve high coverage. Extensive evaluation on QEMU and VirtualBox, two of the most popular hypervisor platforms among the world, shows that V-Shuttle can efficiently reproduce existing vulnerabilities and find new vulnerabilities. We further carried out a long-term fuzzing campaign in QEMU/KVM and VirtualBox with V-Shuttle. In total, we discovered 35 new bugs with 17 CVEs assigne. ### Token-Level Fuzzing (WiSec 2021) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec21-salls.pdf) **Abstract:** Fuzzing has become a commonly used approach to identifying bugs in complex, real-world programs. However, interpreters are notoriously difficult to fuzz effectively, as they expect highly structured inputs, which are rarely produced by most fuzzing mutations. For this class of programs, grammar-based fuzzing has been shown to be effective. Tools based on this approach can find bugs in the code that is executed after parsing the interpreter inputs, by following language-specific rules when generating and mutating test cases. Unfortunately, grammar-based fuzzing is often unable to discover subtle bugs associated with the parsing and handling of the language syntax. Additionally, if the grammar provided to the fuzzer is incomplete, or does not match the implementation completely, the fuzzer will fail to exercise important parts of the available functionality. In this paper, we propose a new fuzzing technique, called Token-Level Fuzzing. Instead of applying mutations either at the byte level or at the grammar level, Token-Level Fuzzing applies mutations at the token level. Evolutionary fuzzers can leverage this technique to both generate inputs that are parsed successfully and generate inputs that do not conform strictly to the grammar. As a result, the proposed approach can find bugs that neither byte-level fuzzing nor grammar-based fuzzing can find. We evaluated Token-Level Fuzzing by modifying AFL and fuzzing four popular JavaScript engines, finding 29 previously unknown bugs, several of which could not be found with state-of-the-art byte-level and grammar-based fuzzers. ### Extended grammar-based fuzzing algorithm for JavaScript Engines (2021) * <img src="image/pdf_24px.png">[Paper](http://www.mathnet.ru/links/df9ecd382b70b1e4bc06d2fe1ecb5f4d/pdma550.pdf) **Abstract:** JavaScript engine security continues to be critical for user safety. Unfortunately, modern fuzzing algorithms cover only a small part of the entire engine. JavaScript engine requires highly structured input â€? JavaScript programs that are syntactically and semantically correct. The most of generated input struggle to pass syntax and semantic correctness checks. In this paper, we describe the extension of the grammar-based fuzzing algorithm. We propose a way of describing grammar for fuzzing using a set of JavaScript source codes. Grammars constructed with our method cover larger part of JavaScript language in comparison with grammars created by describing grammar rules. Another change of the basic algorithm is controlling the context in the mutation process. It allows filtering a lot of inputs that don't give new results. Our experiments show that the improved algorithm has increased speed of finding new paths in the target program. ### Gramatron: Effective Grammar-Aware Fuzzing (ISSTA 2021) * <img src="image/pdf_24px.png">[Paper](https://www.nebelwelt.net/files/21ISSTA.pdf) * <img src="image/youtube.png">[Video](https://youtu.be/QKn1zMkLrO8) **Abstract:** Fuzzers aware of the input grammar can explore deeper program states using grammar-aware mutations. Existing grammar-aware fuzzers are ineffective at synthesizing complex bug triggers due to: (i) grammars introducing a sampling bias during input generation due to their structure, and (ii) the current mutation operators for parse trees performing localized small-scale changes. Gramatron uses grammar automatons in conjunction with aggressive mutation operators to synthesize complex bug triggers faster. We build grammar automatons to address the sampling bias. It restructures the grammar to allow for unbiased sampling from the input state space. We redesign grammar-aware mutation operators to be more aggressive, i.e., perform large-scale changes. Gramatron can consistently generate complex bug triggers in an efficient manner as compared to using conventional grammars with parse trees. Inputs generated from scratch by Gramatron have higher diversity as they achieve up to 24.2% more coverage relative to existing fuzzers. Gramatron makes input generation 98% faster and the input representations are 24% smaller. Our redesigned mutation operators are 6.4× more aggressive while still being 68% faster at performing these mutations. We evaluate Gramatron across three interpreters with 10 known bugs consisting of three complex bug triggers and seven simple bug triggers against two Nautilus variants. Gramatron finds all the complex bug triggers reliably and faster. For the simple bug triggers, Gramatron outperforms Nautilus four out of seven times. To demonstrate Gramatron’s effectiveness in the wild, we deployed Gramatron on three popular interpreters for a 10-day fuzzing campaign where it discovered 10 new vulnerabilities. ### One Engine to Fuzz 'em All: Generic Language Processor Testing with Semantic Validation (S&P 2021) * <img src="image/pdf_24px.png">[Paper](https://www.computer.org/csdl/proceedings-article/sp/2021/893400b217/1t0x95QZOEg) * <img src="image/youtube.png">[Video](https://youtu.be/tcTbXr8zf-Y) * <img src="image/github_24px.png">[Code](https://github.com/s3team/Polyglot) **Abstract:** Language processors, such as compilers and interpreters, are indispensable in building modern software. Errors in language processors can lead to severe consequences, like incorrect functionalities or even malicious attacks. However, it is not trivial to automatically test language processors to find bugs. Existing testing methods (or fuzzers) either fail to generate high-quality (i.e., semantically correct) test cases, or only support limited programming languages. In this paper, we propose POLYGLOT, a generic fuzzing framework that generates high-quality test cases for exploring processors of different programming languages. To achieve the generic applicability, POLYGLOT neutralizes the difference in syntax and semantics of programming languages with a uniform intermediate representation (IR). To improve the language validity, POLYGLOT performs constrained mutation and semantic validation to preserve syntactic correctness and fix semantic errors. We have applied POLYGLOT on 21 popular language processors of 9 programming languages, and identified 173 new bugs, 113 of which are fixed with 18 CVEs assigned. Our experiments show that POLYGLOT can support a wide range of programming languages, and outperforms existing fuzzers with up to 30x improvement in code coverage. ### Growing A Test Corpus with Bonsai Fuzzing (ICSE 2021) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2021/icse-2021-papers/63/Growing-A-Test-Corpus-with-Bonsai-Fuzzing) **Abstract:** This paper presents a coverage-guided grammar-based fuzzing technique for automatically generating a corpus of concise test inputs for programs such as compilers. We walk-through a case study of a compiler designed for education and the corresponding problem of generating meaningful test cases to provide to students. The prior state-of-the-art solution is a combination of fuzzing and test-case reduction techniques such as variants of delta-debugging. Our key insight is that instead of attempting to minimize convoluted fuzzer-generated test inputs, we can instead grow concise test inputs by construction using a form of iterative deepening. We call this approach Bonsai Fuzzing. Experimental results show that Bonsai Fuzzing can generate test corpora having inputs that are 16â€?45% smaller in size on average as compared to a fuzz-then-reduce approach, while achieving approximately the same code coverage and fault-detection capability. ### Favocado: Fuzzing the Binding Code of JavaScript Engines Using Semantically Correct Test Cases (NDSS 2021) * <img src="image/pdf_24px.png">[Paper](https://sefcom.asu.edu/publications/favocado-ndss21.pdf) * <img src="image/github_24px.png">[Code](https://github.com/favocado/Favocado) **Abstract:** JavaScript runtime systems include some specialized programming interfaces, called binding layers. Binding layers translate data representations between JavaScript and unsafe low-level languages, such as C and C++, by converting data between different types. Due to the wide adoption of JavaScript (and JavaScript engines) in the entire computing ecosystem, discovering bugs in JavaScript binding layers is critical. Nonetheless, existing JavaScript fuzzers cannot adequately fuzz binding layers due to two major challenges: Generating syntactically and semantically correct test cases and reducing the size of the input space for fuzzing. In this paper, we propose Favocado, a novel fuzzing approach that focuses on fuzzing binding layers of JavaScript runtime systems. Favocado can generate syntactically and semantically correct JavaScript test cases through the use of extracted semantic information and careful maintaining of execution states. This way, test cases that Favocado generates do not raise unintended runtime exceptions, which substantially increases the chance of triggering binding code. Additionally, exploiting a unique feature (relative isolation) of binding layers, Favocado significantly reduces the size of the fuzzing input space by splitting DOM objects into equivalence classes and focusing fuzzing within each equivalence class. We demonstrate the effectiveness of Favocado in our experiments and show that Favocado outperforms a stateof-the-art DOM fuzzer. Finally, during the evaluation, we find 61 previously unknown bugs in four JavaScript runtime systems (Adobe Acrobat Reader, Foxit PDF Reader, Chromium, and WebKit). 33 of these bugs are security vulnerabilities. ### CMFuzz: context-aware adaptive mutation for fuzzers (Empirical Software Engineering 2021) * <img src="image/pdf_24px.png">[Paper](https://link.springer.com/article/10.1007/s10664-020-09927-3) **Abstract:** Mutation-based fuzzing is a simple yet effective technique to discover bugs and security vulnerabilities in software. Given a set of well-formed initial seeds, mutation-based fuzzers continually generate interesting seeds by applying specific mutation strategy in order to maximize code coverage or the number of unique bugs explored at any point-in-time. However, existing fuzzers remain limited in the paths it could cover since it simply follows a uniform distribution to choose mutation operators. In this paper, we proposed a novel context-aware adaptive mutation scheme, namely CMFuzz, which utilizes a contextual bandit algorithm LinUCB to effectively choose optimal mutation operators for various seed files. To this end, CMFuzz dynamically extracts and encodes file characteristics, which allows mutation-based fuzzers to perform context-aware mutation. We apply this scheme on top of several state-of-the-art fuzzers, i.e., PTfuzz, AFL, and AFLFast, and implement CMFuzz-PT, CMFuzz-AFL, and CMFuzz-AFLFast, respectively. We conduct evaluation on 12 real-world open source applications and LAVA-M dataset against their counterparts. Extensive evaluations demonstrate that CMFuzz-based fuzzers achieve higher code coverage and find more crashes at a faster rate than their counterparts on most cases. Furthermore, we also utilize other mainstream bandit algorithms, e.g., Thompson Sample and epsilon-greedy, and implement Thompson-PT and Greedy-PT based on PTfuzz to examine the performance of proposed model. CMFuzz-PT significantly outperforms Thompson-PT especially in terms of unique crashes and paths, i.e., found 1.79× unique crashes and 1.29× unique paths on average. Compared to Greedy-PT, our approach still increases the amount of unique crashes and paths by 1.11× and 1.05×, respectively. ### Generating Highly-structured Input Data by Combining Search-based Testing and Grammar-based Fuzzing (ASE 2020) * <img src="image/pdf_24px.png">[Paper](https://research.tudelft.nl/en/publications/generating-highly-structured-input-data-by-combining-search-based) **Abstract:** Software testing is an important and time-consuming task that is often done manually. In the last decades, researchers have come up with techniques to generate input data (e.g., fuzzing) and automate the process of generating test cases (e.g., search-based testing). However, these techniques are known to have their own limitations: search-based testing does not generate highly-structured data; grammar-based fuzzing does not generate test case structures. To address these limitations, we combine these two techniques. By applying grammar-based mutations to the input data gathered by the search-based testing algorithm, it allows us to co-evolve both aspects of test case generation. We evaluate our approach, called G-EvoSuite, by performing an empirical study on 20 Java classes from the three most popular JSON parsers across multiple search budgets. Our results show that the proposed approach on average improves branch coverage for JSON related classes by 15% (with a maximum increase of 50%) without negatively impacting other classes. ### Montage: A Neural Network Language Model-Guided JavaScript Engine Fuzzer (Usenix Security2020) * <img src="image/pdf_24px.png">[Paper](https://www.usenix.org/system/files/sec20summer_lee-suyoung_prepub_0.pdf) **Abstract:** JavaScript (JS) engine vulnerabilities pose significant security threats affecting billions of web browsers. While fuzzing is a prevalent technique for finding such vulnerabilities, there have been few studies that leverage the recent advances in neural network language models (NNLMs). In this paper, we present Montage, the first NNLM-guided fuzzer for finding JS engine vulnerabilities. The key aspect of our technique is to transform a JS abstract syntax tree (AST) into a sequence of AST subtrees that can directly train prevailing NNLMs. We demonstrate that Montage is capable of generating valid JS tests, and show that it outperforms previous studies in terms of finding vulnerabilities. Montage found 37 real-world bugs, including three CVEs, in the latest JS engines, demonstrating its efficacy in finding JS engine bugs. ### Fuzzing JavaScript Engines with Aspect-preserving Mutation (S&P 2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#1Nr9y) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2020/07/10/fuzzing-javascript-engines-with-aspect-preserving-mutation/) * <img src="image/pdf_24px.png">[Paper](https://gts3.org/assets/papers/2020/park:die.pdf) * <img src="image/ppt_24px.png">[Slides](https://gts3.org/assets/papers/2020/park:die-slides.pdf) * <img src="image/github_24px.png">[Code](https://github.com/sslab-gatech/DIE) **Abstract:** Fuzzing is a practical, widely-deployed technique to find bugs in complex, real-world programs like JavaScript engines. We observed, however, that existing fuzzing approaches, either generative or mutational, fall short in fully harvesting high-quality input corpora such as known proof of concept (PoC) exploits or unit tests. Existing fuzzers tend to destruct subtle semantics or conditions encoded in the input corpus in order to generate new test cases because this approach helps in discovering new code paths of the program. Nevertheless, for JavaScript-like complex programs, such a conventional design leads to test cases that tackle only shallow parts of the complex codebase and fails to reach deep bugs effectively due to the huge input space. In this paper, we advocate a new technique, called an aspect preserving mutation, that stochastically preserves the desirable properties, called aspects, that we prefer to be maintained across mutation. We demonstrate the aspect preservation with two mutation strategies, namely, structure and type preservation, in our fully-fledged JavaScript fuzzer, called DIE. Our evaluation shows that DIE’s aspect-preserving mutation is more effective in discovering new bugs (5.7× more unique crashes) and producing valid test cases (2.4× fewer runtime errors) than the state-ofthe-art JavaScript fuzzers. DIE newly discovered 48 high-impact bugs in ChakraCore, JavaScriptCore, and V8 (38 fixed with 12 CVEs assigned as of today). The source code of DIE is publicly available as an open-source project. ### Language-Agnostic Generation of Compilable Test Programs (ICST 2020) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/document/9159098) * <img src="image/github_24px.png">[Code](https://github.com/FAU-Inf2/StarSmith) **Abstract:** Testing is an integral part of the development of compilers and other language processors. To automatically create large sets of test programs, random program generators, or fuzzers, have emerged. Unfortunately, existing approaches are either language-specific (and thus require a rewrite for each language) or may generate programs that violate rules of the respective programming language (which limits their usefulness). This work introduces *Smith, a language-agnostic framework for the generation of valid, compilable test programs. It takes as input an abstract attribute grammar that specifies the syntactic and semantic rules of a programming language. It then creates test programs that satisfy all these rules. By aggressively pruning the search space and keeping the construction as local as possible, *Smith can generate huge, complex test programs in short time. We present four case studies covering four real-world programming languages (C, Lua, SQL, and SMT-LIB 2) to show that *Smith is both efficient and effective, while being flexible enough to support programming languages that differ considerably. We found bugs in all four case studies. For example, *Smith detected 165 different crashes in older versions of GCC and LLVM. *Smith and the language grammars are available online. ### Smart Greybox Fuzzing (TSE 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/TSE19_Smart.pdf) **Abstract:** Coverage-based greybox fuzzing (CGF) is one of the most successful approaches for automated vulnerability detection. Given a seed file (as a sequence of bits), a CGF randomly flips, deletes or copies some bits to generate new files. CGF iteratively constructs (and fuzzes) a seed corpus by retaining those generated files which enhance coverage. However, random bitflips are unlikely to produce valid files (or valid chunks in files), for applications processing complex file formats. In this work, we introduce smart greybox fuzzing (SGF) which leverages a high-level structural representation of the seed file to generate new files. We define innovative mutation operators that work on the virtual file structure rather than on the bit level which allows SGF to explore completely new input domains while maintaining file validity. We introduce a novel validity-based power schedule that enables SGF to spend more time generating files that are more likely to pass the parsing stage of the program, which can expose vulnerabilities much deeper in the processing logic. Our evaluation demonstrates the effectiveness of SGF. On several libraries that parse complex chunk-based files, our tool AFLSMART achieves substantially more branch coverage (up to 87% improvement), and exposes more vulnerabilities than baseline AFL. Our tool AFLSMART has discovered 42 zero-day vulnerabilities in widely-used, well-tested tools and libraries; so far 17 CVEs were assigned. ### Semantic Fuzzing with Zest (ISSTA 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#h6RGL) * <img src="image/pdf_24px.png">[Paper](./Paper/ISSTA19_Zest.pdf) **Abstract:** Programs expecting structured inputs often consist of both a syntactic analysis stage, which parses raw input, and a semantic analysis stage, which conducts checks on the parsed input and executes the core logic of the program. Generator-based testing tools in the lineage of QuickCheck are a promising way to generate random syntactically valid test inputs for these programs. We present Zest, a technique which automatically guides QuickCheck-like randominput generators to better explore the semantic analysis stage of test programs. Zest converts random-input generators into deterministic parametric generators. We present the key insight that mutations in the untyped parameter domain map to structural mutations in the input domain. Zest leverages program feedback in the form of code coverage and input validity to perform feedback-directed parameter search. We evaluate Zest against AFL and QuickCheck on five Java programs: Maven, Ant, BCEL, Closure, and Rhino. Zest covers 1.03x-2.81x as many branches within the benchmarks semantic analysis stages as baseline techniques. Further, we find 10 new bugs in the semantic analysis stages of these benchmarks. Zest is the most effective technique in finding these bugs reliably and quickly, requiring at most 10 minutes on average to find each bug. ### Field-aware Evolutionary Fuzzing Based on Input Specifications and Vulnerability Metrics (2019) * <img src="image/pdf_24px.png">[Paper](./Paper/20_Field-aware.pdf.pdf) **Abstract:** Evolutionary fuzzing technology based on genetic algorithm has become one of the most effective vulnerability discovery techniques due to its fast and scalable advantages. How to effectively mutate the seed input plays a crucial role in improving the efficiency of the fuzzing. A good mutation strategy can increase code coverage and vulnerability triggering probability. Existing fuzzing tools generally focus on how to mutate smartly to improve code coverage to find more vulnerabilities (such as passing the branch with magic bytes), but they still face two challenges which substantially reduces the efficiency of vulnerability discovery. First, the input space is huge and current fuzzers are not aware of the input format, resulting in many mutated inputs are invalid. Second, they believe all bytes are equal and mutate them sequentially, wasting lots of time testing some uninteresting bytes. To this end, this paper proposes a field-aware mutation strategy that can find more vulnerabilities by generating fewer but more effective inputs. Specifically, we extract the field and type information of the seed input through the existing input specifications to ensure that the mutation is performed in field level instead of byte level and the optimal mutation strategy is selected. At the same time, the input fields are scored by code assessment based on vulnerability metrics, thus the more important fields (i.e., fields that are more likely to trigger the vulnerability) are prioritized to be mutated. We implemented a prototype tool, FaFuzzer, and evaluated it on two different datasets consisting of a variety of real-world applications. Experiments show that our field-aware strategy can find more vulnerabilities with fewer inputs than existing tools, while maintaining high code coverage. We found many unknown bugs in five widely used real-world applications and reported them to the relevant vendors. ### Parser-Directed Fuzzing (PLDI 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#KuJuN) * <img src="image/pdf_24px.png">[Paper](./Paper/PLDI19_Parser.pdf) **Abstract:** To be effective, software test generation needs to well cover the space of possible inputs. Traditional fuzzing generates large numbers of random inputs, which however are unlikely to contain keywords and other specific inputs of non-trivial input languages. Constraint-based test generation solves conditions of paths leading to uncovered code, but fails on programs with complex input conditions because of path explosion. In this paper, we present a test generation technique specifically directed at input parsers. We systematically produce inputs for the parser and track comparisons made; after every rejection, we satisfy the comparisons leading to rejection. This approach effectively covers the input space: Evaluated on five subjects, from CSV files to JavaScript, our pFuzzer prototype covers more tokens than both random-based and constraint-based approaches, while requiring no symbolic analysis and far fewer tests than random fuzzers. ### GRIMOIRE: Synthesizing Structure while Fuzzing (USENIX Security2019) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX19_Grimoire.pdf) **Abstract:** In the past few years, fuz­zing has re­cei­ved si­gni­fi­cant at­ten­ti­on from the re­se­arch com­mu­ni­ty. Howe­ver, most of this at­ten­ti­on was di­rec­ted towards pro­grams wi­thout a de­di­ca­ted par­sing stage. In such cases, fuz­zers which le­ver­a­ge the input struc­tu­re of a pro­gram can achie­ve a si­gni­fi­cant­ly hig­her code co­ver­a­ge com­pa­red to tra­di­tio­nal fuz­zing ap­proa­ches. This ad­van­ce­ment in co­ver­a­ge is achie­ved by ap­p­ly­ing lar­ge-sca­le mu­ta­ti­ons in the ap­p­li­ca­ti­on's input space. Howe­ver, this im­pro­ve­ment comes at the cost of re­qui­ring ex­pert do­main know­ledge, as these fuz­zers de­pend on struc­tu­re input spe­ci­fi­ca­ti­ons (e.g., gram­mars). Gram­mar in­fe­rence, a tech­ni­que which can au­to­ma­ti­cal­ly ge­ne­ra­te such gram­mars for a given pro­gram, can be used to ad­dress this short­co­ming. Such tech­ni­ques usual­ly infer a pro­gram's gram­mar in a pre-pro­ces­sing step and can miss im­portant struc­tu­res that are un­co­ver­ed only later du­ring nor­mal fuz­zing. In this paper, we pre­sent the de­sign and im­ple­men­ta­ti­on of GRI­MOIRE, a fully au­to­ma­ted co­ver­a­ge-gui­ded fuz­zer which works wi­thout any form of human in­ter­ac­tion or pre-con­fi­gu­ra­ti­on; yet, it is still able to ef­fi­ci­ent­ly test pro­grams that ex­pect high­ly struc­tu­red in­puts. We achie­ve this by per­for­ming lar­ge-sca­le mu­ta­ti­ons in the pro­gram input space using gram­mar-li­ke com­bi­na­ti­ons to syn­the­si­ze new high­ly struc­tu­red in­puts wi­thout any pre-pro­ces­sing step. Our eva­lua­ti­on shows that GRI­MOIRE out­per­forms other co­ver­a­ge-gui­ded fuz­zers when fuz­zing pro­grams with high­ly struc­tu­red in­puts. Fur­ther­mo­re, it im­pro­ves upon exis­ting gram­mar-ba­sed co­ver­a­ge-gui­ded fuz­zers. Using GRI­MOIRE, we iden­ti­fied 19 dis­tinct me­mo­ry cor­rup­ti­on bugs in re­al-world pro­grams and ob­tained 11 new CVEs. ### Life after Speech Recognition: Fuzzing Semantic Misinterpretation for Voice Assistant Applications (NDSS 2019) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS19_Life.pdf) **Abstract:** Popular Voice Assistant (VA) services such as Amazon Alexa and Google Assistant are now rapidly appifying their platforms to allow more flexible and diverse voice-controlled service experience. However, the ubiquitous deployment of VA devices and the increasing number of third-party applications have raised security and privacy concerns. While previous works such as hidden voice attacks mostly examine the problems of VA servicesâ€? default Automatic Speech Recognition (ASR) component, our work analyzes and evaluates the security of the succeeding component after ASR, i.e., Natural Language Understanding (NLU), which performs semantic interpretation (i.e., text-to-intent) after ASR’s acoustic-to-text processing. In particular, we focus on NLU’s Intent Classifier which is used in customizing machine understanding for third-party VA Applications (or vApps). We find that the semantic inconsistency caused by the improper semantic interpretation of an Intent Classifier can create the opportunity of breaching the integrity of vApp processing when attackers delicately leverage some common spoken errors. In this paper, we design the first linguistic-model-guided fuzzing tool, named LipFuzzer, to assess the security of Intent Classifier and systematically discover potential misinterpretation-prone spoken errors based on vAppsâ€? voice command templates. To guide the fuzzing, we construct adversarial linguistic models with the help of Statistical Relational Learning (SRL) and emerging Natural Language Processing (NLP) techniques. In evaluation, we have successfully verified the effectiveness and accuracy of LipFuzzer. We also use LipFuzzer to evaluate both Amazon Alexa and Google Assistant vApp platforms. We have identified that a large portion of real-world vApps are vulnerable based on our fuzzing result. ### SLF: Fuzzing without Valid Seed Inputs (ICSE 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#mhYUc) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE19_SLF.pdf) **Abstract:** Fuzzing is an important technique to detect software bugs and vulnerabilities. It works by mutating a small set of seed inputs to generate a large number of new inputs. Fuzzersâ€? performance often substantially degrades when valid seed inputs are not available. Although existing techniques such as symbolic execution can generate seed inputs from scratch, they have various limitations hindering their applications in real-world complex software without source code. In this paper, we propose a novel fuzzing technique that features the capability of generating valid seed inputs. It piggy-backs on AFL to identify input validity checks and the input fields that have impact on such checks. It further classifies these checks according to their relations to the input. Such classes include arithmetic relation, object offset, data structure length and so on. A multi-goal search algorithm is developed to apply class specific mutations in order to satisfy inter-dependent checks all together. We evaluate our technique on 20 popular benchmark programs collected from other fuzzing projects and the Google fuzzer test suite, and compare it with existing fuzzers AFL and AFLFast, symbolic execution engines KLEE and S2E, and a hybrid tool Driller that combines fuzzing with symbolic execution. The results show that our technique is highly effective and efficient, out-performing the other tools. ### Superion: Grammar-Aware Greybox Fuzzing (ICSE 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#uJyov) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE19_Superion.pdf) **Abstract:** In recent years, coverage-based greybox fuzzing has proven itself to be one of the most effective techniques for finding security bugs in practice. Particularly, American Fuzzy Lop (AFL for short) is deemed to be a great success in fuzzing relatively simple test inputs. Unfortunately, when it meets structured test inputs such as XML and JavaScript, those grammar-blind trimming and mutation strategies in AFL hinder the effectiveness and efficiency. To this end, we propose a grammar-aware coverage-based grey-box fuzzing approach to fuzz programs that process structured inputs. Given the grammar (which is often publicly available) of test inputs, we introduce a grammar-aware trimming strategy to trim test inputs at the tree level using the abstract syntax trees (ASTs) of parsed test inputs. Further, we introduce two grammar-aware mutation strategies (i.e., enhanced dictionary-based mutation and tree-based mutation). Specifically, tree-based mutation works via replacing subtrees using the ASTs of parsed test inputs. Equipped with grammar-awareness, our approach can carry the fuzzing exploration into width and depth. We implemented our approach as an extension to AFL, named Superion; and evaluated the effectiveness of Superion on real-life large-scale programs (a XML engine libplist and three JavaScript engines WebKit, Jerryscript and ChakraCore). Our results have demonstrated that Superion can improve the code coverage (i.e., 16.7% and 8.8% in line and function coverage) and bug-finding capability (i.e., 30 new bugs, among which we discovered 21 new vulnerabilities with 16 CVEs assigned and 3.2K USD bug bounty rewards received) over AFL and jsfunfuzz. ### ProFuzzer: On-the-fly Input Type Probing for Better Zero-day Vulnerability Discovery (S&P 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#u2wje) * <img src="image/zhihu.png">[Reading Note](https://zhuanlan.zhihu.com/p/130901035) * <img src="image/pdf_24px.png">[Paper](./Paper/SP19_Profuzz.pdf) * <img src="image/ppt_24px.png">[Slides](https://www.inforsec.org/wp/wp-content/uploads/2020/01/%E6%B8%B8%E4%BC%9F-ProFuzzer-Wei-You.pdf) * <img src="image/github_24px.png">[POC](https://github.com/profuzzer) **Abstract:** Existing mutation based fuzzers tend to randomly mutate the input of a program without understanding its underlying syntax and semantics. In this paper, we propose a novel on-the-fly probing technique (called ProFuzzer) that automatically recovers and understands input fields of critical importance to vulnerability discovery during a fuzzing process and intelligently adapts the mutation strategy to enhance the chance of hitting zero-day targets. Since such probing is transparently piggybacked to the regular fuzzing, no prior knowledge of the input specification is needed. During fuzzing, individual bytes are first mutated and their fuzzing results are automatically analyzed to link those related together and identify the type for the field connecting them; these bytes are further mutated together following type-specific strategies, which substantially prunes the search space. We define the probe types generally across all applications, thereby making our technique application agnostic. Our experiments on standard benchmarks and real-world applications show that ProFuzzer substantially outperforms AFL and its optimized version AFLFast, as well as other state-of-art fuzzers including VUzzer, Driller and QSYM. Within two months, it exposed 42 zero-days in 10 intensively tested programs, generating 30 CVEs. ### CodeAlchemist: Semantics-Aware Code Generation to Find Vulnerabilities in JavaScript Engines (NDSS 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#CfBUR) * <img src="image/blog_24px.jpg">[Reading Note from dawuge](https://dawuge.github.io/2019/10/31/CodeAlchemistandT-Fuzz/) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS19_CodeAlchemist.pdf) * <img src="image/ppt_24px.png">[Slides](./Paper/NDSS19_CodeAlchemist_slidesz.pdf) **Abstract:** JavaScript engines are an attractive target for attackers due to their popularity and flexibility in building exploits. Current state-of-the-art fuzzers for finding JavaScript engine vulnerabilities focus mainly on generating syntactically correct test cases based on either a predefined context-free grammar or a trained probabilistic language model. Unfortunately, syntactically correct JavaScript sentences are often semantically invalid at runtime. Furthermore, statically analyzing the semantics of JavaScript code is challenging due to its dynamic nature: JavaScript code is generated at runtime, and JavaScript expressions are dynamically-typed. To address this challenge, we propose a novel test case generation algorithm that we call semantics-aware assembly, and implement it in a fuzz testing tool termed CodeAlchemist. Our tool can generate arbitrary JavaScript code snippets that are both semantically and syntactically correct, and it effectively yields test cases that can crash JavaScript engines. We found numerous vulnerabilities of the latest JavaScript engines with CodeAlchemist and reported them to the vendors. ### NAUTILUS: Fishing for Deep Bugs with Grammars (NDSS 2019) * <img src="image/wechat_24px.png">[Reading Note From BAIZE](https://mp.weixin.qq.com/s/8TaYwNTeNsAMFr0UNNNMHg) * <img src="image/pdf_24px.png">[Paper](./Paper/NDSS19_Nautilus.pdf) * <img src="image/ppt_24px.png">[Slides](https://www.ndss-symposium.org/wp-content/uploads/ndss2019_04A-3_Aschermann_slides.pdf) * <img src="image/github_24px.png">[Code](https://github.com/RUB-SysSec/nautilus) **Abstract:** Fuzzing is a well-known method for efficiently identifying bugs in programs.Unfortunately, when fuzzing targets that require highly-structured inputs such as interpreters, many fuzzing methods struggle to pass the syntax checks. More specifically, interpreters often process inputs in multiple stages: first syntactic, then semantic correctness is checked. Only if these checks are passed, the interpreted code gets executed. This prevents fuzzers from executing ``deeper'' --- and hence potentially more interesting --- code. Typically two valid inputs that lead to the execution of different features in the target application require too many mutations for simple mutation-based fuzzers to discover: making small changes like bit flips usually only leads to the execution of error paths in the parsing engine. So-called grammar fuzzers are able to pass the syntax checks by using Context-Free Grammars. Using feedback can significantly increase the efficiency of fuzzing engines. Hence, it is commonly used in state-of-the-art mutational fuzzers that do not use grammars. Yet, grammar fuzzers do not make use of code coverage, i.e., they do not know whether any input triggers new functionality or not. In this paper, we propose NAUTILUS, a method to efficiently fuzz programs that require highly-structured inputs by combining the use of grammars with the use of code coverage feedback. This allows us to recombine aspects of interesting inputs that were learned individually, and to dramatically increase the probability that any generated input will be accepted by the parser. We implemented a proof-of-concept fuzzer that we tested on multiple targets, including ChakraCore (the JavaScript engine of Microsoft Edge), PHP, mruby, and Lua. NAUTILUS identified multiple bugs in all of the targets: Seven in mruby, three in PHP, two in ChakraCore, and one in Lua. Reporting these bugs was awarded with a sum of 2600 USD and 6 CVEs were assigned. Our experiments show that combining context-free grammars and feedback-driven fuzzing significantly outperforms state-of-the-art approaches like American Fuzzy Lop (AFL) by an order of magnitude and grammar fuzzers by more than a factor of two when measuring code coverage. ### TIFF: Using Input Type Inference To Improve Fuzzing (ACSAC 2018) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#M4YZI) * <img src="image/pdf_24px.png">[Paper](./Paper/ACSAC18_TIFF.pdf) * <img src="image/github_24px.png">[Code](https://github.com/vusec/tiff) **Abstract:** Developers commonly use fuzzing techniques to hunt down all manner of memory corruption vulnerabilities during the testing phase. Irrespective of the fuzzer, input mutation plays a central role in providing adequate code coverage, as well as in triggering bugs. However, each class of memory corruption bugs requires a different trigger condition. While the goal of a fuzzer is to find bugs, most existing fuzzers merely approximate this goal by targeting their mutation strategies toward maximizing code coverage. In this work, we present a new mutation strategy that maximizes the likelihood of triggering memory-corruption bugs by generating fewer, but better inputs. In particular, our strategy achieves bug- directed mutation by inferring the type of the input bytes. To do so, it tags each offset of the input with a basic type (e.g., 32-bit integer, string, array etc.), while deriving mutation rules for specific classes of bugs, We infer types by means of in-memory data-structure identification and dynamic taint analysis, and implement our novel mutation strategy in a fully functional fuzzer which we call TIFF (Type Inference-based Fuzzing Framework). Our evaluation on real-world applications shows that type-based fuzzing triggers bugs much earlier than existing solutions, while maintaining high code coverage. For example, on several real-world applications and libraries (e.g., poppler, mpg123 etc.), we find real bugs (with known CVEs) in almost half of the time and upto an order of magnitude fewer inputs than state-of-the-art fuzzers. ### Skyfire: Data-Driven Seed Generation for Fuzzing (S&P 2017) * <img src="image/pdf_24px.png">[Paper](./Paper/SP17_Skyfire.pdf) **Abstract:** Programs that take highly-structured files as inputs normally process inputs in stages: syntax parsing, semantic checking, and application execution. Deep bugs are often hidden in the application execution stage, and it is non-trivial to automatically generate test inputs to trigger them. Mutation-based fuzzing generates test inputs by modifying well-formed seed inputs randomly or heuristically. Most inputs are rejected at the early syntax parsing stage. Differently, generation-based fuzzing generates inputs from a specification (e.g., grammar). They can quickly carry the fuzzing beyond the syntax parsing stage. However, most inputs fail to pass the semantic checking (e.g., violating semantic rules), which restricts their capability of discovering deep bugs. In this paper, we propose a novel data-driven seed generation approach, named Skyfire, which leverages the knowledge in the vast amount of existing samples to generate well-distributed seed inputs for fuzzing programs that process highly-structured inputs. Skyfire takes as inputs a corpus and a grammar, and consists of two steps. The first step of Skyfire learns a probabilistic context-sensitive grammar (PCSG) to specify both syntax features and semantic rules, and then the second step leverages the learned PCSG to generate seed inputs. We fed the collected samples and the inputs generated by Skyfire as seeds of AFL to fuzz several open-source XSLT and XML engines (i.e., Sablotron, libxslt, and libxml2). The results have demonstrated that Skyfire can generate well-distributed inputs and thus significantly improve the code coverage (i.e., 20% for line coverage and 15% for function coverage on average) and the bug-finding capability of fuzzers. We also used the inputs generated by Skyfire to fuzz the closed-source JavaScript and rendering engine of Internet Explorer 11. Altogether, we discovered 19 new memory corruption bugs (among which there are 16 new vulnerabilities and received 33.5k USD bug bounty rewards) and 32 denial-of-service bugs. # Exploit Generation ### ETHPLOIT: From Fuzzing to Efficient Exploit Generation against Smart Contracts (SANER2020) * <img src="image/pdf_24px.png">[Paper](./Paper/SANER20_ETHPLOIT.pdf) * <img src="image/ppt_24px.png">[Slides](https://loccs.sjtu.edu.cn/~romangol/slides/saner20b.pdf) **Abstract:** Smart contracts, programs running on blockchain systems, leverage diverse decentralized applications (DApps). Unfortunately, well-known smart contract platforms, Ethereum for example, face serious security problems. Exploits to contracts may cause enormous financial losses, which emphasize the importance of smart contract testing. However, current exploit generation tools have difficulty to solve hard constraints in execution paths and cannot simulate the blockchain behaviors very well. These problems cause a loss of coverage and accuracy of exploit generation. To overcome the problems, we design and implement ETHPLOIT, a smart contract exploit generator based on fuzzing. ETHPLOIT adopts static taint analysis to generate exploit targeted transaction sequences, a dynamic seed strategy to pass hard constraints and an instrumented Ethereum Virtual Machine to simulate blockchain behaviors. We evaluate ETHPLOIT on 45,308 smart contracts and discovered 554 exploitable contracts. ETHPLOIT automatically generated 644 exploits without any false positive and 306 of them cannot be generated by previous exploit generation tools. ### Gollum: Modular and Greybox Exploit Generation for Heap Overflows in Interpreters (CCS 2019) * <img src="image/pdf_24px.png">[Paper](https://www.kroening.com/papers/ccs2019.pdf) **Abstract:** We present the first approach to automatic exploit generation for heap overflows in interpreters. It is also the first approach to exploit generation in any class of program that integrates a solution for automatic heap layout manipulation. At the core of the approach is a novel method for discovering exploit primitives---inputs to the target program that result in a sensitive operation, such as a function call or a memory write, utilizing attacker-injected data. To produce an exploit primitive from a heap overflow vulnerability, one has to discover a target data structure to corrupt, ensure an instance of that data structure is adjacent to the source of the overflow on the heap, and ensure that the post-overflow corrupted data is used in a manner desired by the attacker. Our system addresses all three tasks in an automatic, greybox, and modular manner. Our implementation is called GOLLUM, and we demonstrate its capabilities by producing exploits from 10 unique vulnerabilities in the PHP and Python interpreters, 5 of which do not have existing public exploits. ### From proof-of-concept to exploitable (Cybersecurity 2019) * <img src="image/pdf_24px.png">[Paper](https://cybersecurity.springeropen.com/track/pdf/10.1186/s42400-019-0028-9) * <img src="image/ppt_24px.png">[Slides](./Paper/CCS18_Revery_Slides) * <img src="image/youtube.png">[Video](https://www.youtube.com/watch?v=QsG_nTBSN4c) **Abstract:** Exploitability assessment of vulnerabilities is important for both defenders and attackers. The ultimate way to assess the exploitability is crafting a working exploit. However, it usually takes tremendous hours and significant manual efforts. To address this issue, automated techniques can be adopted. Existing solutions usually explore in depth the crashing paths, i.e., paths taken by proof-of-concept (PoC) inputs triggering vulnerabilities, and assess exploitability by finding exploitable states along the paths. However, exploitable states do not always exist in crashing paths. Moreover, existing solutions heavily rely on symbolic execution and are not scalable in path exploration and exploit generation. In this paper, we propose a novel solution to generate exploit for userspace programs or facilitate the process of crafting a kernel UAF exploit. Technically, we utilize oriented fuzzing to explore diverging paths from vulnerability point. For userspace programs, we adopt a control-flow stitching solution to stitch crashing paths and diverging paths together to generate exploit. For kernel UAF, we leverage a lightweight symbolic execution to identify, analyze and evaluate the system calls valuable and useful for exploiting vulnerabilities. We have developed a prototype system and evaluated it on a set of 19 CTF (capture the flag) programs and 15 realworld Linux kernel UAF vulnerabilities. Experiment results showed it could generate exploit for most of the userspace test set, and it could also facilitate security mitigation bypassing and exploitability evaluation for kernel test set. ### Revery: From Proof-of-Concept to Exploitable (CCS 2018) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS18_Revery.pdf) * <img src="image/ppt_24px.png">[Slides](./Paper/CCS18_Revery_Slides) * <img src="image/youtube.png">[Video](https://www.youtube.com/watch?v=QsG_nTBSN4c) **Abstract:** Automatic exploit generation is an open challenge. Existing solutions usually explore in depth the crashing paths, i.e., paths taken by proof-of-concept (POC) inputs triggering vulnerabilities, and generate exploits when exploitable states are found along the paths. However, exploitable states do not always exist in crashing paths. Moreover, existing solutions heavily rely on symbolic execution and are not scalable in path exploration and exploit generation. In addition, few solutions could exploit heap-based vulnerabilities. In this paper, we propose a new solution revery to search for exploitable states in paths diverging from crashing paths, and generate control-flow hijacking exploits for heap-based vulnerabilities. It adopts three novel techniques:(1) a digraph to characterize a vulnerability's memory layout and its contributor instructions;(2) a fuzz solution to explore diverging paths, which have similar memory layouts as the crashing paths, in order to search more exploitable states and generate corresponding diverging inputs;(3) a stitch solution to stitch crashing paths and diverging paths together, and synthesize EXP inputs able to trigger both vulnerabilities and exploitable states. We have developed a prototype of revery based on the binary analysis engine angr, and evaluated it on a set of 19 real world CTF (capture the flag) challenges. Experiment results showed that it could generate exploits for 9 (47%) of them, and generate EXP inputs able to trigger exploitable states for another 5 (26%) of them. ### SemFuzz: Semantics-based Automatic Generation of Proof-of-Concept Exploits (CCS 2017) * <img src="image/pdf_24px.png">[Paper](./Paper/CCS17_SemFuzz.pdf) **Abstract:** Patches and related information about software vulnerabilities are often made available to the public, aiming to facilitate timely fixes. Unfortunately, the slow paces of system updates (30 days on average) often present to the attackers enough time to recover hidden bugs for attacking the unpatched systems. Making things worse is the potential to automatically generate exploits on input-validation flaws through reverse-engineering patches, even though such vulnerabilities are relatively rare (e.g., 5% among all Linux kernel vulnerabilities in last few years). Less understood, however, are the implications of other bug-related information (e.g., bug descriptions in CVE), particularly whether utilization of such information can facilitate exploit generation, even on other vulnerability types that have never been automatically attacked. In this paper, we seek to use such information to generate proof-of-concept (PoC) exploits for the vulnerability types never automatically attacked. Unlike an input validation flaw that is often patched by adding missing sanitization checks, fixing other vulnerability types is more complicated, usually involving replacement of the whole chunk of code. Without understanding of the code changed, automatic exploit becomes less likely. To address this challenge, we present SemFuzz, a novel technique leveraging vulnerability-related text (e.g., CVE reports and Linux git logs) to guide automatic generation of PoC exploits. Such an end-to-end approach is made possible by natural-language processing (NLP) based information extraction and a semantics-based fuzzing process guided by such information. Running over 112 Linux kernel flaws reported in the past five years, SemFuzz successfully triggered 18 of them, and further discovered one zero-day and one undisclosed vulnerabilities. These flaws include use-after-free, memory corruption, information leak, etc., indicating that more complicated flaws can also be automatically attacked. This finding calls into question the way vulnerability-related information is shared today. ### ExploitMeter: Combining Fuzzing with Machine Learning for Automated Evaluation of Software Exploitability (PAC 2017) * <img src="image/pdf_24px.png">[Paper](./Paper/PAC17_ExploitMeter.pdf) **Abstract:** Exploitable software vulnerabilities pose severe threats to its information security and privacy. Although a great amount of efforts have been dedicated to improving software security, research on quantifying software exploitability is still in its infancy. In this work, we propose ExploitMeter, a fuzzing-based framework of quantifying software exploitability that facilitates decision-making for software assurance and cyber insurance. Designed to be dynamic, efficient and rigorous, ExploitMeter integrates machine learning-based prediction and dynamic fuzzing tests in a Bayesian manner. Using 100 Linux applications, we conduct extensive experiments to evaluate the performance of ExploitMeter in a dynamic environment. # Parallel / Ensemble Fuzzing ### UltraFuzz: Towards Resource-saving in Distributed Fuzzing (TSE 2022) * <img src="image/pdf_24px.png">[Paper](https://ieeexplore.ieee.org/abstract/document/9939114) * <img src="image/gitlink_24px.png">[Code](https://gitlink.org.cn/hunter-2018/Ultrafuzz) **Abstract:** Recent research has sought to improve fuzzing performance via parallel computing. However, researchers focus on improving efficiency while ignoring the increasing cost of testing resources. Parallel fuzzing in the distributed environment amplifies the resource-wasting problem caused by the random nature of fuzzing. In the parallel mode, owing to the lack of an appropriate task dispatching scheme and timely fuzzing status synchronization among different fuzzing instances, task conflicts and workload imbalance occur, making the resource-wasting problem severe. In this paper, we design UltraFuzz, a fuzzer for resource-saving in distributed fuzzing. Based on centralized dynamic scheduling, UltraFuzz can dispatch tasks and schedule power globally and reasonably to avoid resource-wasting. Besides, UltraFuzz can elastically allocate computing power for fuzzing and seed evaluation, thereby avoiding the potential bottleneck of seed evaluation that blocks the fuzzing process. UltraFuzz was evaluated using real-world programs, and the results show that with the same testing resource, UltraFuzz outperforms state-of-the-art tools, such as AFL, AFL-P, PAFL, and EnFuzz. Most importantly, the experiment reveals certain results that seem counter-intuitive, namely that parallel fuzzing can achieve "super-linear acceleration" when compared with single-core fuzzing. We conduct additional experiments to reveal the deep reasons behind this phenomenon and dig deep into the inherent advantages of parallel fuzzing over serial fuzzing, including the global optimization of seed energy scheduling and the escape of local optimal seed. Additionally, 24 real-world vulnerabilities were discovered using UltraFuzz. ### Towards Systematic and Dynamic Task Allocation for Collaborative Parallel Fuzzing (ASE 2021 NIER) * <img src="image/pdf_24px.png">[Paper](https://thuanpv.github.io/publications/AFLTeam-ASE21-NIER.pdf) * <img src="image/github_24px.png">[Code](https://github.com/MelbourneFuzzingHub/aflteam) **Abstract:** Parallel coverage-guided greybox fuzzing is the most common setup for vulnerability discovery at scale. However, so far it has received little attention from the research community compared to single-mode fuzzing, leaving open several problems particularly in its task allocation strategies. Current approaches focus on managing micro tasks, at the seed input level, and their task division algorithms are either ad-hoc or static. In this paper, we leverage research on graph partitioning and search algorithms to propose a systematic and dynamic task allocation solution that works at the macro-task level. First, we design an attributed graph to capture both the program structures (e.g., program call graph) and fuzzing information (e.g., branch hit counts, bug discovery probability). Second, our graph partitioning algorithm divides the global program search space into sub-search-spaces. Finally our search algorithm prioritizes these sub-search-spaces (i.e., tasks) and explores them to maximize code coverage and number of bugs found. The results are collected to update the graph and guide further iterations of partitioning and exploration. We implemented a prototype tool called AFLTeam. In our preliminary experiments on well-tested benchmarks, AFLTeam achieved higher code coverage (up to 16.4% branch coverage improvement) compared to the default parallel mode of AFL and discovered 2 zero-day bugs in FFmpeg and JasPer toolkits. ### CollabFuzz: A Framework for Collaborative Fuzzing (EuroSec 2021) * <img src="image/pdf_24px.png">[Paper](./Paper/Eurosec21_Collabfuzz.pdf) **Abstract:** In the recent past, there has been lots of work on improving fuzz testing. In prior work, EnFuzz showed that by sharing progress among different fuzzers, they can perform better than the sum of their parts. In this paper, we continue this line of work and present CollabFuzz, a collaborative fuzzing framework allowing multiple different fuzzers to collaborate under an informed scheduling policy based on a number of central analyses. More specifically, CollabFuzz is a generic framework that allows a user to express different test case scheduling policies, such as the collaborative approach presented by EnFuzz. CollabFuzz can control which tests cases are handed out to what fuzzer and allows the orchestration of different fuzzers across the network. Furthermore, it allows the centralized analysis of the test cases generated by the various fuzzers under its control, allowing to implement scheduling policies based on the results of arbitrary program (e.g., data-flow) analysis. ### Improving Web Application Vulnerability Detection Leveraging Ensemble Fuzzing (ENASE 2021) * <img src="image/pdf_24px.png">[Paper](http://www.di.fc.ul.pt/~imedeiros/papers/ENASE2021_Fuzzing.pdf) **Abstract:** The vast majority of online services we use nowadays provide their web application to the users. The correctness of the source code of these applications is crucial to prevent attackers from exploiting its vulnerabilities, leading to severe consequences like the disclosure of sensitive information or the degradation of the availability of the application. Currently, multiple existent solutions analyse and detect vulnerabilities in the source code. Attackers, however, do not usually have access to the source code and must work with the information that is made public. Their goals are clear â€? exploit vulnerabilities without accessing the code â€?, and they resort of black-box fuzzing tools to achieve such. In this paper, we propose an ensemble fuzzing approach to check the correctness of the web applications from the point of view of an attacker and, in a posterior phase, analyse the source code to correlate with the collected information. The approach focuses first on the quality of fuzzersâ€? crawlers and afterwards on fuzzers capabilities of exploiting the results of all crawlers between them, in order to provide better coverage and precision in the detection of web vulnerabilities. Our preliminary results show that the ensemble performs better than fuzzers individually. ### Cupid: Automatic Fuzzer Selection for Collaborative Fuzzing (ACSAC 2020) * <img src="image/pdf_24px.png">[Paper](https://www.syssec.ruhr-uni-bochum.de/media/emma/veroeffentlichungen/2020/09/26/ACSAC20-Cupid_TiM9H07.pdf) **Abstract:** Combining the strengths of individual fuzzing methods is an appealing idea to find software faults more efficiently, especially when the computing budget is limited. In prior work, EnFuzz introduced the idea of ensemble fuzzing and devised three heuristics to classify properties of fuzzers in terms of diversity. Based on these heuristics, the authors manually picked a combination of different fuzzers that collaborate. In this paper, we generalize this idea by collecting and applying empirical data from single, isolated fuzzer runs to automatically identify a set of fuzzers that complement each other when executed collaboratively. To this end, we present Cupid, a collaborative fuzzing framework allowing automated, data-driven selection of multiple complementary fuzzers for parallelized and distributed fuzzing. We evaluate the automatically selected target-independent combination of fuzzers by Cupid on Google’s fuzzer-test-suite, a collection of real-world binaries, as well as on the synthetic Lava-M dataset. We find that Cupid outperforms two expert-guided, targetspecific and hand-picked combinations on Google’s fuzzer-test-suite in terms of branch coverage, and improves bug finding on Lava-M by 10%. Most importantly, we improve the latency for obtaining 95% and 99% of the coverage by 90% and 64%, respectively. Furthermore, Cupid reduces the amount of CPU hours needed to find a high-performing combination of fuzzers by multiple orders of magnitude compared to an exhaustive evaluation. ### EnFuzz: Ensemble Fuzzing with Seed Synchronization among Diverse Fuzzers (USENIX Security2019) * <img src="image/wechat_24px.png">[Reading Note](https://mp.weixin.qq.com/s/wjp-54oevmK4XNAuEi_AnA) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX19_EnFuzz.pdf) **Abstract:** Fuzzing is widely used for software vulnerability detection. There are various kinds of fuzzers with different fuzzing strategies, and most of them perform well on their targets. However, in industry practice and empirical study, the performance and generalization ability of those well-designed fuzzing strategies are challenged by the complexity and diversity of real-world applications. In this paper, inspired by the idea of ensemble learning, we first propose an ensemble fuzzing approach EnFuzz, that integrates multiple fuzzing strategies to obtain better performance and generalization ability than that of any constituent fuzzer alone. First, we define the diversity of the base fuzzers and choose those most recent and well-designed fuzzers as base fuzzers. Then, EnFuzz ensembles those base fuzzers with seed synchronization and result integration mechanisms. For evaluation, we implement EnFuzz , a prototype basing on four strong open-source fuzzers (AFL, AFLFast, AFLGo, FairFuzz), and test them on Google's fuzzing test suite, which consists of widely used real-world applications. The 24-hour experiment indicates that, with the same resources usage, these four base fuzzers perform variously on different applications, while EnFuzz shows better generalization ability and always outperforms others in terms of path coverage, branch coverage and crash discovery. Even compared with the best cases of AFL, AFLFast, AFLGo and FairFuzz, EnFuzz discovers 26.8%, 117%, 38.8% and 39.5% more unique crashes, executes 9.16%, 39.2%, 19.9% and 20.0% more paths and covers 5.96%, 12.0%, 21.4% and 11.1% more branches respectively. ### PAFL: Extend FuzzingOptimizations of Single Mode to Industrial Parallel Mode (ESEC/FSE 2018) * <img src="image/wechat_24px.png">[Reading Note](https://mp.weixin.qq.com/s/wjp-54oevmK4XNAuEi_AnA) * <img src="image/pdf_24px.png">[Paper](http://wingtecher.com/themes/WingTecherResearch/assets/papers/fse18-pafl.pdf) **Abstract:** Researchers have proposed many optimizations to improve the efficiency of fuzzing, and most optimized strategies work very well on their targets when running in single mode with instantiating one fuzzer instance. However, in real industrial practice, most fuzzers run in parallel mode with instantiating multiple fuzzer instances, and those optimizations, unfortunately, fail to maintain the efficiency improvements. In this paper, we present PAFL, a framework that utilizes efficient guiding information synchronization and task division to extend those existing fuzzing optimizations of single-mode to industrial parallel mode. With an additional data structure to store the guiding information, the synchronization ensures the information is shared and updated among different fuzzer instances timely. Then, the task division promotes the diversity of fuzzer instances by splitting the fuzzing task into several sub-tasks based on branch bitmap. We first evaluate PAFL using 12 different real-world programs from Google fuzzer-test-suite. Results show that in parallel mode, two AFL improvers–AFLFast and FairFuzz do not outperform AFL, which is different from the case in a single mode. However, when augmented with PAFL, the performance of AFLFast and FairFuzz in parallel mode improves. They cover 8% and 17% more branches, trigger 79% and 52% more unique crashes. For further evaluation of more widely-used software systems from GitHub, optimized fuzzers augmented with PAFL find more real bugs, and 25 of which are security-critical vulnerabilities registered as CVEs in the US National Vulnerability Database. # Sanitizer-guided Fuzzing ### ParmeSan: Sanitizer-guided Greybox Fuzzing (USENIX Security2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#TieIo) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2020/09/04/parmesan-sanitizer-guided-greybox-fuzzing/) * <img src="image/pdf_24px.png">[Paper](./Paper/USENIX20_ParmeSan.pdf) * <img src="image/github_24px.png">[Code](https://github.com/vusec/parmesan) **Abstract:** One of the key questions when fuzzing is where to look for vulnerabilities. Coverage-guided fuzzers indiscriminately optimize for covering as much code as possible given that bug coverage often correlates with code coverage. Since code coverage overapproximates bug coverage, this approach is less than ideal and may lead to non-trivial time-to-exposure (TTE) of bugs. Directed fuzzers try to address this problem by directing the fuzzer to a basic block with a potential vulnerability. This approach can greatly reduce the TTE for a specific bug, but such special-purpose fuzzers can then greatly underapproximate overall bug coverage. In this paper, we present sanitizer-guided fuzzing, a new design point in this space that specifically optimizes for bug coverage. For this purpose, we make the key observation that while the instrumentation performed by existing software sanitizers are regularly used for detecting fuzzer-induced error conditions, they can further serve as a generic and effective mechanism to identify interesting basic blocks for guiding fuzzers. We present the design and implementation of ParmeSan, a new sanitizer-guided fuzzer that builds on this observation. We show that ParmeSan greatly reduces the TTE of real-world bugs, and finds bugs 37% faster than existing state-of-the-art coverage-based fuzzers (Angora) and 288% faster than directed fuzzers (AFLGo), while still covering the same set of bugs. # State / Sequence Guided Fuzzing ### Stateful Greybox Fuzzing (USENIX Security 2022) * <img src="image/pdf_24px.png">[Paper](https://mboehme.github.io/paper/USENIX22.pdf) **Abstract:** Many protocol implementations are reactive systems, where the protocol process is in continuous interaction with other processes and the environment. If a bug can be exposed only in a certain state, a fuzzer needs to provide a specific sequence of events as inputs that would take protocol into this state before the bug is manifested. We call these bugs as "stateful" bugs. Usually, when we are testing a protocol implementation, we do not have a detailed formal specification of the protocol to rely upon. Without knowledge of the protocol, it is inherently difficult for a fuzzer to discover such stateful bugs. A key challenge then is to cover the state space without an explicit specification of the protocol. In this work, we posit that manual annotations for state identification can be avoided for stateful protocol fuzzing. Specifically, we rely on a programmatic intuition that the state variables used in protocol implementations often appear in enum type variables whose values (the state names) come from named constants. In our analysis of the Top-50 most widely used open-source protocol implementations, we found that every implementation uses state variables that are assigned named constants (with easy to comprehend names such as INIT, READY) to represent the current state. In this work, we propose to automatically identify such state variables and track the sequence of values assigned to them during fuzzing to produce a "map" of the explored state space. Our experiments confirm that our stateful fuzzer discovers stateful bugs twice as fast as the baseline greybox fuzzer that we extended. Starting from the initial state, our fuzzer exercises one order of magnitude more state/transition sequences and covers code two times faster than the baseline fuzzer. Several zero-day bugs in prominent protocol implementations were found by our fuzzer, and 8 CVEs have been assigned. ### Linear-time Temporal Logic guided Greybox Fuzzing (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/46/Linear-time-Temporal-Logic-guided-Greybox-Fuzzing) **Abstract:** Software model checking is a verification technique which is widely used for checking temporal properties of software systems. Even though it is a property verification technique, its common usage in practice is in “bug findingâ€?, that is, finding violations of temporal properties. Motivated by this observation and leveraging the recent progresses in fuzzing, we build a greybox fuzzing framework to find violations of Linear-time Temporal Logic (LTL) properties. Our framework takes as input a sequential program written in C, and an LTL property. It finds violations, or counter-example traces, of the LTL property in stateful software systems; however, it does not achieve verification. Our work substantially extends directed greybox fuzzing to witness arbitrarily complex event orderings. We note that existing directed greybox fuzzing approaches are limited to witnessing reaching a location or witnessing simple event orderings like use-after-free. At the same time, compared to model checkers, our approach finds the counter-examples faster, thereby finding more counterexamples within a given time budget. Our LTL-fuzzer tool, built on top of the AFL fuzzer, is shown to be effective in detecting bugs in well-known protocol implementations, such as OpenSSL and Telnet. We use LTL-fuzzer to reproduce known vulnerabilities (CVEs), to find 15 zero-day bugs by checking properties extracted from RFCs (for which 9 CVEs have been assigned), and to find violations of both safety as well as liveness properties in real-world protocol implementations. Our work represents a practical advance over software model checkers â€? while simultaneously also representing a conceptual advance over existing greybox fuzzers. Our work provides a starting point for understanding the unexplored synergies between software model checking and greybox fuzzing. ### Rtkaller: State-aware Task Generation for RTOS Fuzzing (EMSOFT 2021) * <img src="image/pdf_24px.png">[Paper](http://www.wingtecher.com/themes/WingTecherResearch/assets/papers/emsoft21.pdf) **Abstract:** A real-time operating system (RTOS) is an operating system designed to meet certain real-time requirements. It is widely used in embedded applications, and its correctness is safety-critical. However, the validation of RTOS is challenging due to its complex real-time features and large code base. In this paper, we propose Rtkaller, a state-aware kernel fuzzer for the vulnerability detection in RTOS. First, Rtkaller implements an automatic task initialization to transform the syscall sequences into initial tasks with more real-time information. Then, a coverage-guided task mutation is designed to generate those tasks that explore more in-depth real-time related code for parallel execution. Moreover, Rtkaller realizes a task modification to correct those tasks that may hang during fuzzing. We evaluated it on recent versions of rt-Linux, which is one of the most widely used RTOS. Compared to the state-of-the-art kernel fuzzers Syzkaller and Moonshine, Rtkaller achieves the same code coverage at the speed of 1.7X and 1.6X , gains an increase of 26.1% and 22.0% branch coverage within 24 hours respectively. More importantly, Rtkaller has confirmed 28 previously unknown vulnerabilities that are missed by other fuzzers. ### Typestate-Guided Fuzzer for Discovering Use-after-Free Vulnerabilities (ICSE 2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#fUjb3) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2020/07/31/typestate-guided-fuzzer-for-discovering-use-after-free-vulnerabilities/) * <img src="image/wechat_24px.png">[Reading Note](https://mp.weixin.qq.com/s/RE19ba-BnQsZRST338lJHA) * <img src="image/pdf_24px.png">[Paper](https://www.scedt.tees.ac.uk/s.qin/papers/icse2020-uafl.pdf) * <img src="image/ppt_24px.png">[Slides](https://wcventure.github.io/pdf/ICSE2020_UAFL_Slides.pdf) **Abstract:** Existing coverage-based fuzzers usually use the individual control flow graph (CFG) edge coverage to guide the fuzzing process, which has shown great potential in finding vulnerabilities. However, CFG edge coverage is not effective in discovering vulnerabilities such as use-after-free (UaF). This is because, to trigger UaF vulnerabilities, one needs not only to cover individual edges, but also to traverse some long sequence of edges in a particular order, which is challenging for existing fuzzers. To this end, we first propose to model UaF vulnerabilities as typestate properties, then develop a typestate-guided fuzzer, named UAFL, for discovering vulnerabilities violating typestate properties. %Our approach works in two phases. Given a typestate property, we first perform a static typestate analysis to find operation sequences potentially violating the property. Then, the fuzzing process is guided by the operation sequences in order to progressively generate test cases triggering property violations. In addition, we also adopt the information flow analysis to improve the efficiency of the fuzzing process. We performed a thorough evaluation of UAFL on 14 widely-used real-world programs. The experiment results show that UAFL substantially outperforms the state-of-the-art fuzzers, including AFL, AFLFast, FairFuzz, MOpt, Angora and QSYM, in terms of the time taken to discover vulnerabilities. We discovered 10 previously unknown vulnerabilities, and received 5 new CVEs. ### IJON: Exploring Deep State Spaces via Fuzzing (S&P 2020) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://securitygossip.com/blog/2020/03/20/ijon-exploring-deep-state-spaces-via-fuzzing/) * <img src="image/zhihu.png">[Reading Note](https://zhuanlan.zhihu.com/p/109971382) * <img src="image/pdf_24px.png">[Paper](./Paper/SP20_IJON.pdf) * <img src="image/github_24px.png">[Code](https://github.com/RUB-SysSec/ijon) **Abstract:** Although current fuzz testing (fuzzing) methods are highly effective, there are still many situations such as complex state machines where fully automated approaches fail. State-of-the-art fuzzing methods offer very limited ability for a human to interact and aid the fuzzer in such cases. More specifically, most current approaches are limited to adding a dictionary or new seed inputs to guide the fuzzer. When dealing with complex programs, these mechanisms are unable to uncover new parts of the codebase. In this paper, we propose IJON, an annotation mechanism that a human analyst can use to guide the fuzzer. In contrast to the two aforementioned techniques, this approach allows a more systematic exploration of the program’s behavior based on the data representing the internal state of the program. As a consequence, using only a small (usually one line) annotation, a user can help the fuzzer to solve previously unsolvable challenges. We extended various AFL-based fuzzers with the ability to annotate the source code of the target application with guidance hints. Our evaluation demonstrates that such simple annotations are able to solve problems that—to the best of our knowledge—no other current fuzzer or symbolic execution based tool can overcome. For example, with our extension, a fuzzer is able to play and solve games such as Super Mario Bros. or resolve more complex patterns such as hash map lookups. To further demonstrate the capabilities of our annotations, we use AFL combined with IJON to uncover both novel security issues and issues that previously required a custom and comprehensive grammar to be uncovered. Lastly, we show that using IJON and AFL, one can solve many challenges from the CGC data set that resisted all fully automated and human-guided attempts so far. ### MemFuzz: Using Memory Accesses to Guide Fuzzing (ICST 2019) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#VwAnn) * <img src="image/pdf_24px.png">[Paper](./Paper/ICST19_MemFuzz.pdf) **Abstract:** Fuzzing is a form of random testing that is widely used for finding bugs and vulnerabilities. State of the art approaches commonly leverage information about the control flow of prior executions of the program under test to decide which inputs to mutate further. By relying solely on control flow information to characterize executions, such approaches may miss relevant differences. We propose augmenting evolutionary fuzzing by additionally leveraging information about memory accesses performed by the target program. The resulting approach can leverage more sophisticated information about the execution of the target program, enhancing the effectiveness of the evolutionary fuzzing. We implement our approach as a modification of the widely used AFL fuzzer and evaluate our implementation on three widely used target applications. We find distinct crashes from those detected by AFL for all three targets in our evaluation. # Rust Fuzzing ### Rust Library Fuzzing via API Dependency Graph Traversal (ASE 2021) * <img src="image/pdf_24px.png">[Paper](https://arxiv.org/pdf/2104.12064.pdf) * <img src="image/github_24px.png">[Code](https://github.com/Artisan-Lab/RULF) **Abstract:** Robustness is a key concern for Rust library development because Rust promises no risks of undefined behaviors if developers use safe APIs only. Fuzzing is a practical approach for examining the robustness of programs. However, existing fuzzing tools are not directly applicable to library APIs due to the absence of fuzz targets. It mainly relies on human efforts to design fuzz targets case by case which is labor-intensive. To address this problem, this paper proposes a novel automated fuzz target generation approach for fuzzing Rust libraries via API dependency graph traversal. We identify several essential requirements for library fuzzing, including validity and effectiveness of fuzz targets, high API coverage, and efficiency. To meet these requirements, we first employ breadth-first search with pruning to find API sequences under a length threshold, then we backward search longer sequences for uncovered APIs, and finally we optimize the sequence set as a set covering problem. We implement our fuzz target generator and conduct fuzzing experiments with AFL++ on several real-world popular Rust projects. Our tool finally generates 7 to 118 fuzz targets for each library with API coverage up to 0.92. We exercise each target with a threshold of 24 hours and find 30 previously-unknown bugs from seven libraries. ### RUSTY: A Fuzzing Tool for Rust (ACSAC 2020) * <img src="image/pdf_24px.png">[Paper](https://www.acsac.org/2020/program/poster-wips/2020-3-RUSTY%20%20A%20Fuzzing%20Tool%20for%20Rust.pdf) **Abstract:** Rust is known as one of the most popular programming languages on the Stack Overflow website in 2020, indicating that many programmers have had the opportunity to use Rust in different projects. There are many reasons for this success, mostly due to its performance and safety. Rust is a friendly compiler with useful error messages, which provides excellent documentation with an integrated package manager. Furthermore, it is memory-efficient and fast without a garbage collector. Hence, the Rust compiler can power performance-critical services run on embedded devices. Likewise, due to Rusts rich type system and ownership model, it guarantees memory-safety and thread-safety enabling the end-users to reduce various bug types at compile-time. However, even though all the advantages come with Rust, we found there are still various security issues in this ecosystem that can compromise the safety of Rust programs. To perform our security analysis, we created RUSTY that perform bug fuzzing based on the combination of concolic testing and property-based testing. is also the first kind of its own for the Rust ecosystem. Our preliminary evaluation collected multiple trendy Rust projects on GitHub, and RUSTY could successfully identify various memory security issues in this benchmark suite. # Regression Fuzzing ### R2Z2: Detecting Rendering Regressions in Web Browsers through Differential Fuzz Testing (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/8/R2Z2-Detecting-Rendering-Regressions-in-Web-Browsers-through-Differential-Fuzz-Testi) **Abstract:** A rendering regression is a bug introduced by a web browser where a web page no longer functions as users expect. Such rendering bugs critically harm the usability of web browsers as well as web applications. The unique aspect of rendering bugs is that they affect the presented visual appearance of web pages, but those web pages have no pre-defined correct appearance. Therefore, it is challenging to automatically detect errors in their appearance. In practice, web browser vendors rely on non-trivial and time-prohibitive manual analysis to detect and handle rendering regressions. This paper proposes R2Z2, an automated tool to find rendering regressions. R2Z2 uses the differential fuzz testing approach, which repeatedly compares the rendering results of two different versions of a browser while providing the same HTML as input. If the rendering results are different, R2Z2 further performs cross browser compatibility testing to check if the rendering difference is indeed a rendering regression. After identifying a rendering regression, R2Z2 will perform an in-depth analysis to aid in fixing the regression. Specifically, R2Z2 performs a delta-debugging-like analysis to pinpoint the exact browser source code commit causing the regression, as well as inspecting the rendering pipeline stages to pinpoint which pipeline stage is responsible. We implemented a prototype of R2Z2 particularly targeting the Chrome browser. So far, R2Z2 found 11 previously undiscovered rendering regressions in Chrome, all of which were confirmed by the Chrome developers. Importantly, in each case, R2Z2 correctly reported the culprit commit. Moreover, R2Z2 correctly pin-pointed the culprit rendering pipeline stage in all but one case. ### FADATest: Fast and Adaptive Performance Regression Testing of Dynamic Binary Translation Systems (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/132/FADATest-Fast-and-Adaptive-Performance-Regression-Testing-of-Dynamic-Binary-Translat) **Abstract:** Dynamic binary translation (DBT) is the cornerstone of many important applications. In practice, however, it is quite difficult to maintain the performance efficiency of a DBT system due to its inherent complexity. Although performance regression testing isan effective approach to detect potential performance regression issues, it is not easy to apply performance regression testing to DBT systems, because of the natural differences between DBT systems and common software systems and the limited availability of effective test programs. In this paper, we present FADATest, which devises several novel techniques to address these challenges. Specifically,FADATest automatically generates adaptable test programs from existing real benchmark programs of DBT systems according to the runtime characteristics of the benchmarks. The test programs can then be used to achieve highly efficient and adaptive performance regression testing of DBT systems. We have implemented a prototype of FADATest. Experimental results on SPEC CPU 2017 and PARSEC show that FADATest can successfully uncover the same performance regression issues across the evaluated versions of two popular DBT systems, QEMU and Valgrind, as the original benchmark programs. Moreover, the testing efficiency is improved significantly on two different hardware platforms powered by x86-64 and AArch64, respectively. ### Regression Greybox Fuzzing (CCS 2021) * <img src="image/pdf_24px.png">[Paper](https://mboehme.github.io/paper/CCS21.pdf) **Abstract:** What you change is what you fuzz! In an empirical study of all fuzzer-generated bug reports in OSSFuzz, we found that four in every five bugs have been introduced by recent code changes. That is, 77% of 23k bugs are regressions. For a newly added project, there is usually an initial burst of new reports at 2-3 bugs per day. However, after that initial burst, and after weeding out most of the existing bugs, we still get a constant rate of 3-4 bug reports per week. The constant rate can only be explained by an increasing regression rate. Indeed, the probability that a reported bug is a regression (i.e., we could identify the bug-introducing commit) increases from 20% for the first bug to 92% after a few hundred bug reports. In this paper, we introduce regression greybox fuzzing (RGF) a fuzzing approach that focuses on code that has changed more recently or more often. However, for any active software project, it is impractical to fuzz sufficiently each code commit individually. Instead, we propose to fuzz all commits simultaneously, but code present in more (recent) commits with higher priority. We observe that most code is never changed and relatively old. So, we identify means to strengthen the signal from executed code-of-interest. We also extend the concept of power schedules to the bytes of a seed and introduce Ant Colony Optimization to assign more energy to those bytes which promise to generate more interesting inputs. Our large-scale fuzzing experiment demonstrates the validity of our main hypothesis and the efficiency of regression greybox fuzzing. We conducted our experiments in a reproducible manner within Fuzzbench, an extensible fuzzer evaluation platform. Our experiments involved 3+ CPU-years worth of fuzzing campaigns and 20 bugs in 15 open-source C programs available on OSSFuzz. ### DeltaFuzz: Historical Version Information Guided Fuzz Testing (Journal of Computer Science and Technology 2021) * <img src="image/youtube.png">[Video](https://lcs.ios.ac.cn/setta2021/videos/day2_10.mp4) * <img src="image/pdf_24px.png">[Paper](https://jcst.ict.ac.cn/EN/10.1007/s11390-021-1663-7) **Abstract:** With the widespread use of agile software development methods, such as agile and scrum, software is iteratively updated more frequently. To ensure the quality of the software, regression testing is conducted before new versions are released. Moreover, to improve the efficiency of regression testing, testing efforts should be concentrated on the modified and impacted parts of a program. However, the costs of manually constructing new test cases for the modified and impacted parts are relatively expensive. Fuzz testing is an effective method for generating test data automatically, but it is usually devoted to achieving higher code coverage, which makes fuzz testing unsuitable for direct regression testing scenarios. For this reason, we propose a fuzz testing method based on the guidance of historical version information. First, the differences between the program being tested and the historical version are analyzed, and the results of the analysis are used to locate change points. Then, change impact analysis is performed to find the corresponding impacted basic blocks. Finally, the fitness values of test cases are calculated according to the execution traces, and new test cases are generated iteratively by the genetic algorithm. Based on the proposed method, we implement a prototype tool DeltaFuzz and conduct experiments on six open-source projects. Compared with the fuzzing tool AFLGo, AFLFast and AFL, DeltaFuzz could cover the target faster, and the time taken by DeltaFuzz was reduced by 20.59%, 30.05% and 32.61%, respectively. ### HyDiff: Hybrid Differential Software Analysis (ICSE 2020) * <img src="image/blog_24px.jpg">[Reading Note](https://www.yuque.com/xianglincheng/sc94zo/namw67#NrdLd) * <img src="image/zhihu.png">[Reading Note](https://zhuanlan.zhihu.com/p/138238406) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE20_Hydiff.pdf) * <img src="image/github_24px.png">[Code](https://github.com/yannicnoller/hydiff) **Abstract:** Detecting regression bugs in software evolution, analyzing side-channels in programs and evaluating robustness in deep neural networks (DNNs) can all be seen as instances of differential software analysis, where the goal is to generate diverging executions of program paths. Two executions are said to be diverging if the observable program behavior differs, e.g., in terms of program output, execution time, or (DNN) classification. The key challenge of differential software analysis is to simultaneously reason about multiple program paths, often across program variants. This paper presents HyDiff, the first hybrid approach for differential software analysis. HyDiff integrates and extends two very successful testing techniques: Feedback-directed greybox fuzzing for efficient program testing and shadow symbolic execution for systematic program exploration. HyDiff extends greybox fuzzing with divergence-driven feedback based on novel cost metrics that take into account the control flow graph of the program. Furthermore HyDiff extends shadow symbolic execution by applying four-way forking in a systematic exploration and still having the ability to incorporate concrete inputs in the analysis. HyDiff applies divergence revealing heuristics based on resource consumption and control-flow information to efficiently guide the symbolic exploration, which allows its efficient usage beyond regression testing applications. We introduce differential metrics such as output, decision and cost difference, as well as patch distance, to assist the fuzzing and symbolic execution components in maximizing the execution divergence. We implemented our approach on top of the fuzzer AFL and the symbolic execution framework Symbolic PathFinder. We illustrate HyDiff on regression and side-channel analysis for Java bytecode programs, and further show how to use HyDiff for robustness analysis of neural networks. # Directed Fuzzing ### WindRanger: A Directed Greybox Fuzzer driven by Deviation Basic Block (ICSE 2022) * <img src="image/pdf_24px.png">[Paper](https://conf.researchr.org/details/icse-2022/icse-2022-papers/162/WindRanger-A-Directed-Greybox-Fuzzer-driven-by-DeviationBasic-Blocks) **Abstract:** Directed grey-box fuzzing (DGF) is a security testing technique that aims to steer the fuzzer towards predefined target sites in the program. To gain directness, DGF prioritizes the seeds whose execution traces are closer to the target sites. Therefore, evaluating the distance between the execution trace of a seed and the target sites (aka, the seed distance) is important for DGF. The first directed grey-box fuzzer, AFLGo, uses an approach of calculating the basic block level distances during static analysis and accumulating the distances of the executed basic blocks to compute the seed distance. Following AFLGo, most of the existing state-of-the-art DGF techniques use all the basic blocks on the execution trace and only the control flow information for seed distance calculation. However, not every basic block is equally important and there are certain basic blocks where the execution trace starts to deviate from the target sites (aka, deviation basic blocks). In this paper, we propose a technique called WindRanger which leverages deviation basic blocks to facilitate DGF. To identify the deviation basic blocks, WindRanger applies both static reachability analysis and dynamic filtering. To conduct directed fuzzing, WindRanger uses the deviation basic blocks and their related data flow information for seed distance calculation, mutation, seed prioritization as well as explore-exploit scheduling. We evaluated WindRanger on 3 datasets consisting of 29 programs. The experiment results show that WindRanger outperforms AFLGo, AFL, and Fairfuzz by reaching the target sites 21%, 34%, and 37% faster and detecting the target crashes 44%, 66%, and 77% faster respectively. Moreover, we found a 0-day vulnerability with a CVE ID assigned in ffmpeg (a popular multimedia library extensively fuzzed by OSS-fuzz) with WindRanger by supplying manually identified suspect locations as the target sites. ### BEACON: Directed Grey-Box Fuzzing with Provable Path Pruning (S&P 2022) * <img src="image/pdf_24px.png">[Paper](https://5hadowblad3.github.io/files/Oakland22-Beacon.pdf) * <img src="image/github_24px.png">[Code](https://hub.docker.com/r/yguoaz/beacon) **Abstract:** Unlike coverage-based fuzzing that gives equal attention to every part of a code, directed fuzzing aims to direct a fuzzer to a specific target in the code, e.g., the code with potential vulnerabilities. Despite much progress, we observe that existing directed fuzzers are still not efficient as they often symbolically or concretely execute a lot of program paths that cannot reach the target code. They thus waste a lot of computational resources. This paper presents BEACON, which can effectively direct a greybox fuzzer in the sea of paths in a provable manner. That is, assisted by a lightweight static analysis that computes abstracted preconditions for reaching the target, we can prune 82.94% of the executing paths at runtime with negligible analysis overhead (ă5h) but with the guarantee that the pruned paths must be spurious with respect to the target. We have implemented our approach, BEACON, and compared it to five state-of-the-art (directed) fuzzers in the application scenario of vulnerability reproduction. The evaluation results demonstrate that BEACON is 11.50x faster on average than existing directed grey-box fuzzers and it can also improve the speed of the conventional coverage-guided fuzzers, AFL, AFL++, and Mopt, to reproduce specific bugs with 6.31x ,11.86x, and 10.92x speedup, respectively. More interestingly, when used to test the vulnerability patches, BEACON found 14 incomplete fixes of existing CVE-identified vulnerabilities and 8 new bugs while 10 of them are exploitable with new CVE ids assigned ### Improving Configurability of Unit-level Continuous Fuzzing: An Industrial Case Study with SAP HANA (ASE 2021 Industry) * <img src="image/pdf_24px.png">[Paper](https://github.com/hongshin/publications/blob/main/ase21-industry.pdf) **Abstract:** This paper presents industrial experiences on enhancing the configurability of a fuzzing framework for effective continuous fuzzing of the SAP HANA components. We propose five new mutation scheduling strategies for effective uses of grammar-aware mutators in the unit-level fuzzing framework, and three new seed corpus selection strategies to configure a fuzzing campaign to check on changed code in priority. The empirical results show that the proposed extension gives users chances to improve fuzzing effectiveness and efficiency by configuring the framework specifically for each target component ### KCFuzz: Directed Fuzzing Based on Keypoint Coverage (ICAIS 2021) * <img src="image/pdf_24px.png">[Paper](https://link.springer.com/chapter/10.1007/978-3-030-78609-0_27) **Abstract:** Directed fuzzing, as an efficient method to focus on a specific set of targets in the program, often works better than random fuzzing when combined with a researcher’s empirical judgment. However, the current directed fuzzing work is not efficient enough. In previous studies, some have generated closer seed inputs by guiding the execution path through the distance from the target region, but the distance guided algorithm is less robust. Some studies used selective symbolic execution for directed testing to alleviate the path explosion problem, but it brings a higher false-positive rate. In this paper, we propose a keypoint coverage-based fuzzing (KCFuzz) method, which extracts the keypoint list using a control flow graph, obtains the keypoint list coverage information through runtime instrumentation, calculates the test priority of the seeds based on the overall coverage and keypoint coverage using an energy scheduling algorithm, and continuously generates test inputs closer to the target according to the specified mutation strategy. On this basis, a hybrid testing framework is implemented, using keypoint coverage directed fuzzing to generate a seed queue covering keypoints, using offspring generation strategies and hybrid execution technology, and further exploring the new state of the program according to changes in overall and keypoint coverage. The experimental results show that the KCFuzz method can efficiently induce the generation of seed queues to reach the target region, and at the same time, the depth and validity of the exploration paths are higher than those of the most advanced directed fuzzing methods such as AFLGo. ### Constraint-guided Directed Greybox Fuzzing (USENIX Security2021) * <img src="image/pdf_24px.png">[Paper](https://lifeasageek.github.io/papers/gwangmu-cafl.pdf) **Abstract:** Directed greybox fuzzing is an augmented fuzzing technique intended for the targeted usages such as crash reproduction and proof-of-concept generation, which gives directedness to fuzzing by driving the seeds toward the designated program locations called target sites. However, we find that directed greybox fuzzing can still suffer from the long fuzzing time before exposing the targeted crash, because it does not consider the ordered target sites and the data conditions. This paper presents constraint-guided directed greybox fuzzing that aims to satisfy a sequence of constraints rather than merely reaching a set of target sites. Constraint-guided greybox fuzzing defines a constraint as the combination of a target site and the data conditions, and drives the seeds to satisfy the constraints in the specified order. We automatically generate the constraints with seven types of crash dumps and four types of patch changelogs, and evaluate the prototype system CAFL against the representative directed greybox fuzzing system AFLGo with 47 real-world crashes and 12 patch changelogs. The evaluation shows CAFL outperforms AFLGo by 2.88x for crash reproduction, and better performs in PoC generation as the constraints get explicit. ### Constructing More Complete Control Flow Graphs Utilizing Directed Gray-Box Fuzzing (MDPI 2021) * <img src="image/pdf_24px.png">[Paper](https://www.mdpi.com/2076-3417/11/3/1351) **Abstract:** Control Flow Graphs (CFGs) provide fundamental data for many program analyses, such as malware analysis, vulnerability detection, code similarity analysis, etc. Existing techniques for constructing control flow graphs include static, dynamic, and hybrid analysis, which each having their own advantages and disadvantages. However, due to the difficulty of resolving indirect jump relations, the existing techniques are limited in completeness. In this paper, we propose a practical technique that applies static analysis and dynamic analysis to construct more complete control flow graphs. The main innovation of our approach is to adopt directed gray-box fuzzing (DGF) instead of coverage-based gray-box fuzzing (CGF) used in the existing approach to generate test cases that can exercise indirect jumps. We first employ a static analysis to construct the static CFGs without indirect jump relations. Then, we utilize directed gray-box fuzzing to generate test cases and resolve indirect jump relations by monitoring the execution traces of these test cases. Finally, we combine the static CFGs with indirect jump relations to construct more complete CFGs. In addition, we also propose an iterative feedback mechanism to further improve the completeness of CFGs. We have implemented our technique in a prototype and evaluated it through comparing with the existing approaches on eight benchmarks. The results show that our prototype can resolve more indirect jump relations and construct more complete CFGs than existing approaches. ### Binary-level Directed Fuzzing for Use-After-Free Vulnerabilities (RAID 2020) * <img src="image/GoSSIP_note.jpg">[Reading Note from GoSSIP](https://mp.weixin.qq.com/s/_kFbnKNa-fXbfqF-7TFN5A) * <img src="image/pdf_24px.png">[Paper](./Paper/Arxiv20_BinaryUAF.pdf) **Abstract:** Directed fuzzing focuses on automatically testing specific parts of the code by taking advantage of additional information such as (partial) bug stack trace, patches or risky operations. Key applications include bug reproduction, patch testing and static analysis report verification. Although directed fuzzing has received a lot of attention recently, hard-to-detect vulnerabilities such as Use-Afer-Free (UAF) are still not well addressed, more especially at the binary level. We propose UAFuzz, the first (binary-level) directed greybox fuzzer dedicated to UAF bugs. The technique features a fuzzing engine tailored to UAF specifics, a lightweight code instrumentation and an efficient bug triage step. Experimental evaluation for bug reproduction on real cases demonstrates that UAFuzz significantly outperforms state-of-the-art directed fuzzers in terms of fault detection rate, time to exposure and bug triaging. UAFuzz has also been proven effective in patch testing, leading to the discovery of 20 new bugs in Perl, GPAC and GNU Patch (including a buggy patch) - all of them have been acknowledged and 14 have been fixed. Last but not least, we provide to the community the first fuzzing benchmark dedicated to UAF, built on both real codes and real bugs. ### Ankou: Guiding Grey-box Fuzzing towards Combinatorial Difference (ICSE 2020) * <img src="image/pdf_24px.png">[Paper](./Paper/ICSE20_Ankou.pdf) * <img src="image/github_24px.png">[Code](https://github.com/SoftSec-KAIST/Ankou) **Abstract:** Grey-box fuzzing is an evolutionary process, which maintains and evolves a population of test cases with the help of a fitness function. Fitness functions used by current grey-box fuzzers are not informative in that they cannot distinguish different program executions as long as those executions achieve the same coverage. The problem is that the current fitness functions only consider a union of data, but not the combination of them. As such, fuzzers often get stuck in a local optimum during their search. In this paper, we introduce Ankou, the first grey-box fuzzer that recognizes different \emph{combinations} of execution information, and present several scalability challenges encountered while designing and implementing Ankou. Our experimental results show that Ankou is $1.94\times$ and $8.0\times$ more effective in finding bugs than AFL and Angora, respectively. ### RDFuzz: Accelerating Directed Fuzzing with Intertwined Schedule and Optimized Mutation (2020) * <img src="image/pdf_24px.png">[Paper](https://www.hindawi.com/journals/mpe/2020/7698916/) **Abstract:** Directed fuzzing is a practical technique, which concentrates its testing energy on the process toward the target code areas, while costing little on other unconcerned components. It is a promising way to make better use of available resources, especially in testing large-scale programs. However, by observing the state-of-the-art-directed fuzzing engine (AFLGo), we argue that there are two universal limitations, the balance problem between the exploration and the exploitation and the blindness in mutation toward the target code areas. In this paper, we present a new prototype RDFuzz to address these two limitations. In RDFuzz, we first introduce the frequency-guided strategy in the exploration and improve its accuracy by adopting the branch-level instead of the path-level frequency. Then, we introduce the input-distance-based evaluation strategy in the exploitation stage and present an optimized mutation to distinguish and protect the distance sensitive input content. Moreover, an intertwined testing schedule is leveraged to perform the exploration and exploitation in turn. We test RDFuzz on 7 benchmarks, and the experimental re

A curated list of awesome packages, articles, and other cool resources from the Wagtail community.

Awesome Wagtail [](https://github.com/sindresorhus/awesome) [<img src="https://cdn.rawgit.com/springload/awesome-wagtail/ac912cc661a7099813f90545adffa6bb3e75216c/logo.svg" width="104" align="right" alt="Wagtail">](https://wagtail.org/) =============== > A curated list of awesome packages, articles, and other cool resources from the Wagtail community. > [Wagtail](https://wagtail.org/) is a Python CMS powered by Django, focusing on flexibility and user experience. *You might also like [Awesome Django](https://github.com/wsvincent/awesome-django) and [Awesome Python](https://github.com/vinta/awesome-python). :snake:* ## Contents - [General resources](#general-resources) - [Apps](#apps) - [Blogging/news](#bloggingnews) - [Rich text editor extensions](#rich-text-editor-extensions) - [Widgets](#widgets) - [StreamField](#streamfield) - [Static site generation](#static-site-generation) - [Settings management](#settings-management) - [E-commerce](#e-commerce) - [SEO and SMO](#seo-and-smo) - [Analytics](#analytics) - [Customer experience](#customer-experience) - [Security](#security) - [Media](#media) - [Translations](#translations) - [Forms](#forms) - [Testing](#testing) - [Modeladmin](#modeladmin) - [Misc](#misc) - [Tools](#tools) - [Templates & Starter Kits](#templates--starter-kits) - [Resources](#resources) - [Getting started](#getting-started) - [Articles](#articles) - [Recipes](#recipes) - [Presentations](#presentations) - [Podcasts](#podcasts) - [Videos](#videos) - [Books](#books) - [Showcases](#showcases) - [Lists](#lists) - [For editors](#for-editors) - [Community](#community) - [Open-source sites](#open-source-sites) ## General resources - [Official site](https://wagtail.org/) - [GitHub repository](https://github.com/wagtail/wagtail) - [Twitter account](https://twitter.com/wagtailcms) - [Roadmap](https://github.com/wagtail/wagtail/projects/1) - [PyPI classifiers for Wagtail](https://pypi.org/pypi?%3Aaction=list_classifiers) - [Other resources](#resources) ## Apps ### Blogging/news - [Puput](https://puput.readthedocs.org/) - Puput is a powerful and simple Django app to manage a blog. It uses the awesome Wagtail CMS as content management system. - [wagtail_blog](https://gitlab.com/thelabnyc/wagtail_blog) - A WordPress-like blog app implemented in Wagtail. - [wagtailnews](https://github.com/takeflight/wagtailnews) - A plugin for Wagtail that provides news / blogging functionality. - [wagtail-blog-app](https://github.com/Tivix/wagtail-blog-app) - A blog application for the Wagtail Django CMS. - [Django Wagtail Feeds](https://github.com/chrisdev/django-wagtail-feeds) - Add support for RSS Feeds, Facebook Instant Articles and Apple News Publisher to your Wagtail CMS Projects. - [Snotra_RSS](https://github.com/olopost/snotra_rss) - Snotra_RSS is an Atom and RSS news aggregator app for Wagtail. - [wagtail-live](https://github.com/wagtail/wagtail-live) - Build live blogs with Wagtail. ### Rich text editor extensions - [wagtail-readability](https://github.com/takeflight/wagtail-readability) - Test how readable the content you enter into Wagtail is. - [wagtailembedder](https://github.com/springload/wagtailembedder) - Snippets embedder for Wagtail richtext fields. - [Wagtail TinyMCE](https://github.com/isotoma/wagtailtinymce) - A TinyMCE editor integration for Wagtail. - [Wagtail Froala](https://github.com/jaydensmith/wagtailfroala) - Extends Wagtail to use the Froala WYSIWYG editor in RichTextField/RichTextBlock. - [Wagtail Medium Editor](https://github.com/dperetti/Django-wagtailmedium) - A customizable Medium Editor for Wagtail, with link anchors support. - [WagtailDraftail](https://github.com/springload/wagtaildraftail) – Draft.js editor for Wagtail, built upon [Draftail](https://github.com/springload/draftail) and [draftjs_exporter](https://github.com/springload/draftjs_exporter). - [wagtail-readinglevel](https://github.com/vixdigital/wagtail-readinglevel) – Wagtail plugin to determine the reading level of text input into a rich text field. ### Widgets - [wagtailgmaps](https://github.com/springload/wagtailgmaps) - Simple Google Maps address formatter for Wagtail fields. - [Wagtail-Geo-Widget](https://github.com/Frojd/wagtail-geo-widget) - Google Maps widget for the GeoDjango PointField field in Wagtail. - [wagtail-leaflet-widget](https://github.com/icpac-igad/wagtail-leaflet-widget) - A Leaflet JS - OSM based wagtail geo-location widget. - [wagtail-markdown](https://github.com/torchbox/wagtail-markdown) - Markdown fields and blocks for Wagtail. - [wagtail-autocomplete](https://github.com/wagtail/wagtail-autocomplete) - Autocompleting choosers for `ForeignKey`, `ParentalKey`, and `ManyToMany` fields. - [wagtail-instance-selector](https://github.com/ixc/wagtail-instance-selector) - A `ForeignKey` widget to create and select related items. Similar to Django's `raw_id_fields`. - [wagtail-generic-chooser](https://github.com/wagtail/wagtail-generic-chooser) - provides base classes for building chooser popups and form widgets for the Wagtail admin, matching the look and feel of Wagtail's built-in choosers for pages, documents, snippets and images. - [wagtail-multi-upload](https://github.com/spapas/wagtail-multi-upload) - allows uploading of multiple related images for a page. - [wagtail-color-panel](https://github.com/marteinn/wagtail-color-panel) - Introduces panels for selecting colors in Wagtail. ### StreamField - [Wagtail FontAwesome](https://gitlab.com/alexgleason/wagtailfontawesome) - Add FontAwesome icons to StreamField. - [Wagtail Commonblocks](https://github.com/springload/wagtailblocks) - Common StreamField blocks for Wagtail. - [Wagtail SVGmap](https://github.com/City-of-Helsinki/wagtail-svgmap) - ImageMap functionality for Wagtail through inline SVGs. - [Wagtail ClearStream](https://github.com/heymonkeyriot/wagtailclearstream) - An app to make Wagtail's StreamField more modular. - [UWKM Streamfields](https://github.com/UWKM/uwkm_streamfields) – A basic set of Wagtail StreamField blocks for fun and profit. - [wagtail-inventory](https://github.com/cfpb/wagtail-inventory) - Search Wagtail pages by the StreamField blocks they contain. - [Wagtail Code Block](https://github.com/FlipperPA/wagtailcodeblock) - StreamField code blocks for the Wagtail CMS with real-time PrismJS Syntax Highlighting. - [Wagtail Blocks](https://github.com/ibrahimawadhamid/wagtail_blocks) - A Collection of awesome Wagtail CMS stream-field blocks and Charts. - [Wagtail UI Plus](https://github.com/davidcondenl/wagtailuiplus) - Several UI improvements to the Wagtail editor interface for StreamFields and StreamBlocks. - [Wagtail Cache Block](https://github.com/AccordBox/wagtail_cache_block) - A templatetag which add HTML fragment cache to your StreamField block - [Wagtail UIKit Block](https://github.com/kpsaurus/wagtail-uikitblocks) - A collection of UIKit components that can be used as a Wagtail StreamField block. ### Static site generation - [Wagtail-bakery](https://github.com/moorinteractive/wagtail-bakery) - A set of helpers for baking your Django Wagtail site out as flat files. - [Wagtail-Netlify](https://github.com/tomdyson/wagtail-netlify) - Easily publish your statically rendered Wagtail site to Netlify. - [wagtail-freezer](https://github.com/gasman/wagtail-freezer) - Generates static HTML sites from a Wagtail project. ### Settings management - [Wagtail-Constance](https://github.com/MechanisM/wagtail-constance) - django-constance integration for Wagtail CMS. - [Wagtail-Flags](https://github.com/cfpb/wagtail-flags) - Feature flags for Wagtail sites. ### E-commerce - [wagtailinvoices](https://github.com/SableWalnut/wagtailinvoices) - A Wagtail module for creating invoices. - [longclaw](https://github.com/JamesRamm/longclaw) - A shop template for Wagtail CMS. - [django-oscar-wagtail](https://github.com/LabD/django-oscar-wagtail) - Wagtail integration for Oscar Commerce (or Oscar Commerce integration for Wagtail?). - [django-salesman](https://github.com/dinoperovic/django-salesman) - Headless e-commerce framework for Django with Wagtail modeladmin integration. ### SEO and SMO - [wagtail-metadata](https://github.com/takeflight/wagtail-metadata) - A tool to assist with metadata for social media and search engines. - [wagtail-metadata-mixin](https://github.com/bashu/wagtail-metadata-mixin) - OpenGraph, Twitter Card and Google+ snippet tags for Wagtail CMS pages. - [wagtail-schema.org](https://github.com/takeflight/wagtail-schema.org) - Schema.org JSON-LD tags for Wagtail sites. - [wagtail-opengraph-image-generator](https://github.com/candylabshq/wagtail-opengraph-image-generator) - Assists you in automatically creating Open Graph images for your Wagtail pages. - [wagtail-redirect-importer](https://github.com/Frojd/wagtail-redirect-importer) - Your friendly neighborhood importer that lets you import redirects from different tabular data formats, such as .csv and .xls - [wagtail-meta-preview](https://github.com/rinti/wagtail-meta-preview) - Adds ability to get share previews for Facebook, Twitter and Google in the Wagtail admin. - [Wagtail Yoast](https://github.com/Aleksi44/wagtailyoast) - A tool to improve readability of your texts with SEO recommendations. ### Analytics - [Wagtail Analytics](https://github.com/tomdyson/wagalytics) - A Google Analytics dashboard in your Wagtail admin. ### Customer experience - [Wagtail Experiments](https://github.com/torchbox/wagtail-experiments) – A/B testing for Wagtail. - [Wagtail Personalisation](https://github.com/LabD/wagtail-personalisation) - Personalisation module, enabling editors to create customised pages - or parts of pages - based on segments whose rules are configured directly in the admin interface. ### Security - [wagtailenforcer](https://github.com/springload/wagtailenforcer) - If you need to enforce security protocols on your Wagtail site you've come to the right place. - [wagtail-yubikey](https://github.com/ahopkins/wagtail-yubikey) - Enable YubiKey two factor authentication on Wagtail admin panel. - [wagtail-2fa](https://github.com/labd/wagtail-2fa) - Add two-factor authentication to Wagtail by integrating it with django-otp. ### Media - [wagtailmedia](https://github.com/torchbox/wagtailmedia) - A Wagtail module for managing video and audio files within the admin. - [Wagtail Alt Generator](https://github.com/marteinn/wagtail-alt-generator) - A module for generating image description and tags based on computer vision. - [Wagtail FilePreviews](https://github.com/filepreviews/wagtail-filepreviews) - Extend Wagtail's Documents with image previews and metadata from FilePreviews.io. - [Wagtail-Textract](https://github.com/fourdigits/wagtail_textract) - Make Wagtail search Documents contents (PDF, Excel and Word, etc.). - [Wagtail-Lazyimages](https://github.com/ptrck/wagtail-lazyimages) - A plugin that generates tiny blurry placeholder images for lazy loading Wagtail images medium.com style. - [Wagtail Image Import](https://github.com/jacobtoppm/wagtail-image-import) - A plugin for importing images from Google Drive. - [Wagtail SVG](https://github.com/Aleksi44/wagtailsvg) - A Wagtail module for managing SVG files within the admin. - [Wagtail Makeup](https://github.com/kevinhowbrook/wagtail-makeup) - A plugin that replaces all your images with [Unsplash](https://unsplash.com/) images. - [Rent Free Media](https://github.com/RentFreeMedia/rentfreemedia) - A media distribution framework built on Django and Wagtail. Premium / subscription-based publishing like Patreon or Substack. - [Wagtail CLIP](https://github.com/MattSegal/wagtail-clip) - A module for searching the contents of Wagtail images with natural language queries. - [Wagtail Stock Images](https://github.com/vicktornl/wagtail-stock-images) - Search stock images (e.g. via Unsplash) and save them to your Wagtail image library. - [Wagtail Transcription](https://github.com/LilJack118/wagtail-transcription) - Provides a field to automatically creates transcriptions from YouTube videos. ### Translations - [Wagtail Modeltranslation](https://github.com/infoportugal/wagtail-modeltranslation) - Simple app containing a mixin model that integrates [django-modeltranslation](https://github.com/deschler/django-modeltranslation) into Wagtail panels system. - [wagtailtrans](https://github.com/LUKKIEN/wagtailtrans) - A Wagtail add-on for supporting multilingual sites. - [Wagtail Localize](https://github.com/wagtail/wagtail-localize) - A translation plugin for the Wagtail CMS, allows pages or snippets to be translated within Wagtail's admin interface. ### Forms - [Wagtail's built in Form Builder](https://docs.wagtail.org/en/stable/reference/contrib/forms/) for general use cases. - [Wagtail ReCaptcha](https://github.com/springload/wagtail-django-recaptcha) - wagtail-django-captcha provides an easy way to integrate the [django-recaptcha](https://github.com/praekelt/django-recaptcha) field when using the Wagtail formbuilder. - [Wagtail Simple Captcha](https://github.com/acarasimon96/wagtail-django-simple-captcha) - A self-hosted alternative to Wagtail ReCaptcha that easily integrates a [django-simple-captcha](https://github.com/mbi/django-simple-captcha) field into the Wagtail form builder. - [wagtailstreamforms](https://github.com/AccentDesign/wagtailstreamforms) - Build forms in Wagtail's admin for use in streamfields. - [wagtail-contact-reply](https://github.com/KalobTaulien/wagtail-contact-reply) - Reply directly to form submissions from the Wagtail admin - [Wagtail JotForm](https://github.com/kevinhowbrook/wagtail-jotform) - Embeddable Jotform forms for Wagtail pages. - [Wagtail Model Forms](https://github.com/vicktornl/wagtail-model-forms) - The Wagtail Form Builder functionalities available for your models/snippets. ### Testing - [wagtail-linkchecker](https://github.com/takeflight/wagtail-linkchecker) - A tool to assist with finding broken links on your Wagtail site. - [Wagtail Accessibility](https://github.com/takeflight/wagtail-accessibility) – A plugin to assist with accessibility when developing in Wagtail. - [Wagtail Factories](https://github.com/mvantellingen/wagtail-factories) - Factory boy classes for Wagtail. - [Wagtail Foliage](https://github.com/harrislapiroff/wagtail-foliage) - Utilities for programmatically building page trees in Wagtail. ### Modeladmin - [wagtail-admin-list-controls](https://github.com/ixc/wagtail-admin-list-controls) - Adds advanced search, ordering and layout controls to Wagtail's modeladmin list views. - [wagtail-rangefilter](https://github.com/wunderweiss/wagtail-rangefilter) - Integrates django-admin-rangefilter into Wagtail's ModelAdmin. ### Misc - [wagtailmenus](https://github.com/rkhleics/wagtailmenus) - An extension for Torchbox's Wagtail CMS to help you manage and render multi-level navigation and simple flat menus in a consistent, flexible way. - [Wagtail Error Pages](https://gitlab.com/alexgleason/wagtailerrorpages) - Pretty, smart, customizable error pages for Wagtail. - [Wagtail Themes](https://github.com/moorinteractive/wagtail-themes) - Site-specific theme loader for Wagtail. - [Wagtail Sharing](https://github.com/cfpb/wagtail-sharing) – Easier sharing of Wagtail drafts. - [Wagtail Gridder](https://github.com/wharton/wagtailgridder) - Grid card layout similar to Google image search results, with an expanded area for card details. - [Wagtail Condensed Inline Panel](https://github.com/wagtail/wagtail-condensedinlinepanel) - Drop-in replacement for Wagtail's InlinePanel suited for large number of inlines (collapsible with drag and drop support). - [Joyous](https://github.com/linuxsoftware/ls.joyous) - A calendar application for Wagtail. - [Wagtail App Pages](https://github.com/mwesterhof/wagtail_app_pages) - Extend Wagtail pages using an actual URL config and django views. - [Wagtail Transfer](https://github.com/wagtail/wagtail-transfer) - An official extension for Wagtail allowing content to be transferred between multiple instances of a Wagtail project - [Wagtail Import Export](https://github.com/torchbox/wagtail-import-export) - Import/Export pages between Wagtail instances. - [Wagtail Import/Export Tool](https://github.com/berkalpyakici/wagtail-import-export-tool) - Refactor of [Wagtail Import Export](https://github.com/torchbox/wagtail-import-export). This tool supports importing/exporting images, documents, and snippets that are used on imported/exported pages. - [Wagtail Tag Manager](https://github.com/jberghoef/wagtail-tag-manager) - A Wagtail addon that allows for easier and GDPR compliant administration of scripts and tags. - [Wagtail Cache](https://github.com/coderedcorp/wagtail-cache) - A simple page cache for Wagtail using the Django cache middleware. - [Wagtail GraphQL](https://github.com/tr11/wagtail-graphql) - App to automatically add GraphQL support to a Wagtail website. - [Wagtail Orderable](https://github.com/elton2048/wagtail-orderable) - Mixin support for drag-and-drop ordering in admin panel. - [Wagtail Live Preview](https://github.com/KalobTaulien/wagtail-livepreview) - Live page previews beside your content. - [Wagtail Resume](https://github.com/adinhodovic/wagtail-resume) – A Wagtail project made to simplify creation of resumes for developers. - [Wagtail Content Import](https://github.com/torchbox/wagtail-content-import) - Import content from Google Docs or Docx into StreamFields, using a customisable mapping system. - [Wagtail Trash](https://github.com/Frojd/wagtail-trash) - Will place pages in a trash can from where they can be restored instead of being permanently deleted. - [Wagtail PDF View](https://github.com/donhauser/wagtail-pdf) - Render Wagtail pages and models as PDF document using Weasyprint or LaTeX. - [Wagtail Grapple](https://github.com/torchbox/wagtail-grapple) - A Wagtail app that makes building GraphQL endpoints a breeze. - [Wagtail Secret Sharing](https://github.com/vicktornl/wagtail-secret-sharing) - Keep sensitive information out of your chat logs and email via a secure sharing protocol - [Wagtail Cache Invalidator](https://github.com/vicktornl/wagtail-cache-invalidator) - Invalidate and purge (frontend) cache via an user-friendly interface in the Wagtail CMS. ## Tools ### Templates & Starter Kits - [Wagtail Cookiecutter Foundation](https://github.com/chrisdev/wagtail-cookiecutter-foundation) - A Cookiecutter template for Wagtail CMS using Zurb Foundation 6. - [Beginner Wagtail Cookiecutter](https://github.com/heymonkeyriot/beginner-wagtail) – A super simple implementation of Wagtail CMS. - [Wagtail Starter Kit](https://github.com/tkjone/starterkit-wagtail) – A cookiecutter complete with wagtail, django layout, vagrant, provisioning scrips, front end build system and more! - [Wagtail Pipit](https://github.com/Frojd/Wagtail-Boilerplate) – Pipit is a Wagtail boilerplate which aims to provide an easy and modern developer workflow with a React-rendered frontend. - [Django Cookiecutter Wagtail](https://github.com/Jean-Zombie/cookiecutter-django-wagtail) – A Django Cookiecutter template with Wagtail. Based on the original 'Django Cookiecutter'. Features: Docker support using `docker-compose` for development and production (using Traefik with LetsEncrypt support), customizable PostgreSQL version, Bootstrap 4, media storage using Amazon S3 or Google Cloud Storage and many more. - [wagtail-webpack-dokku](https://github.com/helixsoftco/wagtail-webpack-dokku/) - A template with Wagtail, Webpack using django-webpack-loader, Bootstrap 5, production ready for Dokku. - [Wagtail bootstrap blog](https://github.com/AccordBox/wagtail-bootstrap-blog) - A Wagtail blog which has Bootstrap theme, supports writing in `Markdown`, `Latex`. It also has comment workflow, comment form supports `Mention` and `Emoji`. Frontend is built by `Webpack`, `Babel` and `SCSS`. - [Wagtail react blog](https://github.com/AccordBox/wagtail-react-blog) - SPA blog built with React, Bootstrap4, Storybook and Wagtail Rest API. It also supports headless preview. - [CodeRed CMS](https://github.com/coderedcorp/coderedcms) - a professionally supported WordPress alternative for building marketing websites. Create pages, blogs, forms, and every Bootstrap 4 component in the wagtail admin out-of-the-box! [Learn more](https://www.coderedcorp.com/cms/) or [watch the lightning talk](https://www.youtube.com/watch?v=U1Y-jgeGh7g&t=228s). - [Wordpress to Wagtail migration kit](https://github.com/torchbox/wagtail-wordpress-import) - Import WordPress blog content from an XML file into Wagtail. - [cookiecutter-wagtail-package](https://github.com/wagtail/cookiecutter-wagtail-package) - A cookiecutter template for building Wagtail add-on packages. ## Resources ### Getting started - [Getting started in Wagtail, a newcomer's perspective](https://wagtail.org/blog/getting-started-wagtail-newcomers-perspective/) - Having used Drupal almost exclusively as my main tool of choice for a while now, I was asked to put together a build using Wagtail. By [@kiwimind](https://twitter.com/kiwimind). - [Présentation de Wagtail, le dernier CMS Django](https://makina-corpus.com/blog/metier/2016/presentation-de-wagtail-le-dernier-cms-django) - Wagtail est un CMS relativement récent dans l’écosystème Django. Pour autant, son jeune âge ne l’empêche pas de posséder de nombreuses fonctionnalités que nous découvrirons dans cet article. - [Getting Started With Wagtail](https://vix.digital/insights/getting-started-wagtail/) - Working extensively with Wagtail and the surrounding community, we have discovered a range of common pitfalls developers run into when beginning to deliver with Wagtail. ### Articles - [Extending The Functionality of Email Forms in Wagtail](https://posts-by.lb.ee/dev-wagtail-extending-the-functionality-of-email-forms-232c8469ac97) - [Wagtail: 2 Steps for Adding Pages Outside of the CMS](https://www.caktusgroup.com/blog/2016/02/15/wagtail-2-steps-adding-pages-outside-cms/) - [Code blocks for Wagtail using Pygments](https://jordi.nz/code-blocks-wagtail-using-pygments/) - [Adding document previews to Wagtail CMS](https://filepreviews.io/blog/2017/04/20/adding-document-previews-to-wagtail/) - [Wagtail Tutorials: Build Blog Step by Step](https://www.accordbox.com/blog/wagtail-tutorials/) - The tutorials teach you how to create a standard blog from scratch step by step. - [Python CMS Framework Review: Wagtail vs Django-CMS](https://www.accordbox.com/blog/python-cms-framework-review-wagtail-vs-django-cms/) - Talk about the difference between Django-CMS and Wagtail, the two most popular CMS framework in Python world. - [Deploying Wagtail In Production](https://vix.digital/insights/deploying-wagtail-production/) - [Setting Up Foundation Sass With Wagtail](https://vix.digital/insights/setting-foundation-sass-wagtail/) - [Upgrading to Wagtail 2.0](https://wagtail.org/blog/upgrading-to-wagtail-2/) – Wagtail 2.0 is one of our biggest releases to date. - [Getting started with Draftail extensions](https://thib.me/getting-started-with-draftail-extensions) – Do you want to write extensions for Draftail? This is a good place to start. - [Amplify a Wagtail/Django site](https://parbhatpuri.com/amplify-wagtail-django-site-urls-part-1.html) - Prepare you Wagtail site for Accelerated Mobile Pages (AMP). - [Migrating your Drupal content to Wagtail](https://medium.com/@kevinhowbrook/migrating-your-drupal-content-to-wagtail-d43bb34529e8) - [How to Add Buttons to ModelAdmin Index View](https://timonweb.com/tutorials/how-to-add-buttons-to-modeladmin-index-view-in-wagtail-cms/) - [How to Prevent Users from Creating Pages by Type](https://timonweb.com/tutorials/prevent-users-from-creating-certain-page-types-in-wagtail-cms/) - [Drupal Front End WTF, Wagtail Front End FTW](https://medium.com/@kevinhowbrook/drupal-front-end-wtf-wagtail-front-end-ftw-17712628df3e) - Comparing Drupal and Wagtail Markup and approach to each CMS - [How to Create and Manage Menus of Wagtail application](https://www.accordbox.com/blog/wagtail-tutorial-12-how-create-and-manage-menus-wagtail-application/) - [PythonEatsTail](https://pythoneatstail.com) - Complete written and video tutorials to create a Wagtail site with multiple languages, authentication and more - [Upgrading to Wagtail 3.0](https://enzedonline.com/en/tech-blog/upgrading-to-wagtail-3-0/) - General tips to migrate your codebase to Wagtail 3.0. - [Upgrading to Wagtail 3.0 Part 1](https://cynthiakiser.com/blog/2022/06/01/wagtail-3-upgrade-part-1.html) & [Upgrading to Wagtail 3.0 Part 2](https://cynthiakiser.com/blog/2022/06/02/wagtail-3-upgrade-part-2.html) - Two part series in how to migrate to Wagtail 3.0 with specific code examples. ### Recipes - [Oscar Wagtail demo project](https://github.com/LUKKIEN/oscar-wagtail-demo) - A Django recipe for integrating Oscar E-commerce into a Wagtail CMS application. - [Serafeim's Wagtail FAQ](https://github.com/spapas/wagtail-faq) - Answers and recipes for Wagtail - [Consumer Financial Protection Bureau Wagtail development guide](https://github.com/cfpb/development/blob/main/guides/unittesting-django-wagtail.md) - Unit Testing Django and Wagtail ### Presentations - [An Introduction to Wagtail](https://www.youtube.com/watch?v=glIIF-kBXf0) by Eloise "Ducky" Macdonald-Meyer - This talk is an introduction to Wagtail, a content management system built on the Python web framework, Django. - [DjangoCon US 2015 - Wagtail - Yet Another Django CMS](https://www.youtube.com/watch?v=6j0NVq6g4FE) by Tom Dyson - Tom will explain why his agency decided to build a new CMS, share some lessons learned in running a growing open source project, and outline Wagtail's roadmap to version 2 and beyond. [Slide deck](https://speakerdeck.com/tomdyson/wagtail-yet-another-cms-djangocon-us-2015). - [Wellington Wagtail CMS Meetup - Meet Wagtail](https://docs.google.com/presentation/d/19EGWFtfHovHSAvyHCnLbxK50IAR2o7WwKd709cqi9p4/edit) by Josh, Jordi and Rich, from the Springload dev team - An introductory session to Wagtail to showcase the main features it has to offer. - [DjangoCon US 2016 - Atomic Wagtail](https://www.youtube.com/watch?v=kqAKiouk1lY) by Kurt Wall – Brad Frost's atomic design principles are taking the way we design the web by storm. I'll explain what Wagtail is, how you can use it with atomic design principles, and some hurdles you might run into along the way with suggestions on how to help. - [PyCon Australia – Comparing Wagtail, Django CMS and Mezzanine](https://www.youtube.com/watch?v=3UC1MNFOjEI) by Adam Brenecki – This talk explores the different approaches, strengths and weaknesses of each CMS, and what they mean for you as a developer and for your content editors. - [Wagtail — еще одна CMS на Django](https://www.youtube.com/watch?v=yRmZ6WUfoOc) by Mikalai Radchuk - This talk is an introduction to Wagtail in Russian. - [Wagtail & Agile – Wagtail Space 2017](https://youtu.be/-Qii_AyQsxE?t=2m21s) by Edd Baldry. - [Deploy Wagtail to the Divio Cloud – Wagtail Space 2017](https://youtu.be/-Qii_AyQsxE?t=38m13s) by Daniele Procida. - [All about Wagtail – Wagtail Space 2017](https://youtu.be/OedQi5W3Zho) by Robin van der Rijst. - [Presenting Wagtail Clear StreamField, a modular StreamField app – Wagtail Space 2017](https://youtu.be/OedQi5W3Zho?t=19m1s) by Edd Baldry. - [Wagtail Experiments, easy A/B testing for your Wagtail sites – Wagtail Space 2017](https://youtu.be/OedQi5W3Zho?t=34m37s) by Tom Dyson. - [Wagtail's preview, a new hope – Wagtail Space 2017](https://www.youtube.com/watch?v=ObM2pUgY-bs) by Bertrand Bordage. - [The Zen of Wagtail – Wagtail Space 2017](https://youtu.be/ObM2pUgY-bs?t=16m38s) by Matt Westcott. - [Plone to Wagtail – Wagtail Space 2017](https://youtu.be/hZcuq8WJVew?t=2m57s) by Coen van der Kamp. - [Hundreds of Wagtail in Flight – Wagtail Space 2017](https://youtu.be/hZcuq8WJVew?t=24m9s) by Simon de Haan. - [How Google uses Wagtail – Wagtail Space 2018](https://www.youtube.com/watch?v=lh9nmN1mzwQ&t=1937s) by Kevin Chung. - [Introducing Draft.js in Wagtail – Wagtail Space 2018](https://www.youtube.com/watch?v=lh9nmN1mzwQ&t=2690s) by Thibaud Colas. [Presentation](https://thib.me/introducing-draft-js-in-wagtail). - [Let It Go – Wagtail Space 2018](https://www.youtube.com/watch?v=lh9nmN1mzwQ&t=3938s) by Matt Wescott. - [Developing Solutions for Girls, by Men – Wagtail Space 2018](https://www.youtube.com/watch?v=lh9nmN1mzwQ&t=5184s) by Lisa Adams. - [Wagtail’s first hatch – Wagtail Space 2018](https://www.youtube.com/watch?v=P8RUQE7Djdg&t=265s) by Bertrand Bordage. - [The Word Problem – Wagtail Space 2018](https://www.youtube.com/watch?v=P8RUQE7Djdg&t=2841s) by Tom Dyson. - [Wagtail on Divio Cloud – Wagtail Space 2018](https://www.youtube.com/watch?v=P8RUQE7Djdg&t=3856s) by Daniele Procida. - [Chopping the head off Wagtail and sticking it back on – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=152s) by Tony Yates. - [StreamField editor at UWKM – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=400s) by Geert jan Hoogeslag. - [Things i learned at Wagtail Space – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=719s) by Codie Roelf. - [Fly Wagtail to a PyCon – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=912s) by Daniele Procida. - [Wagtail Performance – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=1345s) by Michael van Tellingen. [Code](https://gist.github.com/mvantellingen/daebda6abbaa9a5ed0888f886a77fcf0). - [Mutliple images uploader – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=1661s) by Rajeev J Sebastian. - [Wagtail Space easter egg team demo – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=2057s) by Lars. [Code](https://github.com/specialunderwear/haunted-wagtail). - [Wagtail Space 2019 – Wagtail Space 2018](https://www.youtube.com/watch?v=u0CPaXRSOzI&t=2278s) by Maarten Kling. - [Wagtail in 2018 – Wagtail Space US 2018](https://www.youtube.com/watch?v=ICKYMO0YoFI&index=2&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) by Tom Dyson. - [What the Wagtail Docs Don't Tell You – Wagtail Space US 2018](https://www.youtube.com/watch?v=PCkxBNXWM64&index=3&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) by Lacey Williams Henschel. - [Django Logging for Wagtail – Wagtail Space US 2018](https://www.youtube.com/watch?v=kkztl9ORUKQ&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV&index=4) by Ryan Sullivan. - [Scaling Wagtail for 100 Million Girls – Wagtail Space US 2018](https://www.youtube.com/watch?v=AiOJAKE0M0I&index=5&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) by Lisa Adams and Codie Roelf. - [Using Wagtail to Fight for Press Freedom – Wagtail Space US 2018](https://www.youtube.com/watch?v=FYqbqsa04T8&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV&index=6) by Harris Lapiroff. - [Choosing Wagtail for Columbia University – Wagtail Space US 2018](https://www.youtube.com/watch?v=OiZScRcluCo&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV&index=7) by Zarina Mustapha. - [Running a Multi-Site Newsroom in Wagtail – Wagtail Space US 2018](https://www.youtube.com/watch?v=lMCjInjAz-M&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV&index=8) by Ryan Verner. - [Wagtail in the Cloud – Wagtail Space US 2018](https://www.youtube.com/watch?v=N1MeTEPRmJA&index=9&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) by Daniele Procida. - [Beheading Wagtail: Wagtail as a Headless CMS – Wagtail Space US 2018](https://www.youtube.com/watch?v=HZT14u6WwdY&index=10&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) by Michael Harrison. - [Learning Wagtail – Wagtail Space US 2018](https://www.youtube.com/watch?v=C-tXt5fLj_s&index=11&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) by Dawn Wages. - [Sharing is Caring – Wagtail Space US 2018](https://www.youtube.com/watch?v=6AXyg6vvMTE&index=12&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) by Andy Chosak. - [Lightning Talks – Wagtail Space US 2018](https://www.youtube.com/watch?v=uoxyBIpaXTU&index=13&list=PLEyaio0l1qoGGbXg3XH0205FIF32oO1wV) - [Wagtail: когда хочется чего-то приятнее, чем просто Django – Moscow Python Conf++ 2018](https://www.youtube.com/watch?v=xPPfTvLS7oQ) by Игорь Мосягин - [The State of Wagtail – Wagtail Space 2019](https://youtu.be/MAzZ2lhMhzM?t=592) by Tom Dyson. - [Image rotation feature – Wagtail Space 2019](https://youtu.be/MAzZ2lhMhzM?t=2057) by Chris Adams. Code. - [Debug templates – Wagtail Space 2019](https://youtu.be/MAzZ2lhMhzM?t=2264) by Coen van der Kamp. - [Wagtail Headless with HATEOAS – Wagtail Space 2019](https://youtu.be/MAzZ2lhMhzM?t=2567) by Duco Dokter. - [Building a Planet Friendly Web (with Wagtail) – Wagtail Space 2019](https://youtu.be/MAzZ2lhMhzM?t=2926) by Chris Adams. - [[WIP] The future of (rich text) authoring experiences in Wagtail – Wagtail Space 2019](https://youtu.be/MAzZ2lhMhzM?t=4067) by Thibaud Colas. - [Wagtail & Whatsapp – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=47) by Lisa Adams & Codie Roelf. - [Slack2Wagtail – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=785) by Coen van der Kamp & Lucas Moeskops. - [Wagtail and Oscar – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=1634) by Lars van de Kerkhof. - [wagtail-textract – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=3313) by Kees Hink. [Code](https://github.com/fourdigits/wagtail_textract). - [Django 2.2 compatibility – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=3468) by Matt Wescott. - [SEO dashboard – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=3937) by Janneke Janssen. [Code](https://github.com/LUKKIEN/wagtail-marketing-addons). - [My First Wagtail Contribution – More formats in RichText Editor – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=4126) by Arifin Ibne Matin. - [Fly, Wagtail, fly! – Wagtail Space 2019](https://youtu.be/CSwpj-jyjP4?t=4404) by Daniele Procida. - [Wagtail & GraphQL – Wagtail Space 2019](https://youtu.be/YydSbL8gMS4?t=24) by Arthur Bayr. - [Writing (code) for authors – Wagtail Space US 2019](https://www.youtube.com/watch?v=Ihsrki0d1G8&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=1) by Brian Smith & Eric Sherman. [Slides](https://docs.google.com/presentation/d/1z61u0uKwJxmYS4Zawbu4Zgg-kCtInd1VgsEg-rnwzBE/edit). - [Saving Lives With Wagtail: Recovery Meetings Across the World – Wagtail Space US 2019](https://www.youtube.com/watch?v=QlLWvNT5Wrk&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=2) by Timothy Allen. - [Why we chose Wagtail for CodeRed CMS – Wagtail Space US 2019](https://www.youtube.com/watch?v=1JUOAAmLQFA&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=3) by Vince Salvino. - [Building a Wagtail-based site and authoring environment with accessibility in mind – Wagtail Space US 2019](https://www.youtube.com/watch?v=CxjlAI6R7iY&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=4) by Zarina Mustapha. - [Making Wagtail Accessible – Wagtail Space US 2019](https://www.youtube.com/watch?v=tdB1I_gSCeY&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=5) by Thibaud Colas. [Slides](https://docs.google.com/presentation/d/15y8XIe7SL-RYEO9tEE8n9chx80_X4j4PbczGGM-cEGE/edit). - [Everyone can fly a flag – Wagtail Space US 2019](https://www.youtube.com/watch?v=ZqwmgsqMTEs&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=6) by Will Barton. [Slides](https://docs.google.com/presentation/d/1-A1doke2ylcqG72oIP-MLiX8SKXKkKNxQeKxddYUGBw/edit). - [Architecting for a multi-domain site – Wagtail Space US 2019](https://www.youtube.com/watch?v=xMbJmHF7kCw&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=7) by Ben Beecher. [Slides](https://slides.com/benbeecher/mds/). - [Contributions can be more than code – Wagtail Space US 2019](https://www.youtube.com/watch?v=tK-3kEBbblg&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=8) by Kalob Taulien. - [Thoughtful Code Review – Wagtail Space US 2019](https://www.youtube.com/watch?v=RY0K1BEV-_U&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=9) by Naomi Morduch Toubman. [Slides](https://docs.google.com/presentation/d/1b_Hda8381G6mMc7uzYDc2EYjocfwSi2TYiRMI7d4e3I/). - [Solving your problems by spelunking the Wagtail code – Wagtail Space US 2019](https://www.youtube.com/watch?v=BMoOhjgirFM&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=10) by Harris Lapiroff. [Slides](https://harrislapiroff.github.io/wagtail-space-us-2019/) - [The State of Wagtail: 2019 – Wagtail Space US 2019](https://www.youtube.com/watch?v=s29vaGnFcq8&list=PLEyaio0l1qoEIUFM9bnRKoN6VKEUOdxAn&index=11) by Tom Dyson. - [Wagtail Guide - Getting started - Wagtail Space US 2022](https://www.youtube.com/watch?v=E3-kFY6jPPY) by Coen van der Kamp. - [A New Approach to Multitenant Wagtail - Wagtail Space US 2022](https://www.youtube.com/watch?v=WN0L4YNrWes) by Stephanie C. Smith and Addison Hardy. - [The Wagtail Marketplace for Games-based Courses - Wagtail Space 2022](https://www.youtube.com/watch?v=ueou6CxiR3Y) by Sarah Toms. - [The Wagtail Ecosystem - Wagtail Space US 2022](https://www.youtube.com/watch?v=4Qd43nsxmoc) by Vince Salvino. - [Wagtail charts and graphs - Wagtail Space US 2022](https://www.youtube.com/watch?v=QK-Vhlpos3Q) by Sævar Öfjörð Magnússon & Arnar Tumi Þorsteinsson. - [Wagtail as a headless CMS for JavaScript frontends - Wagtail Space US 2022](https://www.youtube.com/watch?v=bYRQ492BED0) by Tommaso Amici. - [Adding a GraphQL API to Wagtail - Wagtail Space US 2022](https://www.youtube.com/watch?v=_O5isU354vg) by Patrick Arminio. - [Bringing JSONField into Wagtail Core - Wagtail Space US 2022](https://www.youtube.com/watch?v=XtazMDNdlK8) by Sage Abdullah. - [Wagtail vs. WordPress - Wagtail Space US 2022](https://www.youtube.com/watch?v=Vl2g7H3aodw) by Kalob Taulien. - [Designing the new page editor - Wagtail Space US 2022](https://www.youtube.com/watch?v=t2xiPJ91UCE) by Phil Dexter and Ben Enright. - [5 Things I Learned About Wagtail the Hard Way - Wagtail Space US 2022](https://www.youtube.com/watch?v=LNqVzLkZkig) by Meagen Voss. - [Tips for Maintaining Wagtail Packages - Wagtail Space US 2022](https://www.youtube.com/watch?v=Zh608nVBrEw) by Tim Allen. - [Wagtail Guide - Wagtail Space US 2022](https://www.youtube.com/watch) by Coen van der Kamp. - [The state of Wagtail 2022 - Wagtail Space NL 2022](https://www.youtube.com/watch?v=4D49RENHfoM) by Tom Dyson. - [Choosers - Wagtail Space NL 2022](https://www.youtube.com/watch?v=nSjVAISLr4M) by Matthew Westcott. - [Working with Image Filters - Wagtail Space NL 2022](https://www.youtube.com/watch?v=gCGT51BcTdM) by Arnar Tumi Þorsteinsson. - [Things I learned - Wagtail Space NL 2022](https://www.youtube.com/watch?v=xG5-s48TZt8) by Dan Braghis. - [Wagtail Roadrunner Beep Beep - Wagtail Space NL 2022](https://www.youtube.com/watch?v=ynlFUcutSWQ) by Lars van de Kerkhof. - [Dockerising wagtail projects in 5 minutes - Wagtail Space NL 2022](https://www.youtube.com/watch?v=PgkpBMoN4UY) by Sævar Öfjörð Magnússon. - [Wagtail in the News Room - Wagtail Space NL 2022](https://www.youtube.com/watch?v=B85HwmX5uaw) by Sævar Öfjörð Magnússon & Arnar Tumi Þorsteinsson. - [Digital Nomad - Wagtail Space NL 2022](https://www.youtube.com/watch?v=9Evrwzpg-dw) by Maikel Martens. - [Unobtrusive internationalisation - Wagtail Space NL 2022](https://www.youtube.com/watch?v=_dhScxTdtjA) by Lars van de Kerkhof. - [Moving Wagtail pages - Wagtail Space NL 2022](https://www.youtube.com/watch?v=OFqPKffSVWI) by Viggo de Vries. - [Wagtail architecture options, or should I go headless - Wagtail Space NL 2022](https://www.youtube.com/watch?v=JMULuz6RzjQ) by Dan Braghis. - [Wagtail headless and NextJS frontend - Wagtail Space NL 2022](https://www) by Lucas Moeskops. ### Podcasts - [Podcast.__init__ Episode 58 - Wagtail with Tom Dyson](https://www.podcastinit.com/episode-58-wagtail-with-tom-dyson/) - In this episode Tom Dyson explains how Wagtail came to be created, what sets it apart from other options, and when you should implement it for your projects. - [Django Chat: Wagtail CMS - Tom Dyson](https://django-chat.simplecast.com/episodes/wagtail-cms-tom-dyson) - An interview with Tom Dyson on Wagtail, the leading Django-based CMS used by tens of thousands of organizations including Google, NASA, and the British NHS. ### Videos - [Learn Wagtail](https://learnwagtail.com/) - Regular video tutorials about all aspects of Wagtail. - [Wagtail screencasts: Creating and displaying pages in Wagtail](https://www.youtube.com/watch?v=o_dFgr8HZYU) - This video will show you how to create and display pages using the Wagtail CMS. - [Draftail extensions – custom entities tutorial](https://www.youtube.com/watch?v=nCMgoTerEb4) - Step-by-step tutorial to make extensions for Draftail. - [Wagtail Wednesdays #01 - Adding Help Text to Improve Wagtail Editor Experience](https://www.youtube.com/watch?v=ciYNMcv3lE0) - Catherine talks you through the steps you can take to add some useful supplementary text fields to the Wagtail admin. - [Wagtail Wednesdays #02 - Customising Rich Text Features in Wagtail](https://www.youtube.com/watch?v=ei7ot_Wry3o) - Catherine talks you through the steps you can take to customise your rich text editors to control which features are available to your content editors. - [Wagtail Wednesdays #03 - Using tabs to create a cleaner admin interface](https://www.youtube.com/watch?v=uZc0aZrHtQw) - Chris talks you through using tabs to organise fields. - [Wagtail Wednesdays #04 - Organising Images and Documents using Wagtail Collections](https://www.youtube.com/watch?v=HGXHtFpLDCA) - Kieran talks you through the process of organising your images and documents into collections. - [Wagtail Wednesdays #05 - How to organise your fields and streamline the editor experience](https://www.youtube.com/watch?v=CedcZmQ9KHs) - Chelsea talks you through the process of organising your fields to make it easier to manage them and streamline the editor experience. - [Wagtail Wednesdays #06 - Creating & using custom settings in your wagtail site](https://www.youtube.com/watch?v=KJWCGq3IRNc) - Chris talks you through setting up and using custom site settings. - [Wagtail Wednesdays #07 - How to Enable the Wagtail Styleguide](https://www.youtube.com/watch?v=_CfU9UivYPI) - It’s a really helpful resource that takes no time at all to enable and it allows you to check your components against the guidelines and shows all the available Wagtail icons. - [How to Deploy Wagtail to Google App Engine](https://www.youtube.com/watch?v=uD9PTag2-PQ) - Focus is Google Cloud Platform but a great introduction on how to get Wagtail up and running in their PAAS. ### Books - [Wagtail CMS in Action](https://www.manning.com/books/wagtail-cms-in-action) - Book about creating powerful, simple web applications using the Wagtail content management system. - [The Definitive Guide to Next.js and Wagtail](https://leanpub.com/the-definitive-guide-to-nextjs-and-wagtail/) - Build a Jamstack web app with Next.js and Wagtail CMS. - [Build a Blog With Wagtail CMS (3.0.0)](https://leanpub.com/buildblogwithwagtailcms) - This book will teach you how to build a modern blog with Wagtail CMS. - [Build SPA with React and Wagtail (2.0.0)](https://leanpub.com/react-wagtail) - This book will teach you how to build a SPA (single-page application) with React and Wagtail CMS. - [Build a Blog with React (SSR) and Wagtail](https://leanpub.com/react-wagtail-ssr) - This book will teach you how to build a blog with React, Wagtail CMS and SSR (Server-Side Rendering). ### Showcases - [Made with Wagtail](https://madewithwagtail.org/) - A showcase of sites and apps made with Wagtail CMS. - [Contributed apps and website code](https://github.com/torchbox/wagtail/wiki/Contributed-apps-and-website-code) - A provisional directory of third-party contributed Wagtail websites and apps. ### Lists - [PyPI - Python Package Index](https://pypi.org/search/?q=Wagtail) - Wagtail packages on the Python Package Index. - [Django Packages](https://djangopackages.org/grids/g/wagtail-cms/) - Wagtail projects and packages on Django Packages. ## For editors - [How Do I Wagtail?](https://foundation.mozilla.org/en/docs/how-do-i-wagtail/) - Mozilla's editor facing guide for how to use Wagtail's admin interface. Source for this hosted on [Mozilla's Github](https://github.com/mozilla/foundation.mozilla.org/tree/master/network-api/networkapi/wagtailpages) - [Wagtail Editor's manual](https://docs.wagtail.org/en/stable/editor_manual/index.html) - Wagtail documentation for editors - [CCA Wagtail Editor Portal](https://portal.cca.edu/help/wagtail-documentation/) - User facing documentation for Wagtail by California College of the Arts - [Caltech Wagtail Editor Portal](https://sites.caltech.edu/) - User facing documentation for Wagtail by Caltech - [IoGT Wagtail CMS](https://goodinternet.org/cms-manual/intro/intro-to-cms/) - User facing documentation for Wagtail by What is the IoGT (Internet of Good Things). ## Community - [Dutch Wagtail Meetup](https://www.meetup.com/Dutch-Wagtail-Meetup/) - This is a group for anyone interested in working and developing with Wagtail. - [Wellington Wagtail CMS Meetup](https://www.meetup.com/Wellington-Wagtail-CMS-Meetup/) - The first Wagtail CMS meetup in New Zealand! - [Wagtail Space](https://www.wagtail.space/) - Wagtail training sessions, Wagtail (lightning) talks and a Wagtail sprint. From March 13th until 15th 2019, Wagtail Space takes place in Arnhem, The Netherlands. - [Wagtail’s first hatch](https://www.kickstarter.com/projects/noripyt/wagtails-first-hatch) – Kickstarter campaign to accelerate the development of Wagtail. - [Wagtail updates on Telegram](https://telegram.me/wagtail) - Unofficial Telegram channel for general Wagtail updates. - [Wagtail support on Telegram](https://telegram.me/wagtailcms) - Unofficial Telegram channel for support questions and discussions. ## Open-source sites - [bakerydemo](https://github.com/wagtail/bakerydemo) – Next generation Wagtail demo, born in Reykjavík. - [wagtaildemo](https://github.com/wagtail/wagtaildemo) – An example site implemented with Wagtail. - [Torchbox](https://github.com/torchbox/wagtail-torchbox) – Wagtail build of Torchbox.com. - [Made with Wagtail](https://github.com/springload/madewithwagtail) - A showcase of sites and apps made with Wagtail CMS. - [OpenCanada.org](https://github.com/OpenCanada/website) – The opencanada.org website source. - [Federal Election Commission](https://github.com/fecgov/fec-cms) – The content management system (CMS) for the new Federal Election Commission website. - [Table Tennis Wellington Business Class](https://github.com/jordij/bctt.nz) – Website for the table tennis business league in Wellington NZ. - [Jordi Joan’s blog](https://github.com/jordij/jordijoan.me) – Personal blog site using Wagtail CMS. - [Localore: Finding America](https://github.com/ghostwords/localore) – Wagtail-based CMS and Ansible playbooks for Localore: Finding America. - [Adventure Capitalists](https://github.com/AdventureCapitalists/website) – Wagtail powered website for the world's only investment band. - [NHS.UK Content Store](https://github.com/nhsuk/nhsuk-content-store) – NHS.UK content store and editing app. - [dev.hel.fi](https://github.com/City-of-Helsinki/devheldev) – City of Helsinki development site with Wagtail. - [Digital Helsinki](https://github.com/City-of-Helsinki/digihel) – City of Helsinki Digital Helsinki Wagtail CMS. - [Secure the News](https://github.com/freedomofpress/securethenews) – An automated scanner and web dashboard for tracking TLS deployment across news organizations. - [HackSoft](https://github.com/HackSoftware/hacksoft.io) – Website for HackSoft. - [HackConf](https://github.com/HackSoftware/hackconf.bg) – Website for the annual HackConf. - [RTEI](https://github.com/okfn/rtei) – Right to Education Index website (OKFN). - [BVSPCA](https://github.com/nfletton/bvspca) – Bow Valley SPCA website. - [Project TIER](https://github.com/ProjectTIER/projecttier.org) – Teaching Integrity in Empirical Research. - [SecureDrop](https://github.com/freedomofpress/securedrop.org) – Wagtail-powered website of the SecureDrop whistleblower document submission system. - [Consumer Financial Protection Bureau](https://github.com/cfpb/consumerfinance.gov) – The source code of the Wagtail-powered consumerfinance.gov is available here on GitHub. - [WesternFriend](https://github.com/WesternFriend/WF-website) - community website with directory, ecommerce, and online subscription - [WagtailParadise](https://github.com/abrahamrome/WagtailParadise) - demo Wagtail site showing common features and recipes - [Outreachy website](https://github.com/outreachy/website/) - Website for Outreachy, who provide internships in open source and open science. ## Contribute Contributions are always welcome! Please read the [contribution guidelines](.github/CONTRIBUTING.md) first. ## License [](https://creativecommons.org/publicdomain/zero/1.0/) To the extent possible under law, [Springload](https://www.springload.co.nz/) has waived all copyright and related or neighboring rights to this work.

:sunglasses: List of helpful resources added by the community for the community!

# Awesome Resources [](https://github.com/shahednasser/awesome-resources) :sunglasses: List of helpful resources added by the community for the community! > Please read [this discussion](https://github.com/shahednasser/awesome-resources/discussions/433) before contributing to Hacktoberfest. [](https://www.buymeacoffee.com/shahednasser) [](https://www.producthunt.com/posts/awesome-resources?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-awesome-resources) ## Contribution To add a resource or contribute, please check out our contribution guide [here](https://github.com/shahednasser/awesome-resources/blob/master/CONTRIBUTING.md). ## Emojis Filter and Cheatsheet (If you're viewing this one the website, try clicking the icon buttons to filter the items in the list based on the category) Throughout this list you'll see next to each resource and emoji. Here's what each mean: :books: Course, long series or list of tutorials, or books :file_folder: Documentation :speaker: Podcast :green_book: Single Tutorial :wrench: Tool :video_camera: Video Resource (Youtube, video course, etc...) :bulb: Other ## Content - [Algorithms](#algorithms) - [Android](#android) - [Angular](#angular) - [Artificial Intelligence](#artificial-intelligence) - [Big Data](#bigdata) - [Blockchain](#blockchain) - [Bots](#bots) - [C](#c) - [C++](#c-1) - [Clojure](#clojure) - [Computer Science](#computer-science) - [Theoretical Computer Science](#theoretical-computer-science) - [CSS](#css) - [CSharp](#csharp) - [Dart](#dart) - [Database](#database) - [Data Science](#data-science) - [Deep Learning](#deep-learning) - [DevOps](#devops) - [Django](#django) - [Docker](#docker) - [Express](#express) - [Ethical Hacking](#ethical-hacking) - [Expo](#expo) - [Fundamental CP algorithms](#fundamental-cp-algorithms) - [Algebra](#algebra) - [Combinatorics](#combinatorics) - [Data Structures](#data-structures) - [Dynamic Programming](#dynamic-programming) - [Graph Theory](#graph-theory) - [Linear Algebra](#linear-algebra) - [String Processing](#string-processing) - [Flutter](#flutter) - [GIT](#git) - [GitHub](#github) - [Go](#go) - [GraphQL](#graphql) - [HTML](#html) - [Ionic](#ionic) - [Java](#java) - [Javascript](#javascript) - [Kubernetes](#kubernetes) - [Laravel](#laravel) - [LESS](#less) - [Linux](#linux) - [Machine Learning](#machine-learning) - [Magento](#magento) - [Markdown](#markdown) - [MySQL](#mysql) - [NodeJS](#nodejs) - [Operating Systems](#operating-systems) - [PHP](#php) - [PostgreSQL](#postgresql) - [Power Automate](#power-automate) - [Python](#python) - [React](#react) - [React Native](#react-native) - [Regular Expressions](#regular-expressions) - [Ruby](#ruby) - [Rust](#rust) - [Sass](#sass) - [Spring](#spring) - [Svelte](#svelte) - [Swift](#swift) - [System Design](#system-design) - [Terraform](#terraform) - [Testing](#testing) - [Typescript](#typescript) - [Unity](#unity) - [Vue](#vue) - [Web Accessibility](#web-accessibility) - [Web Development](#web-development) - [Webpack](#webpack) - [Others](#others) - [Cheat Sheets](#cheat-sheets) - [Design](#design) - [Free Hosting](#free-hosting) - [Open Source](#open-source) - [Standard Template Library](#standard-template-library) - [VS Code](#vs-code) - [Tools](#tools) - [Talks and Podcasts](#talks-and-podcasts) --- **[⬆ Back to Index](#content)** ## Android - :books: [Vogella Tutorials](https://www.vogella.com/tutorials/android.html) - :books: [Android Basics with Kotlin Course](https://developer.android.com/courses/android-basics-kotlin/course) - :file_folder: [Build your first app](https://developer.android.com/training/basics/firstapp) - :file_folder: [Official Documentation](https://developer.android.com/docs) - :bulb: [Android™ Notes for Professionals book](https://books.goalkicker.com/AndroidBook/) - :bulb: [Android Developer Roadmap](https://roadmap.sh/android) - :bulb: [Android cheat sheet](http://alvinalexander.com/android/android-cheat-sheet-main-concepts/) - :bulb: [Android Tips & Tricks](https://github.com/nisrulz/android-tips-tricks) - :bulb: [Awesome Android](https://github.com/JStumpp/awesome-android) - :books: [Kotlin Fundamentals for Android Developers](https://www.udacity.com/course/kotlin-bootcamp-for-programmers--ud9011) - :video_camera: [Android Jetpack Compose For Beginners](https://www.youtube.com/playlist?list=PLQkwcJG4YTCSpJ2NLhDTHhi6XBNfk9WiC) --- **[⬆ Back to Index](#content)** ## Angular - :books: [Egghead.io - Angular](https://egghead.io/browse/frameworks/angular) - :video_camera: [Egghead.io - Build Redux Style Applications with Angular2, RxJS, and ngrx/store](https://egghead.io/courses/building-a-time-machine-with-angular-2-and-rxjs) - :video_camera: [Udemy - Introduction to Angular 2](https://www.udemy.com/introduction-to-angular2/) - :video_camera: [Udemy - Angular 2 with TypeScript for Beginners: The Pragmatic Guide](https://www.udemy.com/angular-2-tutorial-for-beginners/) - :video_camera: [Udemy - The Complete Guide to Angular 2](https://www.udemy.com/the-complete-guide-to-angular-2/) - :video_camera: [Pluralsight - Angular 2: First Look](https://www.pluralsight.com/courses/angular-2-first-look) - :video_camera: [Pluralsight - Angular 2: Getting Started](https://www.pluralsight.com/courses/angular-2-getting-started-update) - :bulb: [Angular Material - Material Design components for Angular](https://material.angular.io/) - :bulb: [Angular Powered Bootstrap - Bootstrap widgets for Angular](https://ng-bootstrap.github.io/#/home) - :books: [freeCodeCamp.org - Learn Angular - Full Tutorial Course](https://www.youtube.com/watch?v=2OHbjep_WjQ) --- **[⬆ Back to Index](#content)** ## Artificial Intelligence - :books: [Learn Basics Of AI](https://www.elementsofai.com/) --- **[⬆ Back to Index](#content)** ## Big Data - :video_camera: [Big Data](https://youtube.com/playlist?list=PL-Jc9J83PIiFFhKLTP1_UDUiNE0xXbJqr) --- **[⬆ Back to Index](#content)** ## Blockchain - :bulb: [KnowEthereum (handpicked ethereum resources)](https://knowethereum.com/) - :green_book: [Learn Solidity By Example](https://solidity-by-example.org/) - :books: [Crypto Zombie - Build DApps By Building Simple Games](https://cryptozombies.io/) - :video_camera: [Learn Blockchain, Solidity, and Full Stack Web3 Development with JavaScript](https://www.youtube.com/watch?v=gyMwXuJrbJQ) - :video_camera: [Solidity, Blockchain, and Smart Contract Course – Beginner to Expert Python Tutorial](https://www.youtube.com/watch?v=M576WGiDBdQ) - :video_camera: [Complete Blockchain tutorial for beginners](https://www.youtube.com/watch?v=gyMwXuJrbJQ&t=9919s) - :books: [Become a Web3 Developer](https://learnweb3.io/) --- **[⬆ Back to Index](#content)** ## Bots - :green_book: [Simple Twitter Bot Tutorial with Node.js](https://blog.shahednasser.com/simple-twitter-bot-tutorial-with-node-js/) - :green_book: [Create a Simple WhatsApp Chatbot without Coding](https://medium.com/ibm-data-ai/integrating-ibm-watson-assistant-with-whatsapp-e62dcaa803fd) - :file_folder: [Build Your First Wit App](https://wit.ai/docs/quickstart) - :green_book: [How to Make a Twitter Bot in Python With Tweepy](https://realpython.com/twitter-bot-python-tweepy/) - :video_camera: [Discord.JS v13 - Make your own Discord bots by following this video series](https://www.youtube.com/playlist?list=PLaxxQQak6D_f4Z5DtQo0b1McgjLVHmE8Q) --- **[⬆ Back to Index](#content)** ## C - :video_camera: [C Full Course](https://www.youtube.com/watch?v=87SH2Cn0s9A&t=3s) - :video_camera: [C Programming for Beginners](https://youtube.com/playlist?list=PLBlnK6fEyqRggZZgYpPMUxdY1CYkZtARR) - :books: [Learn C Org](https://www.learn-c.org) - :bulb: [C Cheatsheet](https://www.codewithharry.com/blogpost/c-cheatsheet) - :books: [C Tutorial - Learn C in Detail](https://www.scaler.com/topics/c/) --- **[⬆ Back to Index](#content)** ## C++ - :bulb: [CP Algorithms](https://cp-algorithms.com/index.html) - :books: [Tutorials Point Course](https://www.tutorialspoint.com/cplusplus/index.htm) - :bulb: [How to Learn the C++ Languages: The Ultimate List](https://www.toptal.com/c/the-ultimate-list-of-resources-to-learn-c-and-c-plus-plus) - :bulb: [The C++ Standard Template Library (STL)](https://www.geeksforgeeks.org/the-c-standard-template-library-stl/) - :books: [C++ Series GeeksForGeeks](https://www.geeksforgeeks.org/c-plus-plus/) - :books: [LearnCPP](https://www.learncpp.com/) - :video_camera: [C++ Tutorial](https://www.youtube.com/watch?v=DamuE8TM3xo&list=PLGLfVvz_LVvQ9S8YSV0iDsuEU8v11yP9M) - :file_folder: [C++ API Reference](https://www.cplusplus.com/reference/) - :video_camera: [C++ Standard Template Library in Practice](https://www.udemy.com/course/c-standard-template-library-in-practice/learn/) - :video_camera: [C++ Standard Template Library for Competative programming](https://www.youtube.com/watch?v=RRVYpIET_RU) - :bulb: [C++ Cheatsheet](https://www.codewithharry.com/blogpost/cpp-cheatsheet) - :books: [C++ Tutorial - Learn CPP in Detail](https://www.scaler.com/topics/cpp/) - :video_camera: [Complete C++ Placement DSA Course](https://youtube.com/playlist?list=PLDzeHZWIZsTryvtXdMr6rPh4IDexB5NIA) --- **[⬆ Back to Index](#content)** ## Clojure - :books: [Clojure for the Brave and True](https://www.braveclojure.com/clojure-for-the-brave-and-true/) - :bulb: [Clojure Cheatsheet](https://clojure.org/api/cheatsheet) - :file_folder: [Clojure Documentation](https://clojuredocs.org/) - :file_folder: [Clojure API](https://clojure.org/api/api) - :video_camera: [Clojure Tutorial](https://www.youtube.com/watch?v=ciGyHkDuPAE) - :video_camera: [Clojure Crash Course](https://www.youtube.com/watch?v=ZkJcVCW9GqY) - :video_camera: [The Clojure Language](https://www.youtube.com/playlist?list=PLAC43CFB134E85266) - :video_camera: [Clojure tutorial by a Defold developer](https://www.youtube.com/playlist?list=PLXsXu5srjNlxI7b2smnHxDeMMwR4mVZ2m) --- **[⬆ Back to Index](#content)** ## Computer Science - :bulb: [Awesome Awesomeness](https://github.com/bayandin/awesome-awesomeness) - :books: [CS50](https://cs50.harvard.edu/) - :books: [Khan Academy - Computer Science](https://www.khanacademy.org/computing/computer-science) - :bulb: [Open Source Society University - Path to a free self-taught education in Computer Science!](https://github.com/ossu/computer-science) - :books: [Teach Yourself Computer Science](https://teachyourselfcs.com/) - :books: [Introduction to Compilers and How they Work](https://www.edx.org/course/compilers) --- **[⬆ Back to Index](#content)** ## Theoretical Computer Science - :file_folder: [Agda usage](https://agda.readthedocs.io/en/v2.6.0.1/getting-started/what-is-agda.html) - :books: [Freely available programming books](https://github.com/EbookFoundation/free-programming-books) - :file_folder: [Programming Language Foundation in Agda](https://plfa.github.io/) - :video_camera: [Type Theory playlist](https://www.youtube.com/playlist?list=PLoPjtLnIwJuJcZpSHIsVliXFsTH99-2W5) --- **[⬆ Back to Index](#content)** ## CSS - :books: [CSS Tutorial on W3Schools](https://www.w3schools.com/css/) - :bulb: [30SecondsOfCode CSS Snippet](https://www.30secondsofcode.org/css/p/1) - :green_book: [A Complete Guide to Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) - :green_book: [A Complete Guide to Grid](https://css-tricks.com/snippets/css/complete-guide-grid/) - :wrench: [CSS Framework - Bootstrap](https://getbootstrap.com/) - :wrench: [CSS Framework - Bulma](https://bulma.io/) - :wrench: [CSS Framework - Materialize](https://materializecss.com/) - :wrench: [CSS Framework - Tailwind CSS](https://tailwindcss.com/) - :video_camera: [CSS Flexbox - Wes Bos](https://flexbox.io/) - :video_camera: [CSS Grid - Wes Bos](https://cssgrid.io/) - :wrench: [CSS Box-Shadow Generator](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Backgrounds_and_Borders/Box-shadow_generator) - :wrench: [CSS Gradient Generator](https://cssgradient.io/) - :wrench: [CSS Animated Gradient Background Generator](https://animated-gradient-background-generator.netlify.app/) - :wrench: [Online CSS3 Code Generator - EnjoyCSS](https://enjoycss.com/) : A gallery with ready made solutions from text effects to art and templates. - :wrench: [CSS Section Separator Generator](https://wweb.dev/resources/css-separator-generator/) - :bulb: [CSS Grid - A simple visual cheatsheet by Malven](https://grid.malven.co/) - :bulb: [CSS Flex - A simple visual cheatsheet by Malven](https://flexbox.malven.co/) - :bulb: [CSSBattle](https://cssbattle.dev/) - :books: [Learning Advanced CSS and HTML](https://learn.shayhowe.com/advanced-html-css/) - :bulb: [Style Stage - A modern CSS showcase styled by community contributions](https://stylestage.dev/) - :video_camera: [Tailwind CSS Tutorial for Beginners - Full Course](https://www.youtube.com/watch?v=4wGmylafgM4) - :video_camera: [Introduction to CSS](https://www.youtube.com/playlist?list=PLZlA0Gpn_vH9D0J0Mtp6lIiD_8046k3si) - :video_camera: [CSS Units px, rem, em, vh, vw / Absolute Vs Relative Units](https://nados.io/video/css-units-px-rem-em-vh-vw-absolute-vs-relative-units) - :wrench: [Whirl](https://whirl.netlify.app/) : CSS loading animations with minimal effort! - :wrench: [CSS Selector Generator](https://github.com/antonmedv/finder) - :bulb: [CSS Cheat Sheet](https://www.hostinger.com/tutorials/css-cheat-sheet) - :books: [CSS Tutorial - Learn CSS in Detail](https://www.scaler.com/topics/css/) - :wrench: [CSS Multicolor Gradient](https://gradienta.io/) - :bulb: [CSS Grid Garden](https://cssgridgarden.com/) - :bulb: [CSS Flexbox-Froggy](https://flexboxfroggy.com/) - Learn Flexbox while playing - :bulb: [Knights of the Flexbox Table](https://knightsoftheflexboxtable.com) - :books: [Learn CSS From Scratch](https://web.dev/learn/css/) - :bulb: [100 Days CSS Challenge](https://100dayscss.com/) - :bulb: [CSS Reference](https://cssreference.io/) - :wrench: [CSS Validator](https://jigsaw.w3.org/css-validator/) - :wrench: [CSS Color Picker](https://0to255.com/) - :wrench: [CSS Framework - UIkit](https://getuikit.com/) - :wrench: [CSS Framework - Skeleton](http://getskeleton.com/) - :wrench: [CSS Framework - Pure](https://purecss.io/) - :wrench: [CSS Framework - Material Design Lite](https://getmdl.io/) - :green_book: [Understanding Layout Algorithms](https://www.joshwcomeau.com/css/understanding-layout-algorithms/) --- **[⬆ Back to Index](#content)** ## CSharp - :bulb: [5 books every C# developer should read](https://medium.com/@jakubgarfield/5-books-every-c-developer-should-read-83844a5e2e3c) - :bulb: [C# From a Java Developer's Perspective](http://www.25hoursaday.com/CsharpVsJava.html) - :file_folder: [C# Microsoft Docs](https://docs.microsoft.com/en-us/dotnet/csharp/tutorials/) - :books: [The C# Yellow Book](https://www.robmiles.com/c-yellow-book/) - :books: [Free C# online courses](https://skillcombo.com/topic/c-sharp/) --- **[⬆ Back to Index](#content)** ## Dart - :file_folder: [Asynchronous programming: futures, async, await](https://dart.dev/codelabs/async-await) - :file_folder: [Books about Dart](https://dart.dev/resources/books) - :file_folder: [Dart Cheatsheet](https://dart.dev/codelabs/dart-cheatsheet) - :file_folder: [DartPad in tutorials: best practices](https://dart.dev/resources/dartpad-best-practices) - :video_camera: [Dart videos from Google](https://www.youtube.com/playlist?list=PLjxrf2q8roU0Net_g1NT5_vOO3s_FR02J) - :video_camera: [Dart Tutorial for Beginners: Basics and Fundamentals for Flutter](https://www.youtube.com/playlist?list=PLlxmoA0rQ-LyHW9voBdNo4gEEIh0SjG-q) - :books: [Intro to Dart for Java Developers](https://codelabs.developers.google.com/codelabs/from-java-to-dart/#0) - :file_folder: [Iterable collections](https://dart.dev/codelabs/iterables) --- **[⬆ Back to Index](#content)** ## Database - :video_camera: [Practical SQL Series](https://youtube.com/playlist?list=PL-Jc9J83PIiFRR58Ezyy2z3gYhPA0lKmt) - :video_camera: [DBMS Database Management System-For College](https://www.youtube.com/playlist?list=PLxCzCOWd7aiFAN6I8CuViBuCdJgiOkT2Y) - :video_camera: [Database Systems - Cornell University Course (SQL, NoSQL, Large-Scale Data Analysis)](https://www.youtube.com/watch?v=4cWkVbC2bNE) - :books: [SQL Bolt - learn SQL with simple, interactive exercises](https://sqlbolt.com/) --- **[⬆ Back to Index](#content)** ## Data Science - :books: [DPhi-Data Science Courses](https://dphi.tech/) - :books: [Data Science Methodology](https://cognitiveclass.ai/courses/data-science-methodology-2) - :bulb: [Data Science Cheat Sheets](https://www.kaggle.com/timoboz/data-science-cheat-sheets) - :books: [IBM Data Science Coursera](https://www.coursera.org/professional-certificates/ibm-data-science) - :video_camera: [Introduction to Data Science with R](https://www.youtube.com/watch?v=32o0DnuRjfg&list=PLTJTBoU5HOCRrTs3cJK-PbHM39cwCU0PF&index=1) - :bulb: [Machine Learning Algorithms from Scratch](https://github.com/python-engineer/MLfromscratch) - :books: [Python for Data Science: Fundamentals](https://www.dataquest.io/course/python-for-data-science-fundamentals) - :books: [Python for Data Science: Intermediate](https://www.dataquest.io/course/python-for-data-science-intermediate/) --- **[⬆ Back to Index](#content)** ## Deep Learning - :books: [Andrew Ng's Deep Learning Specializations Course](https://www.coursera.org/specializations/deep-learning) - :green_book: [Convolutional networks CS231n](https://cs231n.github.io/convolutional-networks/) - :books: [Deep Learning Fundamentals](https://www.dataquest.io/course/deep-learning-fundamentals/) - :bulb: [Deep learning cheat sheet](https://stanford.edu/~shervine/teaching/cs-229/cheatsheet-deep-learning) - :books: [Natural Language Processing CS224n](http://web.stanford.edu/class/cs224n/) - :books: [IBM Deep Learning Course with certification](https://cognitiveclass.ai/courses/introduction-deep-learning) - :books: [Geometric Deep Learning](https://geometricdeeplearning.com/lectures/) - :books: [CS224W: Machine Learning with Graphs](http://web.stanford.edu/class/cs224w/) --- **[⬆ Back to Index](#content)** ## Django - :file_folder: [Django Documentation](https://docs.djangoproject.com/) - :green_book: [Deploy Django Application on Heroku](https://www.codementor.io/@jamesezechukwu/how-to-deploy-django-app-on-heroku-dtsee04d4) - :video_camera: [Everything about using Celery with Django](https://youtube.com/playlist?list=PLLz6Bi1mIXhHKA1Szy2aj9Jbs6nw9fhNY) - :video_camera: [Python Backend Web Development Course (with Django)](https://youtu.be/jBzwzrDvZ18) - :video_camera: [Django tutorial for beginners](https://www.youtube.com/playlist?list=PLsyeobzWxl7r2ukVgTqIQcl-1T0C2mzau) - :bulb: [Django Cheatsheet](https://www.codewithharry.com/blogpost/django-cheatsheet) - :green_book: [Django REST APIs](https://djangostars.com/blog/rest-apis-django-development/) --- **[⬆ Back to Index](#content)** ## DevOps - :file_folder: [90DaysOfDevOps](https://github.com/MichaelCade/90DaysOfDevOps) - :file_folder: [Azure DevOps](https://azure.microsoft.com/en-us/overview/devops-tutorial/) - :green_book: [Agile vs Devops](https://enterprisersproject.com/article/2019/1/agile-vs-devops-whats-difference) - :books: [Become a DevOps Engineer - Linkedin Learning](https://www.linkedin.com/learning/paths/become-a-devops-engineer?u=57692769) - :bulb: [DevOps terms: 10 essential concepts, explained](https://enterprisersproject.com/article/2019/8/devops-terms-10-essential-concepts) - :books: [DevOps for Dummies - by IBM](https://www.ibm.com/downloads/cas/P9NYOK3B) - :bulb: [DevOps Roadmap for beginners](https://roadmap.sh/devops) - :bulb: [How To Become a DevOps Engineer In Six Months or Less](https://medium.com/@devfire/how-to-become-a-devops-engineer-in-six-months-or-less-366097df7737) - :video_camera: [Free DevOps Bootcamp from beginner to advanced](https://www.youtube.com/playlist?list=PL9gnSGHSqcnoqBXdMwUTRod4Gi3eac2Ak) - :video_camera: [DevOps roadmap with Resources](youtube.com/watch?v=7l_n97Mt0ko&t=6s) - :bulb: [How to Become a DevOps Engineer in Six Months - by Spacelift](https://spacelift.io/blog/how-to-become-devops-engineer) - :bulb: [9 DevOps Best Practices – What You Should Do and NOT Do - by Spacelift](https://spacelift.io/blog/devops-best-practices) - :bulb: [Best tools for DevOps](https://kush01.hashnode.dev/best-tools-for-devops) - :books: [DevOps Bootcamp](https://www.commclassroom.org/devops) --- **[⬆ Back to Index](#content)** ## Docker - :file_folder: [Docker Overview & Basics](https://docs.docker.com/get-started/overview/) - :video_camera: [Docker for beginners](https://youtu.be/zJ6WbK9zFpI) - :books: [Docker Curriculum Ebook](https://docker-curriculum.com/) - :wrench: [Docker Labs environment](https://labs.play-with-docker.com/) - :books: [Docker labs](https://www.sharelearn.net/practice/dockerlabs) - :bulb: [Docker Cheat sheet](https://dockerlabs.collabnix.com/docker/cheatsheet/) --- **[⬆ Back to Index](#content)** ## Express - :green_book: [LinkedIn Login using Node JS, Express and passport](https://www.loginradius.com/engineering/blog/linkedin-login-using-node-passport/) - :books: [Curated ExpressJS Courses](https://hackr.io/tutorials/learn-express-js) - a list of community curated resources - :books: [ExpressJS Courses at Classpert](https://classpert.com/express-js) - a list of courses (free and paid) from Classpert Online Course Search - :bulb: [Security Practices in Express App](https://expressjs.com/en/advanced/best-practice-security.html) --- **[⬆ Back to Index](#content)** ## Algorithms - :bulb: [List of helpful algos](https://www.geeksforgeeks.org/fundamentals-of-algorithms/) - :books: [Stanford University Algorithms: Design and Analysis, Part 1](https://online.stanford.edu/courses/soe-ycsalgorithms1-algorithms-design-and-analysis-part-1) - :books: [Stanford University Algorithms: Design and Analysis, Part 2](https://online.stanford.edu/courses/soe-ycs0001-algorithms-design-and-analysis-part-2) - :video_camera: [Sorting Algorithms](https://www.youtube.com/playlist?list=PL2_aWCzGMAwKedT2KfDMB9YA5DgASZb3U) - mycodeschool - :bulb: [Algorithm Visualizer](https://algorithm-visualizer.org/) - :video_camera: [Greedy Algorithm by Abdul Bari](https://www.youtube.com/playlist?list=PL8zDQ1C22qvvwdkPj1uXLpwzcYDJtjnze) --- **[⬆ Back to Index](#content)** ## Ethical Hacking - :bulb: [Collection of hackers, pentesters & security researchers](https://github.com/Hack-with-Github/Awesome-Hacking) - :video_camera: [Ethical Hacking from Scratch](https://www.udemy.com/course/learn-ethical-hacking-from-scratch/learn/) - :wrench: [Open Source Reverse Engineering Platform](https://github.com/radareorg/cutter) - :video_camera: [Penetration Testing Bootcamp](https://hackersploit.org/penetration-testing-bootcamp/) - :bulb: [Practical-Ethical-Hacking-Resources](https://github.com/TCM-Course-Resources/Practical-Ethical-Hacking-Resources) --- **[⬆ Back to Index](#content)** ## Networking - :video_camera: [Fundamentals of Networking](https://www.youtube.com/playlist?list=PLIFyRwBY_4bRLmKfP1KnZA6rZbRHtxmXi) - :video_camera: [Computer Networking Full Course - OSI Model Deep Dive with Real Life Examples](https://www.youtube.com/watch?v=IPvYjXCsTg8) - :video_camera: [Computer Networking Course - Network Engineering (CompTIA Network+ Exam Prep)](https://www.youtube.com/watch?v=qiQR5rTSshw) --- **[⬆ Back to Index](#content)** ## Expo - :video_camera: [Expo Crash Course by Traversy Media](https://www.youtube.com/watch?v=Hf4MJH0jDb4) --- **[⬆ Back to Index](#content)** ## Fundamental CP algorithms ### Algebra - :green_book: [Binary Exponentiation](https://cp-algorithms.com/algebra/binary-exp.html) - :green_book: [Euclidean algorithm for computing the greatest common divisor](https://cp-algorithms.com/algebra/euclid-algorithm.html) - :green_book: [Extended Euclidean Algorithm](https://cp-algorithms.com/algebra/extended-euclid-algorithm.html) - :green_book: [Fibonacci Numbers](https://cp-algorithms.com/algebra/fibonacci-numbers.html) - :green_book: [Linear Diophantine Equations](https://cp-algorithms.com/algebra/linear-diophantine-equation.html) ### Combinatorics - :green_book: [Binomial Coefficients](https://cp-algorithms.com/combinatorics/binomial-coefficients.html) - :green_book: [Catalan Numbers](https://cp-algorithms.com/combinatorics/catalan-numbers.html) - :green_book: [Finding Power of Factorial Divisor](https://cp-algorithms.com/algebra/factorial-divisors.html) ### Data Structures - :video_camera: [DSA + Java Interview Preparation Course](https://youtube.com/playlist?list=PL9gnSGHSqcnr_DxHsP7AW9ftq0AtAyYqJ) - :video_camera: [DSA + C++ Interview Preparation Course](https://www.youtube.com/watch?v=z9bZufPHFLU&list=PLfqMhTWNBTe0b2nM6JHVCnAkhQRGiZMSJ) - :video_camera: [Data Structures](https://www.youtube.com/playlist?list=PL2_aWCzGMAwI3W_JlcBbtYTwiQSsOTa6P) - :video_camera: [DSA-One Course - The Complete Data Structures and Algorithms Course](https://www.youtube.com/playlist?list=PLUcsbZa0qzu3yNzzAxgvSgRobdUUJvz7p) - :green_book: [Minimum Stack / Minimum Queue](https://cp-algorithms.com/data_structures/stack_queue_modification.html) - :books: [Data Structures Tutorial - Scalar](https://www.scaler.com/topics/data-structures/) - :books: [Princeton University Algorithms, Part 1](https://www.coursera.org/learn/algorithms-part1) - :books: [Princeton University Algorithms, Part 2](https://www.coursera.org/learn/algorithms-part2) - :books: [Sparse Table](https://cp-algorithms.com/data_structures/sparse-table.html) - :books: [This is CS50x](https://cs50.harvard.edu/x/2021) - David J. Malan - :books: [IIT Bombay Foundation of Data Structures (CS213.1x)](https://courses.edx.org/courses/course-v1:IITBombayX+CS213.1x+1T2017/course/) - :books: [Intro to Data Structures and Algorithms](https://www.udacity.com/course/data-structures-and-algorithms-in-python--ud513) - Brynn Claypoole, Horatio Thomas ### Dynamic Programming - :green_book: [Divide and Conquer DP](https://cp-algorithms.com/dynamic_programming/divide-and-conquer-dp.html) - :green_book: [Dynamic Programming on Broken Profile. Problem "Parquet"](https://cp-algorithms.com/dynamic_programming/profile-dynamics.html) - :green_book: [Dynamic Programming GeeksforGeeks](https://www.geeksforgeeks.org/dynamic-programming/) - :green_book: [Finding the largest zero submatrix](https://cp-algorithms.com/dynamic_programming/zero_matrix.html) - :video_camera: [Best Dynamic Programming Playlist](https://youtube.com/playlist?list=PL_z_8CaSLPWekqhdCPmFohncHwz8TY2Go) ### Linear Algebra - :green_book: [Gauss & System of Linear Equations](https://cp-algorithms.com/linear_algebra/linear-system-gauss.html) - :green_book: [Gauss & Determinant](https://cp-algorithms.com/linear_algebra/determinant-gauss.html) - :green_book: [Kraut & Determinant](https://cp-algorithms.com/linear_algebra/determinant-kraut.html) - :green_book: [Rank of a matrix](https://cp-algorithms.com/linear_algebra/rank-matrix.html) ### String Processing - :green_book: [Aho-Corasick algorithm](https://cp-algorithms.com/string/aho_corasick.html) - :green_book: [Prefix function - Knuth-Morris-Pratt](https://cp-algorithms.com/string/prefix-function.html) - :green_book: [Rabin-Karp for String Matching](https://cp-algorithms.com/string/rabin-karp.html) - :green_book: [String Hashing](https://cp-algorithms.com/string/string-hashing.html) - :green_book: [Suffix Array](https://cp-algorithms.com/string/suffix-array.html) - :green_book: [Z-function](https://cp-algorithms.com/string/z-function.html) ### Graph Theory - :books: [Introduction to Graph Theory](https://www.udemy.com/course/graph-theory-algorithms/learn/) - :green_book: [Breadth First Search](https://cp-algorithms.com/graph/breadth-first-search.html) - :green_book: [Depth First Search](https://cp-algorithms.com/graph/depth-first-search.html) - :green_book: [Shortest Path (Dijkstra's Algorithm)](https://cp-algorithms.com/graph/dijkstra.html) - :green_book: [Shortest Path with Negative Weights (Bellman Ford Algorithm)](https://cp-algorithms.com/graph/bellman_ford.html) - :green_book: [Minimum Spanning Tree (Prim's Algorithm)](https://cp-algorithms.com/graph/mst_prim.html) - :green_book: [Minimum Spanning Tree (Kruskal's Algorithm)](https://cp-algorithms.com/graph/mst_kruskal.html) - :green_book: [Max Flow (Ford-Fulkerson and Edmonds-Karp Algorithms)](https://cp-algorithms.com/graph/edmonds_karp.html) - :video_camera: [Striver's Graph Series](https://www.youtube.com/playlist?list=PLgUwDviBIf0rGEWe64KWas0Nryn7SCRWw) --- **[⬆ Back to Index](#content)** ## Flutter - :green_book: [Adding Google Maps to a Flutter app](https://codelabs.developers.google.com/codelabs/google-maps-in-flutter/#0) - :video_camera: [Animation in Flutter](https://www.youtube.com/playlist?list=PLjxrf2q8roU2v6UqYlt_KPaXlnjbYySua) - :green_book: [Building beautiful UIs with Flutter](https://codelabs.developers.google.com/codelabs/flutter/#0) - :green_book: [Building Beautiful Transitions with Material Motion for Flutter](https://codelabs.developers.google.com/codelabs/material-motion-flutter/) - :green_book: [Building a Cupertino app with Flutter](https://codelabs.developers.google.com/codelabs/flutter-cupertino/#0) - :green_book: [Build a Photo Sharing app with Google Photos and Flutter](https://codelabs.developers.google.com/codelabs/google-photos-sharing/#0) - :green_book: [Firebase for Flutter](https://codelabs.developers.google.com/codelabs/flutter-firebase/#0) - :video_camera: [Flutter Tutorial for Beginners - YouTube](https://www.youtube.com/playlist?list=PL4cUxeGkcC9jLYyp2Aoh6hcWuxFDX6PBJ) - :video_camera: [Flutter Animation Tutorial - YouTube](https://www.youtube.com/playlist?list=PL4cUxeGkcC9gP1qg8yj-Jokef29VRCLt1) - :video_camera: [Flutter & Firebase App Build - YouTube](https://www.youtube.com/playlist?list=PL4cUxeGkcC9j--TKIdkb3ISfRbJeJYQwC) - :file_folder: [Flutter Documentation](https://flutter.dev/docs) - :green_book: [How to test a Flutter app](https://codelabs.developers.google.com/codelabs/flutter-app-testing/#0) - :video_camera: [Reactive Programming with Flutter](https://www.youtube.com/playlist?list=PL_Wj0DgxTlJc8E3ulwdekyVI4Wc819azh) - :file_folder: [Write your first Flutter app, Part 1](https://flutter.dev/docs/get-started/codelab) - :green_book: [Write your first Flutter app, Part 2](https://codelabs.developers.google.com/codelabs/first-flutter-app-pt2/#0) - :green_book: [Write a Flutter desktop application](https://codelabs.developers.google.com/codelabs/flutter-github-graphql-client/#0) - :video_camera: [Flutter Bloc Complete Course](https://www.youtube.com/watch?v=THCkkQ-V1-8) - :video_camera: [Flutter Bloc - from Zero To HERO](https://www.youtube.com/playlist?list=PLptHs0ZDJKt_T-oNj_6Q98v-tBnVf-S_o) --- **[⬆ Back to Index](#content)** ## Free Hosting - :wrench: [Netlify](https://www.netlify.com/) - :wrench: [Heroku](https://www.heroku.com/) - :wrench: [Vercel](https://vercel.com/) - :wrench: [Fly.io](https://fly.io/) - :wrench: [Github Pages](http://pages.github.com) - :wrench: [Gitlab Pages](http://docs.gitlab.com/ee/user/project/pages) - :wrench: [Deta](https://www.deta.sh/) - :wrench: [InfinityFree](https://infinityfree.net/) - :wrench: [Cyclic](https://www.cyclic.sh/) - :wrench: [Surge](https://surge.sh/) - :wrench: [Adaptable](https://adaptable.io/) --- **[⬆ Back to Index](#content)** ## GIT - :file_folder: [Pro Git Book](https://git-scm.com/book/en/v2/) - :books: [Udacity's Git Commit Style Guide](https://udacity.github.io/git-styleguide/) - :bulb: [Learn Git Branching](https://learngitbranching.js.org/): A beautiful visual guide to learn simple and advanced Git. - :bulb: [Git Explorer](https://gitexplorer.com/) - :bulb: [NPD Software :: Git Cheatsheet](http://ndpsoftware.com/git-cheatsheet.html#loc=index;) - :bulb: [Git notes for Professionals Book](https://goalkicker.com/GitBook/) - :books: [Introduction to Git and Github ebook - Bobby Iliev(Markdown, PDF)](https://github.com/bobbyiliev/introduction-to-git-and-github-ebook) - :books: [Introduction to Git and Github - Launch School](https://launchschool.com/books/git) - :books: [Git Immersion](https://gitimmersion.com/) - :bulb: [30SecondsOfCode Git Snippets](https://www.30secondsofcode.org/git/p/1) - :bulb: [Git - the simple guide](https://rogerdudler.github.io/git-guide/) - :bulb: [Oh My Git](https://blinry.itch.io/oh-my-git): Open source Git learning game. - :bulb: [Git Exercises by Fracz](https://gitexercises.fracz.com/) - :green_book: [A Visual Git Reference](https://marklodato.github.io/visual-git-guide/index-en.html) - :green_book: [GIT PURR! Git Commands Explained with Cats](https://girliemac.com/blog/2017/12/26/git-purr/) - :bulb: [Top GitHub best practices for developers](https://www.datree.io/resources/github-best-practices) - :books: [Learning Git By Atlassian](https://www.atlassian.com/git) - :video_camera: [An Introduction to Git and GitHub by Brian Yu](https://www.youtube.com/watch?v=MJUJ4wbFm_A) - :file_folder: [Git Documentaton](https://git-scm.com/docs) - :green_book: [Dangit, Git!?!](https://dangitgit.com/en) - :bulb: [Using multiple Git accounts with SSH keys](https://gist.github.com/oanhnn/80a89405ab9023894df7) - :green_book: [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) - :video_camera: [Kunal Kushwaha's Complete Git and GitHub tutorial](https://www.youtube.com/watch?v=apGV9Kg7ics) - :video_camera: [Git & GitHub Tutorial For Beginners In Hindi - हिंदी में](https://www.youtube.com/watch?v=gwWKnnCMQ5c) --- **[⬆ Back to Index](#content)** ## GitHub - :green_book: [How to create a pull request in GitHub](https://opensource.com/article/19/7/create-pull-request-github) - :green_book: [Squash mutilple commits into one in GitHub](https://www.internalpointers.com/post/squash-commits-into-one-git) - :books: [GitHub Learning Lab](https://lab.github.com/) - :video_camera: [Hands-on-experience-of-git-commands](https://www.youtube.com/watch?v=uj4fy4kpaOA) - :green_book: [Step by Step Guide to Contributing on GitHub](https://www.dataschool.io/how-to-contribute-on-github/) - :bulb: [GitHub Protips: Tips, tricks, hacks, and secrets from Lee Reilly](https://github.blog/2020-04-09-github-protips-tips-tricks-hacks-and-secrets-from-lee-reilly/) - :green_book: [GitHub Minesweeper](https://profy.dev/project/github-minesweeper/intro-overview): hands-on introduction to working with Git and GitHub in a team - :wrench: [Readme.so](https://readme.so/): Easiest way to make good readme for your github repos - :video_camera: [Complete Git and Github Tutorial](https://www.youtube.com/watch?v=apGV9Kg7ics) - :green_book: [How to Create Github Profile README](https://www.sitepoint.com/github-profile-readme/) --- **[⬆ Back to Index](#content)** ## Go - :file_folder: [A Tour of Go - A Complete Tour of the Go Programming Language.](https://tour.golang.org/) - :books: [Go by Example](https://gobyexample.com/) - :books: [Gophercises: Free Coding Exercises for Budding Gophers](https://gophercises.com/) - :books: [Learn Go with Tests](https://quii.gitbook.io/learn-go-with-tests/) - :bulb: [50 Shades of Go: Traps, Gotchas, and Common Mistakes for New Golang Devs](http://devs.cloudimmunity.com/gotchas-and-common-mistakes-in-go-golang/) - :video_camera: [Golang for begineers - YouTube playlist](https://www.youtube.com/playlist?list=PLRAV69dS1uWSR89FRQGZ6q9BR2b44Tr9N) - :video_camera: [Let's go with golang - YouTube playlist](https://www.youtube.com/playlist?list=PLRAV69dS1uWQGDQoBYMZWKjzuhCaOnBpa) - :file_folder: [Effective Go](https://go.dev/doc/effective_go) --- **[⬆ Back to Index](#content)** ## GraphQL - :video_camera: [GraphQL tutorial for beginners](https://www.howtographql.com/) - :books: [GraphQL Tutorials](https://www.tutorialspoint.com/graphql/index.htm) - :video_camera: [Complete App with GraphQl](https://www.youtube.com/playlist?list=PL55RiY5tL51rG1x02Yyj93iypUuHYXcB_) - :video_camera: [Learn GraphQL with React](https://www.youtube.com/playlist?list=PL4cUxeGkcC9iK6Qhn-QLcXCXPQUov1U7f) - :books: [Apollo Odyssey - GraphQL Tutorials](https://www.apollographql.com/tutorials/) --- **[⬆ Back to Index](#content)** ## HTML - :bulb: [HTML Cheat sheet by CodeWithHarry](https://www.codewithharry.com/blogpost/html-cheatsheet) - :bulb: [5 HTML Tricks Nobody is Talking About](https://javascript.plainenglish.io/5-html-tricks-nobody-is-talking-about-a0480104fe19) - :bulb: [11 Lifesaving HTML/CSS Tricks Every Developer Should Know](https://www.lambdatest.com/blog/html-css-tricks/) - :bulb: [HTML CheatSheet](https://htmlcheatsheet.com/) - :file_folder: [HTML documentation for beginners](https://html.com/) - :green_book: [Build your first HTML Project](https://www.freecodecamp.org/news/html-css-tutorial-build-a-recipe-website/) - :video_camera: [HTML tutorial for beginners](https://www.youtube.com/playlist?list=PL4cUxeGkcC9ibZ2TSBaGGNrgh4ZgYE6Cc) - :video_camera: [Introduction to HTML](https://www.youtube.com/playlist?list=PLgUwDviBIf0rGEWe64KWas0Nryn7SCRWw) - :video_camera: [Learn HTML! with 100Devs](https://www.youtube.com/watch?v=eCRbEILXXmE) - :books: [HTML Tutorial - Learn HTML in Detail](https://www.scaler.com/topics/html/) --- **[⬆ Back to Index](#content)** ## Ionic - :video_camera: [Angular to React for Ionic Developers](https://www.youtube.com/watch?v=r0OqtdjCUK8) - :green_book: [Add a Firebase Database to your Ionic App](https://ionicthemes.com/tutorials/add-a-firebase-database-to-your-ionic-app) - :bulb: [Awesome Ionic - A curated list of awesome Ionic libraries, resources, and solutions from Ionic 1 to the latest version of the framework](https://github.com/Alexintosh/Awesome-Ionic) - :green_book: [Building an Ionic JWT Refresh Token Flow](https://devdactic.com/ionic-jwt-refresh-token/) --- **[⬆ Back to Index](#content)** ## Java - :books: [Learn Java - Free Interactive Java Tutorial](https://www.learnjavaonline.org/) - :bulb: [10 Simple Java Projects for Beginners](https://javahungry.blogspot.com/2019/12/java-projects-for-beginners.html) - :video_camera: [Advanced Java Programming](https://www.udemy.com/course/advanced-java-programming/) - :books: [Learn Servlet Tutorials](https://www.javatpoint.com/servlet-tutorial) - :books: [Object Oriented Programming in Java](https://www.coursera.org/learn/object-oriented-java) - :books: [Learn Java Programming Language Step by Step](http://www.c4learn.com/javaprogramming/) - :video_camera: [Java Full Course](https://www.youtube.com/watch?v=xk4_1vDrzzo) - :books: [Java Programming - Test Automation University](https://testautomationu.applitools.com/java-programming-course) - :books: [Java Programming - University of Helsinki](https://java-programming.mooc.fi) - :video_camera: [Learn Java 8 - Full Tutorial for Beginners - freeCodeCamp](https://youtu.be/grEKMHGYyns) - :video_camera: [Java Beginner Course - freeCodeCamp](https://youtu.be/7WiJGTPuVeU) - :video_camera: [Java Tutorial for Beginners - Programming with Mosh](https://youtu.be/eIrMbAQSU34) - :video_camera: [Java + DSA + Interview Preparation Course](https://www.youtube.com/playlist?list=PL9gnSGHSqcnr_DxHsP7AW9ftq0AtAyYqJ) - :bulb: [Java Cheatsheet](https://www.codewithharry.com/blogpost/java-cheatsheet) - :books: [Java Tutorial - Learn Java Programming in Detail](https://www.scaler.com/topics/java/) - :books: [Java Programming Cheat sheet - Princeton](https://introcs.cs.princeton.edu/java/11cheatsheet/) --- **[⬆ Back to Index](#content)** ## Javascript - :video_camera: [Learn How JavaScripts works Behind the Scene by Akshay Saini](https://www.youtube.com/playlist?list=PLlasXeu85E9cQ32gLCvAvr9vNaUccPVNP) - :books: [CoderslangJS](https://js.coderslang.com/) - :bulb: [Beginner JavaScript Notes + Reference by Wes Bos](https://wesbos.com/javascript) - :green_book: [Learn Modern JavaScript ES6 \| ES7 \| ES8](https://codeloop.org/learn-modern-javascript-es6-es7-es8/) - :green_book: [Learn JavaScript through a game](https://dev.to/nitdgplug/learn-javascript-through-a-game-1beh) - :bulb: [JavaScript ES2020 - The Features You Should Know](https://catalins.tech/javascript-es2020-the-features-you-should-know) - :bulb: [S.O.L.I.D. Principles around You, in JavaScript](https://dev.to/francescoxx/s-o-l-i-d-principles-around-you-in-javascript-5gao) - :bulb: [The 30 days JavaScript Challenge](https://javascript30.com/) - :video_camera: [JavaScript: Understanding the Weird Parts](https://www.youtube.com/watch?v=Bv_5Zv5c-Ts&ab_channel=TonyAlicea) - :books: [Full Stack Javascript course by The Odin Project](https://www.theodinproject.com/paths/full-stack-javascript) - :books: [Building Front-End Web Apps with Plain JavaScript](https://web-engineering.info/tech/JsFrontendApp/book/) - :books: [The Modern JavaScript Tutorial](https://javascript.info/) - :bulb: [20 Killer JavaScript One Liners](https://dev.to/saviomartin/20-killer-javascript-one-liners-94f) - :books: [You Don't Know JS Yet (book series)](https://github.com/getify/You-Dont-Know-JS) - :bulb: [30SecondsOfCode JavaScript Snippets](https://www.30secondsofcode.org/js/p/1) - :books: [Full Stack open 2021](https://fullstackopen.com/en/) - :green_book: [Demystifying JavaScript Promises - A New Way to Learn](https://blog.greenroots.info/series/javascript-promises) - :bulb: [Favorite JavaScript Utilities in single line of code! No more!](https://1loc.dev/) - :bulb: [JavaScript CheatSheet by DaveChild](https://cheatography.com/davechild/cheat-sheets/javascript/) - :books: [Introduction to JavaScript](https://www.codecademy.com/learn/introduction-to-javascript/modules/learn-javascript-introduction/cheatsheet) - :wrench: [Free js.org Subdomain For Github Pages](https://github.com/js-org/js.org) - :books: [Eloquent JavaScript - A Modern Introduction to Programming](https://eloquentjavascript.net/) - :books: [JavaScript Garden](https://bonsaiden.github.io/JavaScript-Garden/) - :video_camera: [JavaScript by Example - Level 1 by Hussein Nasser](https://www.youtube.com/playlist?list=PLQnljOFTspQW9tY3eqBrmbY7CqxNrW-g3) - :video_camera: [JavaScript by Example - Level 2 by Hussein Nasser](https://www.youtube.com/playlist?list=PLQnljOFTspQWab0g3W6ZaDM6_Buh20EWM) - :video_camera: [Namaste JavaScript](https://www.youtube.com/playlist?list=PLlasXeu85E9cQ32gLCvAvr9vNaUccPVNP) - :books: [20+ Web Projects With Vanilla JavaScript](https://vanillawebprojects.com) - :bulb: [JavaScript plugins - jQuery & Vanilla](http://www.unheap.com) - :video_camera: [JavaScript tutorial for Beginners 😎](https://www.youtube.com/watch?v=lI1ae4REbFM&t=1s) - :books: [Modern JavaScript Explained For Dinosaurs](https://medium.com/the-node-js-collection/modern-javascript-explained-for-dinosaurs-f695e9747b70) - :books: [TheJSWay Book](https://github.com/thejsway/thejsway) - :video_camera: [Learn Javascript with 100Devs](https://www.youtube.com/watch?v=_A20kVsaqIk) - :books: [JavaScript Tutorial - Learn JavaScript in Detail](https://www.scaler.com/topics/javascript/) - :wrench: [Visualize JavaScript and Understand the Workflow](https://www.jsv9000.app/) - :books: [FreeCodeCamp - JavaScript Algorithms and Data Structures](https://www.freecodecamp.org/learn/javascript-algorithms-and-data-structures/) --- **[⬆ Back to Index](#content)** ## Kubernetes - :file_folder: [Kubernetes Documentation](https://kubernetes.io/docs/home/) - :green_book: [Understanding Kubernetes: Developer's Guide](https://blog.thewiz.net/understanding-kubernetes-developers-guide) - :books: [100 Days of Kubernetes](https://100daysofkubernetes.io/overview.html) --- **[⬆ Back to Index](#content)** ## OpenShift - :file_folder: [OpenShift Documentation](https://docs.openshift.com) - :books: [OpenShift Interactive Learning Portal](https://learn.openshift.com) - :books: [OpenShift Tutorials](https://developers.redhat.com) --- **[⬆ Back to Index](#content)** ## Laravel - :file_folder: [Official Documentation](https://laravel.com) - :video_camera: [Video Tutorials for Laravel](https://laracasts.com) - :wrench: [Serverless Deployment for Laravel](https://vapor.laravel.com) - :wrench: [Micro Laravel Framework for APIs](https://lumen.laravel.com) - :wrench: [Server Management for Laravel](https://forge.laravel.com) - :video_camera: [Creating "Laravel Checklister"](https://www.youtube.com/playlist?list=PLdXLsjL7A9k0D8fXpJl4Rc1ffmAs5XIEg) - :books: [Laravel Tutorial](https://www.javatpoint.com/laravel) - :books: [Laravel News](https://laravel-news.com) - :books: [LaraShout: Laravel Tutorials and Guides](https://www.larashout.com) - :bulb: [Laravel Daily](https://laraveldaily.com) - :books: [Laravel Bootcamp](https://bootcamp.laravel.com) --- **[⬆ Back to Index](#content)** ## LESS - :file_folder: [Official Documentation](http://lesscss.org/) - :books: [Complete tutorial from Tutorialpoint](https://www.tutorialspoint.com/less/index.htm) - :video_camera: [Less CSS Tutorials for Beginners Playlist](https://www.youtube.com/playlist?list=PL6gx4Cwl9DGCshbAx1JpBtNoKh8iKAAiy) --- **[⬆ Back to Index](#content)** ## Linux - :video_camera: [Introduction to Linux](https://training.linuxfoundation.org/resources/free-courses/introduction-to-linux/) - :video_camera: [Introduction to Linux & Terminal Commands - Full Course for Beginners](https://www.youtube.com/watch?v=iwolPf6kN-k&list=PL9gnSGHSqcnoqBXdMwUTRod4Gi3eac2Ak&index=4) - :books: [KodeKloud - Linux Foundation Certified System Administrator (LFCS)](https://kodekloud.com/courses/linux-foundation-certified-system-administrator-lfcs/) - :books: [Linux kernel and its insides](https://0xax.gitbooks.io/linux-insides/content/) - :bulb: [Interactive map of Linux Kernel](https://makelinux.github.io/kernel/map/) - :books: [Linux Device Drivers, Third Edition](https://lwn.net/Kernel/LDD3/) - :bulb: [Linux Commands Cheat Sheet](https://www.linuxtrainingacademy.com/linux-commands-cheat-sheet/) - :books: [Linux Fundamentals Part 1](https://tryhackme.com/room/linuxfundamentalspart1) - :books: [Linux Fundamentals Part 2](https://tryhackme.com/room/linuxfundamentalspart2) - :books: [Linux Fundamentals Part 3](https://tryhackme.com/room/linuxfundamentalspart3) --- **[⬆ Back to Index](#content)** ## Machine Learning - :books: [Google's Machine Learning Crash Course](https://developers.google.com/machine-learning/crash-course/) - :books: [Andrew Ng's Machine Learning Coursera Course](https://www.coursera.org/learn/machine-learning) - :books: [Intro to Machine Learning](https://www.kaggle.com/learn/intro-to-machine-learning) - :books: [Intermediate Machine Learning](https://www.kaggle.com/learn/intermediate-machine-learning) - :books: [Understanding Machine Learning: From Theory to Algorithms](https://www.cs.huji.ac.il/~shais/UnderstandingMachineLearning/copy.html) - :books: [Probability and Statistics](https://ocw.mit.edu/courses/mathematics/18-05-introduction-to-probability-and-statistics-spring-2014/index.htm) - :books: [freecodecamp's courses for machine learning](https://www.freecodecamp.org/learn/) - :bulb: [A quick review of the linear algebra concepts relevant to machine learning.](http://www.deeplearningbook.org/contents/linear_algebra.html) - :books: [Calculus](http://cs231n.stanford.edu/handouts/derivatives.pdf) - :books: [Statistical concepts for machine learning](http://www-bcf.usc.edu/~gareth/ISL/) - :bulb: [AWS Machine Learning Tools](https://www-freecodecamp-org.cdn.ampproject.org/c/s/www.freecodecamp.org/news/aws-machine-learning-tools-the-complete-guide/amp/) - :green_book: [Introductory Primer](https://www.toptal.com/machine-learning/machine-learning-theory-an-introductory-primer) - :bulb: [Machine Learning Roadmap](https://whimsical.com/machine-learning-roadmap-2020-CA7f3ykvXpnJ9Az32vYXva) - :books: [TinyML Course](https://www.edx.org/professional-certificate/harvardx-tiny-machine-learning) - :books: [Deep Learning - University of buffalo](https://cedar.buffalo.edu/~srihari/CSE676/index.html) - :books: [Machine Learning Introduction with Python](https://www.dataquest.io/path/machine-learning-intro-with-python/) - :speaker: [Machine Learning Guide Podcast](https://ocdevel.com/mlg) - :books: [An Introduction to Statistical Learning with Applications in R](https://www.statlearning.com/) - :video_camera: [Neural Networks Theory](https://youtube.com/playlist?list=PLblh5JKOoLUIxGDQs4LFFD--41Vzf-ME1) --- **[⬆ Back to Index](#content)** ## Magento - :wrench: [Fast Virtual Machine for Magento2](https://github.com/zepgram/magento2-fast-vm/) - :wrench: [Docker Configuration for Magento2](https://github.com/markshust/docker-magento) - :books: [Become Magento 2 Developer with Mage Mastery (online courses and workshops)](https://magemastery.net/) --- **[⬆ Back to Index](#content)** ## Markdown - :bulb: [List of Badges, in Markdown](https://github.com/Naereen/badges) - :bulb: [Markdown Cheatsheet](https://www.markdownguide.org/cheat-sheet/) --- **[⬆ Back to Index](#content)** ## MySQL - :books: [MySQL Tutorial](https://www.mysqltutorial.org) - :video_camera: [MySQL - The Basics // Learn SQL in 23 Easy Steps - Fireship](https://youtu.be/Cz3WcZLRaWc) - :video_camera: [MySQL Crash Course - Traversy Media](https://youtu.be/9ylj9NR0Lcg) - :video_camera: [MySQL Tutorial for Beginners - Programming with Mosh](https://youtu.be/7S_tz1z_5bA) - :video_camera: [SQL Tutorial - Full Database Course for Beginners - freeCodeCamp](https://youtu.be/HXV3zeQKqGY) - :video_camera: [MySQL Database - Full Course - freeCodeCamp](https://youtu.be/ER8oKX5myE0) - :bulb: [MySQL Cheatsheet](https://www.codewithharry.com/blogpost/mysql-cheatsheet) - :books: [SQLBolt](https://sqlbolt.com/) --- **[⬆ Back to Index](#content)** ## NodeJS - :books: [Introduction to nodejs](https://www.tutorialspoint.com/nodejs/nodejs_introduction.htm) - :books: [Beginners guide to nodejs (step by step)](https://www.w3schools.com/nodejs/nodejs_intro.asp) - :green_book: [Node JS Architecture](https://www.journaldev.com/7462/node-js-architecture-single-threaded-event-loop) - :green_book: [Deploy Node App on AWS EC2](https://jobin.hashnode.dev/deploy-your-node-js-app-into-production-with-nginx-and-ssl-installationstep-by-step-tutorial) - :bulb: [30SecondsOfCode Node JS Snippets](https://www.30secondsofcode.org/js/t/node/p/1) - :green_book: [The only NodeJs introduction you’ll ever need](https://codeburst.io/the-only-nodejs-introduction-youll-ever-need-d969a47ef219) - :video_camera: [Introduction to Node.js](https://www.youtube.com/playlist?list=PLZlA0Gpn_vH_uZs4vJMIhcinABSTUH2bY) - :green_book: [Back End Development and APIs](https://www.freecodecamp.org/learn/back-end-development-and-apis/) - :video_camera: [Backend Interview Series](https://youtube.com/playlist?list=PL-Jc9J83PIiHI7u_6G8j1oKyhQn_plX8i) - :books: [30 Days of Node](https://www.nodejsera.com/30-days-of-node.html) - :file_folder: [Node.js Documentation](https://nodejs.org/en/docs/) --- **[⬆ Back to Index](#content)** ## Operating Systems - :video_camera: [Operating Systems](https://youtube.com/playlist?list=PL-Jc9J83PIiEKfEI9f7afzCutT_3hPQP3) - :books: [Operating System Tutorial - Learn Operating System](https://www.scaler.com/topics/operating-system/) - :video_camera: [Operating System - For College](https://www.youtube.com/playlist?list=plxczcowd7aigz9donhrre9i3mwn6xdp8p) - :books: [Operating Systems: Three Easy Pieces](https://pages.cs.wisc.edu/~remzi/OSTEP/) - :video_camera: [Operating Systems: Operating Systems for Placements/Interview](https://youtube.com/playlist?list=PLDzeHZWIZsTr3nwuTegHLa2qlI81QweYG) --- **[⬆ Back to Index](#content)** ## PHP - :books: [PHP: The Right Way](https://phptherightway.com/) - :video_camera: [PHP Front to Back](https://www.youtube.com/playlist?list=PLillGF-Rfqbap2IB6ZS4BBBcYPagAjpjn) - :books: [PHP Apprentice: An Online Book For Learning PHP](https://phpapprentice.com/) - :books: [Learn PHP - SoloLearn](https://www.sololearn.com/Course/PHP/) - :bulb: [40+ Useful Php tips for beginners](https://www.binarytides.com/35-techniques-to-enhance-your-php-code/) - :bulb: [PHP Cheat Sheet](https://websitesetup.org/php-cheat-sheet/) - :green_book: [Design Patterns](https://refactoring.guru/design-patterns/php) --- **[⬆ Back to Index](#content)** ## PostgreSQL - :bulb: [SQL Cheat Sheet - ABZ-Aaron](https://github.com/ABZ-Aaron/CheatSheets/blob/main/SQL-V2-Light.pdf) - :books: [PostgreSQL Tutorial](https://www.postgresqltutorial.com) - :video_camera: [Learn PostgreSQL Tutorial - freeCodeCamp](https://youtu.be/qw--VYLpxG4) - :video_camera: [SQL Tutorial for Beginners - Ben Awad](https://youtu.be/tp_5c6jaNQE) - :video_camera: [SQL Tutorials - Corey Schafer](https://youtube.com/playlist?list=PL-osiE80TeTsKOdPrKeSOp4rN3mza8VHN) - :file_folder: [PostgreSQL SQL documentation](https://www.postgresql.org/docs/9.2/sql.html) - :bulb: [PostgreSQL exercises](https://pgexercises.com/) --- **[⬆ Back to Index](#content)** ## Power Automate - :file_folder: [Power Automate official documentation](https://learn.microsoft.com/en-us/power-automate) --- **[⬆ Back to Index](#content)** ## Python - :books: [CS50P - CS50's intro to Programing With Python](https://cs50.harvard.edu/python/2022/) - :books: [Automate The Boring Stuff With Python](https://automatetheboringstuff.com/2e/chapter0/) - :books: [Python Intermediate Tutorial](https://github.com/python-engineer/python-engineer-notebooks/tree/master/advanced-python) - :books: [Python Programming MOOC 2022(University of Helsinki)](https://programming-22.mooc.fi/) - :books: [Python Tutorial](https://www.w3schools.com/python/) - :video_camera: [Python for Everybody (14 hour course)](https://www.youtube.com/watch?v=8DvywoWv6fI&feature=emb_title) - :bulb: [Python Tips and Tricks for Beginners](https://towardsdatascience.com/python-tips-and-tricks-for-beginners-62473d569d0a) - :books: [The Hitchhiker's Guide to Python](https://docs.python-guide.org/) - :books: [Python Tutorials with online IDE - jobtensor](https://jobtensor.com/Tutorial/Python/en/Introduction) - :video_camera: [Python 3 Basics Tutorial Series - YouTube](https://www.youtube.com/playlist?list=PLQVvvaa0QuDe8XSftW-RAxdo6OmaeL85M) - :green_book: [Learning Python: From Zero To Hero](https://www.freecodecamp.org/news/learning-python-from-zero-to-hero-120ea540b567/) - :video_camera: [Complete Python Tutorial In Hindi - YouTube](https://www.youtube.com/playlist?list=PLwgFb6VsUj_lQTpQKDtLXKXElQychT_2j) - :bulb: [TheAlgorithms/Python: All Algorithms implemented in Python](https://github.com/TheAlgorithms/Python) - :bulb: [30SecondsOfCode Python Snippets](https://www.30secondsofcode.org/python/p/1) - :green_book: [Selenium with Python Tutorial](https://www.javatpoint.com/selenium-python#Selenium-with-python) - :video_camera: [Python Flask Tutorial](https://youtube.com/playlist?list=PLzMcBGfZo4-n4vJJybUVV3Un_NFS5EOgX) - :bulb: [Python Cheatsheet](https://www.codewithharry.com/blogpost/python-cheatsheet) - :bulb: [Python Cheatsheet](https://www.pythoncheatsheet.org/) - :books: [Python Tutorial - Learn Python Programming](https://www.scaler.com/topics/python/) - :books: [Python From Scratch](https://www.pythontutorial.net/) --- **[⬆ Back to Index](#content)** ## React - :books: [React Tutorial - W3Schools](https://www.w3schools.com/react/) - :books: [Egghead.io: Start Learning React](https://egghead.io/courses/start-learning-react) - :file_folder: [React Official Tutorial](https://facebook.github.io/react/docs/tutorial.html) - :file_folder: [Using React in Visual Studio Code](https://code.visualstudio.com/docs/nodejs/reactjs-tutorial) - :books: [Scrimba - Learn React for free interactively](https://scrimba.com/g/glearnreact) - :bulb: [FreeCodeCamp React Challenges](https://learn.freecodecamp.org/front-end-libraries/react) - :bulb: [React Cheatsheet](https://devhints.io/react) - :bulb: [React Patterns](https://reactpatterns.com/) - :bulb: [Useful Packages you should know in React](https://medium.com/better-programming/14-useful-packages-every-react-developer-should-know-55b47a325d3) - :books: [Learn React Test Driven Development](https://learntdd.in/react/) - :video_camera: [ReactJS Tutorial for Beginners](https://youtube.com/playlist?list=PLC3y8-rFHvwgg3vaYJgHGnModB54rxOk3) - :books: [The React Beginner's Handbook](https://flaviocopes.com/page/react-handbook/) - :video_camera: [React.js Clones by PAPA React](https://youtube.com/playlist?list=PLf16UKl7nR5AjcrYOe1niifJSAls3spDk) - :books: [Full-Stack Web Development with React Specialization](https://www.coursera.org/specializations/full-stack-react?) - :green_book: [React Custom Hooks Tutorial](https://usehooks.com/) - :video_camera: [10 react hooks explained](https://youtu.be/TNhaISOUy6Q) - :video_camera: [React Hooks](https://www.youtube.com/playlist?list=PLZlA0Gpn_vH8EtggFGERCwMY5u5hOjf-h) - :video_camera: [React JS Crash Course](https://youtube.com/watch?v=w7ejDZ8SWv8) - :books: [Become a React Developer - Linkedin Learning](https://www.linkedin.com/learning/paths/become-a-react-developer) - :video_camera: [React Testing Tutorial by Codevolution](https://www.youtube.com/playlist?list=PLC3y8-rFHvwirqe1KHFCHJ0RqNuN61SJd) - :video_camera: [React JS Full Course 2022 | Build an App and Master React in 1 Hour](https://www.youtube.com/watch?v=b9eMGE7QtTk) --- **[⬆ Back to Index](#content)** ## React Native - :file_folder: [React Native Tutorial](https://reactnative.dev/docs/tutorial) - :bulb: [Performance Limitations of React Native and How to Overcome Them](https://medium.com/@talkol/performance-limitations-of-react-native-and-how-to-overcome-them-947630d7f440) - :green_book: [VSCode setup for React Native](https://medium.com/react-native-training/vscode-for-react-native-526ec4a368ce) - :green_book: [Build E-Commerce App in React Native](https://hackernoon.com/building-an-e-commerce-search-app-with-react-native-2c87760a2315) - :green_book: [How to deploy react native apps](https://medium.com/react-native-training/understanding-react-native-deployments-6e54157920b7) - :video_camera: [React Native Tutorial For Beginners](https://www.youtube.com/playlist?list=PL4cUxeGkcC9ixPU-QkScoRBVxtPPzVjrQ) - :books: [Become a React Native Developer - Linkedin Learning](https://www.linkedin.com/learning/paths/become-a-react-native-developer) --- **[⬆ Back to Index](#content)** ## Regular Expressions - :wrench: [RegExr - an online tool to learn, build, & test Regular Expressions](https://regexr.com/) - :wrench: [Regex101 - Build, test, and debug regex](https://regex101.com/) - :books: [Regex Learn - Learn Regex step by step, from zero to advanced](https://regexlearn.com/) - :books: [Codecademy - Learn the Basics of Regular Expressions](https://www.codecademy.com/learn/introduction-to-regular-expressions) - :video_camera: [Net Ninja - Regex YT Playlist](https://youtube.com/playlist?list=PL4cUxeGkcC9g6m_6Sld9Q4jzqdqHd2HiD) --- **[⬆ Back to Index](#content)** ## Ruby - :books: [Ruby from Tutorialspoint](https://www.tutorialspoint.com/ruby/index.htm) - :video_camera: [Full course by freeCodeCamp.org](https://www.youtube.com/watch?v=t_ispmWmdjY) - :books: [Full Stack Ruby and Ruby on Rails course by The Odin Project](https://www.theodinproject.com/paths/full-stack-ruby-on-rails) --- **[⬆ Back to Index](#content)** ## Rust - :file_folder: [The Rust Programming Language book](https://doc.rust-lang.org/book/) - :bulb: [Rustlings - small exercises to get you used to reading and writing Rust code](https://github.com/rust-lang/rustlings) - :video_camera: [The Rust Lang Book video series by Let's Get Rusty](https://youtube.com/playlist?list=PLai5B987bZ9CoVR-QEIN9foz4QCJ0H2Y8) - :video_camera: [Rust Programming Course for Beginners - Tutorial](https://www.youtube.com/watch?v=MsocPEZBd-M) --- **[⬆ Back to Index](#content)** ## Sass - :file_folder: [Complete Documentation](https://sass-lang.com/documentation) - :wrench: [Zurb - Library to Create Transitions & Animations](https://zurb.com/playground/motion-ui) - :wrench: [Vanilla Framework](https://vanillaframework.io/) - :wrench: [Susy - Grid Layout Engine](https://www.oddbird.net/susy/) - :video_camera: [SASS Tutorial (Build Your Own CSS Library)](https://youtube.com/playlist?list=PL4cUxeGkcC9jxJX7vojNVK-o8ubDZEcNb) --- **[⬆ Back to Index](#content)** ## Spring - :file_folder: [Getting Started - Building an Application](https://spring.io/guides/gs/spring-boot/) - :file_folder: [Spring Security Architecture](https://spring.io/guides/topicals/spring-security-architecture/) - :file_folder: [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/) - :video_camera: [Spring Boot Tutorial for Beginners](https://www.youtube.com/watch?v=vtPkZShrvXQ&t=1551s) --- **[⬆ Back to Index](#content)** ## Svelte - :file_folder: [Introduction and basics of Svelte](https://svelte.dev/tutorial/basics) - :green_book: [Getting started with Svelte - MDN](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Svelte_getting_started) - :video_camera: [Svelte for beginners - The Net Ninja](https://www.youtube.com/playlist?list=PL4cUxeGkcC9hlbrVO_2QFVqVPhlZmz7tO) - :video_camera: [Learn the Svelte JavaScript Framework: Full Course - Freecodecamp](https://www.youtube.com/watch?v=ujbE0mzX-CU) --- **[⬆ Back to Index](#content)** ## Swift - :books: [Swift Tutorial](https://www.w3schools.in/swift-tutorial/) - :books: [Build your very first iOS app](https://www.edx.org/course/build-your-very-first-ios-app) - :video_camera: [Swift Programming Tutorial for Beginners](https://www.youtube.com/watch?v=Ulp1Kimblg0) - :file_folder: [Documentation](https://swift.org/documentation/#the-swift-programming-language) - :green_book: [Swift UI quick start](https://www.hackingwithswift.com/quick-start/swiftui) - :video_camera: [SwiftUI Basics Tutorial](https://www.youtube.com/watch?v=HXoVSbwWUIk) --- **[⬆ Back to Index](#content)** ## System Design - :video_camera: [System Design Concepts](https://www.youtube.com/playlist?list=PLMCXHnjXnTnvo6alSjVkgxV-VH6EPyvoX) - :video_camera: [System Design Primer Course](https://www.youtube.com/playlist?list=PLTCrU9sGyburBw9wNOHebv9SjlE4Elv5a) - :video_camera: [System Design Interview Preparation Series by codeKarle](https://www.youtube.com/playlist?list=PLhgw50vUymycJPN6ZbGTpVKAJ0cL4OEH3) - :video_camera: [Basics of System Design by Coding Simplified](https://www.youtube.com/playlist?list=PLt4nG7RVVk1g_LutiJ8_LvE914rIE5z4u) --- **[⬆ Back to Index](#content)** ## Terraform - :bulb: [Terraform Study Guide](https://github.com/ari-hacks/terraform-study-guide) - :books: [HashiCorp Certified: Terraform Associate 2021 (Zeal Vora)](https://www.udemy.com/course/terraform-beginner-to-advanced/) - :video_camera: [Deep Dive - Terraform (Pluralsight)](https://www.pluralsight.com/courses/deep-dive-terraform) - :video_camera: [Terraform Course - Automate your AWS cloud infrastructure](https://youtu.be/SLB_c_ayRMo) - :video_camera: [Terraform for DevOps Beginners + Labs: Complete Step by Step Guide!](https://youtu.be/YcJ9IeukJL8) - :bulb: [250 Practice Questions For Terraform Associate Certification](https://medium.com/bb-tutorials-and-thoughts/250-practice-questions-for-terraform-associate-certification-7a3ccebe6a1a) --- **[⬆ Back to Index](#content)** ## Testing - :bulb: [How to Start a Career in Testing?](https://juniorlearnstocode.blogspot.com/2020/04/how-to-start-career-in-testing.html/) - :green_book: [Testing React with Jest and Enzyme](https://blog.bitsrc.io/how-to-test-react-components-with-jest-and-enzyme-in-depth-145fcd06b90?gi=3bb2d7ae19f4) - :wrench: [TestProject: Free Test Automation For All](https://testproject.io) - :wrench: [Apache JMeter](https://jmeter.apache.org) - :books: [API Testing 101: Learn The Basics](https://www.soapui.org/learn/functional-testing/api-testing-101/) - :bulb: [ISTQB Certification](https://www.istqb.com/) --- **[⬆ Back to Index](#content)** ## Typescript - :file_folder: [TypeScript Documentation: Handbook](https://www.typescriptlang.org/docs/) - :books: [Scrimba - Introduction to TypeScript](https://scrimba.com/learn/intrototypescript) - :video_camera: [Typescript - The Basics](https://www.youtube.com/watch?v=ahCwqrYpIuM) - :video_camera: [Typescript Basics - Course](https://www.youtube.com/playlist?list=PLqq-6Pq4lTTanfgsbnFzfWUhhAz3tIezU) - :bulb: [Clean Code concepts adapted for TypeScript](https://github.com/labs42io/clean-code-typescript) - :video_camera: [TypeScript Course for Beginners 2021 - Learn TypeScript from Scratch!](https://www.youtube.com/watch?v=BwuLxPH8IDs&t=1s) - :books: [Learn TypeScript Step by Step Tutorial](https://www.tutorialsteacher.com/typescript) - :books: [Learn TypeScript From Scratch](https://www.typescripttutorial.net/) - :books: [Type-Level TypeScript](https://type-level-typescript.com/) --- **[⬆ Back to Index](#content)** ## Unity - :file_folder: [Unity Docs](https://docs.unity3d.com/Manual/index.html) - :file_folder: [Official Unity Learn Page](https://learn.unity.com) - :books: [Unity for Beginners](https://www.raywenderlich.com/unity/paths/learn) --- **[⬆ Back to Index](#content)** ## Vue - :video_camera: [Vue JS 3 Tutorial for Beginners - Youtube Playlist of a Series of 12 Videos](https://www.youtube.com/playlist?list=PL4cUxeGkcC9hYYGbV60Vq3IXYNfDk8At1) - :bulb: [Using GitLab CI/CD to auto-deploy your Vue.js application to AWS S3](https://medium.com/@croo/using-gitlab-ci-cd-to-auto-deploy-your-vue-js-application-to-aws-s3-9affe1eb3457) - :bulb: [Dockerizing a Vue App](https://mherman.org/blog/dockerizing-a-vue-app/) - :green_book: [Deploying a Flask and Vue App to Heroku with Docker and Gitlab CI](https://testdriven.io/blog/deploying-flask-to-heroku-with-docker-and-gitlab/) - :bulb: [Large-scale Vuex application structures](https://medium.com/3yourmind/large-scale-vuex-application-structures-651e44863e2f) --- **[⬆ Back to Index](#content)** ## Web Accessibility - :bulb: [Web Accessibility Evaluation Tools List](https://www.w3.org/WAI/ER/tools/) - :green_book: [Mozilla Accessibility Guide](https://developer.mozilla.org/en-US/docs/Web/Accessibility) - :green_book: [Google Developers Guide on Accessibility](https://developers.google.com/web/fundamentals/accessibility) - :green_book: [Accessibility Testing Tutorial - A Complete Step By Step Guide](https://www.softwaretestingmaterial.com/accessibility-testing/) --- **[⬆ Back to Index](#content)** ## Web Development - :books: [IBM Full Stack Software Developer Specialization](https://www.coursera.org/professional-certificates/ibm-full-stack-cloud-developer) - :video_camera: [Frontend Interview Series](https://youtube.com/playlist?list=PL-Jc9J83PIiFXzRwSTSwqL7U2hoMk6K6F) - :video_camera: [Frontend Interview Series](https://youtube.com/playlist?list=PL-Jc9J83PIiFXzRwSTSwqL7U2hoMk6K6F) - :video_camera: [Frontend with HTML CSS JS & Browser APIs](https://youtube.com/playlist?list=PL-Jc9J83PIiHU9RkY9sfh3G64-bd0ptvC) - :bulb: [Frontendmentor.io Design To Code Frontend Challenges](https://www.frontendmentor.io) - :bulb: [Codewell.cc Design To Code Frontend Challenges](https://www.codewell.cc) --- **[⬆ Back to Index](#content)** ## Webpack - :green_book: [Getting Started Guide](https://www.valentinog.com/blog/webpack/) - :books: [Webpack Academy](https://webpack-academy.teachable.com/) - :file_folder: [Docs](https://webpack.js.org/guides/getting-started/) --- **[⬆ Back to Index](#content)** ## Others ### Cheat Sheets - :bulb: [Cheatsheet Collection - DevHints](https://devhints.io) - :bulb: [Cheat Sheets](http://www.cheat-sheets.org/) - :bulb: [Programming Cheat Sheets](https://cheatography.com/) - :bulb: [Codehouse - Cheatsheet Collection](https://codehouse.vercel.app/app) - :bulb: [Emmet](https://docs.emmet.io/cheat-sheet/) - :bulb: [LeetCode](https://leetcode.com/) ### Design - :bulb: [Freebie Supply](https://freebiesupply.com/) - :bulb: [unDraw](https://undraw.co/): Free illustrations, updated regularly - :bulb: [Bulbman](https://bulbman.art/): Free Artistic Illustrations for Designers - :bulb: [Feather Icons](https://feathericons.com/) - :bulb: [humaaans](https://humaaans.com/) - :bulb: [absurd](https://absurd.design/) - :bulb: [Crello Free Templates](https://crello.com/templates/) - :bulb: [404 Illustration](https://error404.fun/): Free illustrations for 404 pages - :bulb: [UI Design Daily](https://uidesigndaily.com/): Awesome UI Components of all types - :bulb: [Freepik](https://www.freepik.com/): Find Free Vectors, Stock Photos and PSD - :bulb: [Geometric Shapes](https://tool.graphics/shapes): Free Geometric Shapes to use in Figma and download - :bulb: [3D-Icons](https://free3dicon.com/): Free 3D - Icons to download - :bulb: [533 Hand-Picked Tools & Resources for Web Designers & Developers](https://toolkit.addy.codes/) - :bulb: [Illlustrations](https://illlustrations.co/): Awesome 120+ free illustrations - :bulb: [ls.graphics](https://www.ls.graphics/free-mockups): Free mockups for different type of products - :bulb: [Unsplash](https://unsplash.com/): Free high quality stock images and videos - :bulb: [Undesign](https://undesign.learn.uno/): Collection of free design tools and resources for makers, developers and designers - :bulb: [DopeUI](https://dopeui.co/): High quality website UI templates - :wrench: [Design Junction](https://designjunction.xyz/): Resource library for Designers and Creatives - :bulb: [Coolors](https://coolors.co/): The super fast color schemes generator - :bulb: [uiGradients](https://uigradients.com/): An awesome gradient generator - :bulb: [Glassmorphism Generator](https://ui.glass/generator/): Amazing tool to generate glassmorphism design. - :bulb: [Canva](https://www.canva.com/) - :bulb: [Photopea](https://www.photopea.com/): Free online editor supporting PSD, XCF, Sketch, XD and CDR formats. - :bulb: [Lorem Ipsum Generators](https://loremipsum.io/): Awesome collection of Lorem Ipsum Generators - :books: [Lapa Ninja](https://www.lapa.ninja/learn/): The best resources for Learning Design - :bulb: [Font Awesome](https://fontawesome.com/): Vector icons and social logos for your website - :bulb: [SVG Backgrounds](https://www.svgbackgrounds.com/): Customize and apply backgrounds fast. - :bulb: [Vecteezy](https://www.vecteezy.com/): Download Free Vector Art, Stock Photos & Stock Videos. - :bulb: [Haikei](https://app.haikei.app/): Multiple Shape Generator for UI. - :bulb: [Free Web Illustrations](https://freewebillustrations.com/): Discover 1,500+ Free High-Quality Web Illustrations ### Open Source - :green_book: [How to contribute to Open Source](https://kentcdodds.com/blog/introducing-how-to-contribute-to-open-source) - :bulb: [What open source projects should I contribute](https://kentcdodds.com/blog/what-open-source-project-should-i-contribute-to) - :green_book: [Why Open Source is Important for Students?](https://dev.to/mridulrb/series/11633) - :green_book: [What is Open Source?](https://opensource.com/resources/what-open-source) ### VS Code - :green_book: [How to run graphics.h in VS Code](https://github.com/ullaskunder3/Solution-to-graphics.h) - :bulb: [Top 5 VS Code extensions for web developers](https://jobin.hashnode.dev/top-5-vs-code-extension-for-web-developers-in-2021) - :video_camera: [VS Code Tutorial for Beginners](https://youtu.be/VqCgcpAypFQ?t=21) - :bulb: [The Best VS Code Extensions to Supercharge Your Git](https://betterprogramming.pub/the-best-vs-code-extensions-to-supercharge-your-git-5d5ab3f64f64) ### Tools - :wrench: [Tiny helpers](https://tiny-helpers.dev/): A collection of free single-purpose online tools for web developers - :wrench: [How To Set Up ESLint & Prettier In VS Code](https://dev.to/rahulshawdev/how-to-set-up-eslint-prettier-in-vs-code-1dc1) - :wrench: [Ray.so](https://ray.so/): Create beautiful images of your code snippets! - :wrench: [Squircley](https://squircley.app/): Start creating beautiful organic shapes ready to use for logos, icons and background images - :wrench: [BrandBird](https://www.brandbird.app/): An image editor for busy SaaS founders, who build in public! - :wrench: [Carbon](https://carbon.now.sh/): Create and share beautiful images of your source code. (An alternative of [Ray.so](https://ray.so/)) ### Talks and Podcasts - :video_camera: [Coding Better World Together Live Session with Uncle Bob (Robert C. Martin](https://www.youtube.com/playlist?list=PLmmYSbUCWJ4x1GO839azG_BBw8rkh-zOj) : Coding Better World Together is a set of master lessons from the famous Uncle Bob (Robert Cecil Martin), where he gives us a broad vision of the importance and future of Software in today's society. - :speaker: [Clean Code with Uncle Bob Martin](https://completedeveloperpodcast.com/episode-232/): When folks code long enough, in time they get themselves stuck in a code base that's kind of difficult to wrap thier heads around. In this podcast Uncle Bob Martin talks about the principles of clean code and how to not make a code base too difficult to understand.

A curated list of code katas

 # Awesome Katas [](https://github.com/sindresorhus/awesome) > A curated list of code katas ## Table of Contents - [Introduction](#introduction) - [Dave Thomas's CodeKata](#codekata) - [Wonderland Clojure Katas](#wonderland-clojure-katas) - [SensioLabs PoleDev Katas](#sensiolabs-poledev-katas) - [Gaurav Arora's TDD Katas Collection](#gaurav-aroras-tdd-katas-collection) - [Others](#others) - [Contribution](#contribution) ## Introduction A kata, or code kata, is defined as an exercise in programming which helps hone your skills through practice and repetition. Dave Thomas [@pragdave](https://twitter.com/pragdave), started this movement for programming. This project aims to provide you with a list of some kata exercises that I've found in the Internet and the Github community. These exercises vary from general to more complex algorithms and real life situations for you to try using your preferred programming language. Remember that code katas are not quizzes or puzzles. You should not only try to 'solve' it, but find a very good solution, following best practices of the programming language you are using. ## [CodeKata](http://codekata.com/) - [Kata01: Supermarket Pricing](http://codekata.com/kata/kata01-supermarket-pricing/) - [Kata02: Karate Chop](http://codekata.com/kata/kata02-karate-chop/) - [Kata03: How Big? How Fast?](http://codekata.com/kata/kata03-how-big-how-fast/) - [Kata04: Data Munging](http://codekata.com/kata/kata04-data-munging/) - [Kata05: Bloom Filters](http://codekata.com/kata/kata05-bloom-filters/) - [Kata06: Anagrams](http://codekata.com/kata/kata06-anagrams/) - [Kata07: How'd I Do?](http://codekata.com/kata/kata07-howd-i-do/) - [Kata08: Conflicting Objectives](http://codekata.com/kata/kata08-conflicting-objectives/) - [Kata09: Back to the Checkout](http://codekata.com/kata/kata09-back-to-the-checkout/) - [Kata10: Hashes vs. Classes](http://codekata.com/kata/kata10-hashes-vs-classes/) - [Kata11: Sorting It Out](http://codekata.com/kata/kata11-sorting-it-out/) - [Kata12: Best Sellers](http://codekata.com/kata/kata12-best-sellers/) - [Kata13: Counting Code Lines](http://codekata.com/kata/kata13-counting-code-lines/) - [Kata14: Tom Swift Under the Milkwood](http://codekata.com/kata/kata14-tom-swift-under-the-milkwood/) - [Kata15: A Diversion](http://codekata.com/kata/kata15-a-diversion/) - [Kata16: Business Rules](http://codekata.com/kata/kata16-business-rules/) - [Kata17: More Business Rules](http://codekata.com/kata/kata17-more-business-rules/) - [Kata18: Transitive Dependencies](http://codekata.com/kata/kata18-transitive-dependencies/) - [Kata19: Word Chains](http://codekata.com/kata/kata19-word-chains/) - [Kata20: Klondike](http://codekata.com/kata/kata20-klondike/) - [Kata21: Simple Lists](http://codekata.com/kata/kata21-simple-lists/) ## [Wonderland Clojure Katas](https://github.com/gigasquid/wonderland-clojure-katas) - [Alphabet Cipher](https://github.com/gigasquid/wonderland-clojure-katas/tree/master/alphabet-cipher) - [Card game War](https://github.com/gigasquid/wonderland-clojure-katas/tree/master/card-game-war) - [Doublets](https://github.com/gigasquid/wonderland-clojure-katas/tree/master/doublets) - [Fox Goose Bag of Corn](https://github.com/gigasquid/wonderland-clojure-katas/tree/master/fox-goose-bag-of-corn) - [Magic Square](https://github.com/gigasquid/wonderland-clojure-katas/tree/master/magic-square) - [Tiny Maze](https://github.com/gigasquid/wonderland-clojure-katas/tree/master/tiny-maze) - [Wonderland Number](https://github.com/gigasquid/wonderland-clojure-katas/tree/master/wonderland-number) ## [SensioLabs PoleDev Katas](https://github.com/devdrops/Katas) - [Kata 1: (Form) DataTransformer](https://github.com/devdrops/Katas/tree/kata-data-transformers) - [Kata 2: (EventDispatcher) Event Listener / Event Dispatcher](https://github.com/devdrops/Katas/tree/kata-event-listener) - [Kata 3: (Form) Inherit data / Virtual Form](https://github.com/devdrops/Katas/tree/kata-inherit-data) - [Kata 4: (Form) File Upload](https://github.com/devdrops/Katas/tree/kata-upload-file) - [Kata 5: (Translation) Manage translations](https://github.com/devdrops/Katas/tree/kata-translation) ## [Gaurav Arora's TDD Katas Collection](https://github.com/garora/TDD-Katas) - [String Sum Kata](https://github.com/garora/TDD-Katas#string-sum-kata) - [String Calculator Kata](https://github.com/garora/TDD-Katas#string-calculator-kata-via-roy-osherove) - [The Bowling Game Kata](https://github.com/garora/TDD-Katas#the-bowling-game-kata-via-uncle-bob) - [The FizzBuzz Kata](https://github.com/garora/TDD-Katas#the-fizzbuzz-kata) - [The OddEven Kata](https://github.com/garora/TDD-Katas#the-oddeven-kata) - [The PrimeFactor Kata](https://github.com/garora/TDD-Katas#the-primefactor-kata-via-uncle-bob) - [Game of Life](https://github.com/garora/TDD-Katas#game-of-life-) - [Harry Potter](https://github.com/garora/TDD-Katas#harry-potter-) - [LCD Digits](https://github.com/garora/TDD-Katas#lcd-digits-) - [Leap Year](https://github.com/garora/TDD-Katas#leap-year-) - [Mine Fields](https://github.com/garora/TDD-Katas#mine-fields-) - [Poker Hands](https://github.com/garora/TDD-Katas#poker-hands) - [Recently Used List](https://github.com/garora/TDD-Katas#recently-used-list-) - [Reversi](https://github.com/garora/TDD-Katas#reversi-) - [Yehtzee](https://github.com/garora/TDD-Katas#yehtzee-) - [The Word Wrap Kata](http://codingdojo.org/cgi-bin/wiki.pl?KataWordWrap) ## Others - [Look and Say Sequence](https://en.wikipedia.org/wiki/Look-and-say_sequence) - [AKS primality test](https://en.wikipedia.org/wiki/AKS_primality_test) - [Roman Numeral Converter](https://en.wikipedia.org/wiki/Roman_numerals) - [Natural sort order](https://en.wikipedia.org/wiki/Natural_sort_order) - [ES6 Katas](http://es6katas.org/) - [.Net Code Katas](https://github.com/AlanBarber/CodeKatas) - [Bank OCR](http://code.joejag.com/coding-dojo/bank-ocr/) - [Bubble sort](https://en.wikipedia.org/wiki/Bubble_sort) - [Racing Car Katas](https://github.com/emilybache/Racing-Car-Katas) - [Coding Dojo's KataCatalogue](http://codingdojo.org/KataCatalogue/) - [The OCP Kata](http://matteo.vaccari.name/blog/archives/293) - [The Birthday Greetings Kata](http://matteo.vaccari.name/blog/archives/154) - [Social Networking Kata](https://github.com/sandromancuso/social_networking_kata) - [Tell don't ask kata](https://github.com/gabrieletondi/tell-dont-ask-kata) - [Functional Structures Refactoring Kata](https://github.com/matteobaglini/functional-structures-refactoring-kata) - [incremental_katas](https://github.com/Gianfrancoalongi/incremental_katas) - [CLI Arguments Parser Kata](https://github.com/ivoputzer/cli-args-parser-kata) - [Git katas](https://github.com/praqma-training/gitkatas) - [Pdt256 katas (php, go, python, java, haskell, typescript)](https://github.com/pdt256/kata) - [Opening Hours Kata](https://github.com/christian-fei/opening-hours-kata) - [The Quantum Katas](https://github.com/Microsoft/QuantumKatas) - [Katalyst](https://katalyst.codurance.com/) - [The Beverages Prices Refactoring Kata](https://github.com/trikitrok/beverages_pricing_refactoring_kata) - [The Goose Game Kata](https://github.com/xpeppers/goose-game-kata) - [Salary slip kata](https://github.com/sandromancuso/salaryslipkata) - [RPG Game kata](https://github.com/ardalis/kata-catalog/blob/master/katas/RPG%20Combat.md) - [Train Reservation kata](https://github.com/emilybache/KataTrainReservation) - [Password-strength Checker TDD Kata](https://github.com/xpepper/PasswordStrengthChecker) - [Gilded Rose - Many languages](https://github.com/emilybache/GildedRose-Refactoring-Kata) - [Gilded Rose Original - C#](https://github.com/NotMyself/GildedRose) - [Java by Comparison Kata](https://java.by-comparison.com/kata) - [DNA Transcription Kata](https://github.com/nickdelgrosso/dna-transcription-kata) - [Refactoring Golf Kata](https://github.com/daviddenton/refactoring-golf) - [Promotion Text Kata](https://github.com/nealhu/promotion-text-kata) - [Args Kata](https://github.com/nealhu/args-kata) ## Contribution #### Please read the [contribution guidelines](https://github.com/gmontalvoriv/katas/blob/master/CONTRIBUTING.md). ## License [](https://creativecommons.org/publicdomain/zero/1.0/)

A curated list of resources for Frontend development

 ## Introduction [](https://twitter.com/codingknite) This is a collection of resources for Frontend development. Most of the resources are free but we also included paid resources. Resources labelled with 💵 indicate that the resource is a paid resource. If you're just starting, you DON'T need to use every resource on this list. It is practically impossible. Use this as a reference. It is not a guide. ## Contibuting We Invite as many contributions as possible. If you know of a resource that would be a great addition to this list, feel free to make a contribution. Be sure to read [How To Contribute](CONTRIBUTING.MD) ## Table of Contents 1. [**How The Internet Works**](#how-the-internet-works) 2. [**HTML**](#html) 3. [**CSS**](#css) 4. [**JavaScript**](#javascript) 5. [**Git**](#git) 6. [**React**](#react) 7. [**Vue**](#vue) 8. [**Browser Extensions**](#browser-extensions) 9. [**Icons**](#icons) 10. [**Fonts and Typography**](#fonts-and-typography) 11. [**Illustrations**](#illustrations) 12. [**Optimization**](#optimization) 13. [**Color Inspiration**](#color-inspiration) 14. [**Images and Videos**](#images-and-videos) 15. [**Hosting Sites**](#hosting-sites) 16. [**Design Inspiration**](#design-inspiration) 17. [**Portfolio Inspiration**](#portfolio-inspiration) 18. [**Youtube Channels**](#youtube-channels) 19. [**Podcasts**](#podcasts) 20. [**Blogs**](#blogs) 21. [**Interview Prep**](#interview-prep) 22. [**Newsletters**](#newsletters) 23. [**Contributing**](#contributing) ## How the Internet Works ### Documentation - 📜[How does the Internet work? — MDN](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/How_does_the_Internet_work) ### Articles - 📜[How does the Internet Work? — HowStuffWorks](https://computer.howstuffworks.com/internet/basics/internet.htm) - 📜[How the Internet Works — Medium](https://medium.com/@User3141592/how-does-the-internet-work-edc2e22e7eb8#:~:text=It%20is%20a%20network%20that,their%20source%20to%20their%20destination.) - 📜[How Does the Internet Work? — Stanford](https://web.stanford.edu/class/msande91si/www-spr04/readings/week1/InternetWhitepaper.htm) ### Videos - 🎥[What is the Internet KhanAcademy](https://www.khanacademy.org/computing/computers-and-internet/xcae6f4a7ff015e7d:the-internet/xcae6f4a7ff015e7d:introducing-the-internet/v/what-is-the-internet) - 🎥[The Internet: Crash Course Computer Science](https://www.youtube.com/watch?v=AEaKrq3SpW8&list=PL8dPuuaLjXtNlUrzyH5r6jN9ulIgZBpdo&index=30&ab_channel=CrashCourse) - 🎥[Computer Networks: Crash Course Computer Science](https://www.youtube.com/watch?v=3QhU9jd03a0&list=PL8dPuuaLjXtNlUrzyH5r6jN9ulIgZBpdo&index=29&ab_channel=CrashCourse) - 🎥[The World Wide Web: Crash Course Computer Science](https://www.youtube.com/watch?v=guvsH5OFizE&list=PL8dPuuaLjXtNlUrzyH5r6jN9ulIgZBpdo&index=31&ab_channel=CrashCourse) [👆 Back To Top](#table-of-contents) ## HTML ### Documentation - 📜[Structuring the web with HTML MDN](https://developer.mozilla.org/en-US/docs/Learn/HTML) - 📜[HTML Reference](https://htmlreference.io/) ### Cheat Sheets - 📜[OverAPI](https://overapi.com/html) - 📜[HTML Cheat Sheet](https://websitesetup.org/html5-cheat-sheet/) - 📜[HTML Entity Refernce](https://css-tricks.com/snippets/html/glyphs/) ### Articles - 📜[A simple guide to HTML <head> elements](https://htmlhead.dev/) ### Books - 📒[HTML Notes for Pros](https://goalkicker.com/HTML5Book/HTML5NotesForProfessionals.pdf) - 📒[Design and Build Websites 💵](https://www.amazon.com/HTML-CSS-Design-Build-Websites/dp/1118008189) - 📒[Head First HTML with CSS 💵](https://www.amazon.com/Head-First-HTML-CSS-XHTML/dp/059610197X) - 📒[HTML5 Pocket Reference 💵](https://www.amazon.com/HTML5-Pocket-Reference-Comprehensive-Indispensable/dp/1449363350) ### Courses - 📝[HTML & CSS The Odin Project](https://www.theodinproject.com/courses/html-and-css) - 📝[Introduction to HTML Scrimba](https://scrimba.com/learn/html) - 📝[Introduction to Basic HTML & HTML5 FreeCodeCamp](https://www.freecodecamp.org/learn/responsive-web-design/basic-html-and-html5/) - 📝[HTML5 and CSS Fundemantals EDX](https://www.edx.org/course/html5-and-css-fundamentals) - 📝[Learn HTML CodeCademy 💵](https://www.codecademy.com/learn/learn-html) - 📝[Introduction to HTML and CSS Team Treehouse 💵](https://teamtreehouse.com/library/introduction-to-html-and-css) ### Websites - 🌐[HTML5 Doctor - A great reference for HTML Elements](http://html5doctor.com/) - 🌐[HTML-5-TUTORIAL - A Great Website for everything HTML](https://www.html-5-tutorial.com/) - 🌐[HTML5 Up - Responsive HTML5 and CSS3 site templates](http://html5up.net/) - 🌐[HTML Validator - Check if your HTML markup is valid and contains no errors.](https://validator.w3.org/) - 🌐[Templated - A collection of 845 free CSS & HTML5 site templates.](http://templated.co/) [👆 Back To Top](#table-of-contents) ## CSS ### Documentation - 📜[Learn to style HTML using CSS - MDN](https://developer.mozilla.org/en-US/docs/Web/CSS) ### Cheat Sheets - 📜[OverAPI CSS Cheat Sheet](https://overapi.com/css) - 📜[Extensive CSS Reference](https://tympanus.net/codrops/css_reference/) - 📜[Getting to Know CSS](https://learn.shayhowe.com/html-css/getting-to-know-css/) ### Books - 📒[CSS Secrets 💵](https://www.amazon.com/CSS-Secrets-Solutions-Everyday-Problems/dp/1449372635) - 📒[The CSS Pocket Guide 💵](https://www.amazon.com/CSS-Pocket-Guide-Peachpit/dp/0321732278) - 📒[CSS: The Definitive Guide: Third Edition 💵](https://www.amazon.com/CSS-Definitive-Guide-Eric-Meyer/dp/0596527330) ### Courses - 📝[Introduction to CSS - Scrimba](https://scrimba.com/learn/introtocss) - 📝[Introduction to Basic CSS - FreeCodeCamp ](https://www.freecodecamp.org/learn/responsive-web-design/basic-css/) - 📝[Learn CSS - CodeCademy💵](https://www.codecademy.com/learn/learn-css) - 📝[CSS Basics - Team Treehouse 💵](https://teamtreehouse.com/library/css-basics) ### Frameworks and Libraries - 🌐[Base](https://getbase.org/) - 🌐[Bulma](https://bulma.io/) - 🌐[Bootstrap](https://getbootstrap.com/) - 🌐[Animate.css](https://daneden.github.io/animate.css/) - 🌐[Dead Simple Grid](https://github.com/mourner/dead-simple-grid) - 🌐[Foundation](https://foundation.zurb.com/) - 🌐[Materialize CSS](https://materializecss.com/) - 🌐[Milligram](https://milligram.io/) - 🌐[Mustard UI](https://mustard-ui.com/) - 🌐[Picnic CSS](https://picnicss.com/) - 🌐[Pure](https://purecss.io/) - 🌐[Semantic UI](https://semantic-ui.com/) - 🌐[Spectre](https://picturepan2.github.io/spectre/) - 🌐[Skeleton](http://getskeleton.com/) - 🌐[Tachyons](https://tachyons.io/) - 🌐[Tailwind CSS](https://tailwindcss.com/) - 🌐[Tent CSS](https://css.sitetent.com/) - 🌐[UI Kit](https://getuikit.com/) ### Practice your CSS Skills - 🌐[Codepen](http://codepen.io/) - 🌐[CodeSandbox](https://codesandbox.io/) - 🌐[CSS Deck](http://cssdeck.com/) - 🌐[Dablet](http://dabblet.com/) - 🌐[JS Bin](http://jsbin.com/) - 🌐[JSFiddle](https://jsfiddle.net/) - 🌐[Liveweave](http://liveweave.com/) - 🌐[Plunker](http://plnkr.co/) - 🌐[StackBlitz](https://stackblitz.com/) ### Style Guides - 📜[AirBnb Style Guide - CSS](https://github.com/airbnb/css) - 📜[CSS Guidelines](https://cssguidelin.es/) - 📜[Google Style Guide - HTML & CSS](https://google.github.io/styleguide/htmlcssguide.html) - [Trello CSS Guide](https://gist.github.com/bobbygrace/9e961e8982f42eb91b80) ### Websites - 🌐[**7 Days, 7 Websites** - Build 7 websites in 7 days](https://7days7websites.glitch.me/) - 🌐[**Can I use** - Up-to-date browser support tables for front-end technologies](https://caniuse.com/) - 🌐[**Clippy** - A tool to help use the new clip-path property](https://bennettfeely.com/clippy/) - 🌐[**CSSBattle** - Learn CSS through a fun code-golfing game](https://cssbattle.dev) - 🌐[**CSS Easing functions** - A collection of easing functions used in CSS transitions and animations.](https://easings.net/) - 🌐[**CSS Diner** - Learn CSS Selectors through a game](https://flukeout.github.io/) - 🌐[**CSS for People Who Hate CSS**](https://paulcpederson.com/articles/css-for-people-who-hate-css/) - 🌐[**CSS Grid Garden** - Learn CSS Grid through a game](https://cssgridgarden.com/) - 🌐[**CSS Layout** - A collection of popular layouts and patterns made with CSS](https://csslayout.io/) - 🌐[**CSS reference by Codrops** - Excellent guide on how to write better, cleaner and more reusable CSS code.](http://tympanus.net/codrops/css_reference/) - 🌐[**CSS-tricks** - A blog site for everything CSS](https://css-tricks.com) - 🌐[**Cubic Berzier Function Generator**](https://cubic-bezier.com/#.17,.67,.83,.67) - 🌐[**Flexbox Froggy** - Learn CSS Flexbox through a game](https://flexboxfroggy.com/) - 🌐[**Responsinator** - Check the responsiveness of a site across different devices.](https://www.responsinator.com/) - 🌐[**Responsive Grid System** - Quick flexible and easy fluid grid for easy responsive web design.](http://www.responsivegridsystem.com/) - 🌐[**Beautiful CSS box-shadow examples** - A curated collection of 90+ free beautiful box-shadow, click to copy.](https://getcssscan.com/css-box-shadow-examples) - 🌐[**Beautiful CSS buttons examples** - A curated collection of 80+ free beautiful buttons, click to copy.](https://getcssscan.com/css-buttons-examples) [👆 Back To Top](#table-of-contents) ## JavaScript ### Documentation - 📜[JavaScript — Dynamic client-side scripting - MDN](https://developer.mozilla.org/en-US/docs/Learn/JavaScript) ### Reference & Cheat Sheets - 📜[JavaScript Reference - MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference) - 📜[JavaScript Cheat Sheet - OverAPI](https://overapi.com/javascript) ### Courses - 📝[Learn JavaScript - CodeCademy](https://www.codecademy.com/learn/introduction-to-javascript) - 📝[Programming the Web with JavaScript - EDX ](https://www.edx.org/course/programming-for-the-web-with-javascript) - 📝[JavaScript Algorithms and Data Structures - FreeCodeCamp](https://www.freecodecamp.org/learn/javascript-algorithms-and-data-structures/basic-javascript/) - 📝[JavaScript Tutorial - GeekforGeeks](https://www.geeksforgeeks.org/javascript-tutorial/) - 📝[JavaScript30 - Wes Bos](https://javascript30.com/) - 📝[The Complete JavaScript Course - Udemy💵 ](https://www.udemy.com/course/the-complete-javascript-course/) - 📝[Learn Javascript From Scratch - Scaler](https://www.scaler.com/topics/javascript/) ### Books - 📒[Eloquent JavaScript ](https://eloquentjavascript.net/) - 📒[You Don't Know JavaScript ](https://github.com/getify/You-Dont-Know-JS) - 📒[JavaScript Notes for Pros](https://books.goalkicker.com/JavaScriptBook/) - 📒[JavaScript For Cats](http://jsforcats.com/) - 📒[Learning JavaScript Design Patterns](https://addyosmani.com/resources/essentialjsdesignpatterns/book/) - 📒[Secrets of the JavaScript Ninja](https://www.manning.com/books/secrets-of-the-javascript-ninja) - 📒[Speaking JavaScript](http://speakingjs.com/es5/index.html) - 📒[JavaScripts The Good Parts💵](https://www.amazon.com/gp/product/0596517742/ref=as_li_ss_tl?ie=UTF8&camp=1789&creative=390957&creativeASIN=0596517742&linkCode=as2&tag=eldoradohills-20) - 📒[JavaScrit and JQuery💵](http://javascriptbook.com/) ### Challenge Websites - 🌐[AtCoder](https://atcoder.jp/) - 🌐[CodeChef](https://www.codechef.com/) - 🌐[Coderbyte](https://coderbyte.com/) - 🌐[Coderbyte](https://coderbyte.com/) - 🌐[Codewars](https://www.codewars.com/) - 🌐[CodinGame](https://www.codingame.com/) - 🌐[CodeForces](https://codeforces.com/) - 🌐[DevProjects - Free real-world JavaScript projects](https://www.codementor.io/projects/javascript) - 🌐[Exercism](https://exercism.io/) - 🌐[HackerEarth](https://www.hackerearth.com/) - 🌐[Hackerrank](https://www.hackerrank.com/) - 🌐[Leetcode](https://leetcode.com/) - 🌐[Pramp](https://www.pramp.com/#/) - 🌐[Project Euler](https://projecteuler.net/) - 🌐[SPOJ](https://www.spoj.com/) - 🌐[TopCoder](https://www.topcoder.com/) ### Snippets and cheatsheets - 📜[A ridiculous collection of cheatsheets](https://devhints.io/) - 📜[Favorite JavaScript utilities in single line of code](https://1loc.dev/) - 📜[Modern JavaScript Cheatsheet](https://github.com/mbeaudru/modern-js-cheatsheet) - 📜[Short JavaScript code snippets for all your development needs](https://github.com/30-seconds/30-seconds-of-code) ### Style Guides - 📜[Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) - 📜[Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html) - 📜[Standardjs](https://standardjs.com/) ### Visual Studio Code Extensions - 🌐[**Babel JavaScript** - Syntax highlighting for today's JavaScript](https://marketplace.visualstudio.com/items?itemName=mgmcdermott.vscode-language-babel) - 🌐[**Bracket Pair Colorizer 2** - Match brackets with same color](https://marketplace.visualstudio.com/items?itemName=CoenraadS.bracket-pair-colorizer-2) - 🌐[**Debugger for Chrome** - Debugging tool](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) - 🌐[**ESLint** - Code Linter](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - 🌐[**Intellisense** - Code completion and Information](https://marketplace.visualstudio.com/items?itemName=christian-kohler.npm-intellisense) - 🌐[**Live Server** - Live Web Page Reload.](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) - 🌐[**NPM** - npm support for VsCode](https://marketplace.visualstudio.com/items?itemName=eg2.vscode-npm-script) - 🌐[**Path Intellisense** - Auto-complete path files](https://marketplace.visualstudio.com/items?itemName=christian-kohler.path-intellisense) - 🌐[**Prettier** - Code Formatting.](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - 🌐[**Paste JSON as Code** - Copy JSON paste as JavaScript or Typescript](https://marketplace.visualstudio.com/items?itemName=quicktype.quicktype) - 🌐[**Quokka.js** - Prototyping playground that displays the results of an operation inside your IDE](https://marketplace.visualstudio.com/items?itemName=WallabyJs.quokka-vscode) - 🌐[**REST Client** - REST Client for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) - 🌐[**Settings Sync** - Synchronise your editor settings using Github.](https://marketplace.visualstudio.com/items?itemName=Shan.code-settings-sync) - 🌐[**Snippets** - Snippets for JavaScript ES6 syntax and TypeScript.](https://marketplace.visualstudio.com/items?itemName=xabikos.JavaScriptSnippets) ### Websites - 🌐[HTML DOM](https://htmldom.dev/) - 🌐[this vs that](https://thisthat.dev/) ### Articles - 📜[70 JavaScript Interview Questions](https://dev.to/macmacky/70-javascript-interview-questions-5gfi) - 📜[10 JavaScript concepts you need to know for interviews](https://codeburst.io/10-javascript-concepts-you-need-to-know-for-interviews-136df65ecce) - 📜[10 Interview QuestionsEvery JavaScript Developer Should Know ](https://medium.com/javascript-scene/10-interview-questions-every-javascript-developer-should-know-6fa6bdf5ad95) - 📜[A Study Plan To Cure JavaScript Fatigue](https://www.freecodecamp.org/news/a-study-plan-to-cure-javascript-fatigue-8ad3a54f2eb1/) - 📜[How to Manage JavaScript Fatigue ](https://auth0.com/blog/how-to-manage-javascript-fatigue/) [👆 Back To Top](#table-of-contents) ## Git ### Courses - 📝[A Guide to Git & Version Control](https://www.educative.io/courses/guide-to-git-and-version-control/) - 📝[Git Cheat Sheet](http://www.ndpsoftware.com/git-cheatsheet.html) - 📝[Learn Git ](https://www.codecademy.com/learn/learn-git) - 📝[Version Control (Git)](https://missing.csail.mit.edu/2020/version-control/) - 📝[Version Control with Git](https://www.coursera.org/learn/version-control-with-git/) - 📝[Getting Started with Git 💵](https://www.pluralsight.com/courses/getting-started-git/) ### Books - 📒[Pro Git](https://git-scm.com/book/en/v2) ### Tools - 🌐[Bitbucket](https://bitbucket.org/) - 🌐[Github](http://github.com/) - 🌐[Git Extensions for Windows](https://github.com/gitextensions/gitextensions) - 🌐[Sourcetree](https://www.sourcetreeapp.com/) [👆 Back To Top](#table-of-contents) ## React ### Documentation - 📜[React Official Docs ](https://reactjs.org/docs/getting-started.html) ### Cheat Sheets - 📜[React Cheatsheet](https://devhints.io/react) ### Courses - 📝[The Beginner's Guide to React - Egghead](https://egghead.io/courses/the-beginner-s-guide-to-react) - 📝[Introduction to React - freeCodeCamp](https://www.freecodecamp.org/learn/front-end-libraries/react/) - 📝[Introduction to React - FullStackOpen](https://fullstackopen.com/en/part1) - 📝[React Getting Started - Pluralsight](https://www.pluralsight.com/courses/react-js-getting-started) - 📝[Learn React - Scrimba](https://scrimba.com/course/glearnreact) - 📝[React for Beginners - Wes Bos](https://reactforbeginners.com/) - 📝[Epic React - Kent C. Dodds💵 ](https://epicreact.dev/) ### Books - 📒[Build Your Own React](https://pomb.us/build-your-own-react/) - 📒[Pure React](https://daveceddia.com/pure-react/) - 📒[React Explained](https://www.ostraining.com/books/react/) - 📒[Under the hood ReactJS](https://bogdan-lyashenko.github.io/Under-the-hood-ReactJS/) - 📒[Fullstack React 💵](https://www.newline.co/fullstack-react/) - 📒[React from Zero 💵](https://www.newline.co/react-from-zero/) - 📒[Road to React 💵](https://www.roadtoreact.com/) ### Project Ideas - 🌐[Devprojects](https://www.codementor.io/projects/reactjs) - 🌐[DevChallenges](https://devchallenges.io/paths/front-end-developer) ### Podcasts - 🎤[React Round Up](https://devchat.tv/react-round-up) - 🎤[The React Podcast](https://reactpodcast.com/) ### Blog Sites - 🌐[Official React Blog ](https://reactjs.org/blog/) - 🌐[Kent C. Dodds' Blog ](https://blog.kentcdodds.com/) - 🌐[useHooks Blog](https://usehooks.com/) ### Youtube Channels - 🎥[Coding Addict](https://www.youtube.com/channel/UCMZFwxv5l-XtKi693qMJptA) - 🎥[Codevolution](https://www.youtube.com/channel/UC80PWRj_ZU8Zu0HSMNVwKWw) - 🎥[freeCodeCamp](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ) - 🎥[The Net Ninja](https://www.youtube.com/channel/UCW5YeuERMmlnqo4oq8vwUpg) - 🎥[Traversy Media](https://www.youtube.com/user/TechGuyWeb) ### React Tooling - 🌐[ESLint](https://eslint.org/) - 🌐[Lodash](https://lodash.com/) - 🌐[npm](https://www.npmjs.com/) - 🌐[React Sight](http://www.reactsight.com/) - 🌐[React Router](https://github.com/ReactTraining/react-router) - 🌐[React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi) - 🌐[Storybook](https://storybook.js.org/) ### State Management - 🌐[Mobx](https://mobx.js.org/README.html) - 🌐[Recoil](https://github.com/facebookexperimental/Recoil) - 🌐[Redux](https://github.com/reduxjs/redux) ### UI Frameworks & Libraries - 🌐[Grommet](https://v2.grommet.io/components) - 🌐[Material UI](https://material-ui.com/) - 🌐[Material Kit React](https://github.com/creativetimofficial/material-kit-react) - 🌐[Onsen UI](https://onsen.io/react/) - 🌐[Reactstrap](https://reactstrap.github.io/) - 🌐[React Bootstrap](https://react-bootstrap.github.io/) - 🌐[React Toolbox (Material Design)](http://react-toolbox.io/) - 🌐[Rebass](https://rebassjs.org/) - 🌐[Semantic UI React](https://react.semantic-ui.com/) - 🌐[Chakra UI](https://chakra-ui.com/) ### Unit Testing - 🌐[Enzyme](https://github.com/enzymejs/enzyme) - 🌐[Jest](https://jestjs.io/docs/en/tutorial-react) - 🌐[React Testing Library](https://testing-library.com/docs/react-testing-library/intro) - 🌐[Cypress](https://www.cypress.io/) ### Create React App - 🌐[Create React App](https://github.com/facebook/create-react-app) - 🌐[React Boilerplate](https://github.com/react-boilerplate/react-boilerplate) - 🌐[Divjoy](https://divjoy.com) 💵 ### CSS in JS - 🌐[Styled Components](https://styled-components.com/) - 🌐[Emotion (css in js)](https://emotion.sh/) ### Remote Data Fetching - 🌐[Axios](https://axios-http.com/) - 🌐[React Query](https://react-query.tanstack.com/) - 🌐[swr](https://swr.vercel.app/) ### Server Side Rendering - 🌐[Gatsby](https://www.gatsbyjs.com/) - 🌐[Next.js](https://nextjs.org/) ### Experts on Twitter - 📱[Andrew Clark](https://twitter.com/acdlite) - 📱[Brian Vaughn](https://twitter.com/brian_d_vaughn) - 📱[Dan Abramov](https://twitter.com/dan_abramov) - 📱[Kent C. Dodds](https://twitter.com/kentcdodds) - 📱[Luna Ruan](https://twitter.com/lunaruan) - 📱[Rachel Nabors](https://twitter.com/rachelnabors) - 📱[Rick Hanlon](https://twitter.com/rickhanlonii) - 📱[Sebastian Markbåge](https://twitter.com/sebmarkbage) - 📱[Seth Webster](https://twitter.com/sethwebster) ### Conferences - 🌐[ReactNext](https://react-next.com/) - 🌐[React Rally](http://www.reactrally.com/) - 🌐[ReactFest](https://reactfest.uk/) - 🌐[React Europe](https://www.react-europe.org/) ### Community - 🌐[React Forum](https://discuss.reactjs.org/) - 🌐[Reactiflux](https://www.reactiflux.com/) - 🌐[Reddit](https://www.reddit.com/r/reactjs/) - 🌐[React Spectrum](https://spectrum.chat/react) [👆 Back To Top](#table-of-contents) ## Vue ### Documentation - 📜[Getting started with Vue - MDN](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Vue_getting_started) - 📜[Vue Cheatsheet](https://devhints.io/vue) - 📜[Vue Cookbook](https://vuejs.org/v2/cookbook/) - 📜[Vue Docs ](https://vuejs.org/v2/guide/) ### Courses - 📝[Learn Vue.js - Full Course for Beginners - freeCodeCamp](https://www.freecodecamp.org/news/vue-js-full-course/) - 📝[Advanced Vue.js Features from the Ground Up - Frontend Masters](https://frontendmasters.com/courses/advanced-vue/) - 📝[Learn Vue 2: Step By Step - Laracasts](https://laracasts.com/series/learn-vue-2-step-by-step) - 📝[Getting Started with Vue.js - Scotch](https://scotch.io/courses/getting-started-with-vuejs?ref=home-start-here) - 📝[Learn Vue by Building and Deploying a CRUD App - Testdriven](https://testdriven.io/courses/learn-vue/) - 📝[Become a Ninja with Vue 3 - Vue-Exercises Ninja Squad](https://vue-exercises.ninja-squad.com) - 📝[Intro to Vue 2 - Vuemastery](https://www.vuemastery.com/courses/intro-to-vue-js/vue-instance/) - 📝[Learn Vue - VueSchool💵](https://vueschool.io/) - 📝[Premium Beginner to Advanced Vue Course - Vuemastery💵 ](https://www.vuemastery.com/courses) ### Project Ideas - 🌐[Free Vue Projects and Community - DevProjects](https://www.codementor.io/projects/vue) ### Books - 📒[Fullstack Vue 💵](https://www.fullstack.io/vue/) - 📒[Full-Stack Web Development with Vue.js and Node 💵](https://www.amazon.com/Full-Stack-Web-Development-Vue-js-Node/dp/1788831144) - 📒[Large Scale Apps with Vue 3 and TypeScript 💵](http://leanpub.com/vue-typescript/c/vaYXLEFWbMi7) - 📒[Mastering Vue.js 💵](https://masteringvuejs.com) - 📒[The Vue Handbook 💵](https://vuehandbook.com) - 📒[The Mastery Of Vue.js 2 💵](https://leanpub.com/vuejs2) - 📒[Testing Vue.js components with Jest 💵](https://leanpub.com/testingvuejscomponentswithjest) - 📒[Vue.js: Understanding its Tools and Ecosystem 💵](https://www.packtpub.com/business-other/vue-js-understanding-its-tools-and-ecosystem) - 📒[Vue.js 2 Design Patterns and Best Practices 💵](https://www.amazon.com/dp/178883979X) - 📒[Vue: Build & Deploy 💵](https://leanpub.com/vue-book) - 📒[Vue.js: Up and Running 💵](http://shop.oreilly.com/product/0636920103455.do) - 📒[Vue.js in Action 💵](https://www.manning.com/books/vue-js-in-action) ### Podcasts - 🎤[Cynical Developer Episode 99](https://cynicaldeveloper.com/podcast/99/) - 🎤[Enjoy the Vue](https://enjoythevue.io/) - 🎤[JavaScript Jabber Episode 276](https://devchat.tv/js-jabber/jsj-276-vue-js-with-maximilian-schwarzmuller/) - 🎤[Software Engineering Daily](http://softwareengineeringdaily.com/2015/12/29/front-end-javascript-with-evan-you/) - 🎤[Syntax Episode 130](https://syntax.fm/show/130/the-vuejs-show-scott-teaches-wes) - 🎤[Vue News Podcast](https://news.vuejs.org/) - 🎤[Views on Vue](https://devchat.tv/views-on-vue) ### Youtube Channels - 🎥[freeCodeCamp](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ) - 🎥[Traversy Media](https://www.youtube.com/user/TechGuyWeb) - 🎥[Vue NYC](https://www.youtube.com/vuenyc) - 🎥[VueConf EU](https://www.youtube.com/channel/UC9dJjbYeXjirDYYVfUD3bSw) ### Tools - 🌐[Bit](https://github.com/teambit/bit) - 🌐[Bootstrap Vue](https://bootstrap-vue.js.org/) - 🌐[Nuxt.js](https://nuxtjs.org/) - 🌐[Onseen UI](https://onsen.io/vue/) - 🌐[Quansar Framework](http://quasar-framework.org/) - 🌐[Vue Dev Server](https://github.com/paulpflug/vue-dev-server) - 🌐[Vuex](https://vuex.vuejs.org/en/) - 🌐[Vue Router](https://router.vuejs.org/en/) - 🌐[Vue Dev Tools](https://github.com/vuejs/vue-devtools) - 🌐[Vue CLI](https://github.com/vuejs/vue-cli) - 🌐[Vuetify](https://vuetifyjs.com/en/) ### Blogs - 🌐[Aligator.io](https://alligator.io/vuejs/) - 🌐[CSS-Tricks - Vue ](https://css-tricks.com/guides/vue/) - 🌐[The Vue Point](https://medium.com/the-vue-point) - 🌐[Vue.js Developers](https://vuejsdevelopers.com/) ### Community - 🌐[Reddit](https://www.reddit.com/r/vuejs/) - 🌐[Vuejs Forum](https://forum.vuejs.org/) - 🌐[Vue Land](https://vue-land.js.org/) ### Conferences - 🌐[Vue Conf](https://conf.vuejs.org/) - 🌐[Vue Conf US](http://us.vuejs.org/) - 🌐[Vue.js London](http://vuejs.london/) - 🌐[Vue.js Amsterdam](https://www.vuejs.amsterdam/) [👆 Back To Top](#table-of-contents) ## Browser extensions - 🌐[CSS Spider](https://cssspider.fresalabs.com/) - 🌐[Check Browsers Support 💵](https://checkbrowsers.support/) - 🌐[CSS Inspector 💵](https://cssinspector.com/) - 🌐[CSS Scan 💵](https://getcssscan.com/) [👆 Back To Top](#table-of-contents) ## Icons - 🌐[BoxIcons](https://boxicons.com/) - 🌐[CSS.gg](https://css.gg/) - 🌐[Font Awesome](https://fontawesome.com/?from=io) - 🌐[Flaticon](https://www.flaticon.com/home) - 🌐[Freepik](https://www.freepik.com/) - 🌐[Fontastic](http://fontastic.me/) - 🌐[Heroicons](https://heroicons.com/) - 🌐[Iconfactory](https://freeware.iconfactory.com/icons) - 🌐[Icons8](https://icons8.com/) - 🌐[Icontre](https://iconstore.co/) - 🌐[Iconjar](https://geticonjar.com/) - 🌐[IconFinder](https://www.iconfinder.com/free_icons) - 🌐[Iconshock](https://www.iconshock.com/free-icons/) - 🌐[Iconmonstr](https://iconmonstr.com/) - 🌐[Ionicons](https://ionicons.com/) - 🌐[Icomoon](https://icomoon.io/) - 🌐[Material Icons](https://material.io/resources/icons/) - 🌐[Pngtree](https://pngtree.com/free-icon) - 🌐[Swift Icons](https://www.swifticons.com/) - 🌐[UXWing](https://uxwing.com/) [👆 Back To Top](#table-of-contents) ## Fonts and Typography - 🌐[1001Fonts](https://www.1001fonts.com/) - 🌐[Abstract Fonts](http://www.abstractfonts.com/) - 🌐[Befonts](https://befonts.com/) - 🌐[DaFont](https://www.dafont.com/) - 🌐[Google Fonts](https://fonts.google.com/) - 🌐[FFonts](https://www.ffonts.net/) - 🌐[FonstSpace](https://www.fontspace.com/) - 🌐[FontsArena](https://fontsarena.com/) - 🌐[Fontsquirrel](https://www.fontsquirrel.com/) - 🌐[Free Script Fonts](https://www.freescriptfonts.net/) - 🌐[FontSpace](https://www.fontspace.com/) - 🌐[MyFonts](https://www.myfonts.com/) - 🌐[PinSpiry Fonts](https://pinspiry.com/category/free-resources/fonts/) - 🌐[TypeTester](https://www.typetester.org/) - 🌐[Typo Guide](http://www.typogui.de/) - 🌐[Unblast](https://unblast.com/fonts/) [👆 Back To Top](#table-of-contents) ## Illustrations - 🌐[Blob maker](https://www.blobmaker.app/) - 🌐[Blush](https://blush.design/) - 🌐[Draw Kit](https://drawkit.io/) - 🌐[IRA Design](https://iradesign.io/gallery/illustrations) - 🌐[Interfacer](https://interfacer.xyz/) - 🌐[Icons 8](https://icons8.com/ouch) - 🌐[Manypixels](https://gallery.manypixels.co/) - 🌐[Undraw](https://undraw.co/illustrations) [👆 Back To Top](#table-of-contents) ## Optimization - 🌐[CSS Validator](https://jigsaw.w3.org/css-validator/) - 🌐[Google Analytics](https://marketingplatform.google.com/about/analytics/) - 🌐[Nibbler](https://nibbler.silktide.com/en_US) - 🌐[Namecheap](https://www.namecheap.com/) - 🌐[Optimizilla](http://optimizilla.com/) - 🌐[PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights/) - 🌐[Sizzy](https://sizzy.co/) - 🌐[Usability Checklist](https://stayintech.com/info/UX) - 🌐[Who Is](https://who.is/) - 🌐[Woorank](https://www.woorank.com/) [👆 Back To Top](#table-of-contents) ## Color Inspiration - 🌐[0to255](https://www.0to255.com/) - 🌐[Branition Colors](https://branition.com/colors/) - 🌐[Coolors](https://coolors.co/) - 🌐[Color Hex](https://www.color-hex.com/) - 🌐[Color Hunt](https://colorhunt.co/) - 🌐[Flat UI Colors](https://flatuicolors.com/) - 🌐[LOL Color Palettes](https://www.webdesignrankings.com/resources/lolcolors/) - 🌐[Material Palette](https://www.materialpalette.com/) - 🌐[myColor Space](https://mycolor.space/) - 🌐[Paletton](http://paletton.com/) - 🌐[UIGradients](https://uigradients.com/#Kyoto) [👆 Back To Top](#table-of-contents) ## Images and Videos - 🌐[Burst](https://burst.shopify.com/) - 🌐[Coverr](http://www.coverr.co/) - 🌐[Canva](https://www.canva.com/photos/free/) - 🌐[Free Images](https://www.freeimages.com/) - 🌐[Flickr](https://www.flickr.com/) - 🌐[Gratisography](https://gratisography.com/) - 🌐[ISO Republic](http://isorepublic.com/) - 🌐[Life of Pix](https://www.lifeofpix.com/) - 🌐[Pexels](https://www.pexels.com/) - 🌐[Pixabay](https://pixabay.com/en/) - 🌐[Reshot](https://reshot.com/) - 🌐[Subtle Patterns](http://subtlepatterns.com/) - 🌐[Startup Stock Photos](http://startupstockphotos.com/) - 🌐[The Stocks](http://thestocks.im/) - 🌐[Unsplash](https://unsplash.com/) [👆 Back To Top](#table-of-contents) ## Hosting Sites - 🌐[Amazon Web Services](https://aws.amazon.com/) - 🌐[Digital Ocean](https://www.digitalocean.com/) - 🌐[Firebase](https://firebase.google.com/) - 🌐[Github](https://pages.github.com/) - 🌐[Netlify](https://netlify.com/) - 🌐[Render](https://render.com/) - 🌐[Vercel](https://vercel.com/) [👆 Back To Top](#table-of-contents) ## Design Inspiration - 🌐[Awwwards](https://www.awwwards.com/) - 🌐[Behance](https://www.behance.net/) - 🌐[Call To idea](http://www.calltoidea.com/) - 🌐[Design Inspiration](https://www.designspiration.net/) - 🌐[Dribble](https://dribbble.com/) - 🌐[From Up North](http://www.fromupnorth.com/) - 🌐[Land Book](http://land-book.com/) - 🌐[Media Queries](http://mediaqueri.es/) - 🌐[One Page Love](https://onepagelove.com/) - 🌐[Pinterest](http://pinterest.com/) - 🌐[Site Inspire](http://www.siteinspire.com/) - 🌐[Site Inspire](https://www.siteinspire.com/) - 🌐[Template Monster](https://www.templatemonster.com/) - 🌐[UI Movement](https://uimovement.com/) - 🌐[Webdesign Inspiration](http://webdesign-inspiration.com/) [👆 Back To Top](#table-of-contents) ## Portfolio Inspiration - 🌐[Aral Tasher](https://araltasher.com/) - 🌐[Brittany Chiang](https://brittanychiang.com/) - 🌐[Fidalgo Pedro](https://fidalgo.dev/) - 🌐[Jack Jeznach](http://jacekjeznach.com/) - 🌐[Julia Johnson](https://www.juliacodes.com/) - 🌐[Matt Farley](http://mattfarley.ca/) - 🌐[Nathan Simpson](https://nathansimpson.design/) - 🌐[Developer Portfolios - Github Repo](https://github.com/emmabostian/developer-portfolios) [👆 Back To Top](#table-of-contents) ## Youtube Channels - 🎥[Academind](https://www.youtube.com/c/Academind) - 🎥[Andy Sterkowitz](https://www.youtube.com/channel/UCZ9qFEC82qM6Pk-54Q4TVWA) - 🎥[Ben Awad](https://www.youtube.com/user/99baddawg) - 🎥[Coding Phase](https://www.youtube.com/channel/UC46wWUso9H5KPQcoL9iE3Ug) - 🎥[Clever Programmer](https://www.youtube.com/c/CleverProgrammer) - 🎥[Clement Mihailescu](https://www.youtube.com/channel/UCaO6VoaYJv4kS-TQO_M-N_g) - 🎥[Dev Ed](https://www.youtube.com/channel/UClb90NQQcskPUGDIXsQEz5Q) - 🎥[freeCodeCamp](https://www.youtube.com/c/FreeCodeCamp) - 🎥[Keep On Coding](https://www.youtube.com/channel/UCsLo154Krjwhoz8W00N8ItA) - 🎥[Programming With Mosh](https://www.youtube.com/channel/UCWv7vMbMWH4-V0ZXdmDpPBA) - 🎥[Leon Noel](https://www.youtube.com/channel/UCGiRSHBdWuCgjgmPPz_13xw) - 🎥[The Net Ninja](https://youtube.com/c/TheNetNinja) - 🎥[Traversy Media](https://www.youtube.com/c/TraversyMedia) - 🎥[Web Dev Simplified](https://www.youtube.com/c/WebDevSimplified/) [👆 Back To Top](#table-of-contents) ## Podcasts - 🎤[codeNewbies](https://www.codenewbie.org/podcast) - 🎤[Commit Your Code](https://anchor.fm/commityourcode) - 🎤[Codepen Radio](https://blog.codepen.io/radio/) - 🎤[DevDiscuss](https://dev.to/devdiscuss) - 🎤[freeCodeCamp](https://freecodecamp.libsyn.com/) - 🎤[Frontend Happy Hour](https://frontendhappyhour.com/) - 🎤[Fullstack Radio](https://fullstackradio.com/) - 🎤[JavaScript Jabber](https://devchat.tv/podcasts/js-jabber/) - 🎤[Ladybug Podcast](https://www.ladybug.dev/) - 🎤[Modern Web](https://www.thisdot.co/modern-web) - 🎤[Syntax](https://syntax.fm/) - 🎤[The Changelog](https://changelog.com/) [👆 Back To Top](#table-of-contents) ## Blogs - ✍[Codrops](https://tympanus.net/codrops/) - ✍[CSS-Tricks](https://www.css-tricks.com/) - ✍[Dev.to](https://dev.to/) - ✍[Echo.Js](https://www.echojs.com/) - ✍[freeCodeCamp](https://freecodecamp.org/news) - ✍[Front End Front](https://frontendfront.com/) - ✍[Frontend Focus](https://frontendfoc.us/) - ✍[Hacker News](https://news.ycombinator.com/) - ✍[Hackernoon](http://hackernoon.com/) - ✍[Hashnode](https://hashnode.com/) - ✍[Medium](https://medium.com/) - ✍[Stackoverflow](http://stackoverflow.com/) - ✍[SitePoint](http://www.sitepoint.com/) - ✍[Smashing Magazine](https://www.smashingmagazine.com/) - ✍[Scotch](https://scotch.io/) - ✍[Web Designer Depot](http://www.webdesignerdepot.com/) [👆 Back To Top](#table-of-contents) ## Interview Prep ### Resume Templates - 🌐[Canva](https://www.canva.com/) - 🌐[Creddle](http://creddle.io/) - 🌐[Harvard Office Of Career Services](https://ocs.fas.harvard.edu/guide-template-library) - 🌐[MyPerfectResume](https://www.myperfectresume.com/) - 🌐[ResumeWorded](https://resumeworded.com/) - 🌐[Resume.io](https://resume.io/) - 🌐[Resume Maker](https://www.resumemaker.online/) ### Resume Editing - 🌐[Grammarly](https://www.grammarly.com/) - 🌐[JobScan](https://www.jobscan.co/) - 🌐[SkillSyncer](https://skillsyncer.com/) - 🌐[Top Resume](https://www.topresume.com/) ### Job Sites - 🌐[Angel List](https://angel.co/jobs) - 🌐[Arc.dev - Remote Developer Jobs](https://arc.dev/) - 🌐[Find Remote Jobs](https://frontendremotejobs.com/) - 🌐[Github Jobs](https://jobs.github.com/) - 🌐[JavaScript Job](https://javascriptjob.xyz/) - 🌐[JustRemote](https://justremote.co/remote-developer-jobs) - 🌐[Jobspresso](https://jobspresso.co/remote-work/) - 🌐[JSRemotely](https://jsremotely.com/) - 🌐[Jr Dev Jobs](http://jrdevjobs.com/) - 🌐[Mashable Job Board](https://jobs.mashable.com/) - 🌐[Outsourcely](https://www.outsourcely.com/) - 🌐[Powertofly Jobs](https://powertofly.com/jobs/?location=Remote) - 🌐[Producthunt Jobs](https://www.producthunt.com/jobs?categories=Engineering&remote_ok=true) - 🌐[React Jobs Board](https://reactjobsboard.com/c/remote-react-jobs) - 🌐[Remoters](https://remoters.net/jobs/) - 🌐[Remote Hub](https://remotehub.io/) - 🌐[Remote Hunt](https://remotehunt.com/remote-jobs) - 🌐[Remoteco](https://remote.co/remote-jobs/developer/) - 🌐[Stackoverflow Jobs](https://stackoverflow.com/jobs) - 🌐[Startupers](https://www.startupers.com/) - 🌐[TheRemoteWork](https://theremotework.co/) - 🌐[We Work Remotely](https://weworkremotely.com/remote-jobs/) - 🌐[Women Who Code](http://womenwhocode.com/jobs) - 🌐[Working Nomads](https://www.workingnomads.co/remote-development-jobs) - 🌐[YC Startup Jobs](https://www.workatastartup.com/) - 🌐[Circular](https://trycircular.com) - 🌐[Honeypot](https://honeypot.io) ### Freelance Jobs Sites - 🌐[Codementor](https://www.codementor.io/) - 🌐[Freelancer](https://www.freelancer.com/) - 🌐[FlexJobs](https://www.flexjobs.com/) - 🌐[FreelancerMap](https://www.freelancermap.com/) - 🌐[Gun.io](https://www.gun.io/) - 🌐[Guru](https://www.guru.com/d/jobs/) - 🌐[People Per Hour](https://www.peopleperhour.com/) - 🌐[Upwork](https://www.upwork.com/) ### Mock Interviews - 🌐[Interviewing.io](https://interviewing.io/) - 🌐[Pramp](https://www.pramp.com/) ### Project Pair Programming - 🌐[Chingu](https://chingu.io/) ### Open Source - 🌐[Github Explore](https://github.com/explore) - 🌐[First Contributions](https://firstcontributions.github.io/) - 🌐[Good First Issue](https://goodfirstissue.dev/language/javascript) - 🌐[Good First Issues](https://goodfirstissues.com/) - 🌐[Open Source Fridays](https://opensourcefriday.com/) ### YouTube Series - 🎥[Get A Job Using LinkedIn - Danny Thompson](https://www.youtube.com/playlist?list=PL54X5yR8qizsMpvTCqUIEFMeEp-chvcxk) ### Articles - 📜[5 things you need to know in a programming interview](https://www.freecodecamp.org/news/the-most-important-things-you-need-to-know-for-a-programming-interview-3429ac2454b/amp/) - 📜[Finding your first remote job - Joshua W. Cameau](https://joshwcomeau.com/career/remote-work-pt2/) - 📜[How to Write a Developer Résumé Hiring Managers Will Actually Read](https://www.freecodecamp.org/news/how-to-write-a-resume-that-works/) - 📜[How to Get a Software Engineer Job at Google and Other Top Tech Companies](https://www.freecodecamp.org/news/how-to-get-a-software-engineer-job-at-google-and-other-top-tech-companies-efa235a33a6d/) - 📜[How to Break Into the Tech Industry—a Guide to Job Hunting and Tech Interviews](https://haseebq.com/how-to-break-into-tech-job-hunting-and-interviews/) - 📜[How To Get A Programming Job Without A Degree](https://selftaught.blog/get-programming-job-without-degree/) - 📜[How to Get a Remote Developer Job and Become a Digital Nomad](https://www.codementor.io/@npostolovski/how-to-get-a-remote-developer-job-and-become-a-digital-nomad-if04nmm1s) - 📜[How To Get Your First Web Developer Job: The Ultimate Guide for Junior Developers](https://careerfoundry.com/en/blog/web-development/how-to-get-your-first-web-developer-job-the-ultimate-guide-for-junior-developers/#2-where-should-i-look-for-web-development-jobs) - 📜[Resources that help me land a job at FANG](https://towardsdatascience.com/these-are-all-the-resources-that-help-me-land-a-fang-job-452341dd6bed) - 📜[Tips to get a job as a Developer](https://dev.to/devpato/tips-to-get-a-job-as-a-developer-4ic3) - 📜[The 30-minute guide to rocking your next coding interview](https://www.freecodecamp.org/news/coding-interviews-for-dummies-5e048933b82b/amp/) - 📜[Want to Know How to Get a Remote Job? I Asked 30 Remote Companies - This is What They Said](https://www.freecodecamp.org/news/how-to-get-a-remote-job/) - 📜[Why I studied full-time for 8 months for a Google interview](https://www.freecodecamp.org/news/why-i-studied-full-time-for-8-months-for-a-google-interview-cc662ce9bb13/) ## Newsletters - 🌐[CSS-Tricks](https://css-tricks.com/newsletters/) - 🌐[CSS Weekly](https://css-weekly.com/) - 🌐[FrontEnd Focus](https://frontendfoc.us/) - 🌐[JavaScript Weekly](https://javascriptweekly.com/) - 🌐[Responsive Design Weekly](https://responsivedesign.is/newsletter/) - 🌐[Smashing News Letter](https://www.smashingmagazine.com/the-smashing-newsletter/) [👆 Back To Top](#table-of-contents) ## Contributing You're very welcome to contribute to this list. Be sure to read [How to Contribute](CONTRIBUTING.MD) before making your contribution. ## Contributors ✨ Thanks goes to these wonderful people <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://codingknite.com/"><img src="https://avatars.githubusercontent.com/u/70036189?v=4?s=100" width="100px;" alt=""/><br />_{<b>Joel P. Mugalu</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=codingknite" title="Documentation">📖</a> <a href="#content-codingknite" title="Content">🖋</a> <a href="#maintenance-codingknite" title="Maintenance">🚧</a></td> <td align="center"><a href="https://github.com/ChinmayMhatre"><img src="https://avatars.githubusercontent.com/u/51131670?v=4?s=100" width="100px;" alt=""/><br />_{<b>Chinmay Mhatre</b>}</a><br /><a href="#content-ChinmayMhatre" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=ChinmayMhatre" title="Documentation">📖</a></td> <td align="center"><a href="https://twitter.com/nghuuphuoc"><img src="https://avatars.githubusercontent.com/u/57786711?v=4?s=100" width="100px;" alt=""/><br />_{<b>phuoc-ng</b>}</a><br /><a href="#content-phuoc-ng" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=phuoc-ng" title="Documentation">📖</a></td> <td align="center"><a href="https://divjoy.com/"><img src="https://avatars.githubusercontent.com/u/1481077?v=4?s=100" width="100px;" alt=""/><br />_{<b>Gabe Ragland</b>}</a><br /><a href="#content-gragland" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=gragland" title="Documentation">📖</a></td> <td align="center"><a href="https://www.imranbmohamed.com/"><img src="https://avatars.githubusercontent.com/u/71926855?v=4?s=100" width="100px;" alt=""/><br />_{<b>Imran Mohamed</b>}</a><br /><a href="#content-i786m" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=i786m" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/AlexNodex"><img src="https://avatars.githubusercontent.com/u/17162626?v=4?s=100" width="100px;" alt=""/><br />_{<b>AlexNodex</b>}</a><br /><a href="#content-AlexNodex" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=AlexNodex" title="Documentation">📖</a></td> <td align="center"><a href="https://arun.app/"><img src="https://avatars.githubusercontent.com/u/22396000?v=4?s=100" width="100px;" alt=""/><br />_<b>Arun</b></a><br /><a href="#content-h7y" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=h7y" title="Documentation">📖</a></td> </tr> <tr> <td align="center"><a href="https://binyam.in/"><img src="https://avatars.githubusercontent.com/u/39805353?v=4?s=100" width="100px;" alt=""/><br />_{<b>Binyamin Aron Green</b>}</a><br /><a href="#content-binyamin" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=binyamin" title="Documentation">📖</a></td> <td align="center"><a href="https://cssbattle.dev/"><img src="https://avatars.githubusercontent.com/u/379918?v=4?s=100" width="100px;" alt=""/><br />_{<b>Kushagra Gour</b>}</a><br /><a href="#content-chinchang" title="Content">🖋</a> <a href="https://github.com/codingknite/frontend-development/commits?author=chinchang" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/nathsimpson"><img src="https://avatars.githubusercontent.com/u/12689383?v=4?s=100" width="100px;" alt=""/><br />_{<b>Nathan Simpson</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=nathsimpson" title="Documentation">📖</a></td> <td align="center"><a href="https://mintbean.io/"><img src="https://avatars.githubusercontent.com/u/4856944?v=4?s=100" width="100px;" alt=""/><br />_{<b>Monarch Wadia</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=monarchwadia" title="Documentation">📖</a></td> <td align="center"><a href="https://medium.com/@qjli"><img src="https://avatars.githubusercontent.com/u/75322?v=4?s=100" width="100px;" alt=""/><br />_{<b>QJ Li</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=qjnz" title="Documentation">📖</a></td> <td align="center"><a href="https://sayemon10.github.io/"><img src="https://avatars.githubusercontent.com/u/35277447?v=4?s=100" width="100px;" alt=""/><br />_{<b>S. M. Abdul Aziz</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=sayemon10" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/xerosic"><img src="https://avatars.githubusercontent.com/u/42121005?v=4?s=100" width="100px;" alt=""/><br />_{<b>xerosic</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=xerosic" title="Documentation">📖</a></td> </tr> <tr> <td align="center"><a href="https://zoranjambor.com/"><img src="https://avatars.githubusercontent.com/u/515906?v=4?s=100" width="100px;" alt=""/><br />_{<b>Zoran Jambor</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=ZoranJambor" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/jenniferfu0811"><img src="https://avatars.githubusercontent.com/u/25816882?v=4?s=100" width="100px;" alt=""/><br />_{<b>jenniferfu0811</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=jenniferfu0811" title="Documentation">📖</a></td> <td align="center"><a href="https://twitter.com/gvrizzo"><img src="https://avatars.githubusercontent.com/u/7696343?v=4&s=100" width="100px;" alt=""/><br />_{<b>gvrizzo</b>}</a><br /><a href="https://github.com/codingknite/frontend-development/commits?author=guivr" title="Documentation">📖</a></td> </tr> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

Carefully curated list of awesome Appwrite resources 💪

# Awesome Appwrite [](https://github.com/sindresorhus/awesome)  ## Table of Contents: - [Announcements and Official Blog Posts](#announcements-and-official-blog-posts) - [30 Days of Appwrite](#30-days-of-appwrite-) - [Almost Netflix](#almost-netflix-) - [Hacktoberfest 2021](#hacktoberfest-2021) - [Learning Resources](#learning-resources) - [Getting Started](#getting-started) - [Setup, Customization and Deployment](#setup-customization-and-deployment) - [Web Development](#web-development) - [Mobile Development](#mobile-development) - [Security and Authentication](#security-and-authentication) - [Appwrite Services](#appwrite-services) - [Showcase (Source Code)](#showcase-built-with-appwrite-) - [Angular](#angular) - [Cordova](#cordova) - [Express](#express) - [Flutter](#flutter) - [Godot](#godot) - [Golang](#golang) - [Python](#python) - [React](#react) - [Svelte](#svelte) - [Unity](#unity) - [Vue](#vue) - [Nuxt](#nuxt) - [Android](#android) - [Videos](#videos) - [Books](#books) - [Inspiration](#inspiration) - [Playgrounds and Snippets](#playgrounds-and-snippets) - [SDK](#sdk) - [Tools](#tools) - [Communities](#communities) ## Announcements and Official Blog Posts * [Announcing Appwrite 0.14 with 11 Cloud Function Runtimes! 🥳](https://dev.to/appwrite/announcing-appwrite-014-with-11-cloud-function-runtimes-36f5) * [Announcing the Appwrite SDK for Dart](https://dev.to/appwrite/announcing-appwrite-sdk-for-dart-3ehc) (Official) * [Announcing the Appwrite CLI 🚀](https://dev.to/appwrite/announcing-the-appwrite-cli-4m68) (Official) * [Learn How to Add Object Detection Capabilities to Your Appwrite Storage Using Cloud Functions](https://dev.to/appwrite/learn-how-to-add-object-detection-capabilities-to-your-appwrite-storage-using-cloud-functions-4j6j) (Official) * [Sending a Custom Welcome Email Using Appwrite Functions and Mailgun](https://dev.to/appwrite/sending-a-custom-welcome-email-using-appwrite-functions-and-mailgun-225a) (Official) * [Create an Appwrite File Backup Function Using the Dropbox API](https://dev.to/appwrite/create-an-appwrite-file-backup-function-using-the-dropbox-api-2pfo) (Official) * [Learn How to Create and Run Appwrite Functions With Dart](https://dev.to/appwrite/learn-how-to-create-and-run-appwrite-functions-with-dart-5668) (Official) * [Learn How to Disable ClamAV in Your Appwrite Stack and Reduce Memory Usage](https://dev.to/appwrite/learn-how-to-disable-clamav-in-your-appwrite-stack-and-reduce-memory-usage-2e37) (Official) * [Appwrite Releases a Native Svelte SDK for Its Open-Source BaaS](https://dev.to/appwrite/appwrite-releases-a-native-svelte-sdk-for-its-open-source-baas-5g0g) (Official) ### 30 Days of Appwrite ✨ * [Day 1 - Pilot](https://dev.to/appwrite/30daysofappwrite-4hh) * [Day 2 - Installation](https://dev.to/appwrite/installing-appwrite-366o) * [Day 3 - Appwrite’s building blocks](https://dev.to/appwrite/30daysofappwrite-appwrite-s-building-blocks-1936) * [Day 4 - Appwrite Dashboard](https://dev.to/appwrite/30daysofappwrite-appwrite-dashboard-15cc) * [Day 5 - Your First Request](https://dev.to/appwrite/30daysofappwrite-your-first-request-4oco) * [Day 6 - SSL Certificates](https://dev.to/appwrite/30daysofappwrite-ssl-certificates-c08) * [Day 7 - Server Side SDKs](https://dev.to/appwrite/30daysofappwrite-server-side-sdks-24di) * [Day 8 - Accounts & Users API](https://dev.to/appwrite/30daysofappwrite-accounts-users-api-4592) * [Day 9 - Login and Signup](https://dev.to/appwrite/30daysofappwrite-login-and-signup-2957) * [Day 10 - OAuth Providers](https://dev.to/appwrite/30daysofappwrite-oauth-providers-3jf6) * [Day 11 - Getting Started with SMTP](https://dev.to/appwrite/30daysofappwrite-getting-started-with-smtp-1e2e) * [Day 12 - Email Verification and Forgot Password](https://dev.to/appwrite/30daysofappwrite-email-verification-and-forgot-password-420o) * [Day 13 - Appwrite Teams](https://dev.to/appwrite/30daysofappwrite-appwrite-teams-2fjd) * [Day 14 - Using Team Invites](https://dev.to/appwrite/30daysofappwrite-using-team-invites-gk1) * [Day 15 - Appwrite Database](https://dev.to/appwrite/30daysofappwrite-appwrite-database-22an) * [Day 16 - Database Design 🧐](https://dev.to/appwrite/30daysofappwrite-database-design-140a) * [Day 17 - Create User Profiles](https://dev.to/appwrite/30daysofappwrite-create-user-profiles-1c3m) * [Day 18 - Create Blog Posts](https://dev.to/appwrite/30daysofappwrite-create-blog-posts-31fi) * [Day 19 - Appwrite Storage API](https://dev.to/appwrite/30daysofappwrite-appwrite-storage-api-hgm) * [Day 20 - File Uploads and Downloads](https://dev.to/appwrite/30daysofappwrite-file-uploads-and-downloads-1dld) * [Day 21 - Appwrite Avatars API](https://dev.to/appwrite/30daysofappwrite-appwrite-avatars-api-epi) * [Day 22 - Appwrite CLI](https://dev.to/appwrite/30daysofappwrite-appwrite-cli-2mde) * [Day 23 - Appwrite Cloud Functions](https://dev.to/appwrite/30daysofappwrite-appwrite-cloud-functions-1pf2) * [Day 24 - Our First Cloud Function](https://dev.to/appwrite/30daysofappwrite-our-first-cloud-function-59k6) * [Day 25 - Cloud Function with CRON](https://dev.to/appwrite/30daysofappwrite-cloud-function-with-cron-258c) * [Day 26 - JWT Support in Appwrite](https://dev.to/appwrite/30daysofappwrite-jwt-l08) * [Day 27 - Appwrite for Production](https://dev.to/appwrite/30daysofappwrite-appwrite-for-production-56hi) * [Day 28 - Docker Swarm Integration](https://dev.to/appwrite/30daysofappwrite-docker-swarm-integration-2io9) * [Day 29 - Grafana Integration](https://dev.to/appwrite/grafana-integration-50p9) Showcase for projects built during [#30DaysOfAppwrite](https://30days.appwrite.io/)!! * [Dart Online Compiler](https://github.com/aadarshadhakalg/BLoC-Appwrite) * [Ruitoque´s Food](https://ruitoquefood.com/) * [Todo With Flutter](https://github.com/SirusCodes/todo_appwrite) * [React Native Appwrite OAuth](https://github.com/DiegoBM/react-native-appwrite-oauth) * [Appwrite Todo With React Native](https://github.com/DiegoBM/appwrite-todo-with-react-native) * [Toodo - Appwrite with Ionic](https://github.com/Hrdtr/toodo-app) * [FoodMagic](https://github.com/Sameerkash/FoodMagic) * [Flutter Appwrite Auth System](https://github.com/devkishor8007/Auth_System_Appwrite) * [Flutter Appwrite Todo](https://github.com/devkishor8007/todo-with-flutter/tree/todo_appwrite/flutter_appwrite) * [KnowYourFood](https://github.com/LeBraveLittleToaster/KnowYourFood) * [Budgetist](https://github.com/intel-raja/budgetist_kakeibo#budgetist_kakeibo) ### Almost Netflix 🎬 The Almost Netflix series is a tutorial for building a Netflix clone with Appwrite version 0.12.0 and above. * [Did we just build a Netflix clone with Appwrite?](https://dev.to/appwrite/did-we-just-build-a-netflix-clone-with-appwrite-28ok) * [Introducing Almost Netflix: Netflix clone built with Vue and Appwrite](https://dev.to/appwrite/introducing-almost-netflix-a-netflix-clone-built-with-vue-and-appwrite-34nb) * [Almost Netflix: A Netflix clone built with Flutter + Appwrite](https://dev.to/appwrite/almost-netflix-a-netflix-clone-built-with-flutter-appwrite-4d8p) * [Almost Netflix: An iOS Netflix Clone built with Appwrite](https://dev.to/appwrite/almost-netflix-an-ios-netflix-clone-built-with-appwrite-5b7) ## Hacktoberfest 2021 * [What is Appwrite and how to contribute for Hacktoberfest](https://dev.to/mishmanners/four-projects-to-contribute-to-this-hacktoberfest-pep) * [Appwrite, giving it a shot this Hacktoberfest ‘21](https://medium.com/@anand26shweta/appwrite-giving-it-a-shot-ad1ef79ae44f) ## Hacktoberfest 2022 * [Featured on the GitHub Blog](https://github.blog/release-radar-sept-2022) ## Learning Resources ### Getting Started * [Getting Started for Flutter](https://appwrite.io/docs/getting-started-for-flutter) (Official) * [Getting Started for Server](https://appwrite.io/docs/getting-started-for-server) (Official) * [Getting Started for Apple](https://appwrite.io/docs/getting-started-for-apple) (Official) * [Getting Started for Android](https://appwrite.io/docs/getting-started-for-android) (Official) * [Getting Started for Web](https://appwrite.io/docs/getting-started-for-web) (Official) * [Appwrite Introduction](https://medium.com/@eldadfux/introducing-appwrite-an-open-source-backend-server-for-mobile-web-developers-4be70731575d?source=friends_link&sk=b6a2be384aafd1fa5b1b6ff12906082c) * [Introduction to AppWrite (in Portuguese)](https://medium.com/@fernandayukarikawasaki/uma-introdu%C3%A7%C3%A3o-ao-appwrite-ad90a127d7fa) * [Exploring Appwrite](https://dev.to/asmit2952/exploring-appwrite-1nh5) * [How to get started with Appwrite](https://medium.com/@devanshkajve123/appwrite-what-is-appwrite-how-to-get-started-with-it-contribution-guide-and-more-68ccffb1a2d3) * [What is Appwrite and what are its key feature?](https://knowlegdeninja.blogspot.com/2021/10/what-is-appwrite-and-what-are-its-key.html)(blog) * [Getting started with Appwrite](https://dev.to/asmit2952/getting-started-with-appwrite-3oic) * [Introduction To Appwrite: The Open-Source Firebase Alternative That Is Easy to Self-Host 🚀](https://muthuannamalai.tech/introduction-to-appwrite-the-open-source-firebase-alternative-that-is-easy-to-self-host) * [What is Appwrite and How to use it Efficiently](https://dev.to/noviicee/what-is-appwrite-and-how-to-use-it-efficiently-3o1m) * [What's new in Appwrite 0.7](https://ajith75.hashnode.dev/whats-new-in-appwrite-07) * [How to setup Appwrite in Windows?](https://dev.to/goheljay/why-i-used-appwrite-how-to-setup-appwrite-in-windows-o2l) * [Appwrite - macOS Installation and Debugging Guide](https://dev.to/kritikash18/appwrite-macos-installation-and-debugging-guide-28fm) * [Appwrite: All you need to know](https://krishguptadev.hashnode.dev/appwrite-all-you-need-to-know) * [Set up the backend for your first app in the no-code way using Appwrite!](https://medium.com/@vidushig2020/set-up-the-backend-for-your-first-app-in-the-no-code-way-6052b348d045) * [How to setup Appwrite on Ubuntu](https://dev.to/noviicee/how-to-setup-appwrite-on-ubuntu-3j67) * [Open Source Backend Server - Appwrite](https://dev.to/hardikchopra242/open-source-backend-server-appwrite-48b9) * [Python in Appwrite ](https://dev.to/robimez/python-in-appwrite-378h) * [Appwrite with Dart!](https://dev.to/timothy22000/appwrite-with-dart-3knc) * [Appwrite Frequently Asked Questions](https://medium.com/geekculture/appwrite-frequently-asked-questions-374ce81513fe) * [Everything you need to know to get Appwrite Functions works on PHP runtime](https://imknight.com/everything-you-need-to-know-to-get-appwrite-functions-works-on-php-runtime) * [My First Appwrite Function](https://imknight.com/my-first-appwrite-function) * [What is Appwrite? Featured in GitHub Blog](https://github.blog/release-radar-sept-2022) ### Setup, Customization and Deployment * [How to add custom Docker containers to Appwrite](https://dev.to/streamlux/adding-custom-docker-containers-to-appwrite-2chp) * [Appwrite VS Code extension](https://dev.to/streamlux/appwrite-vs-code-extension-1356) * [Host Appwrite Backend with DigitalOcean Droplet](https://medium.com/@vaytrex/host-your-appwrite-backend-with-digitalocean-droplet-f3d248c60815) * [Setting up Appwrite on DigitalOcean](https://joshuacook.netlify.app/post/appwrite-digital-ocean/) * [Tips for running Appwrite in Production](https://appwrite.io/docs/production) * [Run Your Appwrite Backend Server With Any SMTP Provider for Max Email Deliverability](https://medium.com/@eldadfux/learn-how-to-run-your-appwrite-backend-server-with-any-smtp-provider-for-max-email-deliverability-c6ab2c3efec8?source=friends_link&sk=c4ad7bffb3952547cfb89137da581310) * [Tutorial on how to use an SMTP provider to manage Appwrite end servers to enhance email delivery](https://knowlegdeninja.blogspot.com/2021/10/tutorial-on-how-to-use-smtp-provider-to.html) * [Deploy Appwrite to AWS using Terraform and Ansible](https://dev.to/rizkyrajitha/deploy-appwrite-to-aws-using-terraform-and-ansible-4af) * [Setup Appwrite on Linode](https://imknight.com/setup-appwrite-on-linode/) * [Manage Appwrite data with Appsmith](https://imknight.com/manage-appwrite-data-with-appsmith/) * [Appwrite + Zapier = Magic](https://dev.to/ruthlessruler/appwrite-zapier-magic-12gk) * [Import sample data to Appwrite through Integromat](https://imknight.com/import-data-to-appwrite-through-integromat/) * [Integrate Adalo with Appwrite](https://imknight.com/integrate-adalo-with-appwrite/) * [How to install and configure Appwrite on CyberPanel](https://tafadzwa.hashnode.dev/how-to-install-and-configure-appwrite-on-cyberpanel) * [How to install Appwrite on Amazon EC2 instance](https://awstip.com/installing-appwrite-on-amazon-ec2-instance-13f6744f2b48) * [Deploy Appwrite on Google Cloud](https://blog.wilfredalmeida.com/appwrite-on-google-cloud) * [Introduction to AWS (+run Appwrite)](https://rizkyrajitha.hashnode.dev/introduction-to-aws-run-appwrite) * [How to integrate Appwrite with Google Cloud](https://medium.com/@shahneel2409/integrating-appwrite-with-google-cloud-for-beginners-e62d2239c59) * [How to install Appwrite on a Linode cloud server](https://dev.to/gregordavies/how-to-install-appwrite-on-a-linode-cloud-server-2235) * [Things to do after Setup Appwrite on Digital Ocean](https://imknight.com/things-to-do-after-setup-appwrite-on-digital-ocean) ### Web Development * [Node.JS in Appwrite](https://dev.to/finnkr/nodejs-in-appwrite-21kk) * [Integrating with Appwrite HTTP API Using no-SDK](https://medium.com/appwrite-io/how-to-connect-with-the-appwrite-backend-server-directly-using-only-the-appwrite-http-api-1e720b567395?source=friends_link&sk=1568e3606160605b28274050618cd68f) * [Newsletter Form Application with Appwrite and React](https://thebeginner86.medium.com/newsletter-form-application-with-appwrite-and-react-2791bd38a457) * [Deno in Appwrite](https://dev.to/asiancat54x/deno-appwrite-5271/) * [Getting Started with Appwrite and creating a Login Page with Appwrite and React (Part-1)](https://dev.to/kunals131/getting-started-with-appwrite-and-creating-a-login-page-with-appwrite-and-react-part-1-536l) * [Getting Started with Appwrite and creating a Login Page with Appwrite and React (Part-2)](https://dev.to/kunals131/getting-started-with-appwrite-and-creating-a-login-page-with-appwrite-and-react-part-2-4fgd) * [Appwrite + React](https://anjalirohira.hashnode.dev/integrate-appwrite-inside-react-projects) * [Building A URL Shortener using Appwrite and Express](https://dev.to/dro1/building-a-url-shortener-using-appwrite-and-express-128i) * [Appwrite + React = 🔥](https://medium.com/@hardikchopra242/react-appwrite-23a34bcc52a9) * [Building a Web App with ReactJS and Appwrite](https://dev.to/drishtipeshwani/building-a-web-app-with-reactjs-and-appwrite-4cno) * [Build a Web app using Next.js and Appwrite](https://dev.to/harisarang/build-a-web-app-using-nextjs-and-appwrite-4a0l) * [Getting Started with Appwrite in NextJS by Building An App](https://dev.to/qwe123coder/getting-started-with-appwrite-in-nestjs-22gk) * [Integrate Appwrite Storage API with React](https://dev.to/harisarang/integrate-appwrite-storage-api-with-react-5dg3) * [How To Generate and Store Map Previews in Ruby with Appwrite](https://dev.to/oliverpham/how-to-generate-and-store-map-previews-in-ruby-with-appwrite-43ha) * [What is Appwrite and who i setup in my project?](https://dev.to/jordi5107/what-is-appwrite-and-who-i-setup-in-my-project-3af) * [How Appwrite real-time can make your CMS changes instant](https://sakshiuppoor.hashnode.dev/how-appwrite-real-time-can-make-your-cms-changes-instant) * [Build a Chat app with Appwrite and Nextjs](https://3dweb.hashnode.dev/build-a-chat-app-with-appwrite-and-nextjs) * [How to import Ghost Blog Users to Appwrite](https://dev.to/joysankar2001/importing-ghost-blog-users-to-appwrite-1hag) * [Appwrite + JQuery](https://dev.to/leonyangela/build-your-app-with-appwrite-jquery-55ij) ### Mobile Development * [Appwrite the best backend for mobile apps and its features](https://qr.ae/pGxRuF) * [Appwrite secure open-source backend server for Flutter example app](https://dev.to/netfirms/appwrite-and-flutter-example-app-42ce) * [How setup Appwrite for Android with Retrofit ( Direct HTTP Request )](https://medium.com/@developersm13/how-to-setup-appwrite-io-for-android-with-retrofit-e6271d770cad) * [How to use Appwrite's Flutter SDK](https://dev.to/yashp1210/appwrite-for-flutter-58kb) * [Introduction to Appwrite Cloud Functions with Android and Kotlin](https://hardiksachan.hashnode.dev/introduction-to-appwrite-cloud-functions-with-android-and-kotlin) * [Dart in Appwrite](https://dev.to/oshi36/dart-in-appwrite-47e) * [Appwrite + Appcelerator Titanium: A step by step guide](https://github.com/m1ga/from_zero_to_app/blob/master/appwrite_app.md) * [Write Unit Tests for Appwrite SDK on Flutter With Mockito](https://betterprogramming.pub/write-unit-test-for-appwrite-sdk-on-flutter-with-mockito-e0c3b403199e) * [Integrate Retool Mobile with Appwrite](https://imknight.com/integrate-retool-mobile-with-appwrite) ### Security and Authentication * [Restricting Access to Your Appwrite Console](https://medium.com/appwrite-io/you-can-now-restrict-access-to-your-appwrite-console-b8b447885289?source=friends_link&sk=95b78cf75ff633e0f32b8a76ea619b08) * [User authentication with React.js and Appwrite](https://medium.com/@e.wambugu192/user-authentication-with-react-js-and-appwrite-30c9096e92b2) * [Full List of Appwrite Environment Variables](https://appwrite.io/docs/environment-variables) * [How to Use Magic URL Login with Appwrite](https://muthuannamalai.tech/how-to-use-magic-url-login-with-appwrite) * [How to use Appwrite on React Native](https://dev.to/fernandoamz/appwrite-react-native-48cn) * [How to migrate Wordpress users to Appwrite](https://dev.to/joysankar2001/migrate-wordpress-users-to-appwrite-63j) ### Appwrite Services * [AppWrite Services](https://koulurunandakishorereddy.tech/appwrite-services) * [Image Resizing and Cropping with Appwrite](https://medium.com/appwrite-io/how-to-use-appwrite-open-source-platform-as-your-image-cropping-optimisation-service-2c5efab4edcb?source=friends_link&sk=11c8c6d50c2c24d0084f20f98a90a0bd) * [Cropping and Optimizing images with Appwrite](https://medium.com/@anand26shweta/cropping-and-optimizing-images-with-appwrite-1e3662c37eaa) * [Cloud Functions with Dart and Appwrite](https://dev.to/nehanshj/cloud-functions-with-dart-and-appwrite-2nob) * [Using database api (Contenido en español) ](https://medium.com/@devildeveloper/implementando-un-backend-en-menos-de-cinco-minutos-con-appwrite-7c6d6262cc87) * [Leveraging Power of Appwrite to Build Scheduling Applications](https://medium.com/@ujjwal26599/leveraging-power-of-appwrite-to-build-scheduling-applications-40615fa7e7f7) * [Avatar API support in Appwrite](https://dev.to/pretty19/avatar-api-support-in-appwrite-fc1) * [Appwrites Avatars service](https://dev.to/ashish4arora/appwrites-avatars-service-4gae) * [Appwrite User Services](https://dev.to/asiancat54x/appwrite-users-services-4ohk) * [Introduction to Appwrite's Avatar API](https://drishtip.hashnode.dev/introduction-to-appwrites-avatar-api) * [All you need to know about APPWRITE Team service](https://dev.to/devgossips/all-you-need-to-know-about-appwrite-team-service-client-side-1g1b) * [Send Messages With Telegram Using Appwrite Functions](https://rizkyrajitha.hashnode.dev/send-messages-with-telegram-using-appwrite-functions) * [Use Twilio with Appwrite Java Cloud Functions](https://dev.to/kkhitesh/use-twilio-with-appwrite-java-cloud-functions-123p) * [Appwrites database service](https://mbosnjak.hashnode.dev/appwrites-database-service) * [Appwrites' Storage Services](https://dev.to/kaid00/appwrite-storage-service-39pc) * [Using Appwrite Locale Service in your Next Project](https://dev.to/drishtipeshwani/using-appwrite-locale-service-in-your-next-project-3pcm) * [Appwrites Account Service](https://dev.to/finnkr/appwrites-account-service-2hhd) * [Appwrite Storage Service](https://dev.to/yashp1210/appwrites-storage-service-ned) * [Rick Roll Your Friends Using Appwrite, Twilio, and .NET](https://dev.to/adityaoberai/rick-roll-your-friends-using-appwrite-twilio-and-net-4180) * [Discord crypto price alert bot powered by Appwrite](https://github.com/RizkyRajitha/appwritediscorddemo) * [Six ways to test and call Dart Appwrite Cloud Functions](https://medium.com/@aschilken/free-and-easy-cloud-functions-in-dart-with-appwrite-part-1-190faa3dc7bf) | [Source Code of Flutter example App](https://github.com/schilken/appwrite_cloud_functions) ## Showcase (Built with Appwrite 📣) Share your apps here! Submit a pull request! ### Angular * **Appwrite + Angular Todo MVC** A simple todo app built with Appwrite and Angular. [Source Code](https://github.com/appwrite/todo-with-angular) [Demo](https://appwrite-todo-with-angular.vercel.app/) * **Appwrite + Angular - Simple Blog** - A simple blog example using Angular as the frontend and Appwrite as the backend! [Source Code](https://github.com/NeonSpork/appwrite-blog-example) * **Appwrite + Angular SimpleGrocery** - A simple app to create fast shopping-list. [Source Code](https://github.com/ffex/simple-grocery-demo) * **Appwrite + Angular Transcript This** - A simple app to transcribe Youtube videos from their links. [Source Code](https://github.com/ffex/Transcript-This-Demo) * **Appwrite + Angular VideoTopics** - A simple app to search topic about a Youtube video. [Source Code](https://github.com/ffex/VideoTopics) * **Appwrite + Angular PodBook** - A simple app to trascript podcasts from RSS feed. [Source Code](https://github.com/ffex/PodBook) ### Cordova * **Appwrite + Cordova + React** - A simple instagram clone built with Appwrite, Cordova and React (with vite). [Source Code](https://github.com/arnu515/instagram-clone-with-cordova-appwrite) ### Express * **URL Shortener(Express and Appwrite)** - A simple URL Shortener built with Express and Appwrite. [Source Code](https://github.com/dro-1/appwrite-url-shortener) * **Appwrite + ExpressJS** - A simple API made using Appwrite and ExpressJS. [Source Code](https://github.com/PyroCandy/pokemon-api-appwrite) [Blog Post](https://medium.com/@rushilshekhar1_/making-a-simple-api-using-appwrite-a7ceb096bf8f) * **Appwrite System Health** - A simple demo app to build an express nodejs rest api to monitor health on appwrite app. [Source Code](https://github.com/fernandoamz/node-express-server-rest-api) [Blog Post](https://dev.to/fernandoamz/appwrites-health-service-3lh7) ### Flutter - **Artistry** - Artistry is a demo app built with flutter and Appwrite backend that demonstrates how to perform crud operation,searching, authentication with touch of cool animations. [Source Code](https://github.com/dvmjoshi/artistry_appwrite) * **Flutter TODO App** - A TODO app with Flutter and Appwrite as a backend. [Source Code](https://github.com/Dev-Manny/Appwrite-Todo) * **AppNote** - Flutter notes app using Appwrite as a backend for storing documents. [Source Code](https://github.com/netfirms/appnote), [Blog Post](https://dev.to/netfirms/appwrite-and-flutter-example-app-42ce) * **Flutter Appwrite Quiz App** A simple Quiz App built with Flutter and Appwrite [Source Code](https://github.com/appwrite/quiz-with-flutter) * **Flutter Appwrite Social App** A Social App playground for testing the features of Appwrite. [Source Code](https://github.com/alistairholmes/flutter-appwrite-social-app) * Building **No Signal** - A chatting App using Flutter and Appwrite [Part 1](https://bishwajeet-techmaster.medium.com/building-no-signal-app-using-flutter-and-appwrite-8b31358b5975)| [Part 2](https://bishwajeet-parhi.medium.com/building-no-signal-using-flutter-and-appwrite-part-2-565c5eb3b484) | [Part 3](https://bishwajeet-parhi.medium.com/building-no-signal-using-flutter-and-appwrite-part-3-90b08db16ec) | [Source Code](https://github.com/2002Bishwajeet/no_signal) * **Gradely 2 - Grade Calculator** - A grade calulator app where you can monitor and store your grades, built with Appwrite and Flutter. [Source Code](https://github.com/generalxhd/Gradely2) * **Fitness Challenge App with Appwrite** - Create fitness challenges, invite friends, sync your health data from Apple Health/Google Fit and see who's winning. [Source Code](https://github.com/gireeshp/fitness_challenge) [Blog Post](https://medium.com/@gireeshputhumana/building-the-fitness-challenge-app-with-appwrite-367286790f64) * **Quit Smoking App with Flutter and Appwrite** - A simple Counting app with user auth [Source Code](https://github.com/Jonathanvanhaaften/flutter_appwrite_1) * **Almost Instagram with Flutter and Appwrite** - A functional clone of Instagram social media platform [Source Code](https://github.com/letsintegreat/Almost-Instagram) ### Godot * **Godot + Appwrite** - A demo app to showcase Godot's integration with Appwrite. [Source Code](https://github.com/lohanidamodar/godot-appwrite) ### Golang * **GoRest** A demo app to showcase integrating appwrite apis with golang. Using database endpoints and examples [Source Code](https://github.com/maliaga-pantoja/golang-appwrite-demo) ### Preact - **Blog App** - A simple blog app built with Appwrite and Preact. [Source Code](https://github.com/Sooraj-s-98/Preact-appwrite-blog) ### Python * **Database interactions with the Python SDK demo** - A demonstration of using an Appwrite backend with a FastAPI python web application focussing on using pydantic as the interface with the Database. [Source Code](https://github.com/jhrcook/coffee-counter-appwrite-demo) * **Anime list app with Appwrite and python-telegram-bot** - Created a telegram bot with python that handles searching and taking note of your anime watchlist. [Source Code](https://github.com/RobiMez/Better_anime_list) * **Discordly** A Discord-bot to readily and easily shorten links from Discord itself, made possible by Appwrite. [Source Code](https://github.com/Arpan-206/discordly) ### React - **Tourpal** - Tourpal is a travel journal web app in which you can store all your travel experiences at one place. The app is built with ReactJs and Appwrite. At the same time, it is a completely secure app and uses Google authentication. [Source Code](https://github.com/drishtipeshwani/Tourpal) - **Shuttery** - Shuttery is a web app which fetches and lets you download beautiful pictures from Unsplash to satisfy all your artistic needs. Secure App, with Google OAuth using an Appwrite backend. [Source Code](https://github.com/muKaustav/Appwrite-DemoApp-Hacktoberfest-2021) - **Taskwrite** -Taskwrite is a demo web app built with React JS and Appwrite backend for Hacktoberfest 2021, that demonstrates how to create a To-Do list, that lets users add, edit, and delete tasks. It demonstrates the use of Google OAuth and Database Management. [Source Code](https://github.com/muKaustav/Taskwrite-Appwrite-Hacktoberfest-2021) * **OAuth Provider Tester** - A Simple Appwrite OAuth Tester App built to make new oauth provider testing easy. [Source Code](https://github.com/AmreshSinha/OAuth-Tester-Appwrite) * **User Auth** - User auth is a simple user authentication for web applications. It was made as a guide for your next application. [Source Code](https://github.com/HelixHEX/reactjs-appwrite_userauth), [Blog Post](https://medium.com/@e.wambugu192/user-authentication-with-react-js-and-appwrite-30c9096e92b2) * **Appwrite + React Todo MVC** A simple todo app built with Appwrite and React. [Source Code](https://github.com/appwrite/todo-with-react) [Demo](https://appwrite-todo-with-react.vercel.app/) * **Appwrite + NextJs Todo** A simple login app built with Appwrite and Nextjs. [Source Code](https://github.com/Sooraj-s-98/appwrite-todo-with-nextjs) * **Made with Appwrite (Next.js)** This project can be used to collect information about projects which are built using Appwrite and can also be a place of a showcase for such projects. Built with Next.js and Appwrite. [Source Code](https://github.com/harisarang/madewithappwrite) [Demo](https://madewithappwrite.vercel.app/) [Tutorial](https://dev.to/harisarang/build-a-web-app-using-nextjs-and-appwrite-4a0l) * **Appwrite + NextJs +Nodejs Instagram clone** A instagram clone bulit with Appwrite , Nodejs and Nextjs. [Source Code](https://github.com/Sooraj-s-98/appwrite-instagram-clone) * **Building with Appwrite and Netlify** [Blog](https://medium.com/p/dcffb85ddcf8) * **Appwrite + NextJs Blog App** A Simple Blog App built with Appwrite and Nextjs. [Source Code](https://github.com/alceil/apppwrite-blogapp-with-nextjs) * **Appwrite + NextJs Social Media App** A Social Media App built with Appwrite and Nextjs. [Source Code](https://github.com/SanjayDevTech/appwrite-nextjs-demo) * **React TODO App** - React + Appwrite TODO App Demo by @christyjacob4. [Source Code](https://github.com/christyjacob4/todomvc-react) * **Quiz App (ReactJS and Appwrite)** - A demo web application built using React and integrated with Appwrite. [Source Code](https://github.com/shreyventure/quiz_app_write) * **Notes App with React + Appwrite** - A notes web app demo built with React and Appwrite. [Source Code](https://github.com/kunals131/notes-app-appwrite) * **Appwrite + React Google Drive Clone** - A simple google drive clone build with Appwrite and React. [Source Code](https://github.com/Emiliaaah/appwrite-auth-demo) * **Infinite Scrolling with React + Appwrite** - A simple project to demonstrate infinite scroll paging. [Source Code](https://github.com/SakshiUppoor/infinite-scroll-demo) * **Login Page App with React and Appwrite** - Created an App with complete tutorial [Source Code](https://github.com/kunals131/Login-App-With-Appwrite) * **Pastebin Clone built with Appwrite** - A simple pastebin clone built in React with Appwrite using Google OAuth for Authentication [Source Code](https://github.com/dro-1/appwrite-pastebin-clone) * **Chatwrite** -- A simple, no-login chat app made with Appwrite and React. [Source Code](https://github.com/DarthFloopy/Chatwrite) * **Real-Time CMS using React + Appwrite Real-Time API** - A blogging app to demonstrate how Appwrite's Real-time Service can be used to make CMS changes instant [Source Code](https://bitbucket.org/generic-team-name-23/real-time-cms/src/master/) * **useMindmap** - useMindmap is a mind mapping tool for individuals and teams to put their ideas or projects or whatever else a mind map can be used for. Built with React and Appwrite. [Source Code](https://github.com/benweier/use-mind-map) * **Taskly - better way to manage your tasks** - An app to better manage tasks across all of the different task/todo/issue/project applications. Connect all of your 3party task providers, save time and focus on actually doing your job. [Website](https://taskly.kickass.website/), [Blog post](https://dev.to/capjavert/taskly-better-way-to-manage-your-tasks-2d2m), [Source Code](https://github.com/kickassCoderz/taskly) * **Places** - A showcase of how to use Appwrite to build a location-based app with related Collections, Appwrite Functions to ensure data integrity, and Realtime subscriptions to fetch asynchronously. [Blog Post](https://levelup.gitconnected.com/building-a-location-based-app-with-appwrite-48a2e2b6d4c2) | [Demo](https://places.pages.dev/) | [Source Code](https://github.com/stnguyen90/places) * **Snake Arcade** - A retro themed snake game with a live highscore board built in React using Appwrite Database and Realtime feature. [Blog Post](https://dev.to/anomic30/retro-themed-snake-game-with-live-highscore-board-2lei) | [Demo](https://snake-arcade-bck7y.ondigitalocean.app/) | [Source Code](https://github.com/anomic30/Snake-arcade) * **ScheduMate** - A web application that allows you to easily see the classes that you have in common with your friends. Friends make classes so much better! [Website](https://schedumate.study) | [Source Code](https://github.com/The-Powerpuff-Boys/schedu-mate) * **Next Appwrite Users** - App that showcases how to use Next.js with Appwrite as its backend. Uses Appwrite for Auth both on the frontend and on API routes. [Source code](https://github.com/RobRuizR/next-appwrite-users) ### React Native * **Listr** - A react native mobile application that allows for simple task management using lists | [Source Code](https://github.com/HelixHEX/listr) ### Svelte * **OmniaWrite** - OmniaWrite is a next-generation plain text editor engineered for creative writing. It is perfect for writing novels, lyrics, poems, essays, drafts and screenplays. [Source Code](https://github.com/TorstenDittmann/OmniaWrite), [Blog Post](https://omniawrite.com/posts/update-1-0-0) * **Login Page using Appwrite + Svelte** - A login/register page to showcase Appwrite's JS API with Svelte. [Source Code](https://github.com/PineappleIOnic/appwrite-svelte) * **Appwrite + Svelte Todo MVC** A simple todo app built with Appwrite and Svelte. [Source Code](https://github.com/appwrite/todo-with-svelte) [Demo](https://appwrite-todo-with-svelte.vercel.app/) * **TMStats** A medal tracker for game Trackmania made with Appwrite and Svelte Kit. [Source Code](https://github.com/meldiron/tmstats) [Demo](https://www.tmstats.eu/) * **App-ly** App-ly is an open-source URL shortener made using Svelte and Appwrite. It is a web app that allows you to shorten long URLs, share them, and generate QR Codes for them. [Source Code](https://github.com/Arpan-206/app-ly) * **To You** - Another to-do app, where completing tasks lead to great rewards. Leverages SvelteKit progressive enhancement features to enable a zero-JS experience. [Source Code](https://github.com/tglide/to-you), [Demo](https://to-you-tgl.vercel.app/) ### Vue * **Appwrite + VueJS Whatsapp Clone** - A WhatsApp Web clone using Appwrite and VueJS. [Source Code](https://github.com/yaakov123/whatsapp-clone) * **Appwrite + Vue.js CRUD** This is a Vue.js App made to interact with a Appwrite Server [Source Code](https://github.com/Anstroy/countries-app-vue) * **Appwrite + Vue Todo MVC** A simple todo app built with Appwrite and Vue. [Source Code](https://github.com/appwrite/todo-with-vue) [Demo](https://appwrite-todo-with-vue.vercel.app/) * **Tailwinder** This an open-source complete community website project created for Appwrite hackathon. [Source Code](https://github.com/MooseSaeed/Tailwinder) [Demo](https://dev.to/moose_said/introducing-tailwinder-home-for-tailwind-fans-powered-with-appwrite-4c0o) [Video Demo](https://vimeo.com/manage/videos/709162501) * **Appwrite + Nuxt 3 Workout-Buddy** This is a Nuxt 3 App that uses Appwrite as a backend to showcase the uses of Appwrite Databases and Collections, Authentication, and Pinia stores through CRUD operations! [Source Code](https://github.com/EshaanAgg/workout-buddy) * **(Appwrite + Nuxt) DeUrl** A simple URL Shortener app made with appwrite and NuxtJs. [Source Code](https://github.com/AVDiv/appwrite_nuxtjs_url_shortner) * **Appwrite + Vue Podcast Transcript** A simple Podcast Transcript app built with Appwrite, Deepgram and Vue. [Source Code](https://github.com/timothee-durand/appwrite-transcript) ### Android * **Appwrite + Kotlin Android App -> Taleia** - A simple app that generates sets of random word combinations to fight the writer's block. It Allows to log in and save them with Appwrite to be able to retreive the liked combinations later. [Source Code](https://github.com/und1n3/taleia) ### Unity * **Unofficial Appwrite Unity Plugin** Features include: login, register, send verification mails and request JWT's. [Source Code](https://github.com/AlexMeesters/unity-appwrite-plugin) ### Android * **Appwrite + Kotlin Android App -> Taleia** - A simple app that generates sets of random word combinations to fight the writer's block. It Allows to log in and save them with Appwrite to be able to retreive the liked combinations later. [Source Code](https://github.com/und1n3/taleia) ## Videos * [Appwrite - Secure, Open-Source Backend Server - #techWebinarNepal](https://www.youtube.com/watch?v=OPkHCyq7nlw) * [Introducing Appwrite for Flutter](https://www.youtube.com/watch?v=KNQzncq10CI) (online meetup with [@eldadfux](https://github.com/eldadfux)) * [Appwrite - Services](https://youtu.be/if8f_Bf-Hlw) * [Overview and installation on Windows](https://youtu.be/cJonzmJkPlQ) * [Appwrite + Flutter EP00: Series Introduction](https://www.youtube.com/watch?v=eYXb_xbUjio) * [Appwrite + Flutter EP01: Setup Appwrite](https://www.youtube.com/watch?v=teUUt4ZqIvI) * [Appwrite + Flutter EP02: Wireframing](https://www.youtube.com/watch?v=RjE0tmyBdow) * [Appwrite + Flutter EP03: New Flutter project, UI designs](https://www.youtube.com/watch?v=HvcemJhSeE8) * [Appwrite + Flutter EP04: Let's Authenticate Users](https://www.youtube.com/watch?v=WcGQDmuwGMM) * [Appwrite + Flutter EP4.1: Quick fix for Permission Error](https://www.youtube.com/watch?v=EBevk7dfTjY) * [Appwrite + Flutter EP05: Proper State management & Routing and navigation setup](https://www.youtube.com/watch?v=kYpwnYY9Gf8) * [Appwrite + Flutter EP06: Routing, profile, logout](https://www.youtube.com/watch?v=4ZSX0VSg4bM) * [Appwrite + Flutter EP07: Querying and Listing Transactions](https://www.youtube.com/watch?v=X9vw4PGDbGc) * [Appwrite + Flutter EP08: Create, Read, Update, Delete Operations](https://www.youtube.com/watch?v=1HodtTldSdA) * [Appwrite + Flutter EP09: Searching, ordering and filtering documents](https://www.youtube.com/watch?v=bcG7G-1QBOk) * [Appwrite + Flutter EP10: Deploying Appwrite Server in VPS + Tips for Appwrite in Production](https://www.youtube.com/watch?v=WzHdvLItrEc) * [Appwrite + Flutter EP11: User preferences and Locale API](https://www.youtube.com/watch?v=qKkgXy3H7Mw) * [Appwrite + Flutter EP12: Storage, uploading files, image previews](https://www.youtube.com/watch?v=CNjvNNYWgGU) * [Appwrite ❤️ Flutter : A Trivia Application (Quiz Application)](https://www.youtube.com/watch?v=J3XSlYUhdqs) * [What's new in Appwrite 0.7 🥳 🚀](https://www.youtube.com/watch?v=uuZq3K4Wjrc&list=PLUiueC0kTFqI9WIeUSkKvM-a_3fyaIiuk&index=16&t=14s) * [Create and Run Appwrite Functions with Dart](https://www.youtube.com/watch?v=WNIeIYz30Bg&list=PLUiueC0kTFqI9WIeUSkKvM-a_3fyaIiuk&index=17&t=142s) * [Flutter + Appwrite Starter Application Template (Part 1)](https://www.youtube.com/watch?v=ECtoXQ50Ar0) * [Flutter + Appwrite Starter Application Template (Part 2)](https://www.youtube.com/watch?v=W_PH5tHbhhM) * [Flutter + Appwrite Starter Application Template (Part 3)](https://youtu.be/UZw4VVpt_ZI) * [Flutter + Appwrite Starter Application Template (Part 4)](https://www.youtube.com/watch?v=h3D40BQ4a2E&list=PLUiueC0kTFqLub-jXD3MK4Dy7tjUIQkIh&index=3) * [Flutter + Appwrite Gotchas - Common Issues We Might Run Into and Their Solutions](https://www.youtube.com/watch?v=bx8ifcXfMqA) * [#30DaysofAppwrite​ Video Series](https://www.youtube.com/playlist?list=PLUiueC0kTFqITusEntt8bjhm20hv30Fsa) * [Appwrite with Web.​ Video Series](https://www.youtube.com/playlist?list=PLUr_dKgYaKJbxDEf_SchTwukxb0FlHOFf) * [Using Appwrite with Flutter: A tutorial with examples](https://blog.logrocket.com/appwrite-flutter-tutorial-with-examples/) [Source Code](https://github.com/pinkeshdarji/appwrite) * [Using good-first-issues to contribute to Appwrite](https://youtu.be/k3l_rurKOXg) * [Setting Up Appwrite on Ubuntu](https://youtu.be/05Ykx-1bF_M) * [Appwrite + CloudConvert : How to integrate CloudConvert with Appwrite (with and without CloudConvert SDK)](https://youtu.be/_uSQdU-AVA8) ## Books * [Appwrite Up and Running by Alejandro Garcia](https://leanpub.com/appwrite-up-and-running/) ## Inspiration * [We Created Appwrite to Make Software Development Less Painful](https://medium.com/@eldadfux/software-development-is-harder-than-ever-so-we-created-an-open-source-backend-to-make-it-less-533f3e3b1461?source=friends_link&sk=fe1c6ddf391ecc1af5e0dc3c20c881be) * [How We Integrated Our Docs and SDKs as First-Class Citizens of Our Coding Process](https://medium.com/appwrite-io/how-we-integrated-our-docs-and-sdks-as-first-class-citizens-of-our-coding-process-8e343def0e9?source=friends_link&sk=6f99e56da66d9ddd79867a8974389a24) * [How We Use Snyk to Protect Appwrite's Open-Source Projects from *Evil* Dependencies](https://medium.com/@eldadfux/this-is-how-we-use-snyk-to-protect-our-open-source-projects-from-evil-dependencies-6ee258ca5815?source=friends_link&sk=6b024f64a1ed3caae9d72bccdaeed647) * [Scheduled Tasks: The Good Way (or: Why You Should Stop Using Crontab) ](https://medium.com/@eldadfux/background-tasks-the-good-way-or-why-you-should-stop-using-crontab-4d0e50b9781e?source=friends_link&sk=e7df29ade74b9be2b574acc770cd084e&fbclid=IwAR1ZTWexks_4y03uwG8rRTrFXg6hDm4jdCC0V2eBE_y4aHvqAXPWRF680Xk) * [Why I moved from BaaS to Appwrite (self-hosted Backend)](https://dev.to/torstendittmann/why-i-moved-from-baas-to-appwrite-self-hosted-backend-1e6b) * [Appwrite Setup and Email / Password Authentication](https://justinnoel.dev/2020/06/27/appwrite-setup-and-email-password-authentication/) * [Building Blocks for a Simplicity Driven Engineering Culture](https://medium.com/geekculture/building-blocks-for-a-simplicity-driven-engineering-culture-6725f07381c2) * [Appwrite and Open-Source](https://dev.to/sanketmathur/appwrite-and-open-source-5e7) * [Hacktoberfest (for Noobies) Guide](https://medium.com/@macallreevessmith/hacktoberfest-for-noobies-guide-f5e70b25c2e1) * [Appwrite and How It’s Changing the Mobile Application Development Industry – lofts.sh](https://lofts.sh/appwrite-and-how-its-changing-the-mobile-application-development-industry/) * [My Hacktoberfest journey with Appwrite](https://dev.to/jhrcook/my-hacktoberfest-journey-of-with-appwrite-1k52) * [The Best Open-Source Alternative to Firebase – Appwrite](https://instacodeblog.com/the-best-open-source-alternative-to-firebase-appwrite/) * [Hacktoberfest 2021 with AppWrite](https://dev.to/pretty19/hacktoberfest-2021-with-appwrite-3978) * [Brief introduction to Appwrite and it's features](https://dev.to/froostycodes/appwrite-must-try-obb) * [Hacktoberfest- What I learned by creating a Appwrite demo app](https://dev.to/jonathanvanhaaften/what-i-learned-by-creating-a-appwrite-flutter-demo-51ce) * [Contributing to Appwrite using Gitpod](https://bishwajeet-parhi.medium.com/how-i-used-gitpod-to-make-an-open-source-contribution-in-appwrite-9bc1f74ef155) ## Playgrounds and Snippets * [Playground for Web](https://github.com/appwrite/playground-for-web) * [Playground for Flutter](https://github.com/appwrite/playground-for-flutter) * [Playground for Deno](https://github.com/appwrite/playground-for-deno) * [Playground for Python](https://github.com/appwrite/playground-for-python) * [Playground for Node.js](https://github.com/appwrite/playground-for-node) * [Playground for Android with Retrofit](https://github.com/subhav13/Appwrite-Playground-for-Android-with-Retrofit) * [Playground for Android](https://github.com/appwrite/playground-for-android) * [Create a collection with Node.js](https://gist.github.com/eldadfux/0591d2205311b02966e5e365fbafad2a) * [Delete Appwrite Docker containers and volumes](https://gist.github.com/PedroCisnerosSantana/618a088f60a64f227363c6c10e80b366) ## SDK * [Appwrite Web SDK](https://github.com/appwrite/sdk-for-js) * [Appwrite Android SDK](https://github.com/appwrite/sdk-for-android) * [Appwrite Flutter SDK](https://github.com/appwrite/sdk-for-flutter) (beta) * [Appwrite PHP SDK](https://github.com/appwrite/sdk-for-php) * [Appwrite Svelte SDK](https://github.com/appwrite/sdk-for-svelte) * [Appwrite Node.js SDK](https://github.com/appwrite/sdk-for-node) * [Appwrite Python SDK](https://github.com/appwrite/sdk-for-python) (beta) * [Appwrite Ruby SDK](https://github.com/appwrite/sdk-for-ruby) (beta) * [Appwrite Deno SDK](https://github.com/appwrite/sdk-for-deno) (beta) * [Appwrite Appcelerator Titanium SDK](https://github.com/m1ga/ti.appwrite) * [Appwrite Kotlin SDK](https://github.com/appwrite/sdk-for-kotlin) (beta) * [Appwrite Dart SDK](https://github.com/appwrite/sdk-for-dart) * [Appwrite Go SDK](https://github.com/appwrite/sdk-for-go) * [Appwrite .NET SDK](https://github.com/appwrite/sdk-for-dotnet) * [Appwrite Swift SDK](https://github.com/appwrite/sdk-for-swift) * [Appwrite Apple SDK](https://github.com/appwrite/sdk-for-apple) * [Unoffical Appwrite Minecraft SDK](https://github.com/nCodesDotEU/Appwrite-Minecraft-Database) * [Unofficial Appwrite Godot Engine SDK](https://github.com/GodotNuts/appwrite-sdk) ## Tools * [Appwrite extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Streamlux.vscode-appwrite) proudly built by [@alexweininger](https://github.com/alexweininger) and the [@streamlux](https://github.com/streamlux) team. * [Appwrite CLI](https://github.com/appwrite/sdk-for-cli) interact with your Appwrite server side APIs from your terminal. * [Flutter Appwrite Account Kit](https://github.com/lohanidamodar/flappwrite_account_kit) * [Appwrite Explorer](https://github.com/stnguyen90/appwrite-explorer) explore different aspects of an Appwrite project from the front end * [Deploy Appwrite function](https://github.com/marketplace/actions/deploy-appwrite-function) a GitHub action to deploy your function to Appwrite * [Appwrite Starter](https://www.npmjs.com/package/create-appwrite) start building faster with this initializer for web frameworks * [Appwrite React Admin Data Provider](https://www.npmjs.com/package/ra-appwrite) Data and Auth Providers to integrate [React Admin](https://marmelab.com/react-admin/) with Appwrite * [Awesome Appwrite snippets](https://marketplace.visualstudio.com/items?itemName=Biswa.awesome-appwrite-snippets) that adds Live Templates to your IDE saving time writing the boilerplate in Appwrite. ## Communities * [Appwrite Blog](https://medium.com/appwrite-io) (Official, global) * [Discord Server](https://appwrite.io/discord) (Official, global) * [Twitter](https://twitter.com/appwrite) (Official, global) * [Facebook](https://www.facebook.com/appwrite.io/) (Official, global) * [Appwrite Developers on Facebook](https://www.facebook.com/groups/appwrite.developers/?source_id=227046654430085) (Official, global) * [Gitter](https://gitter.im/appwrite/community) (Legacy, global) You can also find the [Appwrite Topic on GitHub](https://github.com/topics/appwrite)! * [DEV Community](https://dev.to/appwrite)

Une liste de liens permettant de se former aux outils utilisés dans le domaine du Devops

# Awesome French Devops [](https://github.com/sindresorhus/awesome) 🚩 Soutenez ce projet en y mettant simplement une petite étoile. 🌟 <!-- vscode-markdown-toc --> * 1. [Introduction](#Introduction) * 2. [Liens vers les catégories d'outils](#Liensverslescatgoriesdoutils) * 2.1. [Administration de serveurs](/admin-serveurs/README.md) * 2.2. [Langages de Programmation](/langages-programmation/README.md) * 2.3. [Réseaux et Sécurité Informatique](/reseau-securite/README.md) * 2.4. [Configuration et maintenance de Serveurs](/configuration-serveurs/README.md) * 2.5. [Infrastructure as Code](/infra-as-code/README.md) * 2.6. [Pipelines de CI/CD](/ci-cd/README.md) * 2.7. [Conteneurs et Orchestrateurs](/conteneur-orchestration/README.md) * 2.8. [Clouders](/cloud/README.md) * 2.9. [Surveillance](/surveillance/README.md) * 3. [Sites parlant du Devops](#SitesDevops) * 3.1. [Blogs Perso](#BlogsPerso) * 3.2. [Sociétés](#Socits) * 3.3. [Articles](#Articles) * 4. [Livres](#Livres) * 5. [Communautés](#Communauts) * 6. [Mooc](#Mooc) * 7. [Chaines Youtube](#ChainesYoutube) * 8. [Des comptes Mastodon](#DescomptesMastodon) * 9. [Des comptes Twitters](#DescomptesTwitters) * 10. [Des slacks](#Desslacks) * 11. [Podcasts](#Podcasts) * 12. [Conférences](#Conferences) * 13. [Contribuer](#Contribuer) * 13.1. [Lignes directrices](#Lignesdirectrices) <!-- vscode-markdown-toc-config numbering=true autoSave=true /vscode-markdown-toc-config --> <!-- /vscode-markdown-toc --> ## 1. <a name='Introduction'></a>Introduction Ce dépôt a pour objectifs de : * d'aider à démarrer sa formation et à monter en compétences sur la culture et les outils DevOps. Il y a une petite roadmap décrivant le parcours pour les débutants. * recenser tous les liens pointant sur du contenu en Français pour remplir cet objectif. **C'est une question qui revient souvent. Comment je démarre si je veux maîtriser les outils Devops ? Par quoi dois-je commencer ?** Pour **mettre en œuvre avec succès le DevOps** on se doit de connaître un **certain nombre d'outils**. Pour rappel, **l'approche DevOps** met l'accent sur **l'automatisation des processus** de **développement de logiciels** tels que la **construction (build)**, les **tests**, la **mise en production**, les **mesures** et la **détection d'incidents**, ... C'est dans ce cadre que vous serez amené à connaître un certain nombre de ces outils. Je vous propose ce **mind-map** qui représente un peu tous les outils que vous serez amené à **rencontrer le plus souvent** : * **en violet** les plus courants * **en bleu** les moins courants * **en jaune** les très peu rencontrés (mais c'est bien de les connaître de nom) _Si vous débutez il faut suivre l'ordre indiqué par les nombres devant les grands sujets_ _Si vous ne connaissez absolument rien au devops commencez par lire ces [Livres](#Livres) ou suivre ces [Mooc](#Mooc)._  1. **Administration de serveurs** : Savoir configurer et dépanner un serveur Linux ou Windows 2. **Langages de Programmation** : Savoir écrire des petits programmes 3. **Connaitre les rudiments des réseaux et de la Sécurité Informatique** (Adresse IP, Firewalls, Routage) 4. **Configuration et maintenance de serveurs** : WEB, Cache et de Base de Données. 5. **Savoir écrire du code d'infrastructure** 6. **Savoir écrire des pipelines de CI/CD** 7. **Savoir construire et Orchestrer des conteneurs** (applications cloud native) 8. **Connaître les principaux Clouders**. 9. **Mise en place d'outils de Surveillance et de Centralisation de logs** Vous pouvez démarrer plusieurs sujets en parallèle, mais pas trop tout de même. Par exemple pour la partie Administration de Serveurs vous pouvez lire en // la configuration réseau. Vous pouvez aussi regarder la construction de VM avec **Vagrant** pour réaliser vos exercices. Pour vous aider je vais mettre ci-dessous rapidement toute une série de liens menant soit vers des sites, soit des livres (**en cours d'élaboration**) : ## 2. <a name='Liensverslescatgoriesdoutils'></a>Liens vers les catégories d'outils ### 2.1. <a name='Administrationdeserveursadmin-serveursREADME.md'></a>[Administration de serveurs](/admin-serveurs/README.md) ### 2.2. <a name='LangagesdeProgrammationlangages-programmationREADME.md'></a>[Langages de Programmation](/langages-programmation/README.md) ### 2.3. <a name='RseauxetScuritInformatiquereseau-securiteREADME.md'></a>[Réseaux et Sécurité Informatique](/reseau-securite/README.md) ### 2.4. <a name='ConfigurationetmaintenancedeServeursconfiguration-serveursREADME.md'></a>[Configuration et maintenance de Serveurs](/configuration-serveurs/README.md) ### 2.5. <a name='InfrastructureasCodeinfra-as-codeREADME.md'></a>[Infrastructure as Code](/infra-as-code/README.md) ### 2.6. <a name='PipelinesdeCICDci-cdREADME.md'></a>[Pipelines de CI/CD](/ci-cd/README.md) ### 2.7. <a name='ConteneursetOrchestrateursconteneur-orchestrationREADME.md'></a>[Conteneurs et Orchestrateurs](/conteneur-orchestration/README.md) ### 2.8. <a name='ClouderscloudREADME.md'></a>[Clouders](/cloud/README.md) ### 2.9. <a name='SurveillancesurveillanceREADME.md'></a>[Surveillance](/surveillance/README.md) ## 3. <a name='SitesDevops'></a>Sites parlant du Devops Voici une liste non exhaustive où vous trouverez de bons articles sur les **outils Devops**. Regardez dans le dépôt, j'y ai déposé mon export [feedly](https://feedly.com/) avec tous les flux RSS et Atom que je suis pour faire ma veille techno. Je la mettrai à jour régulièrement. [feedly.opml](./feedly.opml) ### 3.1. <a name='BlogsPerso'></a>Blogs Perso * [Antoine Mayer](https://blog.antoinemayer.fr/) * [Bruno Levasseur](https://blog.levassb.ovh/) * [dadall](https://www.dadall.info) * [damyr](https://www.damyr.fr) * [filador](https://blog.filador.fr) * [Frédéric Léger](https://www.webofmars.com/blog/) * [grottedubarbu](https://www.grottedubarbu.fr) * [Idriss Neumann](https://www.ineumann.fr) * [jesuisundev](https://www.jesuisundev.com) * [la forge](https://lafor.ge/) * [mcorbin](https://www.mcorbin.fr/) * [Rémi Verchère](https://www.vrchr.fr/) * [scalastic](https://scalastic.io/) * [Stephane Philippart](https://philippart-s.github.io/blog) * [Stephane ROBERT](https://blog.stephane-robert.info/) * [tferdinand](https://tferdinand.net) * [TheBidouilleur](https://thebidouilleur.xyz) * [Zwindler's Reflection](https://blog.zwindler.fr/) ### 3.2. <a name='Socits'></a>Sociétés * [April : Promouvoir et défendre le logiciel libre](https://april.org/) * [Bearstech](https://bearstech.com/societe/blog/) * [Blackcreeper](https://www.blackcreeper.com/blog/) * [Devoteam Revolve](https://blog.revolve.team/) * [EasyTeam](https://easyteam.fr/blog/) * [Eazytraining](https://eazytraining.fr/blog/) * [Eleven Labs](https://blog.eleven-labs.com) * [Enix](https://enix.io/fr/blog/) * [Ippon](https://blog.ippon.fr) * [Le Journal Du Hacker](https://www.journalduhacker.net) * [LinkValue](https://blog.link-value.fr/) * [NotSoSecure Claranet Cyber Security](https://notsosecure.com/blog) * [OVHcloud](https://blog.ovhcloud.com/) * [Publicis Sapient](http://blog.engineering.publicissapient.fr) * [Red Hat](https://www.redhat.com/fr/blog) * [Scaleway](https://blog.scaleway.com) * [Soat](https://blog.soat.fr) * [Wescale](https://blog.wescale.fr) * [Zenika](https://blog.zenika.com/) * [Webofmars](https://www.webofmars.com/blog/) ### 3.3. <a name='Articles'></a>Articles * [Mieux comprendre DevOps](https://aws.amazon.com/fr/devops/what-is-devops/) * [Accelerate vu par Zenika](https://blog.zenika.com/2021/08/18/accelerate-vu-par-zenika/) ## 4. <a name='Livres'></a>Livres * [Découvrir DevOps - 2e éd. - L'essentiel pour tous les métiers : L'essentiel pour tous les métiers](https://amzn.to/3roccO9) * [Mettre en œuvre DevOps - 3e éd. - Comment évoluer vers une DSI agile : Comment évoluer vers une DSI agile Broché](https://amzn.to/3e0d4pg) * [DevOps - Intégrez et déployez en continu](https://amzn.to/3fRVnsA) de Ernesto Leite * [Automatisation : de Python à Ansible](https://pressbooks.pub/automatisation/) de Alex Faivre & Gilbert Moïsio ## 5. <a name='Communauts'></a>Communautés * [Compagnons du Devops](https://www.compagnons-devops.fr/) * [SRE France](https://sre-france.github.io/) * [DevObs](https://discord.gg/kKUty5pfCQ) * [OpenBaR - build-and-run](https://bit.ly/2RmZttz) * [France DevOps](https://www.francedevops.fr/) ## 6. <a name='Mooc'></a>Mooc * [DevOpsSec](https://devopssec.fr/category/comprendre-le-devops) * [Découvrez la méthodologie DevOps sur OpenClassRooms](https://openclassrooms.com/fr/courses/6093671-decouvrez-la-methodologie-devops) * [Devenir Devops (vidéos) par xavki](https://www.youtube.com/playlist?list=PLn6POgpklwWrBPMKFniOiMyLMdxlgFhrG) 60 vidéos ## 7. <a name='ChainesYoutube'></a>Chaines Youtube * [Aurelie Vache](https://www.youtube.com/channel/UCrRk0kOP58lBMl9B8ZS8Vlg) * [CocAdmin](https://www.youtube.com/c/cocadmin) * [Compagnons du Devops](https://www.youtube.com/c/LesCompagnonsduDevOps) * [ComWorkIO](https://www.youtube.com/@comworkio) * [Cookie Connecté](https://www.youtube.com/channel/UC5cs06DgLFeyLIF_II7lWCQ) * [Cloud Nord](https://www.youtube.com/channel/UCD_iUcnDZgFlU_7fBmWH3tA) * [Devoxx FR](https://www.youtube.com/c/DevoxxFRvideos) * [France DevOps](https://www.youtube.com/channel/UC7Mwqt8IODoaQONPwMrOYQA) * [Inpulse.tv * Playlist Devops & cloud](https://www.youtube.com/playlist?list=PLORtqNVm6r7BVC3ldqwLK4Nl_FgjwpQpU) * [KrustyHack](https://www.youtube.com/channel/UCM0mnsNbecIi_IAPXtHb-TA) * [Le TechLab de Christophe Casalegno](https://www.youtube.com/channel/UCIlCglg-Gl6eNtllSB95gMA) * [Limawi](https://www.youtube.com/channel/UCxOvLOXTZFhy8NPMsxg5ogw) * [Naitech](https://www.youtube.com/channel/UCWftacXxXdvOk6MnoggQYug) * [Xavki](https://www.youtube.com/c/xavki-linux) ## 8. <a name='DescomptesMastodon'> Des comptes Mastodon * [Aurélie Vache](https://k8s.social/@scraly) * [Damy.R](https://mamot.fr/@DamyR) * [David Aparicio](https://framapiaf.org/@dadideo) * [Idriss Neumann](https://mastodon.comwork.io/@idrissneumann) * [Imrane Substack](https://pouet.chapril.org/@imranesubstack) * [Katia Himeur Talhi](https://fosstodon.org/@Katia) * [Mcorbin](https://twtr.plus/users/_mcorbin) * [Stéphane ROBERT](https://pouet.chapril.org/@robert_stephane) * [TheBidouilleur](https://mamot.fr/@TheBidouilleur) * [Xavki](https://twtr.plus/users/xavki_off) * [Zwindler](https://framapiaf.org/@zwindler) ## 9. <a name='DescomptesTwitters'></a>Des comptes Twitters * [Aurélie Vache](https://mobile.twitter.com/aurelievache) * [Cocadmin](https://twitter.com/cocadmin) * [DamyR](https://twitter.com/damyr_fr) * [David Aparicio](https://twitter.com/dadideo) * [Idriss Neumann](https://twitter.com/idriss_neumann) * [Imrane](https://twitter.com/ImraneSubstack) * [Jerôme Petazzoni](https://twitter.com/jpetazzo) * [Juliette Audema](https://twitter.com/ajuliettedev) * [Katia HIMEUR TALHI](https://mobile.twitter.com/katia_tal) * [Mcorbin](https://twitter.com/_mcorbin) * [Michée Lengronne](https://twitter.com/MicheeLengronne) * [Nicolas Hug](https://twitter.com/KrustyHack) * [Stéphane ROBERT](https://twitter.com/RobertStphane19) * [TheBidouilleur](https://twitter.com/TheBidouilleur) * [Xavki](https://twitter.com/xavki_off) * [Zwindler](https://twitter.com/zwindler) ## 10. <a name='Desslacks'></a>Des slacks * [comwork-cloud](https://t.co/kQcXNqtoNZ) ## 11. <a name='Podcasts'></a>Podcasts * [Dans ton kube](https://dtk.p7t.tech/) Parle de Kubernetes * [DevObs](https://devobs.p7t.tech/) Le magazine et observatoire du DevOps * [Electro Monkeys](https://podcasts.audiomeans.fr/electro-monkeys-0c9902cdaea8/) Les concepts et les technologies cloud natives * [Émission libre à vous de l'april #154](https://www.libreavous.org/154-devops-le-monde-du-libre-sobriete-energetique) * [Message à caractère informatique](https://www.clever-cloud.com/fr/podcast/) * [Radio DevOps](https://lydra.fr/radio-devops/) Le mouvement DevOps * [WeSpeakCloud](https://www.podcastics.com/podcast/wespeakcloud/) Les problématiques complexes comme la sécurité ou le DevOps ## 12. <a name='Conferences'></a>Conférences * Une liste des conférences DevOps est disponible sur ce dépôt : [saphoooo/impressionnant](https://github.com/saphoooo/impressionnant) * Plus largement, une liste de toutes les conférences tech (Dev, DevOps, etc) avec les dates de CFP est disponible sur ce dépôt : [scraly/developers-conferences-agenda](https://github.com/scraly/developers-conferences-agenda) ## 13. <a name='Contribuer'></a>Contribuer Vos contributions sont toutes les bienvenues ! Elles doivent être non commerciales. Je me garde le droit de ne pas accepter certaines demandes. ### 13.1. <a name='Lignesdirectrices'></a>Lignes directrices * Ajoutez un lien ou plusieurs par [pull request](https://github.com/stephrobert/awesome-french-devops/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) ou par [Issue](https://github.com/stephrobert/awesome-french-devops/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) * Le lien pointe sur du contenu en Français. Excepté les liens vers les sites officiels des produits cités. * Ajoutez une section si nécessaire. * Évitez les doublons. * Vérifiez votre orthographe et votre grammaire. * Supprimez tout espace blanc de fin.

Curated list of links, references, books videos, tutorials (Free or Paid), Exploit, CTFs, Hacking Practices etc. which are related to AWS Security

# Awesome AWS Security [](https://awesome.re) A common curated list of links, references, books videos, tutorials (Free or Paid), Exploit, CTFs, Hacking Practices etc. which are obviously related to AWS Security. _List inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing._  ## Table of Contents [1. AWS Whitepapers](#AWS-Whitepapers) [2. Books](#Books) [3. Videos](#Videos) [4. Online Tutorials/Blogs/Presentations](#Online-TutorialsBlogsPresentations) [5. Online Courses (Paid/Free)](#Online-Courses-PaidFree) [6. Tools of Trade](#Tools-of-Trade) [7. Security Practice and CTFs](#Security-Practice-and-CTFs) [8. AWS Security Bulleting Important Issues](#AWS-Security-Bulleting-Important-Issues) [9. AWS Security Breaches](#AWS-Security-Breaches) [10. Contributors](#Contributors) ## AWS Whitepapers AWS has awesome lists of whitepapers related to AWS Security. We are adding few important one here. You can anytime check more for updated or new security whitepapers [here](https://aws.amazon.com/security/security-learning/?whitepapers-main.sort-by=item.additionalFields.sortDate&whitepapers-main.sort-order=desc) And don't forget to **bookmark AWS Security bulletin** for new vulnerabilities news from [here](https://aws.amazon.com/security/security-bulletins/) 1. [AWS Overview](https://d1.awsstatic.com/whitepapers/aws-overview.pdf) - One of the important whitepaper to understand an overview of AWS 2. [Introduction to AWS Security Whitepaper](https://docs.aws.amazon.com/whitepapers/latest/introduction-aws-security/introduction-aws-security.pdf) 3. [AWS Well-Architected Security Pillar](https://docs.aws.amazon.com/wellarchitected/latest/security-pillar/wellarchitected-security-pillar.pdf) 4. [Introduction to Security By Design](https://d1.awsstatic.com/whitepapers/compliance/Intro_to_Security_by_Design.pdf) 5. [AWS Well Architected Framework](https://d1.awsstatic.com/whitepapers/architecture/AWS_Well-Architected_Framework.pdf) 6. [AWS Risk And Compliance Whitepaper](https://d0.awsstatic.com/whitepapers/compliance/AWS_Risk_and_Compliance_Whitepaper.pdf) 7. [AWS Security Checklist](https://d1.awsstatic.com/whitepapers/Security/AWS_Security_Checklist.pdf) 8. [AWS HIPAA Compliance Whitepaper](https://d0.awsstatic.com/whitepapers/compliance/AWS_HIPAA_Compliance_Whitepaper.pdf) 9. [AWS Cloud Adoption Framework](https://d1.awsstatic.com/whitepapers/aws_cloud_adoption_framework.pdf) 10. [AWS Auditing Security Checklist](https://d1.awsstatic.com/whitepapers/compliance/AWS_Auditing_Security_Checklist.pdf) 11. [AWS CIS Foundation benchmark](https://d1.awsstatic.com/whitepapers/compliance/AWS_CIS_Foundations_Benchmark.pdf) 12. [AWS Security Incident Response](https://d1.awsstatic.com/whitepapers/aws_security_incident_response.pdf) 13. [Overview of AWS Lambda Security](https://d1.awsstatic.com/whitepapers/Overview-AWS-Lambda-Security.pdf) 14. [AWS KMS Best Practices](https://d1.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) 15. [Encrypting File Data with Amazon Elastic File System](https://d1.awsstatic.com/whitepapers/Security/amazon-efs-encrypted-filesystems.pdf) 16. [Security of AWS CloudHSM backups](https://d1.awsstatic.com/whitepapers/Security/security-of-aws-cloudhsm-backups.pdf) 17. [Security overview of AWS Lambda](https://aws.amazon.com/lambda/security-overview-of-aws-lambda/) 18. [NIST Cybersecurity Framework in the AWS cloud](https://d0.awsstatic.com/whitepapers/compliance/NIST_Cybersecurity_Framework_CSF.pdf) 19. [NIST 800-144 Security and Privacy in Public Cloud Computing](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-144.pdf) 20. [Security at the Edge: Core Principles](https://d1.awsstatic.com/whitepapers/Security/security-at-the-edge.pdf) 21. [AWS KMS Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) 22. [Security Overview of AWS Fargate](https://d1.awsstatic.com/whitepapers/AWS_Fargate_Security_Overview_Whitepaper.pdf) ## Books 1. [Hands-On AWS Penetration Testing with Kali Linux by PackT](https://www.packtpub.com/virtualization-and-cloud/hands-aws-penetration-testing-kali-linux) 2. [Mastering AWS Security by PackT](https://www.packtpub.com/in/virtualization-and-cloud/mastering-aws-security) 3. [Security Best Practices on AWS by PackT](https://www.packtpub.com/in/virtualization-and-cloud/aws-security-best-practices-aws) 4. [Cloud Security Automation](https://www.packtpub.com/in/networking-and-servers/cloud-security-automation) 5. [AWS Automation Cookbook](https://www.packtpub.com/in/virtualization-and-cloud/aws-automation-cookbook) 6. [AWS Lambda Security Best Practices - pdf](http://www.aliencoders.org/wp-content/uploads/2020/01/AWS-Lambda-Security-eBook-1.pdf) - It's published by Puresec and it has a good overview on AWS Lambda Security Best Practices which we should follow 7. [AWS Security by Manning](https://www.manning.com/books/aws-security) - Very nice book in Progress, yet to release. 8. [Securing DevOps](https://www.manning.com/books/securing-devops) - A book which has real-world examples for Cloud Security. Must read book for any Cloud Security Professionals. 9. [Serverless Security](https://ServerlessSecurityBook.com) - An Apress book that discusses serverless security on AWS, Azure and Google Cloud. 10. [AWS Security Cookbook](https://www.packtpub.com/product/aws-security-cookbook/9781838826253) 11. [Practical Guide to Security in the AWS Cloud by SANS and sponsored by AWS Marketplace - pdf](https://pages.awscloud.com/rs/112-TZM-766/images/Cloud%20Security%20Practical%20Guide%20to%20Security%20in%20the%20AWS%20Cloud.pdf) 12. [CSA Guide to Cloud Computing by Sungress](https://www.oreilly.com/library/view/csa-guide-to/9780124201255/) 13. [Practical Cloud Security by O'reilly](https://www.oreilly.com/library/view/practical-cloud-security/9781492037507/) ## Videos 1. [The fundamentals of AWS Security](https://www.youtube.com/watch?v=-ObImxw1PmI) - Youtube 2. [AWS Security by Design](https://www.youtube.com/watch?v=I1SwoKxB13c) - Youtube 3. [Account Security with IAM](https://www.youtube.com/watch?v=9CKsX6MOPDQ) - Youtube 4. [AWS re:Inforce 2019 Security Best Practices](https://www.youtube.com/watch?v=u6BCVkXkPnM) - Youtube 5. [AWS Cloud Security Playlist](https://www.youtube.com/watch?v=N4DdqAkeqD4&list=PLxzKY3wu0_FL4VDfuCohtikXTQNTvKQVX) - Youtube 6. [A cloud security architecture workshop by RSA](https://www.youtube.com/watch?v=4TxvqZFMaoA) - Youtube 7. [AWS Cloud Security](https://www.oreilly.com/library/view/aws-cloud-security/9780135174784/) - Oreilly 8. [Introduction to AWS Security Hub](https://www.youtube.com/watch?v=o0NDi01YPXs) - Youtube 9. [Solution for flaws.cloud AWS Security Challenge](https://www.youtube.com/watch?v=VDptLO9XYbU&list=PLRTsCutScZnzo3uV_79Dur73kqskfaTMS) - Youtube Playlist 10. [AWS Security Best Practice: Well-Architected way](https://www.youtube.com/watch?v=u6BCVkXkPnM) - Youtube 11. [Hands-On With AWS Security Best Practices](https://www.youtube.com/watch?v=dabbsZ_sDX0) 12. [AWS re:Invent 2020: Security at scale: How Goldman Sachs manages network and access control](https://www.youtube.com/watch?v=5cnob8HIswY) ## Online Tutorials/Blogs/Presentations 1. [AWS Security official blog](https://aws.amazon.com/blogs/security/) 2. [AWS in Plain English](https://expeditedsecurity.com/aws-in-plain-english/) 3. [Why the CIA trusts AWS](https://mediatemple.net/blog/tips/aws-building-blocks/) 4. [Fundamentals of AWS Security](https://www.slideshare.net/AmazonWebServices/fundamentals-of-aws-security) - Presentation from AWS 5. [AWS Security primer](https://cloudonaut.io/aws-security-primer/) - Nice overview and quick run through AWS Security resources. 6. [AWS Security Blog](https://aws.amazon.com/blogs/security/) 7. [How a whitehat hacker earned $1500 in 15 minutes due to AWS S3 misconfiguration](https://medium.com/@protector47/how-i-earned-1-500-in-just-15-mins-due-to-amazon-s3-bucket-misconfiguration-953b28242f95) - It was fun going through the blog. You can learn from this article too. 8. [A deep dive into AWS S3 access control](https://labs.detectify.com/2017/07/13/a-deep-dive-into-aws-s3-access-controls-taking-full-control-over-your-assets/) - It will give a very good grip on how S3 buckets can be exploited. Lengthy but worth to go through. 9. [How Federico hacked a whole EC2 network during a penetration test](https://www.secsignal.org/en/news/how-i-hacked-a-whole-ec2-network-during-a-penetration-test/) 10. [A short blog on hacking AWS](https://www.devopsgroup.com/blog/hacking-aws-blog/) - Examples are based on cloudgoat. 11. [S3 security is flawed by design](https://www.upguard.com/blog/s3-security-is-flawed-by-design) - This article will show you why you need to be extra careful when using AWS S3. 12. [51 Tips for Security AWS(pdf)](https://www.mcafee.com/enterprise/en-us/assets/skyhigh/white-papers/wp-definitive-guide-to-aws-ebook.pdf) - McAfee 13. [The role of API gateways in API security](https://dzone.com/articles/the-role-of-api-gateways-in-api-security) 14. [Finding SSRF via HTML Injection inside a PDF file on AWS EC2](https://blog.appsecco.com/finding-ssrf-via-html-injection-inside-a-pdf-file-on-aws-ec2-214cc5ec5d90) 15. [Getting shell and data access in AWS by chaining vulnerabilities](https://blog.appsecco.com/getting-shell-and-data-access-in-aws-by-chaining-vulnerabilities-7630fa57c7ed) 16. [Hacking Serverless Runtimes - Blackhat2017](https://www.blackhat.com/docs/us-17/wednesday/us-17-Krug-Hacking-Severless-Runtimes.pdf) 17. [Detailed blog on ConsoleMe: A Central Control Plane for AWS Permissions and Access by Netflix](https://netflixtechblog.com/consoleme-a-central-control-plane-for-aws-permissions-and-access-fd09afdd60a8) 18. [Strengthen the security of sensitive data stored in Amazon S3 by using additional AWS services](https://aws.amazon.com/blogs/security/strengthen-the-security-of-sensitive-data-stored-in-amazon-s3-by-using-additional-aws-services/) 19. [Use IMDSv2 instead: Defense in depth](https://aws.amazon.com/blogs/security/defense-in-depth-open-firewalls-reverse-proxies-ssrf-vulnerabilities-ec2-instance-metadata-service/ ) 20. [Managing permissions with grants in AWS Key Management Service](https://aws.amazon.com/blogs/security/managing-permissions-with-grants-in-aws-key-management-service/) 21. [AWS IAM Exploitation](https://sra.io/blog/aws-iam-exploitation/) 22. [S3 Pentest by Rhino Security Labs](https://rhinosecuritylabs.com/penetration-testing/penetration-testing-aws-storage/) 23. [How an Attacker Could Use Instance Metadata to Breach Your App in AWS](https://www.mcafee.com/blogs/enterprise/cloud-security/how-an-attacker-could-use-instance-metadata-to-breach-your-app-in-aws/) 24. [Orca Security Research Team Discovers AWS CloudFormation Vulnerability](https://orca.security/resources/blog/aws-cloudformation-vulnerability/) 25. [Orca Security Research Team Discovers AWS Glue Vulnerability](https://orca.security/resources/blog/aws-glue-vulnerability/) 26. [How I Discovered Thousands of Open Databases on AWS](https://infosecwriteups.com/how-i-discovered-thousands-of-open-databases-on-aws-764729aa7f32) 27. [CVE-2022-25165: Privilege Escalation to SYSTEM in AWS VPN Client](https://rhinosecuritylabs.com/aws/cve-2022-25165-aws-vpn-client/) 28. [Downloading and Exploring AWS EBS Snapshots](https://rhinosecuritylabs.com/aws/exploring-aws-ebs-snapshots/) 29. [Weaponizing AWS ECS Task Definitions to Steal Credentials From Running Containers](https://rhinosecuritylabs.com/aws/weaponizing-ecs-task-definitions-steal-credentials-running-containers/) 30. [Good Read on AWS IAM Privilege Escalation – Methods and Mitigation](https://rhinosecuritylabs.com/aws/aws-privilege-escalation-methods-mitigation/) 31. [One more on IAM Privilege Escalation](https://payatu.com/blog/mayank.arora/iam_privilege_escalation_attack) 32. *[A very good repo for learning IAM based vulnerabilities](https://github.com/BishopFox/iam-vulnerable) ## Online Courses (Paid/Free) 1. [AWS Fundamentals: Address Security Risks](https://www.coursera.org/learn/aws-fundamentals-addressing-security-risk) - Coursera 2. [Cloud Computing Security](https://www.coursera.org/learn/cloud-computing-security) - Coursera 3. [AWS: Getting started with Cloud Security](https://www.edx.org/course/aws-getting-started-with-cloud-security) - EdX 4. [AWS Certified Security Specialty](https://www.udemy.com/course/aws-certified-security-specialty/) - Udemy by Zeal Vora 5. [AWS Certified Security Specialty](https://acloud.guru/learn/aws-certified-security-specialty) - From Acloud.guru 6. [AWS Advanced Security](https://www.udemy.com/course/aws-advanced-security/) - Udemy 7. [AWS for Architects: Advanced Security](https://www.linkedin.com/learning/aws-for-architects-advanced-security/) - Linkedin Learn by Lynn Langit 8. [Practical Event Driven Security with AWS](https://acloud.guru/learn/practical-event-driven-security-with-aws) - Acloud.guru 9. [Learning Path for AWS Security](https://learn.acloud.guru/learning-path/aws-security) - Nicely designed the learning path who wants to be an AWS Security Experts from Acloud.guru 10. [Cloud Hacking course](https://www.notsosecure.com/hacking-training/cloud-hacking/) - From NotSoSercure 11. [Breaking and Pwning Apps and Servers in AWS and Azure](https://github.com/appsecco/breaking-and-pwning-apps-and-servers-aws-azure-training) - Previously an instructor led training now released as free and open source courseware for Cloud Pentesters ## Tools of Trade 1. [AWS Security Products - Official](https://aws.amazon.com/products/security/) - Few Important tools that you should consider are: * 1.1 **AWS IAM:** AWS Identity and Access Management (IAM) enables you to manage access to AWS services and resources securely * 1.2 **CloudWatch:** CloudWatch is the AWS monitoring tool * 1.3 **CloudTrail:** AWS CloudTrail is a service that enables governance, compliance, operational auditing, and risk auditing of your AWS account * 1.4 **AWS Inspector:** AWS inspector is a security assessment service that does vulnerability and best-practice scanning for AWS applications * 1.5 **Amazon GuardDuty:** GuardDuty is a managed threat detection service that is simple to deploy, and scales with your infrastructure * 1.6 **AWS KMS:** AWS KMS is a secure and resilient service that uses hardware security modules that have been validated under FIPS 140-2 * 1.7 **AWS Shield:** AWS Shield is a managed DDoS protection service. AWS Shield can protect EC2, Load balancers, CloudFront, Global Accelerator, and Route 53 resources * 1.8 **AWS Trusted Advisor:** AWS Trusted Advisor is an online tool that provides you real time guidance to help you provision your resources following AWS best practices * 1.9 **AWS Config:** AWS Config is a service that enables you to assess, audit, and evaluate the configurations of your AWS resources * 1.10 **Security Hub:** AWS Security Hub gives you a comprehensive view of your high-priority security alerts and security posture across your AWS accounts * 1.11 **AWS WAF:** AWS WAF is a web application firewall that helps protect your web applications or APIs against common web exploits that may affect availability, compromise security, or consume excessive resources * 1.12 **AWS Macie:** Macie is all about protecting data. It is a machine learning service that watches data access trends and finds anomalies to spot data leaks and unauthorized data access. * 1.13 **AWS Detective:** Amazon Detective automatically collects log data from your AWS resources and uses machine learning, statistical analysis, and graph theory to build a linked set of data that enables you to easily conduct faster and more efficient security investigations. * 1.14 **AWS Conformance Packs:** A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed as a single entity in an account and a Region or across an organization in AWS Organizations. [conformance packs on github](https://github.com/awslabs/aws-config-rules/tree/master/aws-config-conformance-packs) 2. [Arsenal of AWS Security Tools](https://github.com/toniblyx/my-arsenal-of-aws-security-tools) - Collection of all security category tools and products 3. [AWS Security Automation](https://github.com/awslabs/aws-security-automation) - Collection of scripts and resources for DevSecOps and Automated Incident Response Security 4. [truffleHog](https://github.com/dxa4481/truffleHog) - Searches through git repositories for high entropy strings and secrets, digging deep into commit history 5. [gitleaks](https://github.com/zricethezav/gitleaks) - Audit git repos for secrets 6. [AWS Security Benchmark](https://github.com/awslabs/aws-security-benchmark) - Open source demos, concept and guidance related to the AWS CIS Foundation framework. 7. [S3 Inspector](https://github.com/kromtech/s3-inspector) - Tool to check AWS S3 bucket permissions 8. [ScoutSuite](https://github.com/nccgroup/ScoutSuite) - Multi-Cloud Security Auditing Tool 9. [Prowler](https://github.com/toniblyx/prowler) - AWS Security Best Practices Assessment, Auditing, Hardening and Forensics Readiness Tool. 10. [AWS Vault](https://github.com/99designs/aws-vault) - A vault for securely storing and accessing AWS credentials in development environments 11. [AWS PWN](https://github.com/dagrz/aws_pwn) - A collection of AWS penetration testing junk 12. [Pacu](https://github.com/RhinoSecurityLabs/pacu) - AWS Penetration Testing Toolkits 13. [Zeus](https://github.com/DenizParlak/Zeus) - AWS Auditing and Hardening tool 14. [Cloud Mapper](https://github.com/duo-labs/cloudmapper) - Analyze your AWS environments (Python) 15. [ConsoleMe](https://github.com/Netflix/consoleme) - A Central Control Plane for AWS Permissions and Access 16. [AWS Firewall Factory](https://github.com/globaldatanet/aws-firewall-factory) - Deploy, update, and stage your WAFs while managing them centrally via FMS. ## Security Practices and CTFs 1. [AWS Well Architected Security Labs](https://wellarchitectedlabs.com/security/) 2. [Flaws to learn common mistakes in AWS through challenge](http://flaws.cloud/) 3. [Flaws2 focuses on AWS security concepts through various challenge levels](http://flaws2.cloud/) 4. [CloudGoat By Rhino Security Labs](https://github.com/RhinoSecurityLabs/cloudgoat) - Vulnerable by Design AWS infrastructure setup tool 5. [OWASP ServerlessGoat](https://github.com/OWASP/Serverless-Goat) - OWASP ServerlessGoat is a deliberately insecure realistic AWS Lambda serverless application maintained by OWASP for educational purposes. 6. [OWASP WrongSecrets](https://github.com/commjoen/wrongsecrets) - OWASP WrongSecrets is a vulnerable app which shows you how to not store secrets. It covers code, Docker, Kubernetes, and AWS cloud bad practices. 7. [AWS S3 CTF Challenges with solutions](https://n0j.github.io/2017/10/02/aws-s3-ctf.html) 8. [AWS CTF with practical scenario](https://r00tz-ctf.awssecworkshops.com/) 9. [Breaking and Pwning Apps and Servers on AWS and Azure by AppSecCo](https://github.com/appsecco/breaking-and-pwning-apps-and-servers-aws-azure-training) - The training covers a multitude of scenarios taken from our vulnerability assessment, penetration testing and OSINT engagements which take the student through the journey of discovery, identification and exploitation of security weaknesses, misconfigurations and poor programming practices that can lead to complete compromise of the cloud infrastructure. 10. [AWS Workshop official](https://awsworkshop.io/) - This is not exactly security part, but would be helpful to understand AWS with this workshop examples. 11. [AWS Security Workshops](https://awssecworkshops.com/) by AWS ## AWS Security Bulletin Important Issues 1. [Container Networking Security Issue ([CVE-2020-8558])](https://nvd.nist.gov/vuln/detail/CVE-2020-8558) (This issue may allow containers running on the same host, or adjacent hosts (hosts running in the same LAN or layer 2 domain), to reach TCP and UDP services bound to localhost (127.0.0.1)) 2. [Minimum Version of TLS 1.2 Required for FIPS Endpoints by March 31, 2021](https://aws.amazon.com/security/security-bulletins/AWS-2020-001/) 3. [Unencrypted md5 plaintext hash in metadata in AWS S3 Crypto SDK for golang](https://github.com/google/security-research/security/advisories/GHSA-76wf-9vgp-pj7w) 4. [CBC padding oracle issue in AWS S3 Crypto SDK for golang](https://github.com/google/security-research/security/advisories/GHSA-f5pg-7wfw-84q9) : [CVE-2020-8911](https://nvd.nist.gov/vuln/detail/CVE-2020-8911) 5. [In-band key negotiation issue in AWS S3 Crypto SDK for golang](https://github.com/google/security-research/security/advisories/GHSA-7f33-f4f5-xwgw) : [CVE-2020-8912](https://nvd.nist.gov/vuln/detail/CVE-2020-8912) 6. [CVE-2018-15869](https://nvd.nist.gov/vuln/detail/CVE-2018-15869): An Amazon Web Services (AWS) developer who does not specify the --owners flag when describing images via AWS CLI, and therefore not properly validating source software per AWS recommended security best practices, may unintentionally load an undesired and potentially malicious Amazon Machine Image (AMI) from the uncurated public community AMI catalog. 7. [How a Security Researcher found 1000s of open databases on AWS](https://infosecwriteups.com/how-i-discovered-thousands-of-open-databases-on-aws-764729aa7f32) ## AWS Security Breaches 1. [AWS Security breaches - 2017](https://www.sumologic.com/blog/aws-security-breaches-2017/) 2. [200 million voters data leak](https://www.skyhighnetworks.com/cloud-security-blog/latest-voter-data-leak-is-a-lesson-in-aws-security/) - A lesson in AWS Security 3. [Imperva blames data breach on Stolen AWS API keys](https://www.zdnet.com/article/imperva-blames-data-breach-on-stolen-aws-api-key/) 4. [Tesla's Amazon cloud account was hacked and used to mine cryptocurrency](https://www.businessinsider.in/finance/teslas-amazon-cloud-account-was-hacked-and-used-to-mine-cryptocurrency/articleshow/63003345.cms) 5. [10 worst Amazon S3 breaches](https://businessinsights.bitdefender.com/worst-amazon-breaches) 6. [Lion Air the Latest to Get Tripped Up by Misconfigured AWS S3](https://www.darkreading.com/attacks-breaches/lion-air-the-latest-to-get-tripped-up-by-misconfigured-aws-s3-/d/d-id/1335864) 7. [Online Fashion App 21 buttons Exposes Financial Records of Top European Influencers due to S3 misconfiguration](https://www.vpnmentor.com/blog/report-21-buttons-breach/) 8. [Capital One Cloud data breach due to S3 misconfiguration](https://rhinosecuritylabs.com/aws/capital-one-cloud_breach_s3-cloudgoat/) 9. [Online Fashion App 21 buttons Exposes Financial Records of Top European Influencers](https://www.vpnmentor.com/blog/report-21-buttons-breach/) 10. [Utah COVID-19 testing service exposes 50,000 patients’ photo IDs, personal info on the web](https://www.comparitech.com/blog/information-security/utah-covid-test-center-leak/) 11. [US municipalities suffer data breach due to misconfigured Amazon S3 buckets](https://www.securitymagazine.com/articles/95704-us-municipalities-suffer-data-breach-due-to-misconfigured-amazon-s3-buckets) ## Contributors [Please refer the guidelines at contribute.md for details](Contribute.md). Thanks to the following folks who made contributions to this project. **Get your name listed here** [List of Contributors](https://github.com/jassics/awesome-aws-security/graphs/contributors)

A curated list of awesome projects and resources related to Argo (a CNCF graduated project)

[](https://github.com/akuity/awesome-argo) [](https://argoproj.github.io/community/join-slack) [](https://twitter.com/argoproj) [](https://www.linkedin.com/company/argoproj/) # Awesome Argo 🎉 [Argo is now a graduated project in CNCF!](https://www.cncf.io/announcements/2022/12/06/the-cloud-native-computing-foundation-announces-argo-has-graduated/) 🔔 Links to recordings for talks from various conferences, such as ArgoCon and KubeCon, are added as soon as they become available! A curated list of awesome projects and resources related to [Argo](https://argoproj.github.io/), a [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/) graduated project.  This list is maintained and sponsored by [Akuity](https://akuity.io/), the Enterprise Company for Argo Project. <img align="center" src="images/akuity.png" alt="akuity" width="50%" height="50%"> ## What is Argo? Argo consists of a set of open source tools for deploying and running applications and workloads on Kubernetes, including: * [Argo Workflows](https://argoproj.github.io/workflows/): Kubernetes-native workflow engine supporting DAG and step-based workflows. * [Argo CD](https://argoproj.github.io/cd/): Declarative continuous delivery with a fully-loaded UI. * [Argo Rollouts](https://argoproj.github.io/rollouts/): Advanced Kubernetes deployment strategies such as Canary and Blue-Green made easy. * [Argo Events](https://argoproj.github.io/events/): Event based dependency management for Kubernetes. In addition, [argoproj-labs](https://github.com/argoproj-labs) is a separate GitHub org for community contributions related to the Argo ecosystem. ## Table of Contents <!-- MarkdownTOC depth=4 --> - [Ecosystem Projects](#ecosystem-projects) - [Books](#books) - [Blog Posts](#blog-posts) - [Videos](#videos) - [Community](#community) - [Acknowledgement](#acknowledgement) <!-- /MarkdownTOC --> <a name="ecosystem-projects" /> ## Ecosystem Projects Selected projects from [argoproj](https://github.com/argoproj) (other than the four projects mentioned above) and [argoproj-labs](https://github.com/argoproj-labs): * [Argo CD Autopilot](https://github.com/argoproj-labs/argocd-autopilot) offers an opinionated way of installing Argo CD and managing GitOps repositories. * [Argo CD Extensions](https://github.com/argoproj-labs/argocd-extensions) enables extensions for Argo CD. * [Argo CD Image Updater](https://github.com/argoproj-labs/argocd-image-updater) is a tool to automatically update the container images of Kubernetes workloads which are managed by Argo CD. * [Argo CD Interlace](https://github.com/argoproj-labs/argocd-interlace) is a Kubernetes controller to enable software supply chain security capabilities in Argo CD. * [Argo CD Operator](https://github.com/argoproj-labs/argocd-operator) is a Kubernetes operator for managing Argo CD clusters. * [Argo CD Vault Plugin](https://github.com/argoproj-labs/argocd-vault-plugin) is an Argo CD plugin to retrieve secrets from Secret Management tools and inject them into Kubernetes resources. * [Argo Helm](https://github.com/argoproj/argo-helm) is a collection of community-maintained Helm charts for Argo projects. * [Argo Rollout Extension](https://github.com/argoproj-labs/rollout-extension) contains the Argo Rollout dashboard that can be added into the Argo CD Web UI. * [Argo Workflows Catalog](https://github.com/argoproj-labs/argo-workflows-catalog) contains free reusable templates for Argo Workflows. * [Argo Workflows Plugins](https://argoproj.github.io/argo-workflows/plugin-directory) contains reusable plugins that extend Argo Workflows with new capabilities. * [GitOps Engine](https://github.com/argoproj/gitops-engine) contains various GitOps operators that address different use-cases and provide different user experiences but all have a similar set of core features. * [Hera](https://github.com/argoproj-labs/hera-workflows) is an Argo Workflows Python SDK that aims to make workflow construction and submission easy and accessible to everyone. * [Notifications Engine](https://github.com/argoproj/notifications-engine) is a configuration-driven Golang library that provides notifications for cloud-native applications. Other open source projects that use Argo: * [active-monitor](https://github.com/keikoproj/active-monitor) is a Kubernetes controller which enables deep cluster monitoring and self-healing using Argo Workflows. * [Apache DolphinScheduler](https://github.com/apache/dolphinscheduler) is a distributed and extensible workflow scheduler platform with powerful DAG UI, dedicated to solving complex job dependencies in the data pipeline and providing various types of jobs available out of the box. * [applicationset-progressive-sync](https://github.com/Skyscanner/applicationset-progressive-sync) is a controller to allow a progressive sync of ArgoCD Applications generated by an ApplicationSet. * [argo-cd-action](https://github.com/clowdhaus/argo-cd-action) is a GitHub Action for executing Argo CD. * [argo-compare](https://github.com/shini4i/argo-compare) is a small CLI tool showing the difference in the resulting helm manifests rendered from Applications in different git branches. * [argo-watcher](https://github.com/shini4i/argo-watcher) is a small service that improves the visibility of deployments that are using Argo CD Image Updater. * [argocd-commenter](https://github.com/int128/argocd-commenter) is a Kubernetes controller to notify a change of Argo CD Application status via comments on GitHub pull requests and GitHub Deployments. * [argocd-lovely-plugin](https://github.com/crumbhole/argocd-lovely-plugin) is a plugin that allows you to composite multiple things together into a single argocd application or applicationSet. Includes allowing Helm+Kustomize, addition other manifests trivially and running additional plugins in a pipe. * [backstage-plugin-argo-cd](https://www.npmjs.com/package/@roadiehq/backstage-plugin-argo-cd) is a Argo CD plugin for Backstage, an open platform for building developer portals. * [Cello](https://github.com/cello-proj/cello) is a service for running infrastructure as code software tools including CDK, Terraform and Cloud Formation via GitOps. * [ci-github-notifiter](https://github.com/sendible-labs/ci-github-notifier) is a lightweight container to post Argo Workflow statuses back to GitHub as [Status Checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). * [Couler](https://github.com/couler-proj/couler) provides a unified interface for constructing and managing workflows on different workflow engines. * [Devtron](https://github.com/devtron-labs/devtron) is a Web-Based CI/CD Platform for Kubernetes, powered by Argo. * [Flowify](https://equinor.github.io/flowify-documentation/) Collaborative no code UI for Argo Workflows. * [k8s-bootstrapper](https://github.com/hivenetes/k8s-bootstrapper) is a framework to set up production ready Kubernetes clusters using Terraform and Argo CD. * [Kedro](https://github.com/quantumblacklabs/kedro) is an open-source Python framework for creating reproducible, maintainable and modular data science code. * [Kubeflow Katib](https://github.com/kubeflow/katib) is a Kubernetes-native project for automated machine learning (AutoML). * [Kubeflow Pipelines](https://github.com/kubeflow/pipelines) is dedicated to making deployments of machine learning workflows on Kubernetes simple, portable, and scalable with Kubeflow. * [Metaflow](https://github.com/Netflix/metaflow) is a Python library for building and managing real-life data science projects. * [Onepanel](https://github.com/onepanelio/onepanel) is the open source, end-to-end computer vision platform. * [Orchest](https://github.com/orchest/orchest) is a tool for building data pipelines/workflows. It supports Jupyter notebooks and scripts in multiple languages and provides a user friendly UI/browser based editor. * [Orkestra](https://github.com/Azure/orkestra) is a cloud-native release orchestration and lifecycle management (LCM) platform for the fine-grained orchestration of inter-dependent Helm charts and their dependencies. * [Ploomber](https://github.com/ploomber/ploomber) helps overcome the challenges of working with Jupyter notebooks and allows teams to develop collaborative, production-ready pipelines using JupyterLab or any text editor. * [provider-argocd](https://github.com/crossplane-contrib/provider-argocd) is the Crossplane infrastructure provider for Argo CD. * [Reloader](https://github.com/stakater/Reloader) is a Kubernetes controller to watch changes in ConfigMap and Secrets and do rolling upgrades on associated Deployments/StatefulSets/Daemonsets and Argo Rollouts. * [Seldon](https://github.com/SeldonIO/seldon-core) is an MLOps framework to package, deploy, monitor and manage thousands of production machine learning models. * [SQLFlow](https://github.com/sql-machine-learning/sqlflow) extends SQL to support AI and compiles the SQL program to a workflow that runs on Kubernetes. * [terraform-provider-argocd](https://github.com/oboukili/terraform-provider-argocd) is the Terraform provider for Argo CD. <a name="books" /> ## Books * [Distributed Machine Learning Patterns](https://github.com/terrytangyuan/distributed-ml-patterns) teaches you how to take machine learning models from your personal laptop to large distributed clusters. You’ll explore key concepts and patterns behind successful distributed machine learning systems, and learn technologies like TensorFlow, Kubernetes, Kubeflow, and Argo Workflows with real-world scenarios and hands-on projects. * [GitOps and Kubernetes](https://www.manning.com/books/gitops-and-kubernetes) teaches you how to use Git and the GitOps methodology to manage a Kubernetes cluster. The book interleaves theory with practice, presenting core Ops concepts alongside easy-to-implement techniques so you can put GitOps into action. Learn to develop pipelines that trace changes, roll back mistakes, and audit container deployment. <a name="blogs" /> ## Blog Posts Please check out the [official Argo Project blog](https://blog.argoproj.io/). Additional links: * [All About ArgoCD, a Beginner’s Guide](https://dev.to/abhinavd26/all-about-argocd-a-beginners-guide-33c9) * [Applied GitOps with Argo CD](https://thenewstack.io/applied-gitops-with-argocd/) * [Architecting Workflows For Reliability](https://blog.argoproj.io/architecting-workflows-for-reliability-d33bd720c6cc) * [Argo 101 - What is Argo?](https://akuity.io/blog/argo-101-what-is-argo/) * [Argo Ansible Role: Provisioning Argo Workflows on OpenShift](https://medium.com/@marekermk/provisioning-argo-on-openshift-with-ansible-and-kustomize-340a1fda8b50) * [Argo CD Best Practices](https://codefresh.io/argo-platform/argo-cd-best-practices/) * [Argo CD Build Environment Examples](https://akuity.io/blog/argo-cd-build-environment-examples/) * [ArgoCD Best Practices You Should Know](https://datree.io/resources/argocd-best-practices-you-should-know) * [ArgoCon 2021 Akuity Team Recap](https://akuity.io/blog/argocon-2021-akuity-team-recap/) * [Argo Integration Review](http://dev.matt.hillsdon.net/2018/03/24/argo-integration-review.html) * [Argo Rollouts and Service Mesh: Automate and Control Canary Releases](https://blog.flomesh.io/argo-rollouts-and-service-mesh-automate-and-control-canary-releases-c71e5403eb2) * [Argo Security Automation with OSS-Fuzz](https://medium.com/argo-project/argo-security-automation-with-oss-fuzz-da38c1f86452) * [Argo Workflow As the Choice To Run Data Pipelines in Casavo](https://medium.com/casavo/argo-workflow-in-casavo-722b40362e4c) * [Automate Canary Analysis on Kubernetes with Argo](https://blog.px.dev/argo-rollouts/) * [Building a Successful Open Source Community as an End User Company](https://medium.com/intuit-engineering/building-a-successful-open-source-community-as-an-end-user-company-89a70445134) * [Best Practices for Multi-tenancy in Argo CD](https://blog.argoproj.io/best-practices-for-multi-tenancy-in-argo-cd-273e25a047b0) * [CI/CD with Argo on Kubernetes](https://medium.com/@bouwe.ceunen/ci-cd-with-argo-on-kubernetes-28c1a99616a9) * [Cloud Native CI/CD with Tekton and ArgoCD on AWS](https://aws.amazon.com/blogs/containers/cloud-native-ci-cd-with-tekton-and-argocd-on-aws/) * [Continuous Delivery Using a Carvel ytt Argo CD Plugin](https://carvel.dev/blog/argocd-carvel-plugin/) * [Decentralized GitOps Over Environments](https://blogs.sap.com/2021/05/06/decentralized-gitops-over-environments/) * [Deploy Argo CD with Ingress and TLS in Three Steps: No YAML Yak Shaving Required](https://itnext.io/deploy-argo-cd-with-ingress-and-tls-in-three-steps-no-yaml-yak-shaving-required-bc536d401491) * [Deploying Argo CD and Sealed Secrets with Helm](https://faun.pub/deploying-argo-cd-and-sealed-secrets-with-helm-8de12f53051b) * [Designing A Complete CI/CD Pipeline CI/CD Pipeline Using Argo Events, Workflows, and CD](https://www.slideshare.net/JulianMazzitelli/designing-a-complete-ci-cd-pipeline-using-argo-events-workflow-and-cd-products-228452500) * [Embracing Cloud-Native for Apache DolphinScheduler with Kubernetes: a Case Study](https://www.infoq.com/articles/cloud-native-apache-dolphinscheduler/) * [Exploring Messaging Systems with Argo Events](https://dfarr.medium.com/exploring-messaging-systems-with-argo-events-a259f663bd30) * [Four Lessons That Took Argo From First Commit to GitOps Darling](https://www.cncf.io/blog/2022/09/21/four-lessons-that-took-argo-from-first-commit-to-gitops-darling) * [From Argo to Mentoring and Everything In Between](https://www.cncf.io/humans-of-cloud-native/yuan-tang-from-argo-to-mentoring-and-everything-in-between/) * [Getting Started with ArgoCD for GitOps Kubernetes Deployments](https://medium.com/@outlier.developer/getting-started-with-argocd-for-gitops-kubernetes-deployments-fafc2ad2af0) * [GitOps Deployment and Kubernetes - using Argo CD](https://medium.com/riskified-technology/gitops-deployment-and-kubernetes-f1ab289efa4b) * [GitOps for Kubeflow using Argo CD](https://v0-6.kubeflow.org/docs/use-cases/gitops-for-kubeflow/) * [GitOps - Getting Started with ArgoCD](https://vzilla.co.uk/vzilla-blog/gitops-getting-started-with-argocd) * [GitOps – Including Backup in Your Continous Deployments](https://vzilla.co.uk/vzilla-blog/gitops-including-backup-in-your-continuous-deployments) * [GitOps Model for Provisioning and Bootstrapping Amazon EKS Clusters Using Crossplane and Argo CD](https://aws.amazon.com/blogs/containers/gitops-model-for-provisioning-and-bootstrapping-amazon-eks-clusters-using-crossplane-and-argo-cd/) * [GitOps Toolsets on Kubernetes with CircleCI and Argo CD](https://www.digitalocean.com/community/tutorials/webinar-series-gitops-tool-sets-on-kubernetes-with-circleci-and-argo-cd) * [GitOps with Argo CD](https://www.giantswarm.io/blog/gitops-with-argocd-giant-swarm) * [Gradual Code Releases Using an In-House Kubernetes Canary Controller on Top of Argo Rollouts](https://doordash.engineering/2021/04/14/gradual-code-releases-using-an-in-house-kubernetes-canary-controller/) * [Hera - the Missing Argo Workflows Python SDK](https://www.dynotx.com/hera-the-missing-argo-workflows-python-sdk/) * [How GitOps and Operators Mark the Rise of Infrastructure-As-Software](https://paytmlabs.com/blog/2021/10/how-to-improve-operational-work-with-operators-and-gitops/) * [How Many Do You Need? - Argo CD Architectures Explained](https://akuity.io/blog/argo-cd-architectures-explained/) * [How to Automate Verification of Deployments with Argo Rollouts and Elastic Observability](https://www.elastic.co/blog/automate-verification-of-deployments-with-argo-rollouts-and-elastic-observability) * [How to Create a Theme for your Argo CD With Minimal CSS](https://akuity.io/blog/how-to-create-a-theme-for-your-argocd-with-minimal-css/) * [How to Deploy With ArgoCD When Helm Values and Chart Are in Different Repositories](https://mixi-developers.mixi.co.jp/argocd-with-helm-fee954d1003c) * [How to Manage Kubernetes Secrets with GitOps?](https://akuity.io/blog/how-to-manage-kubernetes-secrets-gitops/) * [How to Update your OpenFaaS Functions Automatically with the Argo CD Image Updater](https://www.openfaas.com/blog/argocd-image-updater-for-functions/) * [Human-Centric Data Science on Kubernetes with Metaflow](https://blog.argoproj.io/human-centric-data-science-on-kubernetes-with-metaflow-7f60aad34cba) * [Humans of Cloud Native: Yuan Tang – From Argo to Mentoring and Everything In Between](https://www.cncf.io/humans-of-cloud-native/yuan-tang-from-argo-to-mentoring-and-everything-in-between/) * [Jenkins X 3 and Argo CD](https://jenkins-x.io/blog/2021/06/28/argo/) * [KubeCon EU 2022 - Akuity Team Recap](https://akuity.io/blog/kubeconeu-2022-akuity-team-recap) * [Kubernetes Cluster Vending Machine With vcluster](https://blog.ediri.io/kubernetes-cluster-vending-machine-with-vcluster) * [Kubernetes Security through GitOps Best Practices: ArgoCD and Starboard](https://anaisurl.com/gitops-argocd-starboard/) * [Machine Learning Hyperparameter Optimization with Argo](https://canvatechblog.com/machine-learning-hyperparameter-optimization-with-argo-a60d70b1fc8c) * [Making Complex R Applications into Production using Argo Workflows](https://blog.argoproj.io/making-complex-r-application-into-production-using-argo-workflows-648ce5d190b5) * [Manage Namespaces on Multitenant Clusters with ArgoCD, Kustomize and Helm](https://developers.redhat.com/articles/2022/04/13/manage-namespaces-multitenant-clusters-argo-cd-kustomize-and-helm) * [Measuring Argo Workflow Costs with Kubecost](https://blog.kubecost.com/blog/measuring-argo-workflows-with-kubecost/) * [Minimize Failed Deployments with Argo Rollouts and Smoke Tests](https://codefresh.io/continuous-deployment/minimize-failed-deployments-argo-rollouts-smoke-tests/) * [Multi-cluster Management for Kubernetes with Cluster API and Argo CD](https://aws.amazon.com/blogs/containers/multi-cluster-management-for-kubernetes-with-cluster-api-and-argo-cd/) * [Observations and Thoughts after Building 3 Kubernetes Platforms in Financial Services Industry](https://itnext.io/observations-and-thoughts-after-building-3-kubernetes-platforms-in-financial-services-industry-7d6c60206717) * [Open Source Model Management Roundup: Polyaxon, Argo, and Seldon](https://www.anaconda.com/blog/developer-blog/open-source-model-management-roundup-polyaxon-argo-and-seldon/) * [Producing 200 OpenStreetMap Extracts in 35 Minutes Using a Scalable Data Workflow](https://www.interline.io/blog/scaling-openstreetmap-data-workflows/) * [Progressive Delivery with Argo Rollouts: Canary Deployment](https://www.infracloud.io/blogs/progressive-delivery-argo-rollouts-canary-deployment/) * [Recover Automatically from Failed Deployments with Argo Rollouts and Prometheus Metrics](https://codefresh.io/continuous-deployment/recover-automatically-from-failed-deployments/) * [Running Argo Workflows Across Multiple Kubernetes Clusters](https://admiralty.io/blog/running-argo-workflows-across-multiple-kubernetes-clusters/) * [Scheduling Data Science Workflows in Azure with Argo and Metaflow](https://softlandia.fi/en/blog/scheduling-data-science-workflows-in-azure-with-argo-and-metaflow) * [Sealed Secrets on Kubernetes with ArgoCD and Terraform](https://piotrminkowski.com/2022/12/14/sealed-secrets-on-kubernetes-with-argocd-and-terraform/) * [Set up Microservices on Kubernetes — Automating Kubernetes with ArgoCD](https://medium.com/@hmquan08011996/setup-microservices-on-kubernetes-automating-kubernetes-with-argocd-cb94622dac5b) * [Setting up Argo CD With Helm](https://www.arthurkoziel.com/setting-up-argocd-with-helm/) * [Simplify and Automate Deployments Using GitOps with IBM Multicloud Manager 3.1.2](https://www.ibm.com/cloud/blog/simplify-and-automate-deployments-using-gitops-with-ibm-multicloud-manager-3-1-2) * [Solving Configuration Drift Using GitOps with Argo CD](https://www.cncf.io/blog/2020/12/17/solving-configuration-drift-using-gitops-with-argo-cd/) * [Stay Up to Date With Argo CD and Renovate](https://mjpitz.com/blog/2020/12/03/renovate-your-gitops/) * Terraform Automation With Argo on Kubernetes ([Part1](https://medium.com/insideboard/terraform-automation-with-argo-on-kubernetes-part1-51b3914028d6) & [Part2](https://medium.com/insideboard/terraform-automation-with-argo-on-kubernetes-part2-consul-vault-92a020432cd0)) * [Unveil the Secret Ingredients of Continuous Delivery at Enterprise Scale with Argo CD](https://akuity.io/blog/unveil-the-secret-ingredients-of-continuous-delivery-at-enterprise-scale-with-argocd-kubecon-china-2021/) * [Using Argo to Train Predictive Models](https://flightaware.engineering/using-argo-to-train-predictive-models/) * [Using Argo CD with vclusters](https://medium.com/@helfand.4/using-argo-cd-with-vclusters-ff8b9c16ac9e) * [Preventing Tag Mutation With kbld And Argo CD](https://blog.argoproj.io/preventing-tag-mutation-with-kbld-and-argo-cd-19cecd65963) * [Argo Workflows Guide in Chinese](https://github.com/LinuxSuRen/argo-workflows-guide) * [How To Create ArgoCD Applications Automatically Using ApplicationSet? “Automation of GitOps”](https://amralaayassen.medium.com/how-to-create-argocd-applications-automatically-using-applicationset-automation-of-the-gitops-59455eaf4f72) * [Why We’re Switching Off Airflow — Sort Of](https://medium.com/flyr-labs-blog/why-were-switching-off-airflow-sort-of-780c4f58a660) * [Picking A Kubernetes Orchestrator: Airflow, Argo, and Prefect](https://medium.com/arthur-engineering/picking-a-kubernetes-orchestrator-airflow-argo-and-prefect-83539ecc69b) Blogposts that provide comparisons: * ArgoCD * vs. Flux: [[0]](https://www.sgmoratilla.com/2021-10-28-flux-vs-argocd/), [[1]](https://rajputvaibhav.medium.com/argo-cd-vs-flux-cd-right-gitops-tool-for-your-kubernetes-cluster-c71cff489d26), [[2]](https://thenewstack.io/gitops-on-kubernetes-deciding-between-argo-cd-and-flux/) * [vs. Spinnaker](https://tech.trell.co/choosing-a-continous-delivery-tool-spinnaker-vs-argocd-9adcc65a4fde) * [vs. Spinnaker, Jenkins X, and Tekton](https://www.inovex.de/blog/spinnaker-vs-argo-cd-vs-tekton-vs-jenkins-x/) * Argo Workflows * [vs. Airflow and Prefect](https://medium.com/arthur-engineering/picking-a-kubernetes-orchestrator-airflow-argo-and-prefect-83539ecc69b) * [vs. Airflow](https://medium.com/flyr-labs-blog/why-were-switching-off-airflow-sort-of-780c4f58a660) <a name="videos" /> ## Videos Please check out the [official Argo Project YouTube channel](https://www.youtube.com/channel/UCOvYmppcbOPm1viN6ust3lA). 🔥 KubeCon, GitOpsCon, AI Days North America 2022: * [Building a Batch Processing Platform with Argo](https://www.youtube.com/watch?v=JQr16laspSs) * [Building Data Science Platform with Argo Workflows](https://www.youtube.com/watch?v=rLPuTL60T4c) * [How Adobe Planned For Scale With Argo CD, Cluster API, And VCluster](https://youtu.be/p8BluR5WT5w) * [How Salesforce Is Moving From Spinnaker To Argo Workflows For Provisioning Add-Ons](https://youtu.be/THJFffu-iK0) * [How the Argo Project Transitioned From Security Aware To Security First](https://youtu.be/EilOEF4gs0c) * [How To Build Production Grade DevOps Platform Using Argo](https://youtu.be/ohPKiGhhHoI) * [How to Keep a Secret in GitOps, Without Keeping It in Git](https://youtu.be/PTdwW-wG2uA) * [Human-Friendly, Production-Ready Data Science Stack With Argo Workflows & Metaflow](https://www.youtube.com/watch?v=bLg5oHIjOpI) * [Hundreds of Clusters Sitting in a Tree with Argo CD](https://youtu.be/casLvZWlIDw) * [Keynote: Welcome + Opening Remarks (Maintainers Fireside Chat)](https://youtu.be/DWFzChxXXrU?t=469) * [Like Peas And Carrots: Argo CD And Crossplane For Infrastructure Management](https://youtu.be/QO_-PG9snvI) * [Multi-Tenancy For Argo Workflows And Argo CD At Adobe](https://youtu.be/aTgINAFV3T8) * [Observability In ArgoCD/Rollouts Using Streaming ML For Reducing MTTR](https://youtu.be/-YGS1hmd60E) * [Preview Environments with ArgoCD](https://youtu.be/7ahiwZuiCBM) 🔥 ArgoCon 2022 talks: * [Argo Roadmap Updates For CD, Rollouts, Workflows, and Events](https://youtu.be/b07iZCR2ktQ) * [From Code to Docs to Marketing: How to Contribute](https://youtu.be/kQZhdJn1Phw) * [Scaling Argo for the Enterprise](https://youtu.be/kIcuMCargiE) * [Challenging the Status Quo with Kubernetes and Argo](https://youtu.be/bRZmR1NrjFg) * [Smarter Progressive Delivery at Intuit](https://youtu.be/2P8_LWL3-MQ) * [Argo Rollouts at Scale: How We Brought Automated Rollback to 2100+ Micro-services at Monzo](https://youtu.be/Vl5siKnYymY) * [Large Scale Batch Processing with Argo Workflows and Events](https://youtu.be/J5XDDxcgP8E) * [Leveraging Argo Workflows and Argo Events for Cloud Agnostic Enterprise Machine Learning Deployments and Model Management](https://youtu.be/_Jbaecr_ZvI) * [Unleash ArgoCD Observability Superpowers](https://youtu.be/zNGg87RME7I) * [Secure by Default with GitOps - A Guide to OPA with Argo CD](https://youtu.be/EXu0rx0mtrM) * [Managing Thousands of Automatic Machine Learning Experiments with Argo and Katib](https://youtu.be/0jBNXZjQ01I) * [Using Argo Project to Help Elastic infoSec Team in Securing Elastic](https://youtu.be/B8a3ySHvfF0) * [From PR to Artifactory in 60 Secs! Adobe Service Runtime Java Libraries Release Pipelines Using Argo Workflows](https://youtu.be/JD3dRElwXMM) * [Argo CD Observability with AIOps - Detect Incident Fast](https://youtu.be/_pRJ0_yzxNs) * [Attacking Argo CD with Argo CD (and then Defending)](https://youtu.be/bRNMI29F2fI) * [Securing GitOps Supply Chain with Sigstore and Kyverno](https://youtu.be/gBJ169_il6k) * [Harder, Better, Faster, Stronger Pipelines at Adobe](https://youtu.be/AD3isYT6M1c) * [A Distributed Job Scheduler Story: CronWorkflows integration with RBAC infrastructure for Over 100+ Teams](https://youtu.be/LXM3W4OiTpY) * [Automating Map-building Pipelines for Safe Autonomous Driving with Argo Workflows at TuSimple](https://youtu.be/8aJGZEtMB6A) * [Best Practices on Organizing GitOps Repositories](https://youtu.be/CvMevMHExHk) * [Don’t Let a Bot In! Protect Fortune 500 Companies & Users](https://youtu.be/zZtnHkd3IS4) * [Using Argo Workflows to Curate Chaos Engineering with LitmusChaos](https://youtu.be/fsGIbfd-O64) * [Creating A Scalable Foundation for Kubernetes Multi-Tenancy](https://youtu.be/MSXZNMtcQP4) * [CI/CD for Data Pipelines with Argo Workflows](https://youtu.be/729GwVMgeXw) * [Running Cloud-native Spark Jobs with Argo Workflows](https://youtu.be/X3xMtFs5XWo) * [Open Source Canary Deployments with Application Metric Analysis](https://youtu.be/OHU7dGcRZvg) * [The Future of GitOps](https://youtu.be/r0yVUkTyWwI) * [Adobe’s Internal Developer Platform Journey and Lessons](https://youtu.be/NJF6bBU6Duw) KubeCon Europe 2022 talks: * [Applied GitOps with Argo CD Autopilot Using Multiple Clusters with an ApplicationSet](https://youtu.be/r3k2qI2NDsA) * [Argo’s Vibrant Ecosystem and Community](https://youtu.be/9tYkxlhXdw4) * [Automated Progressive Delivery Using GitOps and Service Mesh](https://youtu.be/5Ko-CnP2qhA) * [Building AutoML Pipelines With Argo Workflows and Katib](https://youtu.be/d8o7fEd8l2g) * [Exploring HashiCorp Vault and ArgoCD - the GitOps Way](https://youtu.be/2camnnjyviw) * [GitOpsify Everything: When Crossplane Meets Argo CD](https://youtu.be/9odjdVqJkws) * [How a Couple of Characters (and GitOps) Brought Down Our Site](https://youtu.be/FiEm2zOuHsg) * [Intuitive Progressive Delivery Across Microservices in a Dependency Graph Using Argo Rollouts](https://youtu.be/02y5q4Cc2Fs) * [Implementing Preview Environments with GitOps in Kubernetes](https://youtu.be/QNAiIJRIVWA) * [Infra-like-apps - GitOpsifying Cloud Natively Managed Infrastructure with Crossplane and Argo CD](https://youtu.be/epoTCI4pqdE) * [TikTok’s Story: How To Manage a Thousand Applications on Edge With Argo CD](https://youtu.be/Ftz5_lIepNA) Other talks: * [A Briefer History of Argo Project from the Founding Engineers](https://youtu.be/FQ9uB8FuX_I) * [A Multi-Cluster, Multi-Cloud Infrastructure with GitOps at CERN](https://youtu.be/h6xDWc6fXao) * [Argo-Based Service Delivery for Multi-Tenant, Multi Region Clusters at Adobe](https://youtu.be/Ahps2IwhREw) * [Argo: The Present, Past, and Future](https://youtu.be/76iUpAWakIM) * [Argo and Tekton: Pushing the Boundaries of the Possible on Kubernetes](https://youtu.be/iPRw_n_JV4o) * [Argo CD - GitOps Continuous Delivery for Kubernetes](https://www.youtube.com/watch?v=aWDIQMbp1cc&feature=youtu.be&t=1m4s) * [Argo CD: Applying GitOps Principles To Manage Production Environment In Kubernetes](https://youtu.be/vpWQeoaiRM4) * [Argo CD and Stateful Applications - Tips and Tricks](https://youtu.be/_-oVaO4SxLk) * [Argo CD Production Best Practices](https://youtu.be/ESQLqjbM8h0) * [Argo CD Walkthrough – Learn Argo CD in 18 Minutes](https://youtu.be/2B3qcyCcBXs) * [Argo CD in the Cloud: DevOps and Docker Live Show](https://youtu.be/DxJawE0uZgw?t=366) * [Argo Events - Event-Based Dependency Manager for Kubernetes](https://youtu.be/sUPkGChvD54) * [Argo Events Deep-dive](https://youtu.be/U4tCYcCK20w) * [Argo Graduation Q&A - Open Meeting with the Creators of Argo](https://youtu.be/kjB_7MaDzcw) * [Argo Rollouts - Canary Deployments Made Easy In Kubernetes](https://youtu.be/84Ky0aPbHvY) * [Argo Workflows and Pipelines - CI/CD, Machine Learning, and Other Kubernetes Workflows](https://youtu.be/UMaivwrAyTA) * [Automating Research Workflows at BlackRock](https://www.youtube.com/watch?v=ZK510prml8o) * [Automation of Everything - How To Combine Argo Events, Workflows & Pipelines, CD, and Rollouts](https://youtu.be/XNXJtxkUKeY) * [Bridging into Python Ecosystem with Cloud-Native Distributed Machine Learning Pipelines](https://github.com/terrytangyuan/public-talks/tree/main/talks/bridging-into-python-ecosystem-with-cloud-native-distributed-machine-learning-pipelines-argocon-2021) * [Building a Successful Open Source Community as an End-user Company](https://youtu.be/BrZMZJc3Vh4) * [Building Medical Grade AI with Argo Workflows](https://youtu.be/4VPSktuM5Ow) * [CI/CD for Machine Learning at MLB using Argo Workflows](https://youtu.be/fccWoYlwZKc?t=184) * [CI/CD in Light Speed with K8s and Argo CD](https://www.youtube.com/watch?v=OdzH82VpMwI&feature=youtu.be) * [Cloud Native AutoML with Argo Workflows and Katib](https://youtu.be/KjHqmS4gIxM?t=181) * [Cloud-native CI/CD via ArgoCD & Workflows in Multi-region & Muti-cell Environment](https://youtu.be/IPiNWwPgsjw) * [Cloud Native Live: Argo's Vibrant Ecosystem and Community + Maintainer Q&A](https://youtu.be/h6uecnyyGKw) * [Combining Argo CD (GitOps), Crossplane (Control Plane), and KubeVela (OAM)](https://youtu.be/eEcgn_gU3SM) * [Couchbase - How To Run a Database Cluster in Kubernetes Using Argo CD](https://youtu.be/nkPoPaVzExY) * [Deploying Cluster Addons at Scale using ApplicationSets](https://youtu.be/Yj60Co4UxXk) * [Deployments on the Edge using Argo CD & Workflows and K3s](https://youtu.be/9BSXBgaOmr4) * [Distributed Load Testing Using Argo Workflows](https://youtu.be/9zg2EH2pRw0?t=1221) * [Dynamic, Event-Driven Machine Learning Pipelines with Argo Workflows](https://youtu.be/ei4r0a7eAV0) * [Easy Notifications for Kubernetes](https://youtu.be/gZ0MfSoHbY0) * [Environments Based on Pull Requests (PRs): Using Argo CD To Apply GitOps Principles on Previews](https://youtu.be/cpAaI8p4R60) * [Extending GitOps to Manage K8s (so you don’t have to)!](https://youtu.be/bTHkDdXRx24) * [Getting Started with ArgoCD for GitOps Deployments](https://youtu.be/AvLuplh1skA) * [GitOps Cloud Resource Management](https://youtu.be/TJQHB8XVW44) * [GitOps for Kubernetes with ArgoCD, Crossplane, Kyverno and Paralus](https://www.youtube.com/live/JBG3B5WiYcA?feature=share) * [GitOps Guide to the Galaxy: Argo Workflows](https://www.youtube.com/watch?v=2lI41q8Z7ko) * [GitOps with Argo CD and an Argo Rollouts Canary Release](https://www.youtube.com/watch?v=35Qimb_AZ8U) * [GitOps Without Pipelines With ArgoCD Image Updater](https://youtu.be/avPUQin9kzU) * [How Intuit Does Canary and Blue Green Deployments](https://www.youtube.com/watch?v=yeVkTTO9nOA) * [How Scalable is Argo-Rollouts: A Cloud Operator’s Perspective](https://youtu.be/rCEhxJ2NSTI) * [How to Apply GitOps to Everything - Combining Argo CD and Crossplane](https://youtu.be/yrj4lmScKHQ) * [Integrating Backup into Your GitOps CI/CD Pipeline](https://youtu.be/2mjlmjJ4NjQ) * [Intro to GitOps, Argo projects and Continuous delivery with Kubernetes](https://youtu.be/Ygmf3oauToE) * [Introducing Couler: Unified Interface for Constructing and Managing Workflows](https://github.com/terrytangyuan/public-talks/tree/main/talks/introducing-couler-unified-interface-for-constructing-and-managing-workflows-argo-workflows-community-meeting) * [Introduction to Argo CD: Kubernetes DevOps CI/CD](https://www.youtube.com/watch?v=2WSJF7d8dUg&feature=youtu.be) * [Journey of the Argonauts](https://youtu.be/boqZFQRLc9s) * [K8s Cluster Vending Machine With vCluster](https://youtu.be/GkaqN8urStg) * [Kubernetes Blue-Green Deployments with Argo Rollouts](https://www.youtube.com/watch?v=krDxDz4V4Tg) * [Kubernetes Canary Deployments with Argo Rollouts](https://www.youtube.com/watch?v=fviYWA2mcF8) * [Kubernetes Security through GitOps Best Practices: ArgoCD and Starboard](https://youtu.be/YvMY8to9aHI) * [Leveling Up Your CD: Unlocking Progressive Delivery on Kubernetes](https://www.youtube.com/watch?v=Nv0PPwbIEkY) * [Level Unlocked: GitOps to the Edge and Infrastructure Provisioning](https://youtu.be/4zDm23kA8oE) * [Litmus 2 - Chaos Engineering Meets Argo Workflows](https://youtu.be/B8DfYnDh2F4) * [Machine Learning as Code: GitOps for ML with Kubeflow and ArgoCD](https://www.youtube.com/watch?v=VXrGp5er1ZE&t=0s&index=135&list=PLj6h78yzYM2PZf9eA7bhWnIh_mK1vyOfU) * [Machine Learning with Argo and Ploomber](https://youtu.be/FnpXyg-5W_c?t=172) * [Maintainer Update on Argo CD and Rollouts](https://youtu.be/wn6OOLoHvQg) * [Maintainer Update on Argo Workflows and Events](https://youtu.be/FUekn40l9-A) * [Making Complex R Forecast Applications Into Production Using Argo Workflows](https://www.youtube.com/watch?v=fPjztsUXHcg) * [Manage More Clusters with Less Hassle, with Argo CD Application Sets](https://youtu.be/GcvHKc2IHi8) * [Metaflow Integration with Argo Workflows](https://youtu.be/EagFq5QtcpI?t=859) * [MLOps at Tripadvisor: ML Models CI/CD Automation with Argo](https://youtu.be/BochC4GKxbo?t=906) * [Multi-Stage Delivery with Keptn and Argo Rollouts](https://www.youtube.com/watch?v=w-E8FzTbN3g&t=1s) * [Processing Petabytes in Python with Argo Workflows & Dask](https://youtu.be/f5lPS9WKy_8) * [Robocat Meets Octopus and Octocat: Interoperability in CI/CD](https://youtu.be/Yq5lqr6n0E8) * [Scaling Kubernetes across BlackRock’s Aladdin Platform](https://youtu.be/Hoo9pngi5Q0) * [Scaling Software Delivery on Argo](https://youtu.be/hS_y4SxiPME) * [Shh, It’s a Secret: Managing Your Secrets in a GitOps Way](https://youtu.be/7L6nSuKbC2c) * [Supercharge Your Dev Experience [DX] with ArgoCD, Crossplane, & Shipa](https://youtu.be/-p0sn_X2CXQ) * [TGI Kubernetes with Joe Beda: Argo Workflow System](https://www.youtube.com/watch?v=M_rxPPLG8pU&start=859) * [TGI Kubernetes with Joe Beda: CloudEvents and Argo Events](https://www.youtube.com/watch?v=LQbBgQnUs_k&list=PL7bmigfV0EqQzxcNpmcdTJ9eFRPBe-iZa&index=2&t=0s) * [The Argo Ecosystem: Tailoring Your Installation Through Community Add-ons](https://youtu.be/EPtiDNXpS78) * [The Future of Continuous Delivery](https://youtu.be/dl1vqNpT_DE) * [The Journey from DevOps to GitOps](https://youtu.be/2kokbYtslbw) * [Towards Cloud-Native Distributed Machine Learning Pipelines at Scale](https://github.com/terrytangyuan/public-talks/tree/main/talks/towards-cloud-native-distributed-machine-learning-pipelines-at-scale-pydata-global-2021) * [Tutorial: Everything You Need To Become A GitOps Ninja](https://www.youtube.com/watch?v=r50tRQjisxw) * [Unveil The Secret Ingredients for Argo CD in the Enterprise-Scale](https://github.com/terrytangyuan/public-talks/tree/main/talks/unveil-the-secret-ingredients-for-argo-cd-at-enterprise-scale-kubecon-china-2021) * [Using Argo CD with vclusters](https://www.youtube.com/watch?v=M3ycfeocvNo) * [Using Argo CD & Datree for Stable Kubernetes CI/CD Deployments](https://youtu.be/17894DTru2Y) * [Preventing Tag Mutation With kbld And Argo CD](https://www.youtube.com/watch?v=KkgHYdVfXwY) <a name="community" /> ## Community * [Argo Community Calendar](https://calendar.google.com/calendar/[email protected]) ([ICS File](https://calendar.google.com/calendar/ical/argoproj%40gmail.com/public/basic.ics)) * [Argo Project GitHub Organization](https://github.com/argoproj) ([Maintainers](https://github.com/argoproj/argoproj/blob/master/MAINTAINERS.md) and [Community Governance](https://github.com/argoproj/argoproj/blob/master/community/GOVERNANCE.md)) * ArgoCon ([2022](https://events.linuxfoundation.org/argocon/) and [2021](https://argoproj.github.io/argocon21/)) * Argo Project User Survey Results ([2022](https://blog.argoproj.io/cncf-argo-project-2022-user-survey-results-f9caf46df7fd), [2021](https://github.com/argoproj/argoproj/blob/f4daa47706c73302faba1608cbc312bbafa0abfc/community/user_surveys/Argo%20CD%20and%20Rollouts%20User%20Survey%202021.pdf), and [2020](https://github.com/argoproj/argoproj/blob/f4daa47706c73302faba1608cbc312bbafa0abfc/community/user_surveys/ArgoWorkflows2020SurveySummary.pdf)) * [Peer Appreciation Program for Argo](https://akuity.io/argo-appreciation/) - The community can nominate individuals who they see as going above and beyond when it comes to contributing to and/or promoting the Argo Project. Social media accounts: * [LinkedIn](https://www.linkedin.com/company/argoproj/) * [Slack](https://argoproj.github.io/community/join-slack) * [Twitter](https://twitter.com/argoproj) * [Reddit](https://www.reddit.com/r/argoproj/) <a name="acknowledgement" /> ## Acknowledgement Some of the blogposts and videos are selected from [Argo's community blogs and presentations](https://github.com/argoproj/argoproj#community-blogs-and-presentations). Thanks to the contributors who've submitted pull requests to add the original references to the following locations: * [Argo Workflows](https://github.com/argoproj/argo-workflows/blob/master/README.md#community-blogs-and-presentations) * [Argo CD](https://github.com/argoproj/argo-cd/blob/master/README.md#blogs-and-presentations) * [Argo Events](https://github.com/argoproj/argo-events/blob/master/README.md#blogs-and-presentations) * [Argo Rollouts](https://github.com/argoproj/argo-rollouts/blob/master/README.md#community-blogs-and-presentations) **[⬆ back to top](#)**

Awesome list of progressive web apps! (PR welcomed ;))

# awesome-pwa [](https://github.com/sindresorhus/awesome)  > Useful resources for creating Progressive Web Apps *Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing.* ## What is a Progressive Web App > A Progressive Web App uses modern web capabilities to deliver an app-like user experience. They evolve from pages in browser tabs to immersive, top-level apps, leveraging the web's low friction. _Source:_ [Google Developers - Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/) ## Table of contents * [App Directories](#app-directories) * [Apps](#apps) * [Tutorials](#tutorials) * [Articles](#articles) * [Videos](#videos) * [Tools](#tools) * [Kits](#kits) * [Courses](#courses) * [Conferences](#conferences) ## App Directories * [appsco.pe](https://appsco.pe) * [0data.app](https://0data.app) * [pwalist.app](https://www.pwalist.app/) ## Apps * [2brew](https://2brew.github.io/): PWA timer for coffee brewing * [2fA](https://2fa.crossphoton.tech): Extended 2FA * [abc.xyz](https://abc.xyz): Alphabet website * [Air Horner](https://airhorner.com/): Air horn sound. * [AlarmDJ](https://alarmdj.com): Online alarm clock that plays MP3 files or YouTube videos. * [Aliexpress](https://m.aliexpress.com/?tracelog=wwwhome2mobilesitehome): Global shopping * [ampproject](https://www.ampproject.org): Web component framework. * [Anonynote](https://anonynote.org): Note-taking app. * [Avain.app](https://avain.app): Avain * [Bangle.io](https://bangle.io/) - A Notion like local note taking tool where data is saved in your computer and in Markdown format. * [Bank Maskan](https://pwa.bank-maskan.ir): Iranian bank * [Rayanhamafza FWA](https://fwa.rayanbroker.ir): Iranian funds By RayanHamAfza (Only From Iran-Ip) * [Bento-starter](https://bento-starter.firebaseapp.com): Open-Source Full-Stack solution for fast PWA development * [Best Markdown Editor](https://bestmarkdowneditor.com): undefined * [BitMidi](https://bitmidi.com): Listen to your favorite MIDI files. * [Bolster](https://bolster.pro/): Bolster * [2048 Game](https://2048game.com/) 2048 Game * [Booksie](https://www.booksie.org/): An open catalog of free picture storybooks for children instantly available for reading. * [Budget Tracker](https://btapp.netlify.com/): Track expenses and analyse if they stick to a budget * [bundle](https://bundle.js.org/): A quick and easy way to bundle, minify, and compress (gzip and brotli) your ts, js, jsx and npm projects all online, with the resulting file size. * [Calculator](https://calculator-app-tau.vercel.app/): A calculator app with theme switcher * [Care Cards](https://carecards.io): Care Cards * [Cat Safe Foods](https://catsafefoods.com): Sharing food with your cat? Make sure it's safe first * [Chrome Developer Summit](https://developers.google.com/): Google Developers * [Clock App](https://clockapp.tk/): Analog Alarm Clock App * [Closerintime](https://closerinti.me): #closerintime * [Colosseum](https://naramsim.github.io/Colosseum/): Displays Pokemons in a beautiful way * [ComputerBase](https://www.computerbase.de/): German IT news site. * [Contrax](https://contrax.app): Track your contracts, subscriptions and trials. * [Crazy Dice](https://crazydice.netlify.app): Simple Dice App. * [Currency Converter](https://www.currency-x.com): Currency Calculator * [Currency Exchange Loss Calculator](https://currency-loss.netlify.com/): Currency Exchange Loss Calculator * [Datememe](https://www.datememe.com): Online dating. * [Demo PWA](https://github.com/gokulkrishh/demo-progressive-web-app): Demonstrating offline, push notifications, background sync etc. * [Dev.Opera](https://dev.opera.com/): Dev.Opera * [DevDocs](https://devdocs.io/): API Documentation Browser * [Digikala](https://www.digikala.com/): Digikala Web App * [Dog Safe Foods](https://dogsafefoods.com): Sharing food with your dog? Make sure it's safe first * [DontBore](https://dontbo.re/): Find and share logins. * [DTH Search India](https://www.dthchannelsearch.in/): Search DTH TV channel numbers in India. * [ELFSH](https://elfsh.mousetail.nl): Food and expense manager. * [emberclear](https://emberclear.io): Encrypted Chat. No History. No Logs. * [Emoji Log](https://emojilog.rosano.ca): Personal tracker * [Etch](https://etch.co): A Small team of Designers and Developers. * [Farmhand](https://jeremyckahn.github.io/farmhand/): Farmhand * [FarmOS](https://farmos.app/): Farm record keeping * [Fast Golf Scores](https://fastgolfscores.com): Fast Golf Scores. * [FileLove](https://file.love/): Minimal p2p file transfer right in the browser. * [Firefox Platform Status](https://platform-status.mozilla.org/): Firefox Platform Status * [FlagWarriors](https://flagwarriors.netlify.com): Minimalist multiplayer strategy game. * [Football Peek](https://footballpeek.com/): Football results. * [Freelancer](https://m.freelancer.com/messages): Hire the best freelancers for any job, online. * [ghChat](https://github.com/aermin/ghChat): Chat application for GitHub. * [GitHub Explorer](https://github-e.com/): Profile viewer. * [Google Drive](https://drive.google.com/): File storage. * [Google Duo](https://duo.google.com/): Video Calling. * [Google Maps](https://www.google.com/maps/): Online maps. * [Google Photos](https://photos.google.com/): Photo management. * [Google Stadia](https://stadia.google.com/): Gaming across devices. * [GPA Calculator](https://gpacalculator.memorymaps.io/): Generate animated artwork from your unique GPA inputs. * [GPA Calculator](https://gpacalculator.io): Calculate your college GPA. * [guitar-tuner](https://aerotwist.com/blog/guitar-tuner/): Aerotwist Guitar Tuner * [Housing Go](http://www.housing.com): Real estate in India. * [Hugo](https://app.hugo.team/): Meeting notes. * [Hyperdraft](https://hyperdraft.rosano.ca): Turn your text notes into a website. * [Indecisive.US](https://indecisive.us/): App to help you make a decision. * [Journalistic](https://journalisticapp.com/): Micro Journaling App. * [Joybox](https://joybox.rosano.ca): A pinboard for audiovisual media. * [jsfeatures](https://jsfeatures.in): JavaScript features * [JSON Formatter](https://jsonformatter.live/): Minimalist JSON formatter. * [Kahla](https://web.kahla.app): Business messaging app. * [Kommit](https://kommit.rosano.ca): Create flashcards and learn them with spaced-repetition. * [Launchlet](https://launchlet.dev): Customize any website with JavaScript or CSS. * [Let's Plant](https://letsplant.org/): Plant chooser. * [Lofimusic.app](https://lofimusic.app/): Online radio Radio * [Lorem Ipsum](https://loremipsum.io): Lorem Ipsum generator. * [Math Riddles](https://mathriddles.netlify.app): Interesting Math Riddles. * [Make Better Software](https://makebetter.software): Raise software standards. * [MConverter](https://mconverter.eu): Online file converter. * [Medium](https://medium.com/): Writing space. * [Memory Game PWA](https://pwa-memory-game.surge.sh/): Strengthen your memory. * [Messages for web (by google)](https://messages.google.com/web/): 400 * [MoneyTracker](https://moneytracker.cc/): Personal finances tracking web app. * [Morse Code Translator](https://morsedecoder.com/): Morse Code tools * [MTGStocks](https://www.mtgstocks.com/news): Magic the Gathering price tracker. * [Murlok.io](https://murlok.io/): World of Warcraft Shadowlands. * [MYHELLOIOT](https://adrianromero.github.io/myhelloiot/): MQTT client application. * [Notella](https://github.com/siddharthkp/notella): No fluff notes app. * [OmniCam](https://www.omnicamapp.com/): Live streaming webcams around the world. * [Othello](https://othello-rust.web.app/): Play Othello against the computer. * [PakWheels](https://www.pakwheels.com/): Buy/sell cars. * [Passky](https://vault.passky.org/): Free and open-source Password Manager * [Paytm Lite](https://paytm.com/): Online wallet and payments. * [Photopea](https://www.photopea.com/): Online Photo Editor. * [PixelCraft](https://pixelcraft.web.app): Pixel Art Editor * [Pokedex](https://pokedex.org/): Indexing Pokémon * [PokeQuest Wiki](https://pokequest.wiki/): Search for Pokémon * [Police Lights](https://policelights.tk/): Police Car Light Flash Screen App * [Pomotimer](https://pomotimer.com/): Pomodoro Technique Timer * [PregBuddy](https://app.pregbuddy.com): Information for pregnant women. * [Progressive Beer](https://deanhume.github.io/beer/): Progressive Beer * [PWA-NES](https://pwa-nes.vercel.app/): 8-bit NES emulator * [QR Code Generator](https://qr-code-generator.now.sh): Create custom QR Codes. * [QR Code Scanner](https://qrcodescan.in/): Scan a QR code. * [RedditLattice](https://redditlattice.netlify.app/): A reddit viewer for image based subreddits. Lays out the images in a tight lattice. * [Regex101](https://regex101.com/): Build, test and debug regex. * [Remember](https://paulhoughton.github.io/remember/): Location-based reminders. * [Resume Nation](https://resume-nation.github.io): Resume creator. * [Rydeen](https://rydeen.app/): Task management app for individuals. * [SaintsApp](https://saintsschedule.info/): New Orleans Saints' game schedule. * [Saucekudasai](https://saucekudasai.com): An Anime seacrch engine that finds animeinfo based on image provided * [Scoreboard.Rocks](https://scoreboard.rocks/): Scoreboard App. * [Similar Worlds](https://similarworlds.com/): Experience Project Alternative. Find people with similar interests. * [Simple Currency Converter](https://currency-converter.now.sh): Currency Converter * [Skcript](https://www.skcript.com/): Ruby on Rails Consulting. * [Smaller Pictures](https://smaller-pictures.appspot.com): Image compressor. * [Snapdrop](https://snapdrop.net): Transfer files over wifi. * [SoundCloud](https://soundcloud.com/): Stream and listen to music. * [Soundpad](https://soundpad.tk/): Sound Sequencer App. * [Soundslice](https://www.soundslice.com): Create living sheet music. * [SplittyPie](https://splittypie.com): Easy expense splitting. * [Spotify](https://open.spotify.com/): Music streaming. * [sv-ginger](https://sv-ginger.appspot.com/): Ginger WebGL Morph Demo * [SvenPanel](https://svenpanel.de/): The Shrine - The Message Is Feierei Alda. * [SVGOMG](https://jakearchibald.github.io/svgomg/): SVGO's Missing GUI * [Swahili Dictionary](https://swahili-dictionary.com/): Offline Swahili-English-Swahili dictionary * [Taskade](https://www.taskade.com): Remote Team Workspace. * [Telegram](https://web.telegram.org/): Telegram Web App. * [Themer](https://themer.dev): Theme generator for editors, terminals, wallpapers, and more. * [Threema Web](https://web.threema.ch/): The messenger that puts security and privacy first. * [Timetable](https://leoherrmann.github.io/timetable/): Interactive editable timetable. * [Tinder](https://tinder.com): Dating app. * [todo.blue](https://todo.blue/): ToDo app. * [Todoly](https://t4p4n.github.io/todoly/): A Simple ToDo PWA * [Total Formatter](https://totalformatter.web.app): YAML Formatter * [trivago](https://www.trivago.com/): Hotel prices. * [Tutor Portfolio PWA](https://englishextra.gitlab.io/): ??? * [Twitter](https://twitter.com): Microblogging app. * [Uber Web](https://m.uber.com): Ridesharing app. * [Unalengua IPA Translator](https://unalengua.com/ipa): Translate to IPA. * [VeganCheck](https://vegancheck.me): Check if a product is vegan or not. * [VeggieTables](https://veggietables.org): Track your crops and farming activities. * [Versus](https://versus.com/en): Consumer electronics shopping. * [VideoTrim.app](https://videotrim.app): Video trimmer app in the browser. * [Wave-PD1](https://alexgibson.github.io/wavepad/): Synth toy. * [Web NFC enabled shopping cart](https://webnfc-shoppingcart.appspot.com): Shopping list demo. * [Word Counter](https://wordcounter.io): Count characters, words, sentences, paragraphs, pages. * [Wormhole](https://wormhole.app/): Share files with end-to-end encryption. * [X Sound](https://korilakkuma.github.io/X-Sound/): Online keyboard synth. * [Yahtzee](https://zpix1.github.io/yahtzee/): Dice generator. * [Youtube Music](https://music.youtube.com/): Music streaming via YouTube. * [ztable.io](https://ztable.io/): Z-Table lookup & Z-Score calculator. ## Tutorials * [Build a realtime PWA using Vue.js](https://pusher.com/tutorials/pwa-vuejs) * [Build a realtime PWA with React](https://pusher.com/tutorials/pwa-react) * [Codelabs to build PWAs with Polymer 2.0](https://codelabs.developers.google.com/polymer-summit-2016) * [Getting started with Progressive Web Apps](https://addyosmani.com/blog/getting-started-with-progressive-web-apps/) by [@addyosmani](https://twitter.com/addyosmani) * [Google Developers - Progressive Web Apps](https://developers.google.com/web/progressive-web-apps) * [Introduction to Progressive Web Apps by Google-Udacity](https://in.udacity.com/course/intro-to-progressive-web-apps--ud811/) * [Introduction to progressive web apps](https://blog.pusher.com/introduction-progressive-web-apps/) * [Progressive Web Apps with React.js - 4 part series](https://medium.com/@addyosmani/progressive-web-apps-with-react-js-part-i-introduction-50679aef2b12#.ly1xiybxd) by [@addyosmani](https://twitter.com/addyosmani) * [Retrofit an Existing Website as a Progressive Web App](https://www.sitepoint.com/retrofit-your-website-as-a-progressive-web-app/) * [Service Worker Cookbook - Mozilla](https://serviceworke.rs/) * [Web Powered SMS Inbox with Service Worker: Push Notifications](https://www.twilio.com/blog/2016/02/web-powered-sms-inbox-with-service-worker-push-notifications.html) ## Articles * [A Beginner’s Guide to Progressive Web Apps & the Frontend Web](https://hackernoon.com/a-beginners-guide-to-progressive-web-apps-the-frontend-web-424b6d697e35) * [A full-stack solution for fast PWA development](https://medium.zenika.com/a-full-stack-solution-for-fast-pwa-development-937288b055b8) * [A Tinder Progressive Web App Performance Case Study](https://medium.com/@addyosmani/a-tinder-progressive-web-app-performance-case-study-78919d98ece0) * [Are Progressive Web Apps the Future?](http://developer.telerik.com/featured/are-progressive-web-apps-future/) * [FLIP your animations](https://aerotwist.com/blog/flip-your-animations/) * [From Electron to Progressive Web App](https://mjswensen.com/blog/2019/03/23/from-electron-to-progressive-web-app/) * [How I built a Progressive Beer App](https://deanhume.com/Home/BlogPost/how-i-built-a-progressive-beer-app/10148) * [How I made a Progressive Web App out of my Blog](https://alexjoverm.github.io/2017/08/07/How-I-made-a-Progressive-Web-App-out-of-my-Blog/) * [How we made our website offline first](https://www.skcript.com/svr/offline-is-the-new-online/) * [IndexedDB, WebSQL, LocalStorage – what blocks the DOM?](https://nolanlawson.com/2015/09/29/indexeddb-websql-localstorage-what-blocks-the-dom/) * [Installable Web Apps with the WebApp Manifest in Chrome for Android](https://developers.google.com/web/updates/2014/11/Support-for-installable-web-apps-with-webapp-manifest-in-chrome-38-for-Android) * [Integrating Progressive Web Apps deeply into Android](https://blog.chromium.org/2017/02/integrating-progressive-web-apps-deeply.html) * [Introducing Pokedex.org: a progressive webapp for Pokémon fans](http://www.pocketjavascript.com/blog/2015/11/23/introducing-pokedex-org) * [Introduction to Progressive Web App with example](https://www.loginradius.com/engineering/blog/introduction-to-progressive-web-apps/) * [Intro to (Progressive) Web Apps](https://dev.to/sudhakar3697/intro-to-progressive-web-apps-34oo) * [Is Service Worker ready?](https://jakearchibald.github.io/isserviceworkerready/) * [Progressive web apps have leapfrogged the native install model ... but challenges remain/](http://softwareas.com/progressive-web-apps-have-leapfrogged-the-native-install-model-but-challenges-remain/) * [PWA Performance](https://speedcurve.com/blog/pwa-performance/) * [PWA - E-Commerce - Compare List](https://docs.google.com/spreadsheets/d/1nx5jcHa6reIH20q20uDnZLQNjuK2ohk-HmQ09hy9NCE/edit#gid=0) * [Say Hello to Offline First](http://hood.ie/blog/say-hello-to-offline-first.html) * [Service Worker - Revolution of the Web Platform](https://ponyfoo.com/articles/serviceworker-revolution) * [Service Workers: Dynamic Responsive Images using WebP Images](http://deanhume.com/Home/BlogPost/service-workers--dynamic-responsive-images-using-webp-images/10132/) * [Support for theme-color in Chrome 39 for Android](https://developers.google.com/web/updates/2014/11/Support-for-theme-color-in-Chrome-39-for-Android) * [Swift Migration to Progressive Web App](https://medium.com/engineering-housing/progressing-mobile-web-fac3efb8b454) * [The Building Blocks Of Progressive Web Apps](https://www.smashingmagazine.com/2016/09/the-building-blocks-of-progressive-web-apps/) * [The web app "discovery problem"](https://remysharp.com/2016/04/11/the-webapp-discovery-problem) * [What Progressive Web Apps Mean for the Web](http://developer.telerik.com/featured/what-progressive-web-apps-mean-for-the-web/) * [You’re Missing the Point of Server-Side Rendered JavaScript Apps](http://tomdale.net/2015/02/youre-missing-the-point-of-server-side-rendered-javascript-apps/) ## Videos * [AMP + Progressive Web Apps: Start fast, stay engaged - Google I/O 2016](https://www.youtube.com/watch?v=a5X_Ot-R6lo) * [Angular 2 and Progressive Web Apps - Google I/O 2016](https://www.youtube.com/watch?v=vAb-2d1vcg8) * [Breaking the 1000ms Time to Glass Mobile Barrier (vid)](https://www.youtube.com/watch?v=Il4swGfTOSM) * [Building a Progressive Web App - Aditya Punjani](https://www.youtube.com/watch?v=m2tvYGCdOzs) * [Building and deploying a Progressive Web App at scale with Flipkart (Chrome Dev Summit 2015)](https://www.youtube.com/watch?v=StdKz32M1RM) * [Building for Billions (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=Vmg1ECC2r2Q&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=20) * [Building for billions on the web - Google I/O 2016](https://www.youtube.com/watch?v=E6hGubMkNfM) * [Building Progressive Web Apps with Polymer (Chrome Dev Summit 2015)](https://www.youtube.com/watch?v=g7f1Az5fxgU) * [Building the Google I/O Web App: Launching a Progressive Web App on Google.com - Google I/O 2016](https://www.youtube.com/watch?v=__KvYxcIIm8) * [Deep Engagment with Push Notifications (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=Zq-tRtBN3ws&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=9) * [Fast and resilient web apps: Tools and techniques - Google I/O 2016](https://www.youtube.com/watch?v=aqvz5Oqs238) * [Fireside Chat with the Progressive Web Apps Crew - Google I/O 2016](https://www.youtube.com/watch?v=Sy4oH8JZuJQ) * [Going Big: PWAs Come to Desktop and Chrome OS (Google I/O ’19)](https://www.youtube.com/watch?v=2KhRmFHLuhE) * [Great libraries and tools for great Progressive Web Apps - Google I/O 2016](https://www.youtube.com/watch?v=Use459WBeWc) * [Houdini: Demystifying the Future of CSS - Google I/O 2016](https://www.youtube.com/watch?v=sE3ttkP15f8) * [Instant loading with HTTP/2 (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=G62aCRIlONU&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=7) * [Instant Loading: Building offline-first Progressive Web Apps - Google I/O 2016](https://www.youtube.com/watch?v=cmGr0RszHc8) * [Instant-loading Offline-first (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=qDJAz3IIq18&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=3) * [Interview with Google Software Engineer Alex Russell - O'Reilly Fluent Conference 2016](https://www.youtube.com/watch?v=vMg9sycUnm4&list=PL055Epbe6d5bQubu5EWf_kUNA3ef_qbmL&index=36) * [Konga (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=GNbVdPi24gg&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=26) * [Mythbusting HTTPS (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=e6DUrH56g14&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=5) * [Opening Keynote (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=9Jef9IluQw0&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=1) * [Polymer and Progressive Web Apps: Building on the modern web - Google I/O 2016](https://www.youtube.com/watch?v=fFF2Yup2dMM) * [Polymer Summit 2016 Youtube Playlist](https://www.youtube.com/watch?list=PLNYkxOF6rcICc687SxHQRuo9TVNOJelSZ&v=VBbejeKHrjg) * [Progressive Web Apps (Chrome Dev Summit 2015)](https://www.youtube.com/watch?v=MyQ8mtR9WxI) * [Progressive Web Apps across all frameworks - Google I/O 2016](https://www.youtube.com/watch?v=srdKq0DckXQ) * [Progressive web apps and what's next for mobile](https://www.oreilly.com/ideas/progressive-web-apps-and-whats-next-for-mobile?utm_source=twitter&utm_medium=webplatform&utm_campaign=YTknRussell-jj) * [Progressive Web Apps and What's Next for Mobile](https://www.youtube.com/watch?v=JP5p6t3wNLA) * [Progressive Web Apps Are Easy Now - Or Are They with Thorsten Lorenz -- UtahJS 2018](https://youtu.be/bKxtwzr0sy0) * [Progressive Web Apps in any context (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=8dr_IUGwsO0&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=13) * [Progressive Web Apps on Firebase - Google I/O 2016](https://www.youtube.com/watch?v=SobXoh4rb58) * [Progressive Web Apps Training 2019 - Playlist](https://www.youtube.com/watch?v=psB_Pjwhbxo&list=PLNYkxOF6rcIB2xHBZ7opgc2Mv009X87Hh) * [Progressive Web Apps with Alex Russell](https://www.youtube.com/watch?v=x7cfLDFVyHo) * [Progressive Web Apps: the future of Apps](https://dev.opera.com/blog/pwa-taipei/) * [Progressive, Performant, Polymer: Pick Three - Google I/O 2016](https://www.youtube.com/watch?v=J4i0xJnQUzU) * [Putting the Progressive in Progressive Web Apps (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=zHNYFUhVzgw&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=15) * [PWA starter kit: build fast, scalable, modern apps with Web Components (Google I/O '18)](https://www.youtube.com/watch?v=we3lLo-UFtk) * [PWA Training Course 2017 Playlist with Sarah Clark, Google Developers India](https://www.youtube.com/playlist?list=PLlyCyjh2pUe9RHFCJHU0kxpaivUzADPYk) * [Samsung internets progressive web app commitment (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=4_qhu-4EQGA&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=27) * [Search and the mobile content ecosystem - Google I/O 2016](https://www.youtube.com/watch?v=xeGzQhAU2XI) * [Service workers at scale with Facebook and Flipkart - Google I/O 2016](https://www.youtube.com/watch?v=fGTUIlEM0m8) * [Summit Report: Building for billions with Progressive Web Apps (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=kxE4bLSC-xw&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=18) * [Summit Report: Checking in with Paul Lewis and Jake Archibald (Progressive Web Apps Summit 2016)](https://www.youtube.com/watch?v=TVolBgyaiTQ&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=4) * [Summit Report: Making Progressive Web Apps accessible, at scale! (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=1qqZIeQNuxE&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=14) * [Summit Report: Progressive Web Apps for any occassion! (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=oKQpfevHHUY&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=12) * [Summit Report: Reach, acquisition and conversion (Progressive Web Apps Summit 2016)](https://www.youtube.com/watch?v=Vou8NruMyWA&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=16) * [Summit Report: Talking HTTPS with Emily Schechter (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=U638eR0ltUo&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=6) * [Summit Report: The Web Developers swarm! (Progressive Web Apps Summit 2016)](https://www.youtube.com/watch?v=y-E-z6XVKGI&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=2) * [Summit Report: What do I need to know about HTTP2? (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=w--PU4HO9SM&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=10) * [Summit Report: Why's it called a Progressive Web App? (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=yxy1BOC1-q8&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=8) * [The applied science of runtime performance (vid)](https://www.youtube.com/watch?v=RCFQu0hK6bU) * [The Future of Progressive Web Apps (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=kB4MgJ0AoOw&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=22) * [The Mobile Web: State of the Union - Google I/O 2016](https://www.youtube.com/watch?v=0SSI8liELJU) * [The Service Worker is Coming - Look Busy (vid)](https://www.youtube.com/watch?v=SmZ9XcTpMS4) * [To the Lighthouse (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=LZjQ25NRV-E&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=19) * [Tools for Success (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=m2Zk5CgVX9I&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=21) * [UI Elements at 60fps (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=ZqdNgn5Huqk&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=11) * [Unlocking New Capabilities for the Web (Google I/O ’19)](https://www.youtube.com/watch?v=GSiUzuB-PoI) * [Using Web Components to Build PWAs (Progressive Web App Summit 2016)](https://www.youtube.com/watch?v=pBCDdeqzUlY&list=PLNYkxOF6rcIAWWNR_Q6eLPhsyx6VvYjVb&index=17) * [V8, modern JavaScript, and beyond - Google I/O 2016](https://www.youtube.com/watch?v=N1swY14jiKc) * [Who are you, really: Safer and more convenient sign-in on the web - Google I/O 2016](https://www.youtube.com/watch?v=MnvUlGFb3GQ) * [Why Build Progressive Web Apps? - Playlist](https://www.youtube.com/watch?v=4UK_TDTTWnQ&list=PLNYkxOF6rcIAvsHlT44x-Kve2lG8CrDip) ## Tools * [`@forlagshuset/simple-fs`](https://github.com/fagbokforlaget/simple-fs): Needs offline filesystem? SimpleFS provides sweet promise based nodejs file API on top of indexeddb. * [`a2hs.js`](https://github.com/koddr/a2hs.js): A useful modern JavaScript solution that helps your website users to add (install) a progressive web app to the Home Screen of their mobile iOS devices. * [`DSW`](https://github.com/naschq/dsw): Generate your Service Worker dynamically, webmanifest, rules for requests, redirects, etc. * [`fetch-manifest-json`](https://github.com/hemanth/fetch-manifest-json): Fetch the `mainfest.json` from an URL. * [`fetch-sync`](https://github.com/sdgluck/fetch-sync): Proxy Fetch requests through the Background Sync API * [`HNPWA`](https://github.com/tastejs/hacker-news-pwas): Hacker News readers as Progressive Web Apps. A spiritual successor to TodoMVC. * [`Manifest Generator`](https://brucelawson.github.io/manifest/): This simple page will generate the manifest file for you. * [`manifest-json`](https://www.npmjs.com/package/manifest-json): CLI tool for creating `mainfest.json`. * [`msgr`](https://github.com/sdgluck/msgr): Nifty service worker/client message utility * [`offline-plugin`](https://github.com/NekR/offline-plugin): Offline plugin (ServiceWorker, AppCache) for webpack (<http://webpack.github.io/>) * [`platinum-sw-register`](https://elements.polymer-project.org/elements/platinum-sw?active=platinum-sw-register): handles service worker registration for Polymer applications * [`PWAify`](https://github.com/vladikoff/PWAify): CLI tool to convert your PWA into a cross-platform desktop app. * [`serviceworker-rails`](https://github.com/rossta/serviceworker-rails): Plugin to integrate Service Worker with the Rails asset pipeline. * [`serviceworker-webpack-plugin`](https://github.com/oliviertassinari/serviceworker-webpack-plugin): Simplifies creation of a service worker to serve your webpack bundles. * [`serviceworkerware`](https://github.com/fxos-components/serviceworkerware): An Express-like layer on top of ServiceWorkers to provide a way to easily plug functionality * [`sw-delta`](https://github.com/gmetais/sw-delta): An incremental cache for the web. * [`sw-precache-webpack-plugin`](https://github.com/goldhand/sw-precache-webpack-plugin): SW Precache Webpack Plugin * [`sw-precache`](https://github.com/GoogleChrome/sw-precache): A node module to generate service worker code that will precache specific resources * [`sw-toolbox`](https://github.com/GoogleChrome/sw-toolbox): A runtime caching library * [`UpUp`](https://github.com/TalAter/UpUp): Makes sure your users can always access your site's content, even when they're on a plane, in an elevator, or 20,000 leagues under the sea * [`Workbox`](https://github.com/GoogleChrome/workbox): Javascript Library for building progressive web apps * [`pwa-badge`](https://github.com/ali-master/pwa-badge): Badging for PWA app icons, Like Native Apps ## Kits * [`Bento starter`](https://github.com/kefranabg/bento-starter): Full-stack solution to build Progressive Web Apps. * [`Lavas`](https://lavas.baidu.com): A framework base on vue for building progressive web apps * [`Progressive Web Application skeleton`](https://github.com/PolymerLabs/progressive-webapp-config): A simple set of skeleton files for shipping a Progressive Web App. * [`pwabuilder`](http://www.pwabuilder.com/): All the tools you need to build and deploy your Progressive Web Apps. * [`React Storefront`](https://github.com/moovweb/react-storefront): Framework for progressive web apps with React. * [`Web Starter Kit`](https://github.com/google/web-starter-kit): A workflow for multi-device websites. * [Polymer App Toolbox](https://www.polymer-project.org/3.0/toolbox/): "a collection of components, tools and templates for building Progressive Web Apps with Polymer" * [Preact CLI](https://github.com/developit/preact-cli): "Your next Preact PWA in 30 seconds" * [Simple PWA](https://simplepwa.com): A Progressive Web App template that provides the minimum file structure needed to create a PWA * [Stencil PWA toolkit](https://stenciljs.com/pwa/): Ionic's "Everything you need to easily build fast, production ready Progressive Web Apps" ## Courses * [Developing Progressive Web Apps Course](https://codelabs.developers.google.com/dev-pwa-training) (free) * [Getting Started with Progressive Web Apps](https://www.pluralsight.com/courses/web-apps-progressive-getting-started) (paid) * [Intro to Progressive Web Apps](https://in.udacity.com/course/intro-to-progressive-web-apps--ud811) (free) * [Learn to build progressive web apps using JavaScript](https://www.udemy.com/course/learn-to-build-progressive-web-apps-using-javascript/) (paid) * [Progressive Web App Fundamentals](https://www.pluralsight.com/courses/progressive-web-app-fundamentals) (paid) * [Progressive Web Apps - The Concise PWA Masterclass](https://www.udemy.com/course/progressive-web-apps/) (paid) * [Progressive Web Apps (PWA) - From Beginner to Expert](https://www.udemy.com/course/progressive-web-apps-pwa-from-beginner-to-expert/) (paid) * [Progressive Web Apps (PWA) - The Complete Guide](https://www.udemy.com/course/progressive-web-app-pwa-the-complete-guide/) (paid) ## Conferences * [A list of conferences talking about PWA](https://github.com/mobilehackersio/pwa-confs)

✎ Simple, personal journaling progressive web app

<p align="center"> <img alt="logomark" width="50%" src="https://raw.githubusercontent.com/gillkyle/images/master/sol-journal-logo.png" /> </p> <h2 align="center"> Personal Journaling Platform </h2> Sol Journal is a simple, minimal, journaling platform that works offline and across all devices. It can be hosted yourself on Firebase and then installed as a PWA, on mobile devices for easy access on a phone, or on Desktops. <p align="center"> <img alt="preview of page" src="https://raw.githubusercontent.com/gillkyle/images/master/hero-mixed.png" /> </p> ## Introduction <a href="https://www.producthunt.com/posts/sol-journal?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-sol-journal" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=157146&theme=light" alt="Sol Journal - A simple, open-source personal journaling platform | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a> Journaling is a keystone habit that can improve your happiness and [overall health](https://psycnet.apa.org/record/2004-16777-010). Writing in a journal with pen and paper is effective, but not as easily accessible, maintained, or preserved as taking advantage of digital platforms. Having a journal that is available on any device makes journaling easier. Being tailored specifically to journaling makes it less cumbersome than trying to utilize a note taking app or document for recording thoughts and impressions. ## Getting Started There are 2 ways to get started using Sol Journal: 1. You can develop it locally after hooking it up to your own Firebase project by following the instructions below 2. You can host your own version and manage it yourself by following the [setup docs](https://github.com/gillkyle/sol-journal/blob/master/SETUP.md) Sol Journal uses firebase to support offline functionality and authentication, meaning a new Firebase app will need to be setup with Firestore as a database if you wish to host it yourself. Be sure to add documents for `users` and `entries`, as well as enabling email for user authentication. ## Features In the spirit of minimalism, a few key features are in place for a quick, lightweight journaling experience that can work across devices, including: - 🔥 Authentication: Cloud firestore persists registered users to a users document and saved journal entries to an entries document - 🎨 Theming: the `src/styles/theme.js` file contains a set of colors and default styles that are applied to components with Emotion. A default light and dark theme are already in the file (adding [theme-ui](https://theme-ui.com/) support would be a great future addition) - 🔍 Search: full-text search of a user's entries stored in Firestore for quick access to past entries - 🖥 Mobile Friendly: designed to look great on mobile as well as desktop, with easy navigation on both - 💡 PWA: being a progressive web app makes it installable from Chrome/Safari on desktop, or be added to the homescreen on iOS/Android - 🔌 Offline Support: read/write when you're offline and let the updates happen when your connection is restored - 🗄 Export: backup all of your entries at any time to save your data ## Project setup Files are organized into these folders: `/components`: user interface pieces to construct the design and layout of the site `/data`: local data transformed by Gatsby to become queryable by Gatsby's GraphQL data layer `/img`: images used by places like landing pages that are optimized by gatsby-image and then queryable in the GraphQL layer `/pages`: public pages that can be seen by unauthenticated users and are completely server side rendered by Gatsby during `gatsby build` `/routes`: private, client only routes only visible to authenticated users that are used by the app section of the journal `/styles`: role based design tokens and theme definitions `/util`: simple utility functions, for things like formatting dates ## Developing Clone the project: ```bash git clone https://github.com/gillkyle/sol-journal ``` Install dependencies: ```bash npm install ``` or ```bash yarn ``` Then configure a file in a new `.env` file (using the `.env.sample` file as a reference) with the following keys from the firebase console: ```env GATSBY_FIREBASE_API_KEY=<BUNCHofRandomNumbersAndChars> GATSBY_DEV_AUTH_DOMAIN=<name>.firebaseapp.com GATSBY_DEV_DATABASE_URL=https://<name>.firebaseio.com GATSBY_DEV_PROJECT_ID=<name> GATSBY_DEV_STORAGE_BUCKET=<name>.appspot.com GATSBY_DEV_MESSAGING_SENDER_ID=############ GATSBY_CONFIRMATION_EMAIL_REDIRECT=https://<name>.firebaseapp.com ``` Again, be sure to add documents for `users` and `entries`, as well as enabling email for user authentication. Navigate into the project directory, and then launch the site with this command: ```bash gatsby develop ``` The site will be opened up in your default browser on http://localhost:8000 Edit code in the `/src`, save your changes, and they'll reload instantly in the browser. ## Deploy To create an optimized build of the site run this command: ```bash gatsby build ``` A `/public` folder will be assembled that can be deployed to any static file hosting service like Netlify or surge. It can be deployed to firebase with this command: ```bash firebase deploy -p public ``` ## Inspiration and Other Projects Sol Journal is inspired by [JournalBook](https://github.com/trys/JournalBook) and borrows much of its design and navigation. If you're interested in a comparable version of the project, you can check out [this fork that adds rich text support](https://github.com/garrowp/sol-journal) to the journaling block.

Awes.io // boilerplate based on Vue, Nuxt, TailwindCSS plus Laravel as a backend. 🤟

文档着重构建一个完整的「前端技术架构图谱」，方便 F2E(Front End Engineering又称FEE、F2E) 学习与进阶。

> 更新时间：2022-06-20 16:46:44（脚本自动生成，勿手动修改，详见：info.md) # F2E-Awesome [](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh) [](https://github.com/f2e-awesome/knowledge/stargazers) [](https://github.com/f2e-awesome/knowledge/fork) [](https://github.com/f2e-awesome/knowledge/watchers)  - 难度等级：☆ 为初级，☆☆ 为中级，☆☆☆ 为高级 - 标签体系：[开发工具](#开发工具)、[前端类库](#前端类库)、[移动端](#移动端)、[必学原理](#必学原理)、[PWA](#PWA)、[WebAssembly](#WebAssembly)、[小程序](#小程序)、[Canvas](#Canvas)、[WebGL](#WebGL)、[SVG](#SVG)、[HTML5](#HTML5)、[Elasticsearch](#Elasticsearch)、[Graphql](#Graphql)、[模块化编程](#模块化编程)、[算法](#算法)、[加密](#加密)、[数据结构](#数据结构)、[包管理](#包管理)、[Python](#Python)、[数据库](#数据库)、[设计模式](#设计模式)、[网络协议](#网络协议)、[CSS](#CSS)、[DOM](#DOM)、[函数式编程](#函数式编程)、[跨域](#跨域)、[事件模型](#事件模型)、[安全](#安全)、[前端规范](#前端规范)、[Nginx](#Nginx)、[Git](#Git)、[CDN](#CDN)、[JS](#JS)、[Linux](#Linux)、[Electron](#Electron)、[抓包工具](#抓包工具)、[测试](#测试)、[容器化](#容器化)、[DNS](#DNS)、[监控](#监控)、[数据可视化](#数据可视化)、[浏览器](#浏览器)、[前端工程化](#前端工程化)、[物联网](#物联网)、[消息队列](#消息队列)、[V8](#V8)、[DevOps](#DevOps)、[微前端](#微前端)、[LowCode](#LowCode)、[主流框架](#主流框架)、[架构](#架构)、[AI](#AI)、[面试](#面试)、[前端组织](#前端组织)、[学习网站](#学习网站)、[技术杂谈](#技术杂谈)、[优化](#优化)、[Serverless](#Serverless)、[源码学习](#源码学习)、[Web](#Web) ### 开发工具 - [Sublime Text](https://www.sublimetext.com/3) ☆☆ - [VS Code](https://code.visualstudio.com/Download/) ☆☆☆ - [Atom](https://atom.io/) ☆☆ - [WebStorm](https://www.jetbrains.com/webstorm/download/#section=windows) ☆☆☆ ### 前端类库 - JS 类库 - [jQuery](http://api.jquery.com/) ☆ - [zepto](http://www.zeptojs.cn/) ☆ - [underscore](http://www.css88.com/doc/underscore/) ☆☆ - [lodash](https://www.lodashjs.com/) ☆☆ - UI 库 ☆ - [Bulma](https://bulma.io/) - [EasyUI](http://www.jeasyui.net/) - [Bootstrap](http://www.bootcss.com/) - [Meterial Design](https://material.io) - [Wired Elements(手绘风格 UI 库)](https://juejin.im/entry/5b1dd2b2f265da6e0f70b7e1?utm_source=gold_browser_extension) - 移动端 - [SUI Mobile](http://m.sui.taobao.org/) - [MUI](http://dev.dcloud.net.cn/mui/) - 软件 - PS ☆ - AI ☆ - [精品 MAC 应用分享](http://xclient.info/?t=b4b436fb1b66a3542c9e25e85d474bd51998960d) ☆ - 视觉网站 - [Behance](https://www.behance.net/) ☆☆ - [Dribbble](https://dribbble.com/) ☆☆ - 原型工具 - Axure ☆ - [Sketch](http://www.sketchcn.com/sketch-chinese-user-manual.html) ☆ ### 移动端 - Native App - [React Native](https://facebook.github.io/react-native/) ☆☆ - [Weex](http://weex.apache.org) ☆☆ - [NativeScript](https://www.nativescript.org/) - Hybird App - Ionic ☆☆ - Cordova ☆☆ - Phonegap ☆☆ - Web App ☆ - 响应式布局 - rem ☆ - webview - 页面通信 ☆ - 原理 ☆☆ - [关于 Hbuilder](http://jartto.wang/2015/02/13/about-hbuilder/) ☆ - [移动端 Touchend 事件不触发解决方案](http://jartto.wang/2015/06/25/solutions-to-touchend-on-mobile/) ☆ - [移动Web UI库（H5框架）有哪些](https://blog.csdn.net/u013778905/article/details/78632650) ☆ - [H5 移动调试全攻略](http://jartto.wang/2018/11/01/mobile-debug/) ☆☆ - Flutter - [Awesome-Flutter](https://github.com/fluttercnclub/awesome-fluttercn) ☆ - [闲鱼Flutter互动引擎系列](https://mp.weixin.qq.com/s/oa-XUzWhhsz37Mj-Y6WkzA) ☆☆ - [深入了解 Flutter 的高性能图形渲染](https://mp.weixin.qq.com/s/RNhdYtoQ8RQcjIXJReGZWA) ☆☆☆ ### 必学原理 - [AST 抽象语法树](http://jartto.wang/2018/11/17/about-ast/) ☆☆ - [AST 与前端工程化实战](https://mp.weixin.qq.com/s/frZq6DBjK7TYV3hiqSUj3w) ☆☆ - [编译原理：从 0 写一个 js 解释器](https://zhuanlan.zhihu.com/p/137509746?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) ☆ ### PWA - [官网](https://developers.google.com/web/progressive-web-apps/) ☆☆ - [第一本 PWA 中文书](https://juejin.im/entry/5a1c394a5188255851326da5) ☆☆ - [PWA（Progressive Web App）初探总结](https://blog.csdn.net/qq_19238139/article/details/77531191) ☆ - [讲讲 PWA](https://segmentfault.com/a/1190000012353473) - [React 同构应用 PWA 升级指南](https://github.com/happylindz/blog/issues/14?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) ☆ - [9 amazing PWA secrets](https://www.creativebloq.com/features/9-amazing-pwa-secrets) ☆☆☆ - [awesome-progressive-web-apps](https://github.com/TalAter/awesome-progressive-web-apps) 打造 `PWA` 的资源集合 - [pwa.rocks](https://pwa.rocks/) 一些优秀的 `PWA` 集合 ### WebAssembly - [WebAssembly，Web 的新时代](http://blog.csdn.net/zhangzq86/article/details/61195685) ☆☆ - [来谈谈 WebAssembly 是个啥？为何说它会影响每一个 Web 开发者？](http://blog.csdn.net/wulixiaoxiao1/article/details/60581397) ☆ - [WebAssembly 系列（四）WebAssembly 工作原理](https://segmentfault.com/a/1190000008686643) ☆☆☆ - [如何评论浏览器最新的 WebAssembly 字节码技术？](https://www.zhihu.com/question/31415286) ☆☆ ### 小程序 - [快速上手小程序](http://jartto.wang/2018/01/25/quick-start-mini-programs/) ☆☆ - [细数小程序的坑](http://jartto.wang/2018/02/08/count-pit-of-mini-programs/) ☆☆ - [小程序开发 Tips](http://jartto.wang/2018/03/06/tips-of-mini-programs/) ☆☆ - [Taro 多端统一开发框架](https://github.com/NervJS/taro) ### Canvas - [玩转「Canvas」](https://juejin.im/post/5bfba4d6e51d452fd80f0f0d) ☆ - [Canvas 实现单机版贪吃蛇](https://juejin.im/post/5b115c54f265da6e65165aef?utm_source=gold_browser_extension) ☆☆☆ - [用 Canvas 画一个进度盘](https://juejin.im/post/5b25e3396fb9a00e7a3d5161?utm_source=gold_browser_extension) ☆☆ ### WebGL - [WebGL技术储备](http://taobaofed.org/blog/2015/12/21/webgl-handbook/) ☆☆ - [WebGL的实际使用](http://taobaofed.org/blog/2018/05/07/optimizing-page-performance-with-shader/) ☆☆ - [WebGL 3D版俄罗斯方块](http://www.cnblogs.com/xhload3d/p/9098386.html) ☆☆☆ ### SVG - [走进 SVG ](http://jartto.wang/2016/09/10/step-in-svg/) ☆☆ - [SVG 类库 snap.svg.js](http://snapsvg.io/) ☆☆ ### HTML5 - 初级 ☆ - [语义化](https://www.jianshu.com/p/b226910034f2) - [Audio 和 Video](https://www.w3school.com.cn/tags/html_ref_audio_video_dom.asp) - Web Storage - [HTML5 MDN](https://developer.mozilla.org/zh-CN/docs/Web/Guide/HTML/HTML5) - [HTML5 Tricks](https://www.html5tricks.com/category/html5-tutorials) - [HTML5 教程手册](https://www.html.cn/doc/html5/draganddrop/) - 中级 ☆☆ - 离线存储 - [HTML5 摄像头](http://jartto.wang/2017/11/28/h5-user-media/) - [HTML5 全屏](http://jartto.wang/2017/06/25/h5-fullscreen-api/) - [HTML5 拖放实现](http://jartto.wang/2017/10/23/html5-drag/) - [HTML5 全屏滑动组件](http://kele527.github.io/iSlider/) - [HTML5 之地理定位（Geolocation）](http://jartto.wang/2018/11/16/html5-geolocation/) - [HTML5 之消息通知（Web Notification）](http://jartto.wang/2018/10/30/html5-notification/) - [HTML5 之音频合成（SpeechSynthesis）](http://jartto.wang/2018/10/31/h5-SpeechSynthesis/) - [WebSocket](https://github.com/Pines-Cheng/blog/issues/37) - 高级 ☆☆☆ - Communication - Web Workder - [Web Worker](https://juejin.im/entry/5bcec53f6fb9a05cda77a347?utm_source=gold_browser_extension) - [Web Workers + 5 cases](https://blog.sessionstack.com/how-javascript-works-the-building-blocks-of-web-workers-5-cases-when-you-should-use-them-a547c0757f6a) - [Speedy Introduction to Web Workers](https://auth0.com/blog/speedy-introduction-to-web-workers/) - requestAnimationFrame - requestIdleCallback - 扩展 - [HTML5 API 大盘点](http://jartto.wang/2016/07/25/make-an-inventory-of-html5-api/) ☆☆ - [H5 页面滚动阻尼效果实现](https://juejin.im/post/5b24ffe3f265da59934b33f4?utm_source=gold_browser_extension) ### Elasticsearch - [Elasticsearch 官网](https://www.elastic.co/products/elasticsearch) - [基于 Elasticsearch 实现搜索建议](https://juejin.im/post/5b5a64c7518825620f57e907) ### Graphql - [graphql](https://graphql.cn/) - [apollo](https://www.apollographql.com/) - [apollo-blog](https://dev-blog.apollodata.com/) 需要翻墙 ### 模块化编程 - [CMD](https://github.com/seajs/seajs/issues/242) ☆ - [SeaJS](http://yslove.net/seajs/) ☆ - [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD) ☆ - [Requirejs](http://requirejs.org/docs/optimization.html) ☆ - [JS 模块化编程之彻底弄懂 CommonJS 和 AMD/CMD！](https://www.cnblogs.com/chenguangliang/p/5856701.html) ☆ - [AMD 和 CMD 的区别有哪些？](https://www.zhihu.com/question/20351507) ☆ ### 算法 - [前端数据结构与算法入门](https://mp.weixin.qq.com/s/UgLUXLJ6bSnQ2ZIZnTqLUg) ☆ - [算法练习](https://leetcode-cn.com/problemset/all/) ☆☆ - [JavaScript 算法与数据结构](https://github.com/trekhleb/javascript-algorithms/blob/master/README.zh-CN.md) ☆☆☆ - 算法入门 ☆☆ - [算法图解1 - 二分查找和大O表示法](http://jartto.wang/2018/11/22/algorithm1/) - [算法图解2 - 数组和链表](http://jartto.wang/2018/11/25/algorithm2/) - [算法图解3 - 递归，快排](http://jartto.wang/2018/11/26/algorithm3/) - [算法图解4 - 散列表](http://jartto.wang/2018/11/27/algorithm4/) - [算法图解5 - 图和广度优先搜索](http://jartto.wang/2018/11/28/algorithm5/) - [算法图解6 - 狄克斯特拉算法与贪婪算法](http://jartto.wang/2018/11/29/algorithm6/) - [算法图解7 - 动态规划](http://jartto.wang/2018/11/29/algorithm7/) - 贪心算法 - 动态规划 - 搜索 - 图论 - 计算几何 - 数学 - 大数问题 - 矩阵计算 - [十大经典排序算法动画](https://mp.weixin.qq.com/s/giubE_Jo1NhIqTteeOmj7g) ### 加密 - [初探加密算法](http://jartto.wang/2017/12/03/exploration-the-encryption/) ☆☆☆ - [算法分析](https://pan.baidu.com/s/1bYfdZx3o5vL6MRyCit8P8w) 密码: as75 ☆☆☆ - [程序员实用算法](https://pan.baidu.com/s/1O3iGlPfW-REEW6yRTKw9oQ) 密码: mmap ☆☆☆ - 对称加密 - DES ☆☆☆ - 3DES ☆☆☆ - TDEA ☆☆☆ - Blowfish ☆☆☆ - RC2 ☆☆☆ - RC4 ☆☆☆ - RC5 ☆☆☆ - IDEA ☆☆☆ - SKIPJACK ☆☆☆ - AES ☆☆☆ - 非对称加密 - RSA ☆☆☆ - ECC（移动设备用） ☆☆☆ - Diffie-Hellman ☆☆☆ - El Gamal ☆☆☆ - DSA（数字签名用） ☆☆☆ - Hash 加密 - MD2 ☆☆☆ - MD4 ☆☆☆ - MD5 ☆☆☆ - HAVAL ☆☆☆ - SHA ☆☆☆ - 综合实践 - [OAuth2.0 的四种授权方式](https://mp.weixin.qq.com/s/YaZvBvFx2Ccmw4C2287uog) ☆☆ ### 数据结构 - 分类 - 数组 - 栈 - 队列 - 链表 - 树 - 二叉树 - 图 - 堆 - 散列表 - 链表 - 单向链表 - 双向链表 - 环链表 - [Data Structures for Beginners](https://adrianmejia.com/blog/2018/04/28/data-structures-time-complexity-for-beginners-arrays-hashmaps-linked-lists-stacks-queues-tutorial/) ☆☆ ### 包管理 - npm ☆ - cnpm ☆ - yarn ☆ - homebrew ☆ - bower ☆ ### Python - 初级 ☆ - [Python 入门指南](http://www.runoob.com/manual/pythontutorial/docs/html/) - [Python 官方文档](https://www.python.org/) - Python 笔记 - [简单语法](http://jartto.wang/2018/06/24/learn-python-3/) - [常用操作](http://jartto.wang/2018/06/12/learn-python-2/) - [Open 文件操作](http://jartto.wang/2018/05/19/learn-python-1/) - ... - 中级 ☆☆ - [30s Python](http://python.kriadmin.me/) - [爬虫](https://github.com/facert/awesome-spider) - [Scrapy](http://scrapy-chs.readthedocs.io/zh_CN/0.24/intro/overview.html) - Web 框架 - Tornado - Jinja2 - Flask - Django - 高级 ☆☆☆ - [Cook Book](http://python3-cookbook.readthedocs.io/zh_CN/latest/) - 分布式 - Celery - 移动端 - Kivy - 数据分析 - Pandas - 可视化 - Matplotlib - Seaborn - Plotly - Bokeh - 机器学习 - Tensorflow - PyTorch - MxNet ### 数据库 - MySQL ☆☆☆ - Redis ☆☆☆ - [Redis 教程](http://www.runoob.com/redis/redis-tutorial.html) - [读完这篇，你一定能真正理解 Redis 持久化](https://mp.weixin.qq.com/s/pIb--1AaJa-RARpdZaNBmA) - Memcached ☆☆☆ - [Memcached 教程](http://www.runoob.com/memcached/memcached-install.html) - [三种基本的存储引擎比较](https://mp.weixin.qq.com/s/Iemp-8dKPGXli6GtRnzFaw) ☆☆☆ ### 设计模式 - [菜鸟-设计模式](http://www.runoob.com/design-pattern/design-pattern-tutorial.html) ☆☆ - [JavaScript 设计模式](https://juejin.im/entry/5b2929b351882574bd7edddd?utm_source=gold_browser_extension) ☆ - [常用的 Javascript 设计模式](http://blog.jobbole.com/29454/) ☆☆ - [23 种设计模式全解析](https://www.cnblogs.com/susanws/p/5510229.html) - 创建型模式 - 工厂方法 - 抽象工厂 - 建造者 - 原型 - 单例 - 结构型模式 - 适配器 - 桥接 - 组合 - 装饰器 - 外观 - 享元 - 代理 - 行为型模式 - 解释器 - 模板方法 - 责任链 - 命令 - 迭代器 - 中介者 - 备忘录 - 观察者 - 状态 - 策略 - 访问者 ### 网络协议 - TCP ☆☆☆ - UDP ☆☆☆ - [HTTP 协议入门](http://jartto.wang/2016/08/04/Rudimentary-http-protocol/) ☆ - [HTTP2](http://jartto.wang/2018/03/30/grasp-http2-0/) ☆☆☆ - HTTPS ☆☆ - [一个故事讲完 HTTPS](https://mp.weixin.qq.com/s/StqqafHePlBkWAPQZg3NrA) - [图文还原 HTTPS 原理](https://mp.weixin.qq.com/s/3NKOCOeIUF2SGJnY7II9hA) - 计算机网络的 7 层协议 ☆☆☆ ### CSS - 初级 ☆ - [CSS 3 简介](https://www.html.cn/doc/css3/what/) - [CSS 实用概要](http://jartto.wang/2018/03/06/outline-of-css/) - [CSS 实用 Tips](http://jartto.wang/2017/11/12/f2e-tips/) - [CSS 三大特性](http://jartto.wang/2017/02/08/css-features/) - 盒模型 - box-sizing - IconFont - [CSS 实现水平垂直居中的 10 种方式](https://juejin.im/post/5b9a4477f265da0ad82bf921?utm_source=gold_browser_extension) - 中级 ☆☆ - [BFC](https://zhuanlan.zhihu.com/p/25321647) - [Flex](http://www.runoob.com/w3cnote/flex-grammar.html) - [Grid layout](https://www.jianshu.com/p/441d60be7d8a) - [Flexbox vs Grid：基本概念](https://www.w3cplus.com/css/flexbox-vs-grid-basic-concepts-and-related-attributes.html) - [PostCSS](https://blog.csdn.net/beverley__/article/details/72963369) - 预编译 - [SASS](http://sass.bootcss.com/docs/sass-reference/) - [LESS](http://lesscss.cn/) - [Stylus](http://stylus-lang.com/) - CSS3 动画 - [Animate CSS](https://daneden.github.io/animate.css/?) - [All Animation CSS3](http://all-animation.github.io/) - [Transform](http://www.w3school.com.cn/cssref/pr_transform.asp) - [Translate](http://www.w3school.com.cn/cssref/pr_transform.asp) - [如何检测页面滚动并执行动画](http://jartto.wang/2016/08/18/detect-page-scroll-and-execute-animation/) - [移动端无缝滚动动画实现](https://juejin.im/post/5b2b4e3fe51d4558e15b97ed?utm_source=gold_browser_extension) - 高级 ☆☆☆ - [CSS3 动画原理](http://web.jobbole.com/83549/) - [探究 CSS 解析原理](http://jartto.wang/2017/11/13/Exploring-the-principle-of-CSS-parsing/) - [详谈层合成（composite）](http://jartto.wang/2017/09/29/expand-on-performance-composite/) - [CSS Modules 使用详解](https://blog.csdn.net/xiangzhihong8/article/details/53195926) - [Web 技巧 - 动画](https://juejin.im/post/5d2b49f3f265da1bcb4f5bab) ☆☆ - 扩展 - [30s CSS](https://atomiks.github.io/30-seconds-of-css/) ☆ - [新手引导动画的 4 种实现方式](https://juejin.im/post/5bac9bd0e51d450e516296d0) ### DOM - [JavaScript HTML DOM](http://www.w3school.com.cn/js/js_htmldom.asp) ☆☆ ### 函数式编程 - [什么是函数式编程思维？](https://www.zhihu.com/question/28292740) ☆☆☆ - [我眼中的 JavaScript 函数式编程](http://taobaofed.org/blog/2017/03/16/javascript-functional-programing/) ☆☆☆ - [防抖和节流原理分析](https://juejin.im/post/5b7b88d46fb9a019e9767405) - 参数个数 Arity - 高阶组件 Higher-Order Functions (HOF) - 偏应用函数 Partial Application - 柯里化 Currying - 闭包 Closure - 自动柯里化 Auto Currying - 函数合成 Function Composition - Continuation - 纯函数 Purity - 副作用 Side effects - 幂等 Idempotent - Point-Free Style - 断言 Predicate - 约定 Contracts - 范畴 Category - [JavaScript 函数式编程术语大全](http://www.css88.com/archives/7833) - ... ### 跨域 - [JSONP](https://www.zhihu.com/question/19966531) ☆☆ - [CORS](http://jartto.wang/2016/06/27/solutions-to-CORS/) ☆☆ - [Nginx](http://www.nginx.cn/4592.html) ☆☆ ### 事件模型 - 观察者模式 ☆☆ - DOM0 级模型 ☆☆ - IE 事件模型 ☆☆ - DOM2 级模型 ☆☆ - JQuery Event 模型 ☆☆ - [JS 事件模型](https://segmentfault.com/a/1190000006934031) ☆☆ ### 安全 - [如何防止 XSS 攻击？](https://juejin.im/post/5bad9140e51d450e935c6d64) - [Web 安全之 XSS 和 CSRF](http://jartto.wang/2017/12/15/xss-and-csrf/) ☆☆☆ - [Web 安全的三个攻防姿势](https://juejin.im/post/59e6b21bf265da43247f861d) ☆☆☆ - [XSS 的原理分析与解剖](http://netsecurity.51cto.com/art/201408/448305_all.htm) ☆☆☆ - [对于 XSS 和 CSRF 你究竟了解多少](http://netsecurity.51cto.com/art/201407/446775.htm) ☆☆☆ - [CSRF 攻击的应对之道](https://www.ibm.com/developerworks/cn/web/1102_niugang_csrf/) ☆☆☆ - SQL 注入 ☆☆☆ - HTTPS ☆☆☆ - 内网渗透 ☆☆☆ - DDos 攻击 ☆☆☆ - 点击劫持 ☆☆ - Session 劫持 ☆☆ - 短信接口攻击 ☆☆ - CC ### 前端规范 - [ESLint](https://eslint.org) ☆ - [JSHint](http://www.jslint.com) ☆ - [styleLint](https://stylelint.io/) ☆ - [EditorConfig](https://editorconfig.org/) - [Airbnb JavaScript](https://github.com/airbnb/javascript?utm_source=gold_browser_extension) ** - [项目规范化开发探索](https://www.notion.so/57b80f3f75b741e3a54546c20ae5e8e7) * - [看看这些被同事喷的 JS 代码风格你写过多少](https://juejin.im/post/5becf928f265da61380ec986) * - [谷歌工程实践 - Code Review 标准](https://jimmysong.io/eng-practices/docs/review/reviewer/standard/) ** ### Nginx - [Nginx](http://jartto.wang/2017/04/15/nginx-exception-handling/) ☆☆ - [Nginx 平滑的基于权重轮询算法分析](https://tenfy.cn/2018/11/12/smooth-weighted-round-robin/?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) ☆☆☆ - [Nginx](https://github.com/nginx/nginx) ☆☆☆ - [Nginx 解决跨域问题](http://www.nginx.cn/4592.html) ☆ - [关于负载均衡的一切](https://mp.weixin.qq.com/s/xvozZjmn-CvmQMAEAyDc3w) ☆☆ - [负载均衡的算法](https://mp.weixin.qq.com/s/fkYnkT6PW0I2MS2d2Nh1jg) ☆☆ - [几种常用负载均衡架构](https://developer.51cto.com/art/201904/595761.htm) ☆☆ ### Git - [Git 学习资源汇总](http://jartto.wang/2015/09/08/summarize-the-git/) ☆ - [Git 常规操作](http://jartto.wang/2017/12/01/git-common-operate/) ☆ - [如何配置 Git 对应多个 Repository](http://jartto.wang/2017/12/19/one-git-for-more-repository/) ☆ - [Git 实践系列一：初探](http://jartto.wang/2015/09/07/git-part-1/) ☆ - [Git 钩子的作用](https://git-scm.com/book/zh/v2/%E8%87%AA%E5%AE%9A%E4%B9%89-Git-Git-%E9%92%A9%E5%AD%90) ☆☆ - [Git pre-push hook](https://www.jianshu.com/p/7a10d4db97c0) ☆☆ - [你可能会忽略的 Git 提交规范](http://jartto.wang/2018/07/08/git-commit/) ☆ - [一个维护版本日志整洁的 Git 提交规范](https://juejin.im/post/5bf7b2e9e51d45213e57be92) - [git-flow](https://www.git-tower.com/learn/git/ebook/cn/command-line/advanced-topics/git-flow) ☆☆ - [git flow 的使用](https://www.cnblogs.com/lcngu/p/5770288.html) ☆☆ ### CDN - [什么是 CDN？](https://www.zhihu.com/question/37353035) ☆☆ - [CDN 带来这些性能优化](https://juejin.im/post/5d1385b25188253dc975b577?utm_source=gold_browser_extension) ☆☆☆ ### JS - 初级 ☆ - [JavaScript ES12 新特性抢先体验](https://mp.weixin.qq.com/s/T2IkxRp_PXkhk8T_ciLvjw) ☆ - [JS 标准参考教程](https://www.kancloud.cn/kancloud/javascript-standards-reference/46466) - [原型与原型链](https://github.com/mqyqingfeng/Blog/issues/2) - [作用域](https://github.com/mqyqingfeng/Blog/issues/3)与[作用域链](https://github.com/mqyqingfeng/Blog/issues/6) - [Event Loop](https://juejin.im/post/59e85eebf265da430d571f89) - 闭包 - [反思闭包](http://jartto.wang/2017/12/18/reflective-closure/) - [深入浅出 Javascript 闭包](https://juejin.im/post/5beee511e51d453b8e543ed6) - [call 和 apply](http://jartto.wang/2016/06/28/appreciation-of-the-call-and-apply/) - [正则表达式](http://jartto.wang/2016/07/03/js-regular-expression/) - [正则表达式真的很骚，可惜你不会写](https://juejin.im/post/5b96a8e2e51d450e6a2de115) - [XHR or Fetch API ?](http://jartto.wang/2017/01/17/xhr-or-fetch-api/) - [Understanding ECMAScript 6](https://oshotokill.gitbooks.io/understandinges6-simplified-chinese/content/chapter_1.html) - [为什么要有 ES6](https://github.com/jeyvie/thoughts/blob/master/docs/why_es6.md) - [introduction to ES6 by example](http://coenraets.org/present/es6/#0) - [ES6 标准入门](http://www.waibo.wang/bible/es6/) - [ECMAScript 6 - 阮一峰](http://javascript.ruanyifeng.com/advanced/ecmascript6.html#) - [浏览器同源政策及其规避方法](http://www.138dish.cn/web/same-origin-policy.html) - 中级 ☆☆ - [JS 模板引擎](http://jartto.wang/2016/09/15/grasp-a-js-template-engine/) - [前端路由跳转基本原理](https://juejin.im/post/5c52da9ee51d45221f242804?utm_source=gold_browser_extension) - 垃圾回收 - JS 内存 - [JS 内存管理](https://blog.sessionstack.com/how-javascript-works-memory-management-how-to-handle-4-common-memory-leaks-3f28b94cfbec) - [内存管理速成教程](https://hacks.mozilla.org/2017/06/a-crash-course-in-memory-management/) - 堆和栈 - 继承 - [掌握 JS Stack Trace](http://jartto.wang/2017/12/09/grasp-js-stack-trace/) - [ES6](http://es6.ruanyifeng.com) - [Generator](https://github.com/jeyvie/understanding-ES6/blob/master/docs/8.1_iterator_generator_base.md) - [ES6-Generator 函数](https://juejin.im/post/5b1751d551882513756f0bdc) - [Promise](https://github.com/jeyvie/understanding-ES6/blob/master/docs/11.Promise.md) - [How do Promises work under the hood?](https://blog.safia.rocks/post/170154422915/how-do-promises-work-under-the-hood) - [JavaScript Promise迷你书](http://liubin.org/promises-book/) - [Module](https://github.com/jeyvie/understanding-ES6/blob/master/docs/13.module.md) - [Class](https://github.com/jeyvie/understanding-ES6/blob/master/docs/9.class.md) - [JavaScript 引擎基础：Shapes 和 Inline Caches](https://juejin.im/entry/5b27a175e51d4558c23231dc?utm_source=gold_browser_extension) - [33 Concepts Every JavaScript Developer Should Know](https://github.com/leonardomso/33-js-concepts?utm_source=gold_browser_extension) - 高级 ☆☆☆ - TypeScript - [TypeScript 官网](https://www.tslang.cn) - [深入 TypeScript 的类型系统](https://zhuanlan.zhihu.com/p/38081852) - [TypeScript 总体架构](https://github.com/Microsoft/TypeScript/wiki/Architectural-Overview) - [TypeScript 完全手册](https://zhuanlan.zhihu.com/p/83689446?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) - [如何用 Decorator 装饰你的 Typescript？](https://mp.weixin.qq.com/s/0JTvJJNX4zwE3-Kl6dMvrA) - You-Dont-Know-JS - [Up & Going](https://github.com/getify/You-Dont-Know-JS/blob/master/up%20&%20going/README.md#you-dont-know-js-up--going) - [Scope & Closures](https://github.com/getify/You-Dont-Know-JS/blob/master/scope%20&%20closures/README.md#you-dont-know-js-scope--closures) - [this & Object Prototypes](https://github.com/getify/You-Dont-Know-JS/blob/master/this%20&%20object%20prototypes/README.md#you-dont-know-js-this--object-prototypes) - [Types & Grammar](https://github.com/getify/You-Dont-Know-JS/blob/master/types%20&%20grammar/README.md#you-dont-know-js-types--grammar) - [Async & Performance](https://github.com/getify/You-Dont-Know-JS/blob/master/async%20&%20performance/README.md#you-dont-know-js-async--performance) - [ES6 & Beyond](https://github.com/getify/You-Dont-Know-JS/blob/master/es6%20&%20beyond/README.md#you-dont-know-js-es6--beyond) - [exploring ES6](http://exploringjs.com/es6/) - JavaScript 如何工作 - [对引擎、运行时、调用堆栈的概述](https://juejin.im/post/5a05b4576fb9a04519690d42) - [在 V8 引擎里 5 个优化代码的技巧](https://github.com/xitu/gold-miner/blob/master/TODO/how-javascript-works-inside-the-v8-engine-5-tips-on-how-to-write-optimized-code.md) - [内存管理 + 处理常见的4种内存泄漏](https://github.com/xitu/gold-miner/blob/master/TODO/how-javascript-works-memory-management-how-to-handle-4-common-memory-leaks.md) - [内存管理速成教程](https://mp.weixin.qq.com/s/sVcGRUZqILCVgfhzRyODTg) - [事件循环和异步编程的崛起 + 5个如何更好的使用 async/await 编码的技巧](https://github.com/xitu/gold-miner/blob/master/TODO/how-javascript-works-event-loop-and-the-rise-of-async-programming-5-ways-to-better-coding-with.md) - [深入剖析 WebSockets 和拥有 SSE 技术 的 HTTP/2，以及如何在二者中做出正确的选择](https://github.com/xitu/gold-miner/blob/master/TODO/how-javascript-works-deep-dive-into-websockets-and-http-2-with-sse-how-to-pick-the-right-path.md) - [对比 WebAssembly + 为什么在某些场景下它比 JavaScript 更合适](https://github.com/xitu/gold-miner/blob/master/TODO1/how-javascript-works-a-comparison-with-webassembly-why-in-certain-cases-its-better-to-use-it.md) - [Web Worker 的内部构造以及 5 种你应当使用它的场景](https://github.com/xitu/gold-miner/blob/master/TODO/how-javascript-works-the-building-blocks-of-web-workers-5-cases-when-you-should-use-them.md) - 扩展 - [何谓 JS 挖矿](http://jartto.wang/2017/11/08/js-dig-ore/) ☆ - [30S JS](https://github.com/Chalarangelo/30-seconds-of-code) ☆☆ - [33 Concepts Every JavaScript Developer Should Know ](https://github.com/leonardomso/33-js-concepts?utm_source=gold_browser_extension#1-call-stack) - [ES6 语法侦测](https://github.com/ruanyf/es-checker) ☆ - [初探 performance – 监控网页与程序性能](https://www.cnblogs.com/zhuyang/p/4789020.html) - [新手引导动画的4种实现方式](https://juejin.im/post/5bac9bd0e51d450e516296d0) ☆ ### Linux - ls/cd/rm/cat/chmod/chown/useradd/df/du/ps/top/head/tail ☆☆ - [Linux](http://jartto.wang/2016/06/24/linux-common-operation/) ☆☆ - [掌握 Linux 命令 Grep ](http://jartto.wang/2016/10/12/grasp-linux-grep/) ☆☆ - [Linux 实用命令](http://jartto.wang/2016/11/02/linux-common-command/) ☆☆ - [Mac 下查看端口占用情况](http://jartto.wang/2016/09/28/check-the-system-port-of-mac/) ☆☆ - [程序员必备的 Linux 基础知识](https://juejin.im/post/5b3b19856fb9a04fa42f8c71) ☆☆ - 网络操作 - curl - netstat - lsof - ifconfig - ssh - tcpdump - iptables - grep ☆☆ - sed ☆☆ - awk ☆☆☆ - [commander 将介绍如何利Javascript做为服务端脚本](http://blog.fens.me/nodejs-commander/) - chalk 命令行彩色输出 - [chokidar node文件监控](https://www.npmjs.com/package/chokidar) ### Electron - [初探 Electron - 理论篇](http://jartto.wang/2018/01/03/first-exploration-electron/) ☆☆ - [初探 Electron - 升华篇](http://jartto.wang/2018/01/04/first-exploration-electron-2/) ☆☆ - [初探 Electron - 实践篇 1](http://jartto.wang/2018/01/14/first-exploration-electron-3/) ☆☆ - [初探 Electron - 实践篇 2](http://jartto.wang/2018/01/21/first-exploration-electron-4/) ☆☆ ### 抓包工具 - [Fiddler](https://www.telerik.com/fiddler) ☆☆ - [Charles](https://www.charlesproxy.com) ☆☆ - [HttpWatch](http://www.oneapm.com/lp/bihttpwatch) ☆☆ - [spy-debugger](https://github.com/wuchangming/spy-debugger) ☆☆ - 模拟请求 - [Postman](https://www.getpostman.com) ☆☆ ### 测试 - 单元测试 - Jest ☆☆☆ - [Jasmine](https://jasmine.github.io/) ☆☆☆ - [mocha](https://segmentfault.com/a/1190000011362879) ☆☆☆ - [chai](http://www.chaijs.com/api/assert/) ☆☆☆ - [Karma](http://karma-runner.github.io/2.0/index.html) ☆☆☆ - 软件测试 - [你了解软件测试吗？](http://jartto.wang/2017/11/02/grasp-testing/) ☆☆ - 自动化测试 - [selenium_webdriver](https://www.yiibai.com/selenium/selenium_webdriver.html) ☆☆ - [Appium移动自动化测试](https://www.cnblogs.com/fnng/p/4540731.html) ☆☆ - [Appium移动自动化测试](https://www.cnblogs.com/fnng/p/4540731.html) ☆☆ - [UI 自动化测试](https://github.com/AirtestProject/Airtest) ☆☆☆ >网易UI自动化测试框架，开源的，结合AI，自动更新测试用例、自我学习和需求沉淀。智能测试方向！！！！ - 应用 - [React单元测试策略及落地](https://insights.thoughtworks.cn/react-strategies-for-unit-testing/?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) - [使用 Jest 和 Enzyme 测试 React 组件](https://mp.weixin.qq.com/s/isZLVenQrAUzA77O4TYVfQ) ### 容器化 - Docker - [Docker 边学边用](http://jartto.wang/2020/07/04/learn-docker/) ☆☆ - [Docker 构建统一的前端开发环境](https://juejin.im/post/5b127087e51d450686184183?utm_source=gold_browser_extension) ☆☆ - [私服推荐 Nexus](http://dockone.io/article/2168) ☆☆☆ - [大型企业级推荐 harbor](https://blog.csdn.net/mideagroup/article/details/52053402) ☆☆☆ - [Docker 底层技术](https://www.jianshu.com/p/7a1ce51a0eba?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) ☆☆☆ - [精简 Docker 镜像的五种通用方法](https://mp.weixin.qq.com/s/tMVK62zggVwaqfPsiYGaBg) - K8s - [什么是 Kubernetes ](https://mp.weixin.qq.com/s/NqBb4FG5cVkoUkqQu7XOlg) ☆☆ - [Kubernetes 架构简介](https://mp.weixin.qq.com/s/WUntex914F98gDo-bnchLA) ☆☆ - [一文了解 Kubernetes](http://jartto.wang/2020/07/15/start-k8s/) ☆☆☆ - [Jenkins](https://jenkins.io) ☆☆☆ - [前端AB实验设计思路与实现原理](https://fed.taobao.org/blog/taofed/do71ct/frontend-ab-test) ☆☆☆ ### DNS - [DNS 缓存中毒](https://www.toutiao.com/a6652593929738781195/?tt_from=weixin&utm_campaign=client_share&wxshare_count=1&timestamp=1548950293&app=news_article&utm_source=weixin&iid=59860639007&utm_medium=toutiao_ios&group_id=6652593929738781195) - [例解 DNS 递归/迭代名称解析原理](http://blog.chinaunix.net/uid-10659021-id-3903144.html) ☆☆☆ - [浏览器输入网址后台是如何运作的](http://www.chinaz.com/web/2013/0228/293980.shtml) ☆☆ ### 监控 - [APM](https://github.com/f2e-awesome/monitoring/blob/master/README.md) ☆☆ - [前端错误日志收集方案](https://juejin.im/post/5bd2dbc7f265da0af16183f8?utm_source=gold_browser_extension) ☆ - [前端性能监控系统](https://juejin.im/entry/5b78f88be51d4538a01e9f36) ☆☆ - [前端代码异常监控实战](https://github.com/happylindz/blog/issues/5) ☆☆ - [前端一站式异常捕获方案](https://jixianqianduan.com/frontend-weboptimize/2018/02/22/front-end-react-error-capture.html) ☆☆ - [前端错误收集](https://juejin.im/post/5be2b0f6e51d4523161b92f0) ☆☆ - [如何精确统计页面停留时长](https://techblog.toutiao.com/2018/06/05/ru-he-jing-que-tong-ji-ye-mian-ting-liu-shi-chang/) ☆ - [如何优雅处理前端异常？](http://jartto.wang/2018/11/20/js-exception-handling/) ☆ - [解决 Script Error 的另类思路](https://juejin.im/post/5c00a405f265da610e7fd024) ☆☆ - [大前端时代前端监控的最佳实践](https://www.evernote.com/l/AUQuMjXPG6RBfaeWb_Y17fVmILKyZmLwgow) ☆☆☆ - [前端性能监控：window.performance](https://juejin.im/entry/58ba9cb5128fe100643da2cc) ### 数据可视化 - 图表 ☆☆ - [echarts](http://echarts.baidu.com/option.html#xAxis) - [highcharts](https://www.highcharts.com/products/highcharts/) - [g2](https://antv.alipay.com/g2/demo/index.html) - 地图 ☆☆ - [Google Map](https://developers.google.com/maps/documentation/javascript/examples/user-editable-shapes?hl=zh-cn) - [Mapbox](https://www.mapbox.com/) - [高德](http://lbs.amap.com/) - [百度](http://api.map.baidu.com/) - [腾讯](http://lbs.qq.com/) - [蜂鸟室内地图](https://www.fengmap.com/) - 埋点统计 ☆☆ - [揭开 JS 无埋点技术的神秘面纱](https://mp.weixin.qq.com/s/pGP5Oohcban0P1GAzPlAgg) ### 浏览器 - [再谈 IE 浏览器兼容问题](http://jartto.wang/2016/12/06/talk-about-ie-compatible-over-again/) ☆☆ - [图解浏览器的基本工作原理](https://zhuanlan.zhihu.com/p/47407398) ☆☆ - [what-happens-when](https://github.com/alex/what-happens-when)(输入 URL 后浏览器发生了什么) ☆☆ - [浏览器工作原理](https://www.html5rocks.com/en/tutorials/internals/howbrowserswork/) ☆☆☆ - [渲染进程的内部工作原理](https://developers.google.com/web/updates/2018/09/inside-browser-part3) ☆☆☆ - [Compositor 是如何来提高交互性能的？](https://developers.google.com/web/updates/2018/09/inside-browser-part4) ☆☆☆ - [浏览器内核渲染：重建引擎](https://juejin.im/post/5bbaa7da6fb9a05d3761aafe) - [Chrome Devtools](https://medium.com/@tomsu/devtools-tips-day-1-the-console-dollars-3aa0d93e923c) ☆☆☆ - [Chrome插件(扩展)开发全攻略](https://mp.weixin.qq.com/s/waUg3hx5HsRkyiitJdHudg) ☆ ### 前端工程化 - [Web 研发模式演变](https://github.com/lifesinger/blog/issues/184) ☆☆ - [我们是如何做好前端工程化和静态资源管理](https://aotu.io/notes/2016/07/19/A-little-exploration-of-front-end-engineering/index.html) 京东 ☆☆☆ - [百度 fis](http://fis.baidu.com/fis3/docs/beginning/intro.html) ☆☆ - [Scrat](http://scrat-team.github.io/#!/quick-start) ☆☆ - [Grunt](http://www.gruntjs.net/) ☆☆ - Gulp ☆☆ - [Gulp](https://www.gulpjs.com.cn/) - [Gulp 4](https://fettblog.eu/gulp-4-parallel-and-series/) - Webpack - [Webpack 4](https://juejin.im/post/5af8fa806fb9a07ac162876d) ☆☆☆ - [Webpack 4 配置最佳实践](https://juejin.im/post/5b304f1f51882574c72f19b0?utm_source=gold_browser_extension) - [如何十倍提高你的 webpack 构建效率](https://blog.csdn.net/u011413061/article/details/51872412?from=timeline&isappinstalled=0) ☆☆☆ - webpack 性能优化 - [减小前端资源大小](https://github.com/yued-fe/y-translation/blob/master/en/Web-Performance-Optimization-with-webpack/Introduction.md) ☆☆ - [利用好持久化缓存](https://github.com/yued-fe/y-translation/blob/master/en/Web-Performance-Optimization-with-webpack/Make-Use-of-Long-term-Caching.md) ☆☆☆ - [监控和分析应用](https://github.com/yued-fe/y-translation/blob/master/en/Web-Performance-Optimization-with-webpack/Monitor-and-analyze-the-app.md) ☆☆☆ - Rollup - [Browserify](http://browserify.org/) ☆☆ - [Parcel](http://jartto.wang/2017/12/11/chattered-about-parcel/) ☆☆ - Babel - [Babel 插件手册](https://github.com/jamiebuilds/babel-handbook/blob/master/translations/zh-Hans/plugin-handbook.md) - [babel-runtime 使用与性能优化](https://juejin.im/entry/5b108f4c6fb9a01e5868ba3d?utm_source=gold_browser_extension) - [babel-polyfill 使用与性能优化](https://juejin.im/entry/5b108f866fb9a01e49293627?utm_source=gold_browser_extension) - [什么是 Kubernetes？](https://mp.weixin.qq.com/s/NqBb4FG5cVkoUkqQu7XOlg) ☆☆ - [有赞前端质量保障体系](https://juejin.im/post/5d24096ee51d454d1d6285a1?utm_source=gold_browser_extension) ☆☆☆ - [前端工程实践之可视化搭建系统](https://www.zoo.team/article/luban-one?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) ☆☆ - [前端项目代码质量保障秘藉](https://mp.weixin.qq.com/s/djEyX7zxl51PcYcmP0zfyQ) ☆ ### 物联网 - [ruff](https://baike.baidu.com/item/ruff/19726288?fr=aladdin) ☆☆☆ - [ruff入门应用开发](https://www.imooc.com/learn/958) ☆☆☆ - [要想成为一名物联网工程师，需要学习哪些知识？](https://www.zhihu.com/question/31381245)☆ ### 消息队列 - [消息队列常见的 5 个应用场景](https://juejin.im/entry/5b59ce60e51d45198469a003) - ActiveMQ - RabbitMQ - ZeroMQ - Kafka - [了解 Kafka](http://jartto.wang/2018/10/12/about-kafka/) ☆☆ - [Kafka 入门](https://www.cnblogs.com/likehua/p/3999538.html) ☆☆ - [Kafka的架构原理，你真的理解吗？](https://mp.weixin.qq.com/s/kzM19BcDzRk1PpEMadEluA) ☆☆☆ - MetaMQ - RocketMQ - [消息队列mq总结](https://blog.csdn.net/HD243608836/article/details/80217591) ☆☆ - [缓存淘汰算法--LRU算法](https://www.evernote.com/shard/s324/sh/13a3bb3f-372b-4a93-a980-95b4cc225a46/a383727c1d79df40) ☆☆☆ >这个是各种消息队列的框架的核心算法，都是这个算法的变形 ### V8 引擎 - [Google V8 引擎运用了哪些优秀的算法？](https://www.zhihu.com/question/22498967) ☆☆☆ - [V8 引擎详解](https://blog.csdn.net/swimming_in_it_/article/details/78869549) ☆☆☆ - [Google V8](https://github.com/v8/v8) ☆☆☆ - [V8 并发标记](https://mp.weixin.qq.com/s/pv_4YRo6KjLiVxLViZTr2Q) ☆☆☆ - [V8 引擎的 5 个优化技巧](https://blog.sessionstack.com/how-javascript-works-inside-the-v8-engine-5-tips-on-how-to-write-optimized-code-ac089e62b12e) ☆☆☆ ### DevOps - [DevOps 简介](http://jartto.wang/2018/11/30/about-devops/) ☆ - [猪八戒网的 DevOps 进化论](https://mp.weixin.qq.com/s/I7hRbZrw1QsS0UP4RZIHOw) ☆☆ ### 微前端 - [了解什么是微前端](https://mp.weixin.qq.com/s/kZ3GMg0vXQwof8SX8u2EuA) ☆ - [为什么大公司一定要使用微服务？](https://mp.weixin.qq.com/s/-lxNpu89A9uN_a8f2MiKMw) ☆ - [微前端如何落地？](https://juejin.im/post/5d1d8d426fb9a07efe2dda40) ☆☆☆ - [用微前端的方式搭建类单页应用](https://tech.meituan.com/2018/09/06/fe-tiny-spa.html) ☆☆ - [Bifrost微前端框架及其在美团闪购中的实践](https://mp.weixin.qq.com/s/GgVo5KyZPlEsEeICcPyuLA) ☆☆ - [张克军：微前端架构体系](https://mp.weixin.qq.com/s/OEfRPKuPmBKvJdD_zMgFuQ) ☆☆☆ - [EMP for Vue&React 互相远程调用](https://mp.weixin.qq.com/s/KKZYzzTFBVD-rJeWr3Z7cg) ☆☆ - [字节跳动是如何落地微前端的](https://juejin.cn/post/7016900744695513125?utm_source=gold_browser_extension)☆☆☆ ### LowCode - [国内低代码平台](https://github.com/taowen/awesome-lowcode) ☆☆☆ ### 主流框架 - Angular - [依赖注入](http://jartto.wang/2014/04/24/angularjs-part-7/) ☆ - [指令 Directive](http://jartto.wang/2014/04/28/angularjs-part-9/) ☆☆ - [剖析 Angularjs 语法](http://jartto.wang/2018/02/01/analysis-of-angularjs/) ☆☆ - [build-your-own-angularjs](https://github.com/teropa/build-your-own-angularjs) - [Vue](https://cn.vuejs.org/) - [Mint-UI](http://mint-ui.github.io/#!/zh-cn) ☆ - [Element.UI](http://element.eleme.io/#/zh-CN/guide/design) ☆ - [VUE2](https://cn.vuejs.org/v2/guide/) ☆☆ - [VUEX](https://vuex.vuejs.org/) ☆☆ - [Nuxtjs](https://www.sitepoint.com/nuxt-js-universal-vue-js/) ☆ - [Nuxtjs 2.0 升级爬坑](http://jartto.wang/2019/04/23/update-nuxt2-0/) ☆ - [Axios](https://www.jianshu.com/p/df464b26ae58) ☆ - Vue-Router - [Vue-Router 实现原理](https://juejin.im/post/5b10b46df265da6e2a08a724?utm_source=gold_browser_extension) ☆☆☆ - Vue-Loader ☆☆ - [Vue.js 技术揭秘](https://ustbhuangyi.github.io/vue-analysis/) ☆☆☆ - React - 脚手架 ☆ - Create React App - Codesandbox - Rekit - [30 seconds of React](https://github.com/30-seconds/30-seconds-of-react) ☆☆ - [How Does React Tell a Class from a Function?](https://overreacted.io/how-does-react-tell-a-class-from-a-function/) ☆☆ - [Ant Design](http://jartto.wang/2016/12/14/together-to-learn-ant-design-of-react/) ☆☆ - 虚拟 Dom ☆☆ - Diff 算法 ☆☆☆ - [react-app-rewired](https://github.com/timarney/react-app-rewired) - Dva ☆☆ - [探路 Roadhog](http://jartto.wang/2017/04/25/gating-roadhog/) ☆☆ - Redux - [深入理解 Redux 中间件](https://juejin.im/post/5b237569f265da59bf79f3e9?utm_source=gold_browser_extension) ☆☆☆ - [Redux 中文文档](https://github.com/camsong/redux-in-chinese) ☆☆ - [Redux-Saga](https://github.com/superRaytin/redux-saga-in-chinese) ☆☆☆ - TakeLatest ☆☆☆ - [React 16 新特性](https://baijiahao.baidu.com/s?id=1582848543674223747&wfr=spider&for=pc) ☆☆ - React-Router@4 ☆☆ - [React 性能优化](http://www.css88.com/react/docs/optimizing-performance.html) ☆☆☆ - [21 项优化 React App 性能的技术](https://mp.weixin.qq.com/s/PSYm43GkIR9tZVWpAEWrNA) - [浅谈React性能优化的方向](https://zhuanlan.zhihu.com/p/74229420?utm_source=wechat_session&utm_medium=social&utm_oi=26811677278208&s_r=0) - React Hooks - [30分钟精通 React Hooks](https://juejin.im/post/5be3ea136fb9a049f9121014) ☆☆ - [React Hooks-概览](https://juejin.im/post/5c31ccc8f265da6170074785?utm_source=gold_browser_extension) ☆☆ - [UmiJS](http://jartto.wang/2018/05/24/taste-of-umi/) ☆☆ - Next.js ☆☆ - [Next.js 使用指南1－基本规则](http://jartto.wang/2018/05/27/nextjs-1/) - [Next.js 使用指南2－路由与加载](http://jartto.wang/2018/06/01/nextjs-2/) - [Next.js 使用指南3－高级配置](http://jartto.wang/2018/06/08/nextjs-3/) - [Ts + React + Mobx 实现移动端浏览器控制台](https://juejin.im/post/5bf278295188252e89668ed2?utm_source=gold_browser_extension#comment) - [阿里飞冰组件库](https://alibaba.github.io/ice/) ☆☆ - 单测 - [React单元测试策略及落地](https://insights.thoughtworks.cn/react-strategies-for-unit-testing/?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) - [使用 Jest 和 Enzyme 测试 React 组件](https://mp.weixin.qq.com/s/isZLVenQrAUzA77O4TYVfQ) - 应用 - [构建大型React应用程序的最佳实践](https://mp.weixin.qq.com/s/XspWR3e7Jm38Q-HJm2Ntvw) ### 架构 - [前端架构师入门技能图谱](https://mp.weixin.qq.com/s/fYC1VHibhOoxBpm8NShGWQ) ☆ - [架构师成神路线图](https://mp.weixin.qq.com/s/X_F_8OfbBDHWcUTPY2THrA) ☆☆ - [成为一名架构师得学习哪些知识？](https://mp.weixin.qq.com/s?__biz=MzUyNDkzNzczNQ==&mid=2247485986&idx=1&sn=a4fff71f0138861975865ecd97981c7c&chksm=fa24f54acd537c5c00cca8458698c801d9a7ca62e2feb1044a1424e3b8c8f9a51dd0540f7f13&token=93419027&lang=zh_CN#rd) ☆☆ - [如何画好架构图？](https://mp.weixin.qq.com/s/cqC6djHHjeFzCpFPlJGhxQ) ☆☆ - [Node.js 微服务实践](https://mp.weixin.qq.com/s?__biz=MzAxODE2MjM1MA==&mid=2651556001&idx=1&sn=601d58dc247d2f9c6f239ed8d950b540&chksm=80255f60b752d676860f98ae5523f018800ed91c24dd19afa1004a97a7bc114df02ca84498ca&xtrack=1&scene=0&subscene=131&clicktime=1552693183&ascene=7&devicetype=android-26&version=2700033b&nettype=cmnet&abtest_cookie=BAABAAoACwASABMABQAmlx4AVpkeAMyZHgDamR4A3JkeAAAA&lang=zh_CN&pass_ticket=58OgcYwPpZPMoZMSeUS45Kh9d%2Fe0tCefEY4WSDl%2BzJM%3D&wx_header=1) ☆☆☆ - [如何设计微服务](https://mp.weixin.qq.com/s?__biz=MjM5MDE0Mjc4MA==&mid=2651014354&idx=2&sn=9a356f184842908ab5004bdcfef1caac&chksm=bdbebc818ac935977deb94e3f139ce12c17afc4613d5a2535ede91470d9637471c8317c53f4e&mpshare=1&scene=1&srcid=0315aRwo0BPnixJWFnXKlR80#rd) ☆☆☆ - [各大互联网公司架构演进之路汇总](https://mp.weixin.qq.com/s/K531MIiOWIAvy4sFcbajrQ) ☆☆☆ - [开发十年，我是如何成长为一名优秀的架构师](https://mp.weixin.qq.com/s/8o4OwgdGwv4g5vUVj-1vfw) ☆☆☆ - [淘宝从几百到千万级并发的十四次架构演进之路](https://mp.weixin.qq.com/s/a1xUMOOfgCMzcngQ9xNCGw) ☆☆☆ - [设计图都不会画，还想做架构师？](https://maimai.cn/article/detail?fid=1063405301&efid=yh3ExpigfgCbJagBxj6dXw) ☆☆ - [12306的技术架构](https://mp.weixin.qq.com/s/Ty49SAs0hxpy_fbwPHBflA) ☆☆☆ - [一文读懂架构整洁之道](https://mp.weixin.qq.com/s/XAm1MO4RQYtkj3ay-2jT7A) ☆☆☆ - [如何推动基础架构项目落地](https://zhuanlan.zhihu.com/p/148209120?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io) ☆☆ ### AI - [机器学习模型一览：监督型、半监督型和无监督型](https://mp.weixin.qq.com/s/NQpB_jTl43ft7O02_EXHkw) ☆☆☆ - [如何在 1 秒内做到大数据精准去重？](https://mp.weixin.qq.com/s/XzVT6K3B3XfgnmTVSrchiA) ☆☆☆ - [大数据学习资源(Awesome Big Data)](https://mp.weixin.qq.com/s/wnvIADv7GXa6fFjpnzjzXQ) ☆☆☆ - [Tensorflow.js生态](https://mp.weixin.qq.com/s/LQ8mpNc5_8pU0y9LWfQXjw) ☆☆ ### 面试 - [30s 面试](https://github.com/fejes713/30-seconds-of-interviews#table-of-contents) ☆ - [面试精选之 http 缓存](https://juejin.im/post/5b3c87386fb9a04f9a5cb037#comment) ☆☆ - [张一鸣：10年面试2000人，我发现混的好的人，全都有同一个特质](https://mp.weixin.qq.com/s/S9_H4JXslq2_8GxEXVgg3w) ☆ - [2019 年前端面试都聊啥](https://juejin.im/post/5bf5610be51d452a1353b08d?utm_source=gold_browser_extension) ☆☆ - [BAT 面试总结](https://juejin.im/post/5befeb5051882511a8527dbe) ☆☆ - [JavaScript 深入之 bind 的模拟实现](https://juejin.im/post/59093b1fa0bb9f006517b906) ☆☆ - [前端面试官的套路，你懂吗？](http://jartto.wang/2019/01/06/f2e-interview/) ☆☆ - [前端 100 问](https://juejin.im/post/5d23e750f265da1b855c7bbe) - [一个 TCP 连接上面能发多少个 HTTP 请求](https://www.toutiao.com/a6706021767074284043/?tt_from=weixin&utm_campaign=client_share&wxshare_count=1&timestamp=1561608618&app=news_article&utm_source=weixin&utm_medium=toutiao_ios&req_id=20190627121018010027057145257B9C2&group_id=6706021767074284043) - [彻底弄懂前端路由](https://juejin.im/post/5d2d19ccf265da1b7f29b05f?utm_source=gold_browser_extension) ### 前端组织 - [360奇舞团](https://75team.com/) - [腾讯Web前端团队（Alloy Team）](http://www.alloyteam.com/) - [百度Web 前端研发部（FEX）](http://fex.baidu.com/) - [淘宝前端团队（FED）](http://taobaofed.org/) - [大搜车无线团队](http://f2e.souche.com/) - [京东凹凸实验室](https://aotu.io/index.html) - [蚂蚁金服·数据体验技术团队](https://juejin.im/user/59659aff5188250cf956e6dd/posts) - [前端精读周刊](https://github.com/dt-fe/weekly) - [淘系前端团队](https://tophub.today/n/x9ozQE6eXb) ### 学习网站 - [Freecodecamp](https://www.freecodecamp.org/) - [CodePen](https://codepen.io/) - [算法练习](https://leetcode-cn.com/problemset/all/) - [Pluralsight](https://www.pluralsight.com/codeschool) - [Code School](https://www.codeschool.com/) - [慕课网](https://www.imooc.com/) - [妙味课堂](https://miaov.com/) - [百度传课](https://chuanke.baidu.com/course/_webapp_____.html) ### 技术杂谈 - [一个程序员的成长之路 - 剖析别人，总结自己](https://mp.weixin.qq.com/s/zWPjfHiYxx0HH9lE99Yijw) ☆☆☆ > 张云龙，全民直播CTO，也是个前端工程师 - [秒杀系统优化思路](https://blog.csdn.net/csdn265/article/details/51461466) ☆☆☆ >尽量将请求拦截在系统上游（越上游越好）, 读多写少的常用多使用缓存（缓存抗读压力） - [客户端高可用建设体系](https://juejin.im/post/5b10afc06fb9a01e39624d3d?utm_source=gold_browser_extension) >2000万日订单背后：美团外卖客户端高可用建设体系 - [缓存架构设计](https://mp.weixin.qq.com/s/YxGeisz0L9Ja2dwsiZz01w) ☆☆☆ >微博应对日访问量百亿级的缓存架构设 - [前端重构方案](https://mp.weixin.qq.com/s/H9Dvm_5F8hdBrZynlNdlfw) ☆☆ >规范、技术选型、性能优化、构建工具、开发效率 - [Taro - 多端开发框架](https://juejin.im/entry/5b19155bf265da6e083be667?utm_source=gold_browser_extension) ☆☆ >京东多端统一开发框架 - Taro - [你可能不知道的前端知识点](https://github.com/justjavac/the-front-end-knowledge-you-may-not-know) ☆☆ - [V8 并发标记](https://mp.weixin.qq.com/s/pv_4YRo6KjLiVxLViZTr2Q) ☆☆☆ >引擎V8推出“并发标记”，可节省60%-70%的GC时间 - [JS 的数据结构](https://www.jianshu.com/p/5e0e8d183102) ☆☆ >谁说前端就不需要学习数据结构了？ - [简话开源协议](http://jartto.wang/2018/06/29/talk-about-license/) ☆ >了解开源协议，选择最合适的协议 - [把前端监控做到极致](https://juejin.im/entry/5b3ed06d6fb9a04fe727e671?utm_source=gold_browser_extension) ☆☆ >从 采集、数据处理、分析、报警 4 个维度进一步阐述如何把前端监控做到极致 - [设计一个百万级的消息推送系统](https://juejin.im/post/5ba97ff95188255c9e02d3e3) ☆☆☆ >百万连接其实只是一个形容词，更多的是想表达如何来实现一个分布式的方案，可以灵活的水平拓展从而能支持更多的连接。 - [蚂蚁金服核心技术：百亿特征实时推荐算法揭秘](https://mp.weixin.qq.com/s/6h9MeBs89hTtWsYSZ4pZ5g) >文章提出一整套创新算法与架构，通过对TensorFlow底层的弹性改造，解决了在线学习的弹性特征伸缩和稳定性问题，并以GroupLasso和特征在线频次过滤等自研算法优化了模型稀疏性 - [前端登录，这一篇就够了](https://mp.weixin.qq.com/s?__biz=MzIxNTQ2NDExNA==&mid=100000675&idx=1&sn=0cae464adcc549b239c28199f675e6d1&chksm=1796a27e20e12b68815429681d016430fccda916c573941d9e37d9366987295ccce6394db5c7#rd) >文章列举了常见的登录方式，清晰易懂：Cookie + Session 登录、Token 登录、SSO 单点登录、OAuth 第三方登录 ### 优化 - 初级 ☆ - 图片资源 - [WebP 在项目中的实践](https://www.jianshu.com/p/73ca9e8b986a) - 代码合并 - 压缩 - 混淆 - Css sprits - 减少 HTTP 请求 - Gzip - [GZIP 的压缩原理与日常应用](https://juejin.im/post/5b793126f265da43351d5125) ☆☆☆ - Keep-Alive - DNS - 中级 ☆☆ - [图像优化原理](https://mp.weixin.qq.com/s/7aK6D0InyJs-BXUcaormKA) - [高性能网站建设的 14 个原则](http://www.cnblogs.com/mdyang/archive/2011/07/12/high-performance-web-sites.html) - [Web 优化之 Request](http://jartto.wang/2018/02/09/optimise-for-web-request/) - [如何优化高德地图（AMap）Marker 动画](http://jartto.wang/2017/08/28/how-to-optimize-marker-of-AMap/) - [Web前端优化及工具集锦](https://www.csdn.net/article/2013-09-23/2817020-web-performance-optimization) - [搜索引擎优化 SEO](https://juejin.im/post/5b163fab5188257d571f1d17?utm_source=gold_browser_extension) - 高级 ☆☆☆ - [彻底弄懂 HTTP 机制及原理](https://www.cnblogs.com/chenqf/p/6386163.html) - 缓存 - [HTML5 离线存储](http://jartto.wang/2016/07/25/make-an-inventory-of-html5-api/) - HTML 和 HTTP 头文件设置 - [HTTP 缓存](https://juejin.im/post/5b3c87386fb9a04f9a5cb037#comment) - [Meta](http://laoono.com/2016-05/html-meta-cache.html) - Expires - Cache-Control - Last-Modified / If-Modified-Since - Etag / If-None-Match - Nginx 缓存 - [关键路径渲染优化](https://juejin.im/entry/5b16a05fe51d4506b01106d9) - [关键渲染路径](https://juejin.im/post/5c3333036fb9a049f1545d27) - [前端性能优化——关键渲染路径](https://segmentfault.com/a/1190000013767948) 👍 - Storage - [indexedDB](https://blog.csdn.net/inter_peng/article/details/49133081) - [浏览器存储之争](http://jartto.wang/2018/12/02/indexeddb/) - [Service Worker](https://www.jianshu.com/p/62338c038c42) - [从性能优化的角度看缓存](https://github.com/amandakelake/blog/issues/43) - [聊一聊浏览器缓存机制](http://jartto.wang/2019/02/14/web-cache/) - [浏览器缓存机制：强缓存、协商缓存](https://github.com/amandakelake/blog/issues/41) - [数据存储：cookie、Storage、indexedDB](https://github.com/amandakelake/blog/issues/13) - [离线应用缓存：App Cache => Manifest](https://github.com/amandakelake/blog/issues/15) - 服务端缓存 - [缓存、队列（Memcached、redis、RabbitMQ）](https://www.cnblogs.com/suoning/archive/2016/08/31/5807247.html) - [缓存技术的详解](https://blog.csdn.net/qq_26517369/article/details/78330694) - [缓存淘汰算法--LRU算法](https://www.evernote.com/l/AUQTo7s_NytKk6mAlbTMIlpGo4NyfB1530A) - 扩展 - [网站性能优化实战——从 12.67s 到 1.06s 的故事](https://juejin.im/post/5b0b7d74518825158e173a0c) ☆ - [用 100 行代码提升 10 倍的性能](https://juejin.im/post/5bec223f5188250c102116b5) ☆☆ - [美团网页首帧优化实践](https://juejin.im/post/5bee7dd4e51d451f5b54cbb4) ☆☆ - [前端性能提升秘笈！](http://rdc.hundsun.com/portal/article/942.html) ☆☆ - [网站优化实战](http://jartto.wang/2019/02/16/web-optimization/) ☆☆☆ - [百度APP-Android H5首屏优化实践](https://mp.weixin.qq.com/s/AqQgDB-0dUp2ScLkqxbLZg) ☆☆☆ - [VasSonic，让你的 H5 页面首屏秒开](https://my.oschina.net/u/3447988/blog/1512025) ☆☆☆ - [Lazy Loading Video Based on Connection Speed](https://medium.com/dailyjs/lazy-loading-video-based-on-connection-speed-e2de086f9095) ☆☆☆ - [WebView性能、体验分析与优化](https://tech.meituan.com/2017/06/09/webviewperf.html) ☆☆ - [移动 H5 首屏秒开优化方案探讨](http://blog.cnbang.net/tech/3477/) ☆☆ - [手机QQ Hybrid 的架构如何优化演进](https://mp.weixin.qq.com/s/evzDnTsHrAr2b9jcevwBzA) ☆☆☆ - [高性能渲染十万条数据(虚拟列表)](https://juejin.im/post/5db684ddf265da4d495c40e5?utm_source=gold_browser_extension) ☆☆ - [网站性能指标 - FMP](http://jartto.wang/2020/03/15/about-web-fmp/) ☆☆ - [聚焦 Web 性能指标 TTI](http://jartto.wang/2020/03/29/web-tti/) ☆☆ - 工具 - [YSlow](http://yslow.org) - Performance - [Google PageSpeed](https://developers.google.com/speed/pagespeed/) - LightHouse ### Serverless - [Serverless 入门](https://mp.weixin.qq.com/s?__biz=MzA4ODUzNTE2Nw==&mid=2451046912&idx=1&sn=fc7f97c007e325f553e158fee703178f&chksm=87c41b10b0b39206bcc9cff2332fb2e5003ebd1b50d12ccd72585ffc256e98cac7ea878f064c&mpshare=1&scene=1&srcid=&sharer_sharetime=1587861292401&sharer_shareid=93284882dc8dd6a2672e2f228c47df4e#rd) ☆☆ - [Serverless 掀起新的前端技术变革](https://github.com/nodejh/nodejh.github.io/issues/49) ☆☆☆ - [当 SSR 遇上 Serverless，轻松实现页面瞬开](https://fed.taobao.org/blog/taofed/do71ct/rax-ssr-serverless-quicker) ☆☆ - [阿里自研开源框架 Midway Serverless](https://mp.weixin.qq.com/s/5l4xLdTefz8G8EbZNbon0Q) ☆☆☆ ### 源码学习 - [Lodash 源码分析（一）“Function” Methods](https://segmentfault.com/a/1190000010775719) ☆☆☆ - [Webpack 源码](https://github.com/youngwind/blog/issues/99) ☆☆☆ - [React 源码剖析系列 － 不可思议的 react diff](https://zhuanlan.zhihu.com/p/20346379) ☆☆☆ - [React 源码解析](https://juejin.im/post/5a84682ef265da4e83266cc4#comment) ☆☆☆ - [逐行阅读 Redux 源码](https://juejin.im/post/5be42fc2e51d451c6a14ce2b) ☆☆ - [解密 JQuery](http://www.cnblogs.com/aaronjs/p/3444874.html) ☆☆☆ - [Promise 的实现及解析](https://juejin.im/post/5ab466a35188257b1c7523d2) ☆☆☆ - [浅析 Redux-Saga 实现原理](https://juejin.im/post/59e083c8f265da43111f3a1f) ☆☆☆ - [Antd 源码解读](https://juejin.im/post/5a5b6d3c51882573473db9af) ☆☆☆ - [Vue.js 源码解析](https://github.com/answershuto/learnVue) ☆☆☆ - [自己动手做一个 Vue](https://github.com/fastCreator/MVVM) ☆☆☆ - [vue-come-true](https://github.com/coderzzp/vue-come-true) ☆☆☆ - [Vue.js 源码学习笔记](http://jiongks.name/blog/vue-code-review/) ☆☆☆ - [高效阅读 Github 源代码](https://juejin.im/entry/5ae731f6f265da0b7e0c0ccb?utm_source=gold_browser_extension) ☆ - [从头实现一个 koa 框架](https://zhuanlan.zhihu.com/p/35040744) ☆☆☆ ### Web 服务器端 - [Nodejs](https://nodejs.org/en/) - 基础 web 框架 - [Express](http://www.expressjs.com.cn/) ☆ - [Koa](https://koajs.com/) - [阮一峰 Koa 入门教程](http://www.ruanyifeng.com/blog/2017/08/koa.html) ☆ - [kick-off-koa](https://github.com/koajs/kick-off-koa) ☆ - [koajs examples](https://github.com/koajs/examples) ☆☆ - [koa workshop](https://github.com/koajs/workshop) ☆☆ - [hapijs](https://hapijs.com/) ☆☆ - [restify](http://restify.com/) - [fastify](https://www.fastify.io/) - [thinkjs](https://thinkjs.org/zh-cn/doc/2.2/module.html) - [nextjs](https://zeit.co/blog/next) ☆☆ - node中比较棘手的问题 - node内存泄漏排查 - node错误处理机制 - node.js cluster - [PM2 初体验](http://jartto.wang/2016/06/27/first-experience-of-pm2/) ☆ - Forever ☆☆ - 高度集成 web 框架 - [egg](http://eggjs.org/) ☆☆☆ - [nest](https://nestjs.com/) - [thinkjs](https://thinkjs.org/) - [loopback](https://loopback.io/) - [sails](https://sailsjs.com/) ☆☆ - nohup ☆☆ - Nodejs 事件循环机制: 结合[libuv](http://docs.libuv.org/en/v1.x/design.html)和 nodejs 官网的[blog](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/) - [剖析 nodejs 的事件循环](https://juejin.im/post/5af1413ef265da0b851cce80?utm_source=gold_browser_extension) - [Stream](https://github.com/substack/stream-handbook) ☆☆ - [Buffer](https://nodejs.org/api/buffer.html) ☆☆ - [多进程](https://nodejs.org/dist/latest-v8.x/docs/api/cluster.html) ☆☆ - [eleme node-interview](https://elemefe.github.io/node-interview/#/sections/zh-cn/) ☆☆☆ - [node debug](https://github.com/nswbmw/node-in-debugging) ☆☆ - 内存相关 ☆☆☆ - [js snapshot 相关](http://hello2dj.com/2018/03/05/heapdump%E8%A7%A3%E6%9E%90/) ☆☆☆ - [node技术进阶与实践](https://www.evernote.com/l/AURoreJGCE5F8pV7a6YwRrDBJ-gOohmRdhI) ☆☆☆ - [deno](https://github.com/ry/deno) ☆☆ - [nexus 搭建 npm 私服](https://www.jianshu.com/p/9085f47726a2) ☆☆☆ - [Nginx](https://github.com/nginx/nginx) ☆☆☆ - [nodejs 结合 dubbo 服务 node-zookeeper-dubbo](https://segmentfault.com/a/1190000013145761) ☆☆☆ - [thrifty -> nodejs实例](http://thrift.apache.org/tutorial/nodejs) ☆☆ - [nodejs-learning-guide](https://github.com/chyingp/nodejs-learning-guide) ☆☆☆ - [互联网架构为什么要做服务化？](http://www.open-open.com/lib/view/open1472132696878.html)☆☆ - [什么是微服务](https://blog.csdn.net/wuxiaobingandbob/article/details/78642020?locationNum=1&fps=1) - [服务化架构的演进与实践](https://blog.csdn.net/liubenlong007/article/details/54692241)☆☆ - [服务化实战之 dubbo、dubbox、motan、thrift、grpc等RPC框架比较及选型](https://blog.csdn.net/liubenlong007/article/details/54692241)☆☆ - [Nodejs 最佳实践](https://github.com/i0natan/nodebestpractices?utm_source=gold_browser_extension) ☆☆☆ - [技术栈：为什么 Node 是前端团队的核心技术栈](https://mp.weixin.qq.com/s/dA6M1t957G-nZ-Ir80L1kA) ☆☆☆

⚡ Cheatsheet for developing lightning fast progressive Angular applications

# Angular Performance Checklist <img src="./assets/flash.png" width="1000"> - [中文版](./README.zh-CN.md) - [Русский](./README.ru-RU.md) - [Português](./README.pt-BR.md) - [Español](./README.es-ES.md) - [日本語](./README.ja-JP.md) ## Introduction This document contains a list of practices that will help us boost the performance of our Angular applications. "Angular Performance Checklist" covers different topics - from server-side pre-rendering and bundling of our applications to runtime performance and optimization of the change detection performed by the framework. The document is divided into two main sections: - Network performance - lists practices that are going to improve mostly the load time of our application. They include methods for latency and bandwidth reduction. - Runtime performance - practices that improve the runtime performance of our application. They include mostly change detection and rendering related optimizations. Some practices impact both categories so there could be a slight intersection, however, the differences in the use cases and the implications will be explicitly mentioned. Most subsections list tools, related to the specific practice, that can make us more efficient by automating our development flow. Note that most practices are valid for both HTTP/1.1 and HTTP/2. Practices which make an exception will be mentioned by specifying to which version of the protocol they could be applied. ## Table of Content - [Angular Performance Checklist](#angular-2-performance-checklist) - [Introduction](#introduction) - [Table of Content](#table-of-content) - [Network performance](#network-performance) - [Bundling](#bundling) - [Minification and Dead code elimination](#minification-and-dead-code-elimination) - [Remove template whitespace](#remove-template-whitespace) - [Tree-shaking](#tree-shaking) - [Tree-shakeable providers](#tree-shakeable-providers) - [Ahead-of-Time (AoT) Compilation](#ahead-of-time-aot-compilation) - [Compression](#compression) - [Pre-fetching Resources](#pre-fetching-resources) - [Lazy-Loading of Resources](#lazy-loading-of-resources) - [Don't lazy-load default route](#dont-lazy-load-the-default-route) - [Caching](#caching) - [Use Application Shell](#use-application-shell) - [Use Service Workers](#use-service-workers) - [Runtime Optimizations](#runtime-optimizations) - [Use `enableProdMode`](#use-enableprodmode) - [Ahead-of-Time Compilation](#ahead-of-time-compilation) - [Web Workers](#web-workers) - [Server-Side Rendering](#server-side-rendering) - [Change Detection](#change-detection) - [`ChangeDetectionStrategy.OnPush`](#changedetectionstrategyonpush) - [Detaching the Change Detector](#detaching-the-change-detector) - [Run outside Angular](#run-outside-angular) - [Coalescing event change detections](#coalescing-event-change-detections) - [Use pure pipes](#use-pure-pipes) - [`*ngFor` directive](#ngfor-directive) - [Use `trackBy` option](#use-trackby-option) - [Minimize DOM elements](#minimize-dom-elements) - [Optimize template expressions](#optimize-template-expressions) - [Conclusion](#conclusion) - [Contributing](#contributing) ## Network performance Some of the tools in this section are still in development and are subject to change. The Angular core team is working on automating the build process for our applications as much as possible so a lot of things will happen transparently. ### Bundling Bundling is a standard practice aiming to reduce the number of requests that the browser needs to perform in order to deliver the application requested by the user. In essence, the bundler receives as an input a list of entry points and produces one or more bundles. This way, the browser can get the entire application by performing only a few requests, instead of requesting each individual resource separately. As your application grows bundling everything into a single large bundle would again be counterproductive. Explore Code Splitting techniques using Webpack. **Additional http requests will not be a concern with HTTP/2 because of the [server push](https://http2.github.io/faq/#whats-the-benefit-of-server-push) feature.** **Tooling** Tools which allows us to bundle our applications efficiently are: - [Webpack](https://webpack.js.org) - provides efficient bundling by performing [tree-shaking](#tree-shaking). - [Webpack Code Splitting](https://webpack.js.org/guides/code-splitting/) - Techniques to split your code. - [Webpack & http2](https://medium.com/webpack/webpack-http-2-7083ec3f3ce6#.46idrz8kb) - Need for splitting with http2. - [Rollup](https://github.com/rollup/rollup) - provides bundling by performing efficient tree-shaking, taking advantage of the static nature of the ES2015 modules. - [Google Closure Compiler](https://github.com/google/closure-compiler) - performs plenty of optimizations and provides bundling support. Originally written in Java, since recently it also has a [JavaScript version](https://www.npmjs.com/package/google-closure-compiler) that can be [found here](https://www.npmjs.com/package/google-closure-compiler). - [SystemJS Builder](https://github.com/systemjs/builder) - provides a single-file build for SystemJS of mixed-dependency module trees. - [Browserify](http://browserify.org/). **Resources** - ["Building an Angular Application for Production"](http://blog.mgechev.com/2016/06/26/tree-shaking-angular2-production-build-rollup-javascript/) - ["2.5X Smaller Angular Applications with Google Closure Compiler"](http://blog.mgechev.com/2016/07/21/even-smaller-angular2-applications-closure-tree-shaking/) ### Minification and dead code elimination These practices allow us to minimize the bandwidth consumption by reducing the payload of our application. **Tooling** - [Uglify](https://github.com/mishoo/UglifyJS) - performs minification such as mangling variables, removal of comments & whitespace, dead code elimination, etc. Written completely in JavaScript, has plugins for all popular task runners. - [Google Closure Compiler](https://github.com/google/closure-compiler) - performs similar to uglify type of minification. In advanced mode, it transforms the AST of our program aggressively in order to be able to perform even more sophisticated optimizations. It has also a [JavaScript version](https://www.npmjs.com/package/google-closure-compiler) that can be [found here](https://www.npmjs.com/package/google-closure-compiler). GCC also supports *most of the ES2015 modules syntax* so it can [perform tree-shaking](#tree-shaking). **Resources** - ["Building an Angular Application for Production"](http://blog.mgechev.com/2016/06/26/tree-shaking-angular2-production-build-rollup-javascript/) - ["2.5X Smaller Angular Applications with Google Closure Compiler"](http://blog.mgechev.com/2016/07/21/even-smaller-angular2-applications-closure-tree-shaking/) ### Remove template whitespace Although we don't see the whitespace character (a character matching the `\s` regex) it is still represented by bytes which are transferred over the network. If we reduce the whitespace from our templates to the minimum we will be respectively able to drop the bundle size of the AoT code even further. Thankfully, we don't have to do this manually. The `ComponentMetadata` interface provides the property `preserveWhitespaces` which by default has value `false` meaning that by default the Angular compiler will trim whitespaces to further reduce the size of our application. In case we set the property to `true` Angular will preserve the whitespace. - [preserveWhitespaces in the Angular docs](https://angular.io/api/core/Component#preserveWhitespaces) ### Tree-shaking For the final version of our applications, we usually don't use the entire code which is provided by Angular and/or any third-party library, even the one that we've written. Thanks to the static nature of the ES2015 modules, we're able to get rid of the code which is not referenced in our apps. **Example** ```javascript // foo.js export foo = () => 'foo'; export bar = () => 'bar'; // app.js import { foo } from './foo'; console.log(foo()); ``` Once we tree-shake and bundle `app.js` we'll get: ```javascript let foo = () => 'foo'; console.log(foo()); ``` This means that the unused export `bar` will not be included into the final bundle. **Tooling** - [Webpack](https://webpack.js.org) - provides efficient bundling by performing [tree-shaking](#tree-shaking). Once the application has been bundled, it does not export the unused code so it can be safely considered as dead code and removed by Uglify. - [Rollup](https://github.com/rollup/rollup) - provides bundling by performing an efficient tree-shaking, taking advantage of the static nature of the ES2015 modules. - [Google Closure Compiler](https://github.com/google/closure-compiler) - performs plenty of optimizations and provides bundling support. Originally written in Java, since recently it has also a [JavaScript version](https://www.npmjs.com/package/google-closure-compiler) that can be [found here](https://www.npmjs.com/package/google-closure-compiler). *Note:* GCC does not support `export *` yet, which is essential for building Angular applications because of the heavy usage of the "barrel" pattern. **Resources** - ["Building an Angular Application for Production"](http://blog.mgechev.com/2016/06/26/tree-shaking-angular2-production-build-rollup-javascript/) - ["2.5X Smaller Angular Applications with Google Closure Compiler"](http://blog.mgechev.com/2016/07/21/even-smaller-angular2-applications-closure-tree-shaking/) - ["Using pipeable operators in RxJS"](https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md) ### Tree-Shakeable Providers Since the release of Angular version 6, The angular team provided a new feature to allow services to be tree-shakeable, meaning that your services will not be included in the final bundle unless they're being used by other services or components. This can help reduce the bundle size by removing unused code from the bundle. You can make your services tree-shakeable by using the `providedIn` attribute to define where the service should be initialized when using the `@Injectable()` decorator. Then you should remove it from the `providers` attribute of your `NgModule` declaration as well as its import statement as follows. Before: ```ts // app.module.ts import { NgModule } from '@angular/core' import { AppRoutingModule } from './app-routing.module' import { AppComponent } from './app.component' import { environment } from '../environments/environment' import { MyService } from './app.service' @NgModule({ declarations: [ AppComponent ], imports: [ ... ], providers: [MyService], bootstrap: [AppComponent] }) export class AppModule { } ``` ```ts // my-service.service.ts import { Injectable } from '@angular/core' @Injectable() export class MyService { } ``` After: ```ts // app.module.ts import { NgModule } from '@angular/core' import { AppRoutingModule } from './app-routing.module' import { AppComponent } from './app.component' import { environment } from '../environments/environment' @NgModule({ declarations: [ AppComponent ], imports: [ ... ], providers: [], bootstrap: [AppComponent] }) export class AppModule { } ``` ```ts // my-service.service.ts import { Injectable } from '@angular/core' @Injectable({ providedIn: 'root' }) export class MyService { } ``` If `MyService` is not injected in any component/service, then it will not be included in the bundle. **Resources** - [Angular Providers](https://angular.io/guide/providers) ### Ahead-of-Time (AoT) Compilation A challenge for the available in the wild tools (such as GCC, Rollup, etc.) are the HTML-like templates of the Angular components, which cannot be analyzed with their capabilities. This makes their tree-shaking support less efficient because they're not sure which directives are referenced within the templates. The AoT compiler transpiles the Angular HTML-like templates to JavaScript or TypeScript with ES2015 module imports. This way we are able to efficiently tree-shake during bundling and remove all the unused directives defined by Angular, third-party libraries or by ourselves. **Resources** - ["Ahead-of-Time Compilation in Angular"](http://blog.mgechev.com/2016/08/14/ahead-of-time-compilation-angular-offline-precompilation/) ### Compression Compression of the responses' payload standard practice for bandwidth usage reduction. By specifying the value of the header `Accept-Encoding`, the browser hints the server which compression algorithms are available on the client's machine. On the other hand, the server sets the value for the `Content-Encoding` header of the response in order to tell the browser which algorithm has been chosen for compressing the response. **Tooling** The tooling here is not Angular-specific and entirely depends on the web/application server that we're using. Typical compression algorithms are: - deflate - a data compression algorithm and associated file format that uses a combination of the LZ77 algorithm and Huffman coding. - [brotli](https://github.com/google/brotli) - a generic-purpose lossless compression algorithm that compresses data using a combination of a modern variant of the LZ77 algorithm, Huffman coding, and 2nd order context modeling, with a compression ratio comparable to the best currently available general-purpose compression methods. It is similar in speed with deflate but offers more dense compression. **Resources** - ["Better than Gzip Compression with Brotli"](https://hacks.mozilla.org/2015/11/better-than-gzip-compression-with-brotli/) - ["2.5X Smaller Angular Applications with Google Closure Compiler"](http://blog.mgechev.com/2016/07/21/even-smaller-angular2-applications-closure-tree-shaking/) ### Pre-fetching Resources Resource pre-fetching is a great way to improve user experience. We can either pre-fetch assets (images, styles, modules intended to be [loaded lazily](#lazy-loading-of-resources), etc.) or data. There are different pre-fetching strategies but most of them depend on specifics of the application. ### Lazy-Loading of Resources In case the target application has a huge code base with hundreds of dependencies, the practices listed above may not help us reduce the bundle to a reasonable size (reasonable might be 100K or 2M, it again, completely depends on the business goals). In such cases, a good solution might be to load some of the application's modules lazily. For instance, let's suppose we're building an e-commerce system. In this case, we might want to load the admin panel independently from the user-facing UI. Once the administrator has to add a new product we'd want to provide the UI required for that. This could be either only the "Add product page" or the entire admin panel, depending on our use case/business requirements. **Tooling** - [Webpack](https://github.com/webpack/webpack) - allows asynchronous module loading. - [ngx-quicklink](https://github.com/mgechev/ngx-quicklink) - router preloading strategy which automatically downloads the lazy-loaded modules associated with all the visible links on the screen ### Don't Lazy-Load the Default Route Let's suppose we have the following routing configuration: ```ts // Bad practice const routes: Routes = [ { path: '', redirectTo: '/dashboard', pathMatch: 'full' }, { path: 'dashboard', loadChildren: () => import('./dashboard.module').then(mod => mod.DashboardModule) }, { path: 'heroes', loadChildren: () => import('./heroes.module').then(mod => mod.HeroesModule) } ]; ``` The first time the user opens the application using the url: https://example.com/ they will be redirected to `/dashboard` which will trigger the lazy-route with path `dashboard`. In order Angular to render the bootstrap component of the module, it will has to download the file `dashboard.module` and all of its dependencies. Later, the file needs to be parsed by the JavaScript VM and evaluated. Triggering extra HTTP requests and performing unnecessary computations during the initial page load is a bad practice since it slows down the initial page rendering. Consider declaring the default page route as non-lazy. ### Caching Caching is another common practice intending to speed-up our application by taking advantage of the heuristic that if one resource was recently been requested, it might be requested again in the near future. For caching data we usually use a custom caching mechanism. For caching static assets, we can either use the standard browser caching or Service Workers with the [CacheStorage API](https://developer.mozilla.org/en-US/docs/Web/API/Cache). ### Use Application Shell To make the perceived performance of your application faster, use an [Application Shell](https://developers.google.com/web/updates/2015/11/app-shell). The application shell is the minimum user interface that we show to the users in order to indicate them that the application will be delivered soon. For generating an application shell dynamically you can use Angular Universal with custom directives which conditionally show elements depending on the used rendering platform (i.e. hide everything except the App Shell when using `platform-server`). **Tooling** - [Angular Service Worker](https://angular.io/guide/service-worker-intro) - aims to automate the process of managing Service Workers. It also contains Service Worker for caching static assets and one for [generating application shell](https://developers.google.com/web/updates/2015/11/app-shell?hl=en). - [Angular Universal](https://github.com/angular/angular/tree/master/packages/platform-server) - Universal (isomorphic) JavaScript support for Angular. **Resources** - ["Instant Loading Web Apps with an Application Shell Architecture"](https://developers.google.com/web/updates/2015/11/app-shell) ### Use Service Workers We can think of the Service Worker as an HTTP proxy which is located in the browser. All requests sent from the client are first intercepted by the Service Worker which can either handle them or pass them through the network. You can add a Service Worker to your Angular project by running ``` ng add @angular/pwa ``` **Tooling** - [Angular Service Worker](https://angular.io/guide/service-worker-intro) - aims to automate the process of managing Service Workers. It also contains Service Worker for caching static assets and one for [generating application shell](https://developers.google.com/web/updates/2015/11/app-shell?hl=en). - [Offline Plugin for Webpack](https://github.com/NekR/offline-plugin) - Webpack plugin that adds support for Service Worker with a fall-back to AppCache. **Resources** - ["The offline cookbook"](https://jakearchibald.com/2014/offline-cookbook/) - ["Getting started with service workers"](https://angular.io/guide/service-worker-getting-started) ## Runtime Optimizations This section includes practices that can be applied in order to provide smoother user experience with 60 frames per second (fps). ### Use `enableProdMode` In development mode, Angular performs some extra checks in order to verify that performing change detection does not result in any additional changes to any of the bindings. This way the frameworks assures that the unidirectional data flow has been followed. In order to disable these changes for production do not forget to invoke `enableProdMode`: ```typescript import { enableProdMode } from '@angular/core'; if (ENV === 'production') { enableProdMode(); } ``` ### Ahead-of-Time Compilation AoT can be helpful not only for achieving more efficient bundling by performing tree-shaking, but also for improving the runtime performance of our applications. The alternative of AoT is Just-in-Time compilation (JiT) which is performed runtime, therefore we can reduce the amount of computations required for the rendering of our application by performing the compilation as part of our build process. **Tooling** - [angular2-seed](https://github.com/mgechev/angular2-seed) - a starter project which includes support for AoT compilation. - [angular-cli](https://cli.angular.io) Using the `ng serve --prod` **Resources** - ["Ahead-of-Time Compilation in Angular"](http://blog.mgechev.com/2016/08/14/ahead-of-time-compilation-angular-offline-precompilation/) ### Web Workers The usual problem in the typical single-page application (SPA) is that our code is usually run in a single thread. This means that if we want to achieve smooth user experience with 60fps we have **at most 16ms** for execution between the individual frames are being rendered, otherwise, they'll drop by half. In complex applications with a huge component tree, where the change detection needs to perform millions of checks each second it will not be hard to start dropping frames. Thanks to the Angular's agnosticism and being decoupled from DOM architecture, it's possible to run our entire application (including change detection) in a Web Worker and leave the main UI thread responsible only for rendering. **Tooling** - The module which allows us to run our application in a Web Worker is supported by the core team. Examples of how it can be used can be [found here](https://github.com/angular/angular/tree/master/modules/playground/src/web_workers). - [Webpack Web Worker Loader](https://github.com/webpack/worker-loader) - A Web Worker Loader for webpack. **Resources** - ["Using Web Workers for more responsive apps"](https://www.youtube.com/watch?v=Kz_zKXiNGSE) ### Server-Side Rendering A big issue of the traditional SPA is that they cannot be rendered until the entire JavaScript required for their initial rendering is available. This leads to two big problems: - Not all search engines are running the JavaScript associated with the page so they are not able to index the content of dynamic apps properly. - Poor user experience, since the user will see nothing more than a blank/loading screen until the JavaScript associated with the page is downloaded, parsed and executed. Server-side rendering solves this issue by pre-rendering the requested page on the server and providing the markup of the rendered page during the initial page load. **Tooling** - [Angular Universal](https://github.com/angular/angular/tree/master/packages/platform-server) - Universal (isomorphic) JavaScript support for Angular. - [Preboot](https://github.com/angular/preboot) - Library to help manage the transition of state (i.e. events, focus, data) from a server-generated web view to a client-generated web view. - [Scully](https://github.com/scullyio/scully) - Static site generator for Angular projects looking to embrace the JAMStack. **Resources** - ["Angular Server Rendering"](https://www.youtube.com/watch?v=0wvZ7gakqV4) - ["Angular Universal Patterns"](https://www.youtube.com/watch?v=TCj_oC3m6_U) - ["Create a Static Site Using Angular & Scully"](https://www.youtube.com/watch?v=ugTx-14jRrI) ### Change Detection On each asynchronous event, Angular performs change detection over the entire component tree. Although the code which detects for changes is optimized for [inline-caching](http://mrale.ph/blog/2012/06/03/explaining-js-vms-in-js-inline-caches.html), this still can be a heavy computation in complex applications. A way to improve the performance of the change detection is to not perform it for subtrees which are not supposed to be changed based on the recent actions. #### `ChangeDetectionStrategy.OnPush` The `OnPush` change detection strategy allows us to disable the change detection mechanism for subtrees of the component tree. By setting the change detection strategy to any component to the value `ChangeDetectionStrategy.OnPush` will make the change detection perform **only** when the component has received different inputs. Angular will consider inputs as different when it compares them with the previous inputs by reference, and the result of the reference check is `false`. In combination with [immutable data structures](https://facebook.github.io/immutable-js/), `OnPush` can bring great performance implications for such "pure" components. **Resources** - ["Change Detection in Angular"](https://vsavkin.com/change-detection-in-angular-2-4f216b855d4c) - ["Everything you need to know about change detection in Angular"](https://indepth.dev/posts/1053/everything-you-need-to-know-about-change-detection-in-angular) #### Detaching the Change Detector Another way of implementing a custom change detection mechanism is by `detach`ing and `reattach`ing the change detector (CD) for given a component. Once we `detach` the CD Angular will not perform check for the entire component subtree. This practice is typically used when user actions or interactions with external services trigger the change detection more often than required. In such cases we may want to consider detaching the change detector and reattaching it only when performing change detection is required. #### Run outside Angular The Angular's change detection mechanism is being triggered thanks to [zone.js](https://github.com/angular/zone.js). Zone.js monkey patches all asynchronous APIs in the browser and triggers the change detection at the end of the execution of any async callback. In **rare cases**, we may want the given code to be executed outside the context of the Angular Zone and thus, without running change detection mechanism. In such cases, we can use the method `runOutsideAngular` of the `NgZone` instance. **Example** In the snippet below, you can see an example for a component that uses this practice. When the `_incrementPoints` method is called the component will start incrementing the `_points` property every 10ms (by default). The incrementation will make the illusion of an animation. Since in this case, we don't want to trigger the change detection mechanism for the entire component tree, every 10ms, we can run `_incrementPoints` outside the context of the Angular's zone and update the DOM manually (see the `points` setter). ```ts @Component({ template: '<span #label></span>' }) class PointAnimationComponent { @Input() duration = 1000; @Input() stepDuration = 10; @ViewChild('label') label: ElementRef; @Input() set points(val: number) { this._points = val; if (this.label) { this.label.nativeElement.innerText = this._pipe.transform(this.points, '1.0-0'); } } get points() { return this._points; } private _incrementInterval: any; private _points: number = 0; constructor(private _ngZone: NgZone, private _pipe: DecimalPipe) {} ngOnChanges(changes: any) { const change = changes.points; if (!change) { return; } if (typeof change.previousValue !== 'number') { this.points = change.currentValue; } else { this.points = change.previousValue; this._ngZone.runOutsideAngular(() => { this._incrementPoints(change.currentValue); }); } } private _incrementPoints(newVal: number) { const diff = newVal - this.points; const step = this.stepDuration * (diff / this.duration); const initialPoints = this.points; this._incrementInterval = setInterval(() => { let nextPoints = Math.ceil(initialPoints + diff); if (this.points >= nextPoints) { this.points = initialPoints + diff; clearInterval(this._incrementInterval); } else { this.points += step; } }, this.stepDuration); } } ``` **Warning**: Use this practice **very carefully only when you're sure what you are doing** because if not used properly it can lead to an inconsistent state of the DOM. Also, note that the code above is not going to run in WebWorkers. In order to make it WebWorker-compatible, you need to set the label's value by using the Angular's renderer. #### Coalescing event change detections Angular uses zone.js to intercept events that occurred in the application and runs a change detection automatically. By default this happens when the [microtask queue](https://www.youtube.com/watch?v=cCOL7MC4Pl0) of the browser is empty, which in some cases may call redundant cycles. From v9, Angular provides a way to coalesce event change detections by turning `ngZoneEventCoalescing` on, i.e ```typescript platformBrowser() .bootstrapModule(AppModule, { ngZoneEventCoalescing: true }); ``` The above configuration will schedule change detection with `requestAnimationFrame`, instead of plugging into the microtask queue, which will run checks less frequently and consume fewer computational cycles. > Warning: **ngZoneEventCoalescing: true** may break existing apps that relay on consistently running change detection. **Resources** - [ngZoneEventCoalescing BootstrapOption](https://github.com/angular/angular/blob/master/packages/core/src/application_ref.ts#L268) - source code for BootstrapOptions interface - [Reduce Change Detection Cycles with Event Coalescing in Angular](https://netbasal.com/reduce-change-detection-cycles-with-event-coalescing-in-angular-c4037199859f) - [Simple Angular context help component or how global event listener can affect your perfomance](https://medium.com/@a.yurich.zuev/simple-angular-context-help-component-or-how-global-event-listener-can-affect-your-perfomance-75b67dba197f) ### Use pure pipes As argument the `@Pipe` decorator accepts an object literal with the following format: ```typescript interface PipeMetadata { name: string; pure: boolean; } ``` The pure flag indicates that the pipe is not dependent on any global state and does not produce side-effects. This means that the pipe will return the same output when invoked with the same input. This way Angular can cache the outputs for all the input parameters the pipe has been invoked with, and reuse them in order to not have to recompute them on each evaluation. The default value of the `pure` property is `true`. ### `*ngFor` directive The `*ngFor` directive is used for rendering a collection. #### Use `trackBy` option By default `*ngFor` identifies object uniqueness by reference. Which means when a developer breaks reference to object during updating item's content Angular treats it as removal of the old object and addition of the new object. This effects in destroying old DOM node in the list and adding new DOM node on its place. The developer can provide a hint for angular how to identify object uniqueness: custom tracking function as the `trackBy` option for the `*ngFor` directive. The tracking function takes two arguments: `index` and `item`. Angular uses the value returned from the tracking function to track items identity. It is very common to use the ID of the particular record as the unique key. **Example** ```typescript @Component({ selector: 'yt-feed', template: ` <h1>Your video feed</h1> <yt-player *ngFor="let video of feed; trackBy: trackById" [video]="video"></yt-player> ` }) export class YtFeedComponent { feed = [ { id: 3849, // note "id" field, we refer to it in "trackById" function title: "Angular in 60 minutes", url: "http://youtube.com/ng2-in-60-min", likes: "29345" }, // ... ]; trackById(index, item) { return item.id; } } ``` #### Minimize DOM elements Rendering the DOM elements is usually the most expensive operation when adding elements to the UI. The main work is usually caused by inserting the element into the DOM and applying the styles. If `*ngFor` renders a lot of elements, browsers (especially older ones) may slow down and need more time to finish rendering of all elements. This is not specific to Angular. To reduce rendering time, try the following: - Apply virtual scrolling via [CDK](https://material.angular.io/cdk/scrolling/overview) or [ngx-virtual-scroller](https://github.com/rintoj/ngx-virtual-scroller) - Reducing the amount of DOM elements rendered in `*ngFor` section of your template. Usually, unneeded/unused DOM elements arise from extending the template again and again. Rethinking its structure probably makes things much easier. - Use [`ng-container`](https://angular.io/guide/structural-directives#ngcontainer) where possible **Resources** - ["NgFor directive"](https://angular.io/docs/ts/latest/api/common/index/NgFor-directive.html) - official documentation for `*ngFor` - ["Angular — Improve performance with trackBy"](https://netbasal.com/angular-2-improve-performance-with-trackby-cc147b5104e5) - shows gif demonstration of the approach - [Component Dev Kit (CDK) Virtual Scrolling](https://material.angular.io/cdk/scrolling/overview) - API description - [ngx-virtual-scroller](https://github.com/rintoj/ngx-virtual-scroller) - displays a virtual, "infinite" list ### Optimize template expressions Angular executes template expressions after every change detection cycle. Change detection cycles are triggered by many asynchronous activities such as promise resolutions, http results, timer events, keypresses, and mouse moves. Expressions should finish quickly or the user experience may drag, especially on slower devices. Consider caching values when their computation is expensive. **Resources** - [quick-execution](https://angular.io/guide/template-syntax#quick-execution) - official documentation for template expressions - [Increasing Performance - more than a pipe dream](https://youtu.be/I6ZvpdRM1eQ) - ng-conf video on youtube. Using pipe instead of function in interpolation expression # Conclusion The list of practices will dynamically evolve over time with new/updated practices. In case you notice something missing or you think that any of the practices can be improved do not hesitate to fire an issue and/or a PR. For more information please take a look at the "[Contributing](#contributing)" section below. # Contributing In case you notice something missing, incomplete or incorrect, a pull request will be greatly appreciated. For discussion of practices that are not included in the document please [open an issue](https://github.com/mgechev/angular2-performance-checklist/issues). # License MIT

Reverse engineering SARS-CoV-2

# Reverse engineering the coronavirus (SARS-CoV-2) **Start here**: [`corona.py`](corona.py) ## :thought_balloon: Background This project applies techniques from [reverse engineering](https://en.wikipedia.org/wiki/Reverse_engineering) to understand the [SARS-CoV-2](https://en.wikipedia.org/wiki/Severe_acute_respiratory_syndrome_coronavirus_2) virus. The goal here is simply to build an understanding of the virus from first principles. ### Biology vs. software Biological systems are fundamentally [information processing systems](https://en.wikipedia.org/wiki/Information_processor). While not a perfect analogy, software provides a useful framework for thinking about biology. The table below provides a rough outline of this analogy. :microscope: Biology | :computer: Software | Notes ------- | -------- | ----- [nucleotide](https://en.wikipedia.org/wiki/Nucleotide) | [byte](https://en.wikipedia.org/wiki/Byte) | [genome](https://en.wikipedia.org/wiki/Genome) | [bytecode](https://en.wikipedia.org/wiki/Bytecode) | [translation](https://en.wikipedia.org/wiki/Translation_(biology)) | [disassembly](https://en.wikipedia.org/wiki/Disassembler) | 3 byte wide instruction set with arbitrary "[reading frames](https://en.wikipedia.org/wiki/Reading_frame)" [protein](https://en.wikipedia.org/wiki/Protein) | [function](https://en.wikipedia.org/wiki/Function_(computer_science)) | a polyprotein is a function with multiple pieces [protein secondary structure](https://en.wikipedia.org/wiki/Protein_secondary_structure) | [basic blocks](https://en.wikipedia.org/wiki/Basic_block) | 80% accuracy in [prediction](https://en.wikipedia.org/wiki/Protein_structure_prediction#Secondary_structure) [protein tertiary structure](https://en.wikipedia.org/wiki/Protein_tertiary_structure) | | This seems like the hard one to predict: https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0205819 [quaternary structure](https://en.wikipedia.org/wiki/Protein_quaternary_structure) | [compiled function with inlining](https://en.wikipedia.org/wiki/Inline_expansion) | https://en.wikipedia.org/wiki/Protein%E2%80%93protein_interaction_prediction [gene](https://en.wikipedia.org/wiki/Gene) | [library](https://en.wikipedia.org/wiki/Library_(computing)) | bacteria are statically linked, viruses are dynamically linked [transcription](https://en.wikipedia.org/wiki/Transcription_(biology)) | [loading](https://en.wikipedia.org/wiki/Loader_(computing)) [protein structure prediction](https://en.wikipedia.org/wiki/Protein_structure_prediction) | [library identification](https://www.hex-rays.com/products/ida/tech/flirt/in_depth/) [genome analysis](https://en.wikipedia.org/wiki/Genomics#Genome_analysis) | [static analysis](https://en.wikipedia.org/wiki/Static_program_analysis) | [molecular dynamics](https://en.wikipedia.org/wiki/Molecular_dynamics) simulations of [protein folding](https://en.wikipedia.org/wiki/Protein_folding) | [dynamic analysis](https://en.wikipedia.org/wiki/Dynamic_program_analysis) | Simulation doesn't seem to work yet. Constrained by tooling and compute. no equivalent | [execution](https://en.wikipedia.org/wiki/Execution_(computing)) | We are reverse engineering a CAD format. Runs more like FPGA code, all at once. No serial execution. (What are the FPGA reverse engineering tools?) ## :wrench: Progress ### Downloading the SARS-CoV-2 genome [GenBank](https://www.ncbi.nlm.nih.gov/genbank/) is the NIH genetic sequence database, an annotated collection of all publicly available DNA and RNA sequences. The SARS-CoV-2 sequences available in GenBank have been downloaded in [`download_sequences.py`](download_sequences.py). ### Translating RNA to proteins [`lib.py`](lib.py) contains a function `translate` that converts an RNA sequence to a chain of [amino acids](https://en.wikipedia.org/wiki/Amino_acid). This function is used in [`corona.py`](corona.py). ### Annotating functions The `translate` function is used in [`corona.py`](corona.py) to identify and annotate functions for all proteins encoded by the genome. ### Folding proteins The [OpenMM](http://openmm.org/) toolkit is used for molecular simulation of protein folding in [`fold.py`](fold.py). ## :bulb: Work to be done - Automatic extraction of genes from different coronaviruses - Good multisequence compare tool - Molecular dynamics? - Secondary Structure prediction on orf1a? ## :question: Open questions - How is orf1ab cleaved into polypeptides? Can we predict this from the sequence? - How do the researchers know (guess?) where orf1ab cleaves? - nsp3 and nsp5 do it -- https://www.pnas.org/content/pnas/103/15/5717.full.pdf - Which protein is the immune system responding to? - "spike" and "nucleocapsid" -- http://www.cmi.ustc.edu.cn/1/3/193.pdf - Are some people already immune from exposure to other coronavirus? - Find the "furin cleavage site" in the "spike glycoprotein" - It might be at the "PRRA" -- https://www.sciencedirect.com/science/article/pii/S0166354220300528 - Use ProP or PiTou to predict? -- https://en.wikipedia.org/wiki/Furin - How similar are the other coronaviruses? (causes colds, not either SARS or MERS) - alpha - https://en.wikipedia.org/wiki/Human_coronavirus_229E (simpler, though targets APN) - https://en.wikipedia.org/wiki/Human_coronavirus_NL63 (targets ACE2!) - https://www.ncbi.nlm.nih.gov/nuccore/MG772808 - beta - https://en.wikipedia.org/wiki/Human_coronavirus_OC43 (targets Neu5Ac) - https://www.ncbi.nlm.nih.gov/pmc/articles/PMC2095096/pdf/JIDMM17330.pdf - Specifically, how similar is the N protein OC43, SARS v1, and SARS v2? - https://en.wikipedia.org/wiki/Human_coronavirus_HKU1 (targets Neu5Ac) - MERS-CoV - SARS-CoV - SARS-CoV-2 - What adds the phosphate group to the N protein? Kinase? ## :droplet: Testing ### How tests work - All based on https://en.wikipedia.org/wiki/Reverse_transcription_polymerase_chain_reaction - USA -- https://www.fda.gov/media/134922/download - selected from regions of the virus nucleocapsid (N) gene - 28286---28308--28332---28358 - 29163---29187--29210---29230 - https://biosearchtech.a.bigcontent.io/v1/static/coa_KIT-NCOV-PP1-1000_Lot-No-143503 - South Korea -- http://www.kogene.co.kr/eng/about_us/news/listbody.php?h_gcode=board&h_code=7&po_no=288 - E gene detection (same for all coronavirus) - specific RdRp detection ### Homemade test? - Isolation of viral RNA (no matter what) - https://www.qiagen.com/us/products/diagnostics-and-clinical-research/sample-processing/qiaamp-viral-rna-mini-kit/#orderinginformation - Primers and probes (to detect SARS-CoV-2) - https://www.biosearchtech.com/products/pcr-kits-and-reagents/pathogen-detection/2019-ncov-cdc-probe-and-primer-kit-for-sars-cov-2 - Wouldn't need if using a nanopore sequencer (nanopore MinION) - RT-qPCR Master Mix (to PCR) - https://www.thermofisher.com/order/catalog/product/A15300#/A15300 - Probably wouldn't need if using a nanopore sequencer - All in one? - https://www.chaibio.com/coronavirus - Open qPCR, understand https://www.chaibio.com/openqpcr - FAM and HEX fluorophores? ## :pill: Possible treatments and prophylactics :warning: **Disclaimer**: The information in this repository is for informational purposes only. It is *not* medical advice. ### Hydroxychloroquine + zinc - Zinc blocks RdRp - https://jvi.asm.org/content/91/21/e00754-17 -- how similar is Hep E RdRp? - https://www.ncbi.nlm.nih.gov/pubmed/21079686 - Chloroquine Is a Zinc Ionophore (allows zinc into the cell) - https://www.ncbi.nlm.nih.gov/pmc/articles/PMC4182877/ - Without zinc (seems ineffective) - https://www.recoverytrial.net/files/hcq-recovery-statement-050620-final-002.pdf (where is study?) - With zinc - https://www.infezmed.it/media/journal/Vol_28_2_2020_9.pdf - https://www.sciencedirect.com/science/article/pii/S0306987720306435 - No results yet: https://www.clinicaltrials.gov/ct2/show/NCT04377646 ### [RdRP](https://en.wikipedia.org/wiki/RNA-dependent_RNA_polymerase) inhibitors - Favipiravir (prodrug for favipiravir-RTP) - Adenosine Analog - Remdesivir (prodrug for GS-441524) - https://www.nejm.org/doi/pdf/10.1056/NEJMoa2007764?articleTools=true - Galidesivir ### Dexamethasone - corticosteroid = anti-inflammatory + immunosuppressant - https://www.medrxiv.org/content/10.1101/2020.06.22.20137273v1.full.pdf - Effects in late stage (blocking immune response?) ### Lopinavir-Ritonavir (AIDS cocktail) - Both drugs are protease inhibitors - Wouldn't expect it to work, don't think covid has protease - No effect: https://www.recoverytrial.net/files/lopinavir-ritonavir-recovery-statement-29062020_final.pdf ## :books: Resources ### Coronavirus-related publications - Chapter 4 - Coronavirus Pathogenesis -- https://www.sciencedirect.com/science/article/pii/B9780123858856000092 - https://www.futuremedicine.com/doi/pdf/10.2217/fvl-2018-0008 - https://www.sciencedirect.com/science/article/pii/S2095177920302045 - http://korkinlab.org/wuhan - https://github.com/mattroconnor/deep_learning_coronavirus_cure ### Biology - textbooks - Molecular Biology of the Cell - classes - better tests - https://ocw.mit.edu/courses/biology/7-012-introduction-to-biology-fall-2004/index.htm - suspected better lectures - https://ocw.mit.edu/courses/biology/7-014-introductory-biology-spring-2005/index.htm - alternative lectures - https://youtube.com/playlist?list=PLGhmZX2NKiNldpyRUBBEzNoWL0Cso1jip - basics - https://www.khanacademy.org/science/biology ### Bioinformatics - Nextstrain - https://nextstrain.org/ncov - https://github.com/nextstrain/ncov - https://github.com/nextstrain/augur - https://biopython.org/ - https://github.com/cogent3/cogent3 - https://www.reddit.com/r/bioinformatics/comments/191ykr/resources_for_learning_bioinformatics/ - https://en.wikipedia.org/wiki/Bioinformatics ### Epidemic modeling - https://gabgoh.github.io/COVID/index.html - http://epidemicforecasting.org ### Antibodies - https://www.medrxiv.org/content/10.1101/2020.07.09.20148429v1.full.pdf - https://www.medrxiv.org/content/10.1101/2020.05.11.20086439v2.full.pdf ### Masks - Looking for large controlled studies measuring infection rate with/without wearing mask - https://bmjopen.bmj.com/content/bmjopen/5/4/e006577.full.pdf -- cloth masks bad surgical masks nothing - https://www.ncbi.nlm.nih.gov/pmc/articles/PMC2662657/pdf/08-1167_finalRCME.pdf -- unclear, low adherence - https://sci-hub.tw/10.1001/archpedi.1987.04460060111049 -- masks + goggles help, unclear on mask type - https://onlinelibrary.wiley.com/doi/epdf/10.1111/j.1750-2659.2011.00198.X -- N95 ~2x more effective than medical masks - https://jamanetwork.com/journals/jama/article-abstract/184819 -- N95 and surgical similar in effectiveness ### Vaccines - https://en.wikipedia.org/wiki/COVID-19_vaccine - https://www.nytimes.com/interactive/2020/science/coronavirus-vaccine-tracker.html - generic vaccine types -- https://www.niaid.nih.gov/research/vaccine-types - Nucleic Acid Vaccines (none are currently used) - Use mRNA to produce viral proteins - "It's a very unique way of making a vaccine and, so far, no (such) vaccine has been licenced for infectious disease" - Moderna, mRNA-1273 -- https://clinicaltrials.gov/ct2/show/NCT04283461 - https://www.biorxiv.org/content/10.1101/2020.04.22.055608v1.full.pdf - https://www.medrxiv.org/content/10.1101/2020.06.30.20142570v1.full.pdf - DNA vaccine - "No DNA vaccines have been approved for human use in the United States" - Based on injecting DNA (plasmid) that expresses the spike protein - https://siasky.net/bACLKGmcmX4NCp47WwOOJf0lU666VLeT5HRWpWVtqZPjEA - Viral Vector Vaccines - "There are no viral vector vaccines currently on market for use in humans." - adenovirus vector, AZD1222 - recombinant adenovirus type 5 vector, Ad5-nCoV - Protein-Based Vaccines (subunit vaccines?) - Whole-Virus Vaccines (inactivated vs live-attenuated) - Like old vaccines (live attenuated?) - In phase 3 already, Sinopharm = 15,000 people - Nanoparticle vaccine? - https://www.ipd.uw.edu/2019/03/ipds-first-nanoparticle-vaccine/ - Reverse Engineering - https://berthub.eu/articles/posts/reverse-engineering-source-code-of-the-biontech-pfizer-vaccine/ - https://berthub.eu/articles/posts/part-2-reverse-engineering-source-code-of-the-biontech-pfizer-vaccine/ ### Genome studies (what genes = bad covid) - https://www.nejm.org/doi/full/10.1056/NEJMoa2020283?source=nejmtwitter&medium=organic-social ### DNA Synthesis - Produce "oligos" of around 170-200 bp - "Phosphoramidite chemistry" -- it's a chemical process - Size limited by 0.99^n -> 13% yield on 200bp if the process is 99% good - Column based / Array based - https://www.nature.com/articles/nmeth.2918 - Then assemble them - https://en.wikipedia.org/wiki/Gibson_assembly - 20-40 bp overlap - 5-15 oligos can be combined at once (~2 kb produced) - New technologies - https://static1.squarespace.com/static/5c981af7ebfc7fc8528d6564/t/5f4048cda662a571341b9a60/1598048462430/Alix+-+MDD+DNA+Writing.pdf

🫁 The world's first open-source ventilator tested on human patients. Mass-producible at a low cost (~2000€).

MakAir — Covid-19 Ventilator ===== Mass-producible open-source Covid-19 ARDS ventilator. Aims at helping hospitals cope with a possible shortage of professional ventilators during the outbreak. Worldwide. **Makair ventilator is the world's first open-source ventilator tested with success on human patients** with ongoing clinical trials in France. We are a distributed team of 200+ contributors (engineering, medical, regulatory, etc.), mostly spread through France. Makers, developers, university teachers, researchers and medical teams collaborated on this project. Our testing & assembly operations are located in France. As to ensure international outreach, we made sure that contents required to build your own MakAir ventilator are available in English. The MakAir project has [a website of its own](https://makair.life/). If you're new there, please read the explanations below. _Your contributions are much welcome!_  --- **Quick introduction video:** <p align="center"> <a href="https://www.youtube.com/watch?v=3ZcYR6X3NxE"> <img alt="Play Introduction Video" src="./res/assets/play-introduction.jpg" width="560"> </a> </p> --- # Abstract Roughly, the idea is as follows: as of April 2020 and due to the Covid-19 pandemic, hospitals throughout the world may start lacking mechanical artificial ventilators. We built a pump, and a valve system (controlled by electronics). This way, the breathing cycle can be enforced by proper air routing through the valve system. Our ventilator is able to handle pressure-controlled breathing, stabilized using a [PID controller](https://en.wikipedia.org/wiki/PID_controller) in the software. In order to ensure a proper breathing cycle (inhale + exhale), multiple valves need to be connected together to form a circuit. Their motors need to be controlled in harmony so that the air routing between each valve unit is consistent. This project provides all the parts required to build a good-enough [ARDS](https://en.wikipedia.org/wiki/Acute_respiratory_distress_syndrome) ventilator from mass-produced components. We provide all the required mechanical parts, electronics designs & boards, and firmwares. This ventilator can be 3D-printed and ran on an Arduino board (the maker way), though we **highly advise** that you work with industrial processes as to mold medical-grade plastic parts and assemble the whole ventilator (this would be required for the built ventilator to pass all medical certifications). We target a per-unit cost well under 500 EUR, which could easily be shrunk down to 200 EUR or even 100 EUR per ventilator given proper economies of scale, as well as choices of cheaper on-the-shelf components (eg. servomotors). Features include: - Pressure controlled ventilation (sedated / intubated patients) - Volume controlled ventilation (sedated / intubated patients) - BiPap ventilation (non sedated patients with oxygen mask) - 4 hours battery life - Medical-grade alarms - High flow turbine (up to 100 L/min) - Up to 15 L/min oxygen - Fault tolerant design - Designed to be used continuously and intensively during 30 days MakAir ventilator has been tested by independent researchers and studies found that it can compare with expensive hospital reanimation ventilators (less than 5% error on target pressures and volumes). Mechanically-speaking, the overall system is composed of sub-components that can be plugged together and wired to form an air circuit, namely: - **Air pump** (called "Blower"); - **Air pump casing fit** (called "Blower Holder"); - **Valve system** (called "Pressure Valve"); - **Oxygen Mixer valve** (called "Oxygen Mixer"); - **Air filter casing (patient variant)** (called "Patient Filter Box"); - **Air filter casing (machine variant)** (called "Machine Filter Box"; intake + outtake); - **Connectors** (called "Pneumatic Connectors"); - **Fan support** (called "Fan Holder"); All those components are fitted in box (ie. a casing) that we designed: - **Housing container** (called "Casing"); --- # Designs ## MakAir Standard (Current Design)  ## MakAir Mini (Experimental Design)  --- # ⚠️ Warning Notices **A few important words before you start:** 1. Though 3D-printing (FDM and SLA) can be used to build your own ventilator — this will definitely not scale well to mass-produce MakAir ventilators, and parts might be brittle or leak air. Please work with proper industrial methods and processes if you want to build your own MakAir ventilators. 2. As ARDS patients are sedated, their breathing cycle is forced by mechanical ventilation, while they are intubated. A failing ventilator (due to bad mechanics, pneumatics or software) could kill the patient (O2 desaturation), or permanently damage their lung alveoli (overpressure). It is critical that any self-built MakAir ventilator is tested against a lung simulator system (eg. [ASL 5000](https://www.ingmarmed.com/product/asl-5000-breathing-simulator/)), and validated by medical experts. 3. Medical-grade plastic should be used to produce ventilators, and any kind of grease or adhesive chemicals must be avoided in the ventilator. The ventilators should be produced in a [cleanroom](https://en.wikipedia.org/wiki/Cleanroom) as to avoid dust & germ contaminations. 4. The pneumatic circuit should be thoroughly tested for leaks and its ability to withstand elevated positive air pressure. Joints should be used where relevant, and medical-grade flexible pipes should be used between components. 5. While the MakAir ventilators produced on-site in France were validated by a medical & engineering board, you should independantly seek validation of the MakAir ventilators that you produce; as your assembly methods or parts may vary with ours. _MakAir and Makers For Life should not be held resposible — at any time, for harm caused to human life (eg. lung damage or loss of life). By building your own MakAir, you are held responsible for its safety validations & use._ # Projects As the MakAir ventilator project grew up to be quite large, it is split up in sub-repositories (eg. firmware, PCB designs, etc.). **Software:** * **[makair-firmware](https://github.com/makers-for-life/makair-firmware)**: The firmware software source code and builds, that runs on the motherboard; * **[makair-control-ui](https://github.com/makers-for-life/makair-control-ui)**: The control user interface, that shows realtime graphs of the ventilator while running, on a LCD display; * **[makair-telemetry](https://github.com/makers-for-life/makair-telemetry)**: The telemetry library (and CLI tool), used as a protocol bridge between the Firmware and Control UI; **Electronics:** * **[makair-motherboard](https://github.com/makers-for-life/makair-motherboard)**: The motherboard electronics and PCB design; * **[makair-boards](https://github.com/makers-for-life/makair-boards)**: Other boards PCB design (smaller control boards); **Mechanics:** * **[makair-parts](https://github.com/makers-for-life/makair-parts)**: The mechanical parts that can be 3D-printed and assembled to build the pneumatic circuit; * **[makair-casing](https://github.com/makers-for-life/makair-casing)**: The MakAir casing which houses all electronics and pneumatics; **Misc.:** * **[makair-files](https://github.com/makers-for-life/makair-files)**: Large files, eg. the control UI system image that can be readily flashed and used; * **[makair-simulator](https://github.com/makers-for-life/makair-simulator)**: The MakAir hardware simulator, that let us run a simulated firmware instance on a computer (for development purposes, ie. not used on ventilator units); * **[makair-simulator-web](https://github.com/makers-for-life/makair-simulator-web)**: The Web version of the MakAir hardware simulator, that let us run a simulated firmware instance in a Web browser (for development purposes, ie. not used on ventilator units); # How To Build? This section aims at introducing you on how to manufacture your own MakAir — _the 3D-printed way_. In other words, we will explain there how to build a DIY MakAir using on-the-shelf parts and 3D printers. ## 1️⃣ Print all the parts In order to 3D-print your MakAir, please first ensure you have access to a [SLS](https://en.wikipedia.org/wiki/Selective_laser_sintering) 3D printer at best (eg. [HP Multi Jet Fusion](https://www8.hp.com/us/en/printers/3d-printers/products/multi-jet-technology.html)), or otherwise a [SLA](https://en.wikipedia.org/wiki/Stereolithography) printer (eg. [Formlabs Form 3](https://formlabs.com/3d-printers/form-3/)). If you want to use a [FDM](https://en.wikipedia.org/wiki/Fused_filament_fabrication) printer (eg. [MakerBot Method](https://www.makerbot.com/3d-printers/method/)), please note that some precise parts have been optimized for SLA or SLS printing. Some parts may not print well using FDM printers, even on decent hardware. **👉 To sum up:** at best, use a SLS metal printer, else, use a SLA resin printer. If you do not have access to either of these, you may fallback on a FDM filament printer (using [PLA](https://en.wikipedia.org/wiki/Polylactic_acid) or [ABS](https://en.wikipedia.org/wiki/Acrylonitrile_butadiene_styrene) filaments). ### 1. Parts You can find a list of all parts that should be 3D-printed, as well as the number of parts that should be printed for each one (pick the last active version for each part): - 1 x **Blower** — Print [all STL parts](https://github.com/makers-for-life/makair-parts/tree/master/src/blower/printing/stl) using the same printer (SLA or SLS; FDM discouraged; 50 microns minimum); - 2 x **Pressure Valve** — Print [all STL parts](https://github.com/makers-for-life/makair-parts/tree/master/src/pressure-valve/printing/stl) using the same printer (SLA, SLS or FDM; 200 microns minimum); - 1 x **Oxygen Mixer** — Print [the STL part](https://github.com/makers-for-life/makair-parts/tree/master/src/oxygen-mixer/printing/stl) (SLA or SLS; FDM discouraged; 100 microns minimum); - 1 x **Patient Filter Box** — Print [all STL parts](https://github.com/makers-for-life/makair-parts/tree/master/src/patient-filter-box/printing/stl) using the same printer (SLA, SLS or FDM; 100 microns minimum); - 1 x **Machine Filter Box (Intake)** — Print [all STL parts](https://github.com/makers-for-life/makair-parts/tree/master/src/machine-filter-box/printing/stl) using the same printer, make sure that you pick the proper sub-part (SLA or SLS; FDM discouraged; 100 microns minimum); - 1 x **Machine Filter Box (Outtake)** — Print [all STL parts](https://github.com/makers-for-life/makair-parts/tree/master/src/machine-filter-box/printing/stl) using the same printer, make sure that you pick the proper sub-part (SLA or SLS; FDM discouraged; 100 microns minimum); - 1 x **Pneumatic Connectors (Blower)** — Print [the STL part](https://github.com/makers-for-life/makair-parts/tree/master/src/pneumatic-connectors/printing/stl) using the same printer, make sure that you pick the proper sub-part (SLA or SLS; FDM discouraged; 100 microns minimum); - 1 x **Pneumatic Connectors (O2)** — Print [the STL part](https://github.com/makers-for-life/makair-parts/tree/master/src/pneumatic-connectors/printing/stl) using the same printer, make sure that you pick the proper sub-part (SLA or SLS; FDM discouraged; 100 microns minimum); - 1 x **Pneumatic Connectors (No Pressure)** — Print [the STL part](https://github.com/makers-for-life/makair-parts/tree/master/src/pneumatic-connectors/printing/stl) using the same printer, make sure that you pick the proper sub-part (SLA or SLS; FDM discouraged; 100 microns minimum); - 1 x **Pneumatic Connectors (Pressure)** — Print [the STL part](https://github.com/makers-for-life/makair-parts/tree/master/src/pneumatic-connectors/printing/stl) using the same printer, make sure that you pick the proper sub-part (SLA or SLS; FDM discouraged; 100 microns minimum); If you are using your own proprietary blower — _in addition to the parts above_ — please adjust the [Blower Holder](https://github.com/makers-for-life/makair-parts/tree/master/src/blower-holder) CAD model and print it as well (this one prints well using a FDM printer at worst). ### 2. Casing Now that you got all parts printed, you may assemble them in the MakAir casing box. We recommend that you build the casing using laser-cut acrylic panels. You may find the casing CAD model for [Fusion 360](https://github.com/makers-for-life/makair-casing/tree/master/src/fusion) or as a [STEP file](https://github.com/makers-for-life/makair-casing/tree/master/src/step). _Please ensure that you cut your acrylic panels using the same sizes than stated on our models; as those sizes are optimized to contain all required parts and electronics in the minimum amount of space._ ## 2️⃣ Setup the electronics Electronics are comprised of two parts: the firmware controller board (typically, an Arduino), and the "raw" PCB electronics (LCD, interface buttons, alarm beeper, etc.). Those parts make up the motherboard, on the top of which a rigid panel is mounted, and user instructions are printed (eg. control button bindings). ### 1. Motherboard The motherboard electronic schematics and wiring diagrams [can be found there](https://github.com/makers-for-life/makair-motherboard/tree/master/src/schematics). Please pick the last version available. 👋 _If you need help on this step, you may [open an issue](https://github.com/makers-for-life/makair-motherboard/issues/new)._ ### 2. Smaller Boards The smaller boards electronic schematics and wiring diagrams [can be found there](https://github.com/makers-for-life/makair-boards/tree/master/src/schematics). Please pick the last version available. Those boards are used eg. to control the pinch valve motor or Raspberry Pi hardware clock. 👋 _If you need help on this step, you may [open an issue](https://github.com/makers-for-life/makair-boards/issues/new)._ ### 3. Control Unit Screen The control unit is made of a [Raspberry Pi 4](https://www.raspberrypi.org/products/raspberry-pi-4-model-b/) computer, plugged to a [Raspberry Pi Touch Display](https://www.raspberrypi.org/products/raspberry-pi-touch-display/). 👋 _If you need help on this step, you may [open an issue](https://github.com/makers-for-life/makair-control-ui/issues/new)._ ## 3️⃣ Flash the firmware ### 1. Ventilator Firmware Now that both mechanical parts and electronics are ready, you may flash the latest MakAir firmware binary on your firmware controller board (Arduino, ST Nucleo, or other). Firmware release binaries are available for download on our [releases page](https://github.com/makers-for-life/makair-firmware/releases). 👋 _If you need help on this step, you may [open an issue](https://github.com/makers-for-life/makair-firmware/issues/new)._ ### 2. Control Unit Runtime The Control Unit should be built and ran on the Raspberry Pi 4 using instructions available on the [Control Unit](https://github.com/makers-for-life/makair-control-ui) documentation. You should flash the system image readily available in the [Files](https://github.com/makers-for-life/makair-files) repository. 👋 _If you need help on this step, you may [open an issue](https://github.com/makers-for-life/makair-control-ui/issues/new)._ # Schemes ## Pneumatic Circuit Scheme [](./docs/Pneumatics/Pneumatic%20Circuit/Pneumatic%20Circuit.png) _(design by [Valerian Saliou](https://github.com/valeriansaliou))_ ## Casing Layout ### Top Part: Electronics (Power & Controllers) [](./docs/Casing/Casing%20Layout/Casing%20Layout%20Electronics.png) _(design by Arthur Dagard; drawing by [Valerian Saliou](https://github.com/valeriansaliou); remake by [Lāsma Fedotova](https://github.com/lasmafedotova))_ ### Bottom Part: Pneumatics [](./docs/Casing/Casing%20Layout/Casing%20Layout%20Pneumatics.png) _(design by Arthur Dagard; drawing by [Valerian Saliou](https://github.com/valeriansaliou); remake by [Lāsma Fedotova](https://github.com/lasmafedotova))_ # Article Series A series of explanatory articles have been written on the MakAir story, with the goal of making it easier for teams in the future to start their own ventilator project: * 1️⃣ [MakAir Series: The Inception of an Open-Source Ventilator Project](https://journal.valeriansaliou.name/makair-series-the-inception-of-an-open-source-ventilator-project/) * 2️⃣ [MakAir Series: How to Ventilate a Human Patient 101](https://journal.valeriansaliou.name/makair-series-how-to-ventilate-a-human-patient-101/) * 3️⃣ [MakAir Series: The Building Blocks of a Mechanical Ventilator](https://journal.valeriansaliou.name/makair-series-the-building-blocks-of-a-mechanical-ventilator/) * 4️⃣ [MakAir Series: Engineering Focus on Ventilator Pneumatics](https://journal.valeriansaliou.name/makair-series-engineering-focus-on-ventilator-pneumatics/) * 5️⃣ [MakAir Series: Engineering Focus on Ventilator Electronics](https://journal.valeriansaliou.name/makair-series-engineering-focus-on-ventilator-electronics/) * 6️⃣ [MakAir Series: Engineering Focus on Ventilator Software](https://journal.valeriansaliou.name/makair-series-engineering-focus-on-ventilator-software/) # News & Contact ## Updates * Live updates on Telegram: [join "Newsroom MakAir (Covid-19 Ventilator)"](https://t.me/joinchat/AAAAAE_99-k7pKZur-GXCQ) * YouTube channel: [view "MakAir" on YouTube](https://www.youtube.com/channel/UCcf_3KXjeJSMz39J6gsyTSg) * Coordination on Slack: [request to join "Makers For Life"](https://github.com/makers-for-life/makair/issues/new) (open an issue) ## Contacts * Open-source & questions: [please open an issue on GitHub](https://github.com/makers-for-life/makair/issues/new) * Press contacts: [Grégory Thibord](https://twitter.com/thibord) ([email](mailto:[email protected])) * Medical contacts: [Pierre Antoine Gourraud](http://www.itun.nantes.inserm.fr/Team-5/Pierre-Antoine-Gourraud) ([email](mailto:[email protected])) * Industry relations: [Quentin Adam](http://waxzce.org/) ([email](mailto:[email protected])) * Engineering contact (mechanics): [Valerian Saliou](https://valeriansaliou.name/) ([email](mailto:[email protected])) * Engineering contact (software): [David Sferruzza](https://david.sferruzza.fr/) ([email](mailto:[email protected])) * Engineering contact (electronics): Vincent Le Cunff ([email](mailto:[email protected])) # Sponsors & Contributors This project would not have been possible without the support of those companies and organizations, which have put human, real estate and/or financial resources at work on the project: * [Clever Cloud](https://www.clever-cloud.com/) (founding team) * [Crisp](https://crisp.chat/) (founding team) * [Cooprint](https://cooprint.fr/) (CAD) * [SenX](https://senx.io/) (electronics) * [Tronico](https://www.tronico-alcen.com/) (PCB design) * [Renault Group](https://www.renault.fr/) (manufacturing) * [SEB Group](https://www.groupeseb.com/) (manufacturing) * [Le Palace Nantes](https://lepalace.work/) (team offices) * [Parrot](https://www.parrot.com/) (hardware provider) * [STMicroelectronics](https://www.st.com/) (hardware provider) * [Diabeloop](https://www.diabeloop.com/) (regulatory help) * [Legrand](https://www.legrand.fr/) (hardware provider) * [RTsys](https://rtsys.eu/) (engineering provider) We are supported by public entities as well, namely: * [Defence Innovation Agency](https://www.defense.gouv.fr/) (Ministry of Armed Forces of France) * [CEA](http://www.cea.fr/) (France) * [CHU of Nantes](https://www.chu-nantes.fr/) (France) * [University of Nantes](https://www.univ-nantes.fr/) (France) * [City of Nantes](https://metropole.nantes.fr/) (France) * [Region of Auvergne-Rhône-Alpes](https://www.auvergnerhonealpes.fr/) (France) Adding to that, 200+ individual members of the project who contributed to technical, legal, medical and press subjects (and more). # Research Papers * [Can Open Source Hardware Mechanical Ventilator initiatives help cope with the COVID-19 health crisis](https://www.sciencedirect.com/science/article/pii/S2468067220300596) (English) * [MakAir, a COVID-19-born ventilation machine, combining 3D printing design, digital control and open innovation](https://www.sciencedirect.com/science/article/pii/S1279847920301129) (French) # Press Coverage ## 📺 TV * [France 3, 21st April 2020](https://www.youtube.com/watch?v=M3QLCvUyIII) (French-speaking) * [TF1, 26th April 2020](https://www.youtube.com/watch?v=2X157RLbRIA) (French-speaking) ## 🗞 Newspapers * [Makery, 23th July 2020](https://www.makery.info/en/2020/07/23/quentin-adam-lopen-source-medical-est-une-idee-qui-fera-son-chemin/) (English) * [Le Monde, 20th April 2020](https://www.lemonde.fr/campus/article/2020/04/20/entre-nantes-et-grenoble-une-course-contre-la-montre-pour-creer-un-respirateur-artificiel-a-bas-cout_6037140_4401467.html) (French-speaking) * [Le Parisien, 21st April 2020](http://www.leparisien.fr/economie/business/coronavirus-une-equipe-nantaise-a-reinvente-le-respirateur-artificiel-en-un-mois-21-04-2020-8303016.php) (French-speaking) * [Le Figaro, 26th April 2020](https://www.lefigaro.fr/secteur/high-tech/creer-un-respirateur-artificiel-a-bas-cout-la-folle-aventure-de-makers-for-life-20200426) (French-speaking) * [Le Point, 6th May 2020](https://www.lepoint.fr/sciences-nature/a-brest-on-teste-le-respirateur-concu-par-des-geeks-06-05-2020-2374359_1924.php) (French-speaking)

Introduction to APIs course

[](https://twilio.com/quest?utm_source=gh-badge&utm_medium=referral&utm_campaign=intro-to-apis) # 👋 Introduction to APIs Hello and welcome to this free course on Application Programming Interfaces, or APIs. ⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️ This course has been deprecated! That means that you should no longer use it, you should head to the newer 2023 version! [](https://youtu.be/WXsD0ZgxjRw) [2023 notes](https://twil.io/notes-api-course) ⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️⛔️ ## Important links * [Course notes](./course-notes.md) * [Glitch starter repo for Complimentr in Python](https://github.com/craigsdennis/intro-to-apis-flask) * [Glitch starter repo for Complimentr in JavaScript](https://github.com/craigsdennis/intro-to-apis-node) * [Learn more for free using a video game 🎮](https://twilio.com/quest?utm_source=gh-link&utm_medium=referral&utm_campaign=intro-to-apis) [@craigsdennis](https://twitter.com/craigsdennis)

Crpyocurrency App powered by RapidAPI

# Cryptoverse - Explore the World of Cryptocurrency  ## Introduction This is a code repository for the corresponding video tutorial. In this video, we will create a cryptocurrency app. We're going to use React and multiple APIs powered by https://rapidapi.com. By the end of this video, you will become the master of working with APIs.

Vim-fork focused on extensibility and usability

<h1 align="center"> <img src="https://raw.githubusercontent.com/neovim/neovim.github.io/master/logos/neovim-logo-300x87.png" alt="Neovim"> <a href="https://neovim.io/doc/">Documentation</a> | <a href="https://app.element.io/#/room/#neovim:matrix.org">Chat</a> </h1> [](https://github.com/neovim/neovim/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush) [](https://scan.coverity.com/projects/2227) [](https://neovim.io/doc/reports/clang) [](https://neovim.io/doc/reports/pvs/PVS-studio.html.d) [](https://repology.org/metapackage/neovim) [](https://buildd.debian.org/neovim) [](https://github.com/neovim/neovim/releases/) Neovim is a project that seeks to aggressively refactor [Vim](https://www.vim.org/) in order to: - Simplify maintenance and encourage [contributions](CONTRIBUTING.md) - Split the work between multiple developers - Enable [advanced UIs] without modifications to the core - Maximize [extensibility](https://github.com/neovim/neovim/wiki/Plugin-UI-architecture) See the [Introduction](https://github.com/neovim/neovim/wiki/Introduction) wiki page and [Roadmap] for more information. Features -------- - Modern [GUIs](https://github.com/neovim/neovim/wiki/Related-projects#gui) - [API access](https://github.com/neovim/neovim/wiki/Related-projects#api-clients) from any language including C/C++, C#, Clojure, D, Elixir, Go, Haskell, Java/Kotlin, JavaScript/Node.js, Julia, Lisp, Lua, Perl, Python, Racket, Ruby, Rust - Embedded, scriptable [terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html) - Asynchronous [job control](https://github.com/neovim/neovim/pull/2247) - [Shared data (shada)](https://github.com/neovim/neovim/pull/2506) among multiple editor instances - [XDG base directories](https://github.com/neovim/neovim/pull/3470) support - Compatible with most Vim plugins, including Ruby and Python plugins See [`:help nvim-features`][nvim-features] for the full list, and [`:help news`][nvim-news] for noteworthy changes in the latest version! Install from package -------------------- Pre-built packages for Windows, macOS, and Linux are found on the [Releases](https://github.com/neovim/neovim/releases/) page. [Managed packages] are in [Homebrew], [Debian], [Ubuntu], [Fedora], [Arch Linux], [Void Linux], [Gentoo], and more! Install from source ------------------- See the [Building Neovim](https://github.com/neovim/neovim/wiki/Building-Neovim) wiki page and [supported platforms](https://neovim.io/doc/user/support.html#supported-platforms) for details. The build is CMake-based, but a Makefile is provided as a convenience. After installing the dependencies, run the following command. make CMAKE_BUILD_TYPE=RelWithDebInfo sudo make install To install to a non-default location: make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/full/path/ make install CMake hints for inspecting the build: - `cmake --build build --target help` lists all build targets. - `build/CMakeCache.txt` (or `cmake -LAH build/`) contains the resolved values of all CMake variables. - `build/compile_commands.json` shows the full compiler invocations for each translation unit. Transitioning from Vim -------------------- See [`:help nvim-from-vim`](https://neovim.io/doc/user/nvim.html#nvim-from-vim) for instructions. Project layout -------------- ├─ ci/ build automation ├─ cmake/ CMake utils ├─ cmake.config/ CMake defines ├─ cmake.deps/ subproject to fetch and build dependencies (optional) ├─ runtime/ plugins and docs ├─ src/nvim/ application source code (see src/nvim/README.md) │ ├─ api/ API subsystem │ ├─ eval/ VimL subsystem │ ├─ event/ event-loop subsystem │ ├─ generators/ code generation (pre-compilation) │ ├─ lib/ generic data structures │ ├─ lua/ Lua subsystem │ ├─ msgpack_rpc/ RPC subsystem │ ├─ os/ low-level platform code │ └─ tui/ built-in UI └─ test/ tests (see test/README.md) License ------- Neovim contributions since [b17d96][license-commit] are licensed under the Apache 2.0 license, except for contributions copied from Vim (identified by the `vim-patch` token). See LICENSE for details. Vim is Charityware. You can use and copy it as much as you like, but you are encouraged to make a donation for needy children in Uganda. Please see the kcc section of the vim docs or visit the ICCF web site, available at these URLs: https://iccf-holland.org/ https://www.vim.org/iccf/ https://www.iccf.nl/ You can also sponsor the development of Vim. Vim sponsors can vote for features. The money goes to Uganda anyway. [license-commit]: https://github.com/neovim/neovim/commit/b17d9691a24099c9210289f16afb1a498a89d803 [nvim-features]: https://neovim.io/doc/user/vim_diff.html#nvim-features [nvim-news]: https://neovim.io/doc/user/news.html [Roadmap]: https://neovim.io/roadmap/ [advanced UIs]: https://github.com/neovim/neovim/wiki/Related-projects#gui [Managed packages]: https://github.com/neovim/neovim/wiki/Installing-Neovim#install-from-package [Debian]: https://packages.debian.org/testing/neovim [Ubuntu]: https://packages.ubuntu.com/search?keywords=neovim [Fedora]: https://packages.fedoraproject.org/pkgs/neovim/neovim/ [Arch Linux]: https://www.archlinux.org/packages/?q=neovim [Void Linux]: https://voidlinux.org/packages/?arch=x86_64&q=neovim [Gentoo]: https://packages.gentoo.org/packages/app-editors/neovim [Homebrew]: https://formulae.brew.sh/formula/neovim <!-- vim: set tw=80: -->

Tutorial created in collaboration with Enyel Sequeira, taught by JavaScript Mastery.

# Travel Advisor  ## Introduction Build and Deploy an advanced Travel Companion Application using Google Maps. With Geolocation, Google Maps API, Searching for places, Fetching restaurants, hotels and attractions based on location from specialized Rapid APIs, data filtering and much more, this Travel Advisor App is the best Maps Application that you can currently find on YouTube and on the entire internet. In this video, you'll learn: - Advanced React Best Practices such as folder & file structure, hooks and refs - Creating a User Interface using Material UI - Working with Google Maps API - And most importantly fetching data from unlimited sources using RapidAPI - Essentially, you'll become the master of working with APIs [RapidAPI](https://rapidapi.com/hub?utm_source=youtube.com/JavaScriptMastery&utm_medium=DevRel&utm_campaign=DevRel) [Travel Advisor API](https://rapidapi.com/apidojo/api/travel-advisor?utm_source=youtube.com/JavaScriptMastery&utm_medium=DevRel&utm_campaign=DevRel) [Open Weather Map API](https://rapidapi.com/community/api/open-weather-map?utm_source=youtube.com/JavaScriptMastery&utm_medium=DevRel&utm_campaign=DevRel) ## Stay up to date with new projects New major projects coming soon, subscribe to the mailing list to stay up to date https://javascriptmastery.eo.page/mailing-list. Setup: run ```npm i && npm start``` to start the development server

A api management platform.（API管理平台XXL-API）

<p align="center"> <img src="https://www.xuxueli.com/doc/static/xxl-job/images/xxl-logo.jpg" width="150"> <h3 align="center">XXL-API</h3> <p align="center"> XXL-API, a api management platform. <br> <a href="https://www.xuxueli.com/xxl-api/"><strong>-- Home Page --</strong></a> <br> <br> <a href="https://github.com/xuxueli/xxl-api/releases"> <img src="https://img.shields.io/github/release/xuxueli/xxl-api.svg" > </a> <a href="http://www.gnu.org/licenses/gpl-3.0.html"> <img src="https://img.shields.io/badge/license-GPLv3-blue.svg" > </a> <a href="https://www.xuxueli.com/page/donate.html"> <img src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square" > </a> </p> </p> ## Introduction XXL-API is a powerful and easy-to-use API management platform that provides "management", "documentation", "Mock", and "test" functions for the API. Open source code, out-of-the-box. XXL-API 是一个强大易用的API管理平台，提供API的"管理"、"文档"、"Mock"和"测试"等功能。现已开放源代码，开箱即用。 ## Documentation - [中文文档](https://www.xuxueli.com/xxl-api/) ## Communication - [社区交流](https://www.xuxueli.com/page/community.html) ## Features - 1、极致简单：交互简洁，一分钟上手； - 2、项目隔离：API以项目为维度进行拆分隔离； - 3、分组管理：单个项目内的API支持自定义分组进行管理； - 4、标记星级：支持标注API星级，标记后优先展示； - 5、API管理：创建、更新和删除API； - 6、API属性完善：支持设置丰富的API属性如：API状态、请求方法、请求URL、请求头部、请求参数、响应结果、响应结果格式、响应结果参数、API备注等等； - 7、markdown：支持为API添加markdown格式的备注信息； - 8、Mock：支持为API定义Mock数据并制定数据响应格式，从而快速提供Mock接口，加快开发进度； - 9、在线测试：支持在线对API进行测试并保存测试数据，提供接口测试效率； - 10、权限控制：支持以业务线为维度进行用户权限控制，分配权限才允许操作业务线下项目接口和数据类型，否则仅允许查看； ## Contributing Contributions are welcome! Open a pull request to fix a bug, or open an [Issue](https://github.com/xuxueli/xxl-api/issues/) to discuss a new feature or change. 欢迎参与项目贡献！比如提交PR修复一个bug，或者新建 [Issue](https://github.com/xuxueli/xxl-api/issues/) 讨论新特性或者变更。 ## 接入登记 更多接入的公司，欢迎在 [登记地址](https://github.com/xuxueli/xxl-api/issues/1 ) 登记，登记仅仅为了产品推广。 ## Copyright and License This product is open source and free, and will continue to provide free community technical support. Individual or enterprise users are free to access and use. - Licensed under the GNU General Public License (GPL) v3. - Copyright (c) 2015-present, xuxueli. 产品开源免费，并且将持续提供免费的社区技术支持。个人或企业内部可自由的接入和使用。 ## Donate No matter how much the amount is enough to express your thought, thank you very much ：） [To donate](https://www.xuxueli.com/page/donate.html ) 无论金额多少都足够表达您这份心意，非常感谢 ：） [前往捐赠](https://www.xuxueli.com/page/donate.html )

The simplest way to create REST API with Laravel

<p align="center"> <img src="https://res.cloudinary.com/dudxt4lp6/image/upload/v1572976051/Laravel%20Orion/logo_with_text_t5jjyc.png" width="400"> </p> <p align="center"> <a href="https://packagist.org/packages/tailflow/laravel-orion"><img src="https://img.shields.io/packagist/v/tailflow/laravel-orion.svg" alt="Latest Version on Packagist"></a> <a href="https://github.com/tailflow/laravel-orion/actions"><img src="https://img.shields.io/github/actions/workflow/status/tailflow/laravel-orion/ci.yml?branch=main" alt="Build Status"></a> </p> ## Introduction Laravel Orion allows you to build a fully featured REST API based on your Eloquent models and relationships with simplicity of Laravel as you love it. ## Official Documentation Documentation for Laravel Orion can be found on the [website](https://tailflow.github.io/laravel-orion-docs/). ## Supported By <a href="https://geecko.com?utm_campaign=opensource&utm_source=laravel-orion&utm_medium=github" target="_blank"> <img src="https://res.cloudinary.com/dudxt4lp6/image/upload/v1639908579/Laravel%20Orion/logo_geecko_hcuz34.svg" width="300"> </a> <a href="https://laraveldaily.com?utm_campaign=opensource&utm_source=laravel-orion&utm_medium=github" style="margin-left: 1rem"> <img src="https://res.cloudinary.com/dudxt4lp6/image/upload/v1667408230/Laravel%20Orion/logo_laraveldaily_p3d00p.png" height="100"> </a> ## License The Laravel Orion is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).

Hprose is a cross-language RPC. This project is Hprose for Golang.

<p align="center"><img src="http://hprose.com/[email protected]" alt="Hprose" title="Hprose" width="650" height="200" /></p> # Hprose 2.0 for Golang [](https://gitter.im/hprose/hprose-golang?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://travis-ci.org/hprose/hprose-golang) [](https://godoc.org/github.com/hprose/hprose-golang) [](https://goreportcard.com/report/github.com/hprose/hprose-golang) [](https://codebeat.co/projects/github-com-hprose-hprose-golang) [](https://coveralls.io/github/hprose/hprose-golang?branch=master) [](http://opensource.org/licenses/MIT) [Hprose 2.0 for Golang 中文文档](https://github.com/hprose/hprose-golang/wiki) >--- - **[Introduction](#introduction)** - **[Installation](#installation)** - **[Usage](#usage)** - **[Http Server](#http-server)** - [Based on net/http](#based-on-nethttp) - [Based on fasthttp](#based-on-fasthttp) - [Based on gin](#based-on-gin) - [Based on echo](#based-on-echo) - [Based on beego](#based-on-beego) - [Based on iris](#based-on-iris) - **[Http Client](#http-client)** - [Synchronous Invoking](#synchronous-invoking) - [Asynchronous Invoking](#asynchronous-invoking) - [Passing by reference parameters](#passing-by-reference-parameters) - **[Custom Struct](#custom-struct)** - [Field Alias of Custom Struct](#field-alias-of-custom-struct) - **[Hprose Proxy](#hprose-proxy)** - **[Simple Mode](#simple-mode)** - **[WebSocket Server & Client](#websocket-server--client)** - [WebSocket Server](#websocket-server) - [WebSocket Client](#websocket-client) - **[Unix Socket Server & Client](#unix-socket-server--client)** - [Unix Socket Server](#unix-socket-server) - [Unix Socket Client](#unix-socket-client) - **[Benchmark](#benchmark)** >--- ## Introduction *Hprose* is a High Performance Remote Object Service Engine. It is a modern, lightweight, cross-language, cross-platform, object-oriented, high performance, remote dynamic communication middleware. It is not only easy to use, but powerful. You just need a little time to learn, then you can use it to easily construct cross language cross platform distributed application system. *Hprose* supports many programming languages, for example: * AAuto Quicker * ActionScript * ASP * C++ * Dart * Delphi/Free Pascal * dotNET(C#, Visual Basic...) * Golang * Java * JavaScript * Node.js * Objective-C * Perl * PHP * Python * Ruby * ... Through *Hprose*, You can conveniently and efficiently intercommunicate between those programming languages. This project is the implementation of Hprose 2.0 for Golang. ## Installation ```sh go get -u -v github.com/hprose/hprose-golang ``` ## Usage ### Http Server #### Based on net/http ```go package main import ( "net/http" "github.com/hprose/hprose-golang/rpc" ) func hello(name string) string { return "Hello " + name + "!" } func main() { service := rpc.NewHTTPService() service.AddFunction("hello", hello) http.ListenAndServe(":8080", service) } ``` #### Based on fasthttp ```go package main import ( rpc "github.com/hprose/hprose-golang/rpc/fasthttp" "github.com/valyala/fasthttp" ) func hello(name string) string { return "Hello " + name + "!" } func main() { service := rpc.NewFastHTTPService() service.AddFunction("hello", hello) fasthttp.ListenAndServe(":8080", service.ServeFastHTTP) } ``` #### Based on gin ```go package main import ( "github.com/hprose/hprose-golang/rpc" "gopkg.in/gin-gonic/gin.v1" ) func hello(name string) string { return "Hello " + name + "!" } func main() { service := rpc.NewHTTPService() service.AddFunction("hello", hello) router := gin.Default() router.Any("/path", func(c *gin.Context) { service.ServeHTTP(c.Writer, c.Request) }) router.Run(":8080") } ``` #### Based on echo ```go package main import ( "github.com/hprose/hprose-golang/rpc" "github.com/labstack/echo" ) func hello(name string) string { return "Hello " + name + "!" } func main() { service := rpc.NewHTTPService() service.AddFunction("hello", hello) e := echo.New() e.Any("/path", echo.WrapHandler(service)) e.Start(":8080") } ``` #### Based on beego ```go package main import ( "github.com/astaxie/beego" "github.com/hprose/hprose-golang/rpc" ) func hello(name string) string { return "Hello " + name + "!" } func main() { service := rpc.NewHTTPService() service.AddFunction("hello", hello) beego.Handler("/path", service) beego.Run() } ``` #### Based on iris ```go package main import ( rpc "github.com/hprose/hprose-golang/rpc/fasthttp" "github.com/kataras/iris" ) func hello(name string) string { return "Hello " + name + "!" } func main() { service := rpc.NewFastHTTPService() service.AddFunction("hello", hello) iris.Any("/path", func(c *iris.Context) { service.ServeFastHTTP(c.RequestCtx) }) iris.Listen(":8080") } ``` ### Http Client #### Synchronous Invoking ```go package main import ( "fmt" "github.com/hprose/hprose-golang/rpc" ) type HelloService struct { Hello func(string) (string, error) Hello2 func(string) string `name:"hello"` } func main() { client := rpc.NewHTTPClient("http://127.0.0.1:8080/") var helloService *HelloService client.UseService(&helloService) fmt.Println(helloService.Hello("world")) fmt.Println(helloService.Hello2("world")) } ``` Golang does not support function/method overload, but some other languages support. So hprose provides "Function/Method Alias" to invoke overloaded methods in other languages. You can also use it to invoke the same function/method with different names. You just need define multiple func fields that correspond to the same remote method by the same `name` tag. If an error (must be the last out parameter) returned by server-side function/method, or it panics in the server-side, the client will receive it. If the client func field defines an error out parameter (must be the last one), you can get the server-side error or panic from it. If the client func field has not defined an error out parameter, the client call will panic when receive the server-side error or panic. #### Asynchronous Invoking ```go package main import ( "fmt" "time" "github.com/hprose/hprose-golang/rpc" ) type HelloService struct { Hello func(func(string, error), string) Hello2 func(func(string), string) `name:"hello"` } func main() { client := rpc.NewHTTPClient("http://127.0.0.1:8080/") var helloService *HelloService client.UseService(&helloService) helloService.Hello(func(result string, err error) { fmt.Println(result, err) }, "async world") helloService.Hello2(func(result string) { fmt.Println(result) }, "async world") time.Sleep(time.Second) } ``` If the first in parameter is a callback function, you can invoke the remote method asynchronously. The callback in parameters defines like the out parameters in synchronous invoking method. but if you omit the last error parameter, the asynchronous Invoking will NOT panic, the error will be ignore, too. #### Passing by reference parameters Hprose supports passing by reference parameters. The parameters must be pointer types and define func field with tag `byref:"true"`. For example: ```go package main import ( "fmt" "github.com/hprose/hprose-golang/rpc" ) func swap(a, b *int) { *b, *a = *a, *b } type SwapService struct { Swap func(a, b *int) error `byref:"true"` } func main() { server := rpc.NewTCPServer("") server.AddFunction("swap", swap) server.Handle() client := rpc.NewClient(server.URI()) var swapService *SwapService client.UseService(&swapService) a := 1 b := 2 swapService.Swap(&a, &b) fmt.Println(a, b) client.Close() server.Close() } ``` You will find that hprose also supports TCP server and client in this example. ### Custom Struct You can transfer custom struct objects between hprose client and hprose server directly. Using the `Register` method to register your custom struct is the the only thing you need to do. For example: ```go package main import ( "fmt" "github.com/hprose/hprose-golang/io" "github.com/hprose/hprose-golang/rpc" ) type TestUser struct { Name string Sex int Birthday time.Time Age int Married bool } type RemoteObject struct { GetUserList func() []TestUser } func main() { io.Register(TestUser{}, "User") client := rpc.NewClient("http://www.hprose.com/example/") var ro *RemoteObject client.UseService(&ro) fmt.Println(ro.GetUserList()) } ``` The first argument of `Register` is an object or pointer of your custom struct. The second argument is the alias of your custom struct. The real name of your custom struct can be different between the client and the server, as long as they registered the same alias. The server of this example was written in PHP. In fact, You can use custom struct with golang server too. #### Field Alias of Custom Struct The first letter of the field name will be lowercased automatically when it is serialized by hprose. So we don't need to define a tag to implement this feature like JSON serialization when we interact with the other languages. But it doesn't mean that hprose can't support to define field alias by tag. In fact, it can not only, and it can be compatible with the field alias definition in JSON serialization way. For example: ```go type User struct { Name string `json:"n"` Age int `json:"a"` ThisFieldWillNotBeSerialized string `json:"-"` } io.Register(User{}, "User", "json") ``` The struct above is defined for JSON serialization. But when we called `Register` by passing the third argument `"json"`, we can use the fields aliases defined in `json` tags for hprose serialization. If the field alias is `"-"`, it will be not serialized. You can change the `json` tag to be anything else in the struct definition, such as `hprose`, as long as it is the same with the value of the `Register` third argument. ### Hprose Proxy Hprose supports publishing a special method: MissingMethod. All methods not explicitly published will be redirected to the method. You can use it to implement an hprose proxy. And hprose provides an ResultMode options to improve performance of the proxy server. You can use it like this: ```go package main import ( "net/http" "reflect" "github.com/hprose/hprose-golang/rpc" ) type HproseProxy struct { client rpc.Client settings rpc.InvokeSettings } func newHproseProxy() *HproseProxy { proxy := new(HproseProxy) proxy.client = rpc.NewClient("http://www.hprose.com/example/") proxy.settings = rpc.InvokeSettings{ Mode: rpc.Raw, ResultTypes: []reflect.Type{reflect.TypeOf(([]byte)(nil))}, } return proxy } func (proxy *HproseProxy) Proxy( name string, args []reflect.Value, context rpc.Context) ([]reflect.Value, error) { return proxy.client.Invoke(name, args, &proxy.settings) } func main() { service := rpc.NewHTTPService() service.AddMissingMethod(newHproseProxy().Proxy, rpc.Options{Mode: rpc.Raw}) http.ListenAndServe(":8080", service) } ``` You can also define func field with tag `mode` in client, and the return value must be `[]byte`. The server result mode option is setting by `Options` parameter. The ResultMode have 4 values: * Normal * Serialized * Raw * RawWithEndTag The `Normal` result mode is the default value. In `Serialized` result mode, the returned value is an hprose serialized data in []byte, but the arguments and exception will be parsed to the normal value. In `Raw` result mode, all the reply will be returned directly to the result in []byte, but the result data doesn't have the hprose `TagEnd`. The `RawWithEndTag` is similar to the `Raw` result mode, but it has the hprose `TagEnd`. With the ResultMode option, you can store, cache and forward the result in the original format. ### Simple Mode By default, the data between the hprose client and server can be passed with internal references. if your data have no internal references, you can open the simple mode to improve performance. ```go package main import ( "fmt" "github.com/hprose/hprose-golang/rpc" ) func hello(name string) string { return "Hello " + name + "!" } type HelloService struct { Hello func(string) (string, error) `simple:"true"` } func main() { server := rpc.NewTCPServer("") server.AddFunction("hello", hello, rpc.Options{Simple: true}) server.Handle() client := rpc.NewClient(server.URI()) var helloService *HelloService client.UseService(&helloService) fmt.Println(helloService.Hello("World")) client.Close() server.Close() } ``` ### WebSocket Server & Client #### WebSocket Server ```go package main import ( "net/http" "runtime" rpc "github.com/hprose/hprose-golang/rpc/websocket" ) func hello(name string) string { return "Hello " + name + "!" } func main() { service := rpc.NewWebSocketService() service.AddFunction("hello", hello) http.ListenAndServe(":8080", service) } ``` #### WebSocket Client ```go package main import ( "fmt" rpc "github.com/hprose/hprose-golang/rpc/websocket" ) type HelloService struct { Hello func(string) (string, error) } func main() { client := rpc.NewWebSocketClient("ws://127.0.0.1:8080/") var helloService *HelloService client.UseService(&helloService) fmt.Println(helloService.Hello("world")) } ``` ### Unix Socket Server & Client #### Unix Socket Server ```go package main import ( "net/http" "runtime" "github.com/hprose/hprose-golang/rpc" ) func hello(name string) string { return "Hello " + name + "!" } func main() { server := rpc.NewUnixServer("unix:///tmp/hprose.sock") server.AddFunction("hello", hello) server.Start() } ``` #### Unix Socket Client ```go package main import ( "fmt" "github.com/hprose/hprose-golang/rpc" ) type HelloService struct { Hello func(string) (string, error) } func main() { client := rpc.NewUnixClient("unix:///tmp/hprose.sock") var helloService *HelloService client.UseService(&helloService) fmt.Println(helloService.Hello("world")) } ``` ## Benchmark Hprose is faster than golang RPC, you can run benchmark like this: ``` go test --bench=".*" github.com/hprose/hprose-golang/examples/bench ``` * go1.7.1 darwin/amd64 * macOS Sierra * iMac (Retina 5K, 27-inch, Late 2015) * CPU 4GHz Intel Core i7 * Memory 32 GB 1867 MHz DDR3 ``` BenchmarkParallelHprose2-8 200000 11230 ns/op BenchmarkParallelHprose2Unix-8 300000 5234 ns/op BenchmarkParallelGobRPC-8 100000 16675 ns/op BenchmarkParallelGobRPCUnix-8 200000 6798 ns/op BenchmarkParallelJSONRPC-8 100000 17261 ns/op BenchmarkParallelJSONRPCUnix-8 200000 7917 ns/op ``` ``` BenchmarkHprose2-8 50000 34287 ns/op BenchmarkHprose2Unix-8 200000 11470 ns/op BenchmarkGobRPC-8 30000 45576 ns/op BenchmarkGobRPCUnix-8 100000 24216 ns/op BenchmarkJSONRPC-8 30000 51298 ns/op BenchmarkJSONRPCUnix-8 50000 27408 ns/op ```

A REST client inside your Laravel app

<p align="center"><img src="https://res.cloudinary.com/dave24hwj8/image/upload/v1585775689/new-laravel-compass-logo.svg"></p> <p align="center"> <a href="https://github.com/davidhsianturi/laravel-compass/actions"><img src="https://github.com/davidhsianturi/laravel-compass/workflows/tests/badge.svg" alt="Build Status"></a> <a href="https://packagist.org/packages/davidhsianturi/laravel-compass"><img src="https://img.shields.io/packagist/dt/davidhsianturi/laravel-compass" alt="Total Downloads"></a> <a href="https://packagist.org/packages/davidhsianturi/laravel-compass"><img src="https://img.shields.io/packagist/v/davidhsianturi/laravel-compass" alt="Latest Stable Version"></a> <a href="https://packagist.org/packages/davidhsianturi/laravel-compass"><img src="https://img.shields.io/packagist/l/davidhsianturi/laravel-compass" alt="License"></a> </p> <p align="center"> <kbd> <img src="https://res.cloudinary.com/dave24hwj8/image/upload/v1585775692/Screen_Shot_2020-04-02_at_16.05.24_PM.png"> </kbd> </p> ## Introduction Laravel Compass is an elegant REST assistant for the Laravel framework that you can use to test API calls and create API documentation. it provides automatically endpoints for GET, POST, PUT/PATCH, DELETE, various auth mechanisms, and other utility endpoints based on Laravel routes in your project. ## Installation and usage This package requires PHP 7.2 and Laravel 6.0 or higher. You'll find installation instructions and full documentation on https://davidhsianturi.com/laravel-compass. ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. ## Contributing Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ## License Laravel Compass is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

:cake: Wow, such a powerful music API framework

<p align="center"> <img src="https://user-images.githubusercontent.com/2666735/30165599-36623bea-93a6-11e7-8956-1ddf99ce0e6f.png" alt="Meting"> </p> <p align="center"> <a href="https://i-meto.com"><img alt="Author" src="https://img.shields.io/badge/Author-METO-blue.svg?style=flat-square"/></a> <a href="https://packagist.org/packages/metowolf/Meting"><img alt="Version" src="https://img.shields.io/packagist/v/metowolf/Meting.svg?style=flat-square"/></a> <a href="https://packagist.org/packages/metowolf/meting/stats"><img alt="Downloads" src="https://img.shields.io/packagist/dt/metowolf/Meting.svg?style=flat-square"/></a> <a href="https://travis-ci.org/metowolf/Meting"><img alt="Travis" src="https://img.shields.io/travis/metowolf/Meting.svg?style=flat-square"></a> <img alt="License" src="https://img.shields.io/packagist/l/metowolf/Meting.svg?style=flat-square"/> </p> > :cake: Wow, such a powerful music API framework ## Introduction A powerful music API framework to accelerate your development + **Elegant** - Easy to use, a standardized format for all music platforms. + **Lightweight** - A single-file library that's less than 51KB. + **Powerful** - Support various music platforms, including Tencent, NetEase, Xiami, KuGou, Baidu, Kuwo and more. + **Free** - Under MIT license, need I say more? ## Requirement PHP 5.4+ and BCMath, Curl, OpenSSL extension installed. ## Installation Require this package, with [Composer](https://getcomposer.org), in the root directory of your project. ```bash $ composer require metowolf/meting ``` Then you can import the class into your application: ```php use Metowolf\Meting; $api = new Meting('netease'); $data = $api->format(true)->search('Soldier'); ``` > **Note:** Meting requires [BCMath](http://php.net/manual/en/book.bc.php), [cURL](http://php.net/manual/en/book.curl.php) and [OpenSSL](http://php.net/manual/en/book.openssl.php) extension in order to work. ## Quick Start ```php require 'vendor/autoload.php'; // require 'Meting.php'; use Metowolf\Meting; // Initialize to netease API $api = new Meting('netease'); // Use custom cookie (option) // $api->cookie('paste your cookie'); // Get data $data = $api->format(true)->search('Soldier', [ 'page' => 1, 'limit' => 50 ]); echo $data; // [{"id":35847388,"name":"Hello","artist":["Adele"],"album":"Hello","pic_id":"1407374890649284","url_id":35847388,"lyric_id":35847388,"source":"netease"},{"id":33211676,"name":"Hello","artist":["OMFG"],"album":"Hello",... // Parse link $data = $api->format(true)->url(35847388); echo $data; // {"url":"http:\/\/...","size":4729252,"br":128} ``` ## More usage - [docs](https://github.com/metowolf/Meting/wiki) - [special for netease](https://github.com/metowolf/Meting/wiki/special-for-netease) ## Join the Discussion - [Telegram Group](https://t.me/adplayer) - [Official website](https://i-meto.com) ## Related Projects - [MoePlayer/Hermit-X](https://github.com/MoePlayer/Hermit-X) - [MoePlayer/APlayer-Typecho](https://github.com/MoePlayer/APlayer-Typecho) - [mengkunsoft/MKOnlineMusicPlayer](https://github.com/mengkunsoft/MKOnlineMusicPlayer) - [webjyh/WP-Player](https://github.com/webjyh/WP-Player) - [yiyungent/Meting4Net](https://github.com/yiyungent/Meting4Net) - [injahow/meting-api](https://github.com/injahow/meting-api) - [mPlayer2](https://github.com/dodododooo/mPlayer2) ## Author **Meting** © [metowolf](https://github.com/metowolf), Released under the [MIT](./LICENSE) License.<br> > Blog [@meto](https://i-meto.com) · GitHub [@metowolf](https://github.com/metowolf) · Twitter [@metowolf](https://twitter.com/metowolf)

makes creating API responses in Rails easy and fun

acts_as_api makes creating XML/JSON responses in Rails 3, 4, 5 and 6 easy and fun. It provides a simple interface to determine the representation of your model data, that should be rendered in your API responses. In addition to Rails it theoretically can be used with any ruby app and any database (__ActiveRecord__, __Mongoid__ and __ActiveResource__ are supported out of the box) as it only has few dependencies. The lib is _very_ fast in generating your responses and battle tested in production with platforms like [Diaspora](https://joindiaspora.com) or [flinc](https://flinc.org). ## Introduction acts_as_api enriches the models and controllers of your app in a Rails-like way so you can easily determine how your API responses should look like: ```ruby class User < ActiveRecord::Base acts_as_api api_accessible :public do |template| template.add :first_name template.add :age end # will render json: { "user": { "first_name": "John", "age": 26 } } api_accessible :private, extend: :public do |template| template.add :last_name template.add :email end # will render json: { "user": { "first_name": "John", "last_name": "Doe", "age": 26, "email": "[email protected]" } } end ``` ## Getting started A nice introduction about acts_as_api with examples can be found here: http://fabrik42.github.com/acts_as_api See the Wiki for a lot of usage examples and features: https://github.com/fabrik42/acts_as_api/wiki There are a lot of how-tos like: * [Extending existing api templates](https://github.com/fabrik42/acts_as_api/wiki/Extending-an-existing-api-template) * [Include attributes and all other kinds of methods of your model](https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model) * [Include child associations (if they also act_as_api this will be considered)](https://github.com/fabrik42/acts_as_api/wiki/Including-a-child-association) * [Rename attributes, methods, associations](https://github.com/fabrik42/acts_as_api/wiki/Renaming-an-attribute) * [Keep your API templates out of your models](https://github.com/fabrik42/acts_as_api/wiki/Keep-your-api-templates-out-of-your-models) * [and much more...](https://github.com/fabrik42/acts_as_api/wiki) ## Features: * DRY templates for your api responses * Ships with support for __ActiveRecord__ and __Mongoid__ * Support for Rails 3/4 Responders (extracted to responders gem since Rails 5) * Plays very well together with client libs like [Backbone.js](http://documentcloud.github.com/backbone), [RestKit](http://restkit.org) (iOS) or [gson](http://code.google.com/p/google-gson) (Android). * Easy but very flexible syntax for defining the templates * XML, JSON and JSON-P support out of the box, easy to extend * Minimal dependecies (you can also use it without Rails) * Supports multiple api rendering templates per model. This is especially useful for API versioning or for example for private vs. public access points to a user’s profile. ### Requirements: * ActiveModel (>= 3.0.0) * ActiveSupport (>= 3.0.0) * Rack (>= 1.1.0) ### Links * Introduction: http://fabrik42.github.com/acts_as_api * Docs: http://rdoc.info/projects/fabrik42/acts_as_api * Found a bug? http://github.com/fabrik42/acts_as_api/issues * Wiki: https://github.com/fabrik42/acts_as_api/wiki * Want to contribute - the spec suite is explained here: https://github.com/fabrik42/acts_as_api/tree/master/spec ### Downwards Compatibility Note that upgrading to 0.3.0 will break code that worked with previous versions due to a complete overhaul of the lib. For a legacy version of this readme file look here: https://github.com/fabrik42/acts_as_api/wiki/legacy-acts_as_api-0.2-readme

🚀 PHP Microservice Full Coroutine Framework

 [](https://packagist.org/packages/swoft/swoft) [](https://travis-ci.org/swoft-cloud/swoft) [](https://hub.docker.com/r/swoft/swoft/) [](https://secure.php.net/) [](https://github.com/swoole/swoole-src) [](https://www.swoft.org/docs) [](https://github.com/swoft-cloud/swoft/blob/master/LICENSE) [](https://gitter.im/swoft-cloud/community)  PHP microservice coroutine framework > **[中文说明](README.zh-CN.md)** ## Introduction Swoft is a PHP microservices coroutine framework based on the Swoole extension. Like Go, Swoft has a built-in coroutine web server and a common coroutine client and is resident in memory, independent of traditional PHP-FPM. There are similar Go language operations, similar to the Spring Cloud framework flexible annotations, powerful global dependency injection container, comprehensive service governance, flexible and powerful AOP, standard PSR specification implementation and so on. Through three years of accumulation and direction exploration, Swoft has made Swoft the Spring Cloud in the PHP world, which is the best choice for PHP's high-performance framework and microservices management. ## Feature - Built-in high performance network server(Http/Websocket/RPC/TCP) - Flexible componentization - Flexible annotation function - Diversified command terminal(Console) - Powerful Aspect Oriented Programming（AOP） - Perfect Container management, Dependency Injection (DI) - Flexible event mechanism - Implementation of HTTP message based on PSR-7 - Event Manager Based on PSR-14 - Middleware based on PSR-15 - Internationalization(i18n) support - Simple and efficient parameter validator - High performance connection pool(Mysql/Redis/RPC)，Automatic reconnection - Database is highly compatible Laravel - Cache Redis highly compatible Laravel - Efficient task processing - Efficient seconds crontab - Process pool - Flexible exception handling - Powerful log system - Service registration & discovery - Service breaker - Service restrictions - Service fallback - Configuration Center - Apollo - Consul ## Document - [中文文档](https://www.swoft.org/docs) - [English](http://swoft.io/docs) ## Discuss - Forum https://github.com/swoft-cloud/forum/issues - Gitter.im https://gitter.im/swoft-cloud/community - Reddit https://www.reddit.com/r/swoft/ - QQ Group3: 541038173 - QQ Group2: 778656850(full) - QQ Group1: 548173319(full) ## Requirement - [PHP 7.1+](https://github.com/php/php-src/releases) - [Swoole 4.3.4+](https://github.com/swoole/swoole-src/releases) - [Composer](https://getcomposer.org/) ## Install ### Composer ```bash composer create-project swoft/swoft swoft ``` ## Start - Http Server ```bash [root@swoft swoft]# php bin/swoft http:start ``` - WebSocket Server ```bash [root@swoft swoft]# php bin/swoft ws:start ``` - RPC Server ```bash [root@swoft swoft]# php bin/swoft rpc:start ``` - TCP Server ```bash [root@swoft swoft]# php bin/swoft tcp:start ``` - Process Pool ```bash [root@swoft swoft]# php bin/swoft process:start ``` ## Core Components Component Name | Packagist Version --------------------|--------------------- swoft-annotation | [](https://packagist.org/packages/swoft/annotation) swoft-config | [](https://packagist.org/packages/swoft/config) swoft-db | [](https://packagist.org/packages/swoft/db) swoft-framework | [](https://packagist.org/packages/swoft/framework) swoft-i18n | [](https://packagist.org/packages/swoft/i18n) swoft-proxy | [](https://packagist.org/packages/swoft/proxy) swoft-rpc-client | [](https://packagist.org/packages/swoft/rpc-client) swoft-stdlib | [](https://packagist.org/packages/swoft/stdlib) swoft-tcp-server | [](https://packagist.org/packages/swoft/tcp-server) swoft-aop | [](https://packagist.org/packages/swoft/aop) swoft-connection-pool | [](https://packagist.org/packages/swoft/connection-pool) swoft-error | [](https://packagist.org/packages/swoft/error) swoft-http-message | [](https://packagist.org/packages/swoft/http-message) swoft-log | [](https://packagist.org/packages/swoft/log) swoft-redis | [](https://packagist.org/packages/swoft/redis) swoft-rpc-server | [](https://packagist.org/packages/swoft/rpc-server) swoft-task | [](https://packagist.org/packages/swoft/task) swoft-validator | [](https://packagist.org/packages/swoft/validator) swoft-bean | [](https://packagist.org/packages/swoft/bean) swoft-console | [](https://packagist.org/packages/swoft/console) swoft-event | [](https://packagist.org/packages/swoft/event) swoft-http-server | [](https://packagist.org/packages/swoft/http-server) swoft-process | [](https://packagist.org/packages/swoft/process) swoft-rpc | [](https://packagist.org/packages/swoft/rpc) swoft-server | [](https://packagist.org/packages/swoft/server) swoft-tcp | [](https://packagist.org/packages/swoft/tcp) swoft-websocket-server | [](https://packagist.org/packages/swoft/websocket-server) ## Extension Components Component Name | Packagist Version -----------------|--------------------- swoft-apollo | [](https://packagist.org/packages/swoft/apollo) swoft-breaker | [](https://packagist.org/packages/swoft/breaker) swoft-crontab | [](https://packagist.org/packages/swoft/crontab) swoft-consul | [](https://packagist.org/packages/swoft/consul) swoft-limiter | [](https://packagist.org/packages/swoft/limiter) swoft-view | [](https://packagist.org/packages/swoft/view) swoft-whoops | [](https://packagist.org/packages/swoft/whoops) ## License Swoft is an open-source software licensed under the [LICENSE](LICENSE)

:bar_chart: Cross-platform user-friendly xlsx library for C++11+

<img height="100" src="https://user-images.githubusercontent.com/1735211/29433390-f37fa28e-836c-11e7-8a60-f8df4c30b424.png" alt="xlnt logo"><br/> ==== [](https://travis-ci.org/tfussell/xlnt) [](https://ci.appveyor.com/project/tfussell/xlnt) [](https://coveralls.io/github/tfussell/xlnt?branch=master) [](https://tfussell.gitbooks.io/xlnt/content/) [](http://opensource.org/licenses/MIT) ## Introduction xlnt is a modern C++ library for manipulating spreadsheets in memory and reading/writing them from/to XLSX files as described in [ECMA 376 4th edition](http://www.ecma-international.org/publications/standards/Ecma-376.htm). The first public release of xlnt version 1.0 was on May 10th, 2017. Current work is focused on increasing compatibility, improving performance, and brainstorming future development goals. For a high-level summary of what you can do with this library, see [the feature list](https://tfussell.gitbooks.io/xlnt/content/docs/introduction/Features.html). Contributions are welcome in the form of pull requests or discussions on [the repository's Issues page](https://github.com/tfussell/xlnt/issues). ## Example Including xlnt in your project, creating a new spreadsheet, and saving it as "example.xlsx" ```c++ #include <xlnt/xlnt.hpp> int main() { xlnt::workbook wb; xlnt::worksheet ws = wb.active_sheet(); ws.cell("A1").value(5); ws.cell("B2").value("string data"); ws.cell("C3").formula("=RAND()"); ws.merge_cells("C3:C4"); ws.freeze_panes("B2"); wb.save("example.xlsx"); return 0; } // compile with -std=c++14 -Ixlnt/include -lxlnt ``` ## Documentation Documentation for the current release of xlnt is available [here](https://tfussell.gitbooks.io/xlnt/content/). ## Building xlnt - Using vcpkg You can download and install xlnt using the [vcpkg](https://github.com/microsoft/vcpkg) dependency manager: git clone https://github.com/microsoft/vcpkg.git cd vcpkg ./bootstrap-vcpkg.sh ./vcpkg integrate install ./vcpkg install xlnt The xlnt port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/microsoft/vcpkg) on the vcpkg repository. ## License xlnt is released to the public for free under the terms of the MIT License. See [LICENSE.md](https://github.com/tfussell/xlnt/blob/master/LICENSE.md) for the full text of the license and the licenses of xlnt's third-party dependencies. [LICENSE.md](https://github.com/tfussell/xlnt/blob/master/LICENSE.md) should be distributed alongside any assemblies that use xlnt in source or compiled form.

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具

# ShowDoc ## [点击查看中文版教程](https://www.showdoc.com.cn/help) ### What is ShowDoc? When we take over a module or project which has been developed by others, we always feel crazy watching at the codes without notes or comments. Where is the document?! Where is the document?! **Show me the doc!!** Programmers often want others to write technical documents, but not by themselves. Writing technical documents need lots of time and works, such as it needs to consider how to handle the format and layout of the documents. Beside, the man who writes the documents has to think all kinds of non-technical details. For example, which catalog should to be put in the newly-established word document. In general, all kinds of the word documents are dispersively maintained by different people in a team. How to get the latest documents? Here is a way. The man gets the documents by shouting out, Lol. Then he will receive them from others through IMs or E-mail. This kind of communication is not so bad, but this is not the most effective way. So, what is the most effective way? **ShowDoc comes out!** ShowDoc is a tool greatly applicable for an IT team to share documents online. It can promote communication efficiency between members of a team. ### What can it be used for? - #### API Document ([Demo](https://www.showdoc.com.cn/demo-en)) With the development of mobile Internet, BaaS (Backend as a Service) becomes more and more popular. The server side(backend) provides API, and the APP side or Webpage frontend can conveniently invoke data through the backend. Using ShowDoc can compile exquisite API documents in a very fast and convenient way. - #### Data Dictionary ([Demo](https://www.showdoc.com.cn/demo-en)) A good Data Dictionary, such as database structure can be easily exhibited to others, shown the definition of each field of the database structure. - #### Explain Document ([Demo](https://www.showdoc.com.cn/help-en)) You can absolutely use ShowDoc to write instructions of some tools, or some technical specifications explanation documents for the team to query. ### What functions does it have now? - #### Sharing and Exporting Responsive webpage design can share the project documents to computer or mobile devices for reading. It can also export the project into offline word document. - #### Permission Manage - Public and Private Project Projects on ShowDoc are divided into two categories including Public Project and Private Project. The Public Project can be visited by anyone, the Private Project need to login. The password is set by project owner. - Project Transfer The project owner can freely transfer the project to others. - Project Members You can easily add or delete project members. Members of the project can edit the documents, but they can't transfer or delete the project, only owner has the permission. - #### Edit Function - Support Markdown ShowDoc adopts Markdown Editor, it is excellent both in editing and reading. If you know nothing about Markdown, please google it by the keywords "Learning and Introduction of Markdown". - Template Insert On the editing page, a click on the button which is on the top of the Editor can easily insert API interface template and data dictionary template. After inserting the template, altering data is the only thing needs to be done, and this reduces lots of editing work. - History Version ShowDoc provides a function of History Version on the page, you can easily restore from the history. ### Deploy it on your own server - ShowDoc Deploy Please refer to: [AutoInstall.md](https://github.com/star7th/showdoc/blob/master/documentation/en/AutoInstall.md) - Development & Contribution Please refer to: [Development&Contribution.md](https://github.com/star7th/showdoc/blob/master/documentation/en/Development&Contribution.md) ### About the copyright ShowDoc is issued complying with Apache2 Open Source License, and it is free. Showdoc has an additional copyright notice on compliance with the Apache2 Open Source License: [Showdoc official](https://www.showdoc.com.cn/ 'Showdoc official') And author [star7th](https://github.com/star7th 'star7th') Have the copyright and corresponding rights of the program, On the premise of retaining the copyright information and links on the program UI interface, it can be used for free or secondary development If you need to change copyright information or copyright links, you need to obtain official consent and authorization.

A lightning-fast search engine that fits effortlessly into your apps, websites, and workflow.

<p align="center"> <img src="assets/meilisearch-logo-light.svg?sanitize=true#gh-light-mode-only"> <img src="assets/meilisearch-logo-dark.svg?sanitize=true#gh-dark-mode-only"> </p> <h4 align="center"> <a href="https://www.meilisearch.com">Website</a> | <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> | <a href="https://blog.meilisearch.com">Blog</a> | <a href="https://docs.meilisearch.com">Documentation</a> | <a href="https://docs.meilisearch.com/faq/">FAQ</a> | <a href="https://discord.meilisearch.com">Discord</a> </h4> <p align="center"> <a href="https://deps.rs/repo/github/meilisearch/meilisearch"><img src="https://deps.rs/repo/github/meilisearch/meilisearch/status.svg" alt="Dependency status"></a> <a href="https://github.com/meilisearch/meilisearch/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a> <a href="https://app.bors.tech/repositories/26457"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a> </p> <p align="center">⚡ A lightning-fast search engine that fits effortlessly into your apps, websites, and workflow 🔍</p> Meilisearch helps you shape a delightful search experience in a snap, offering features that work out-of-the-box to speed up your workflow. <p align="center" name="demo"> <a href="https://where2watch.meilisearch.com/#gh-light-mode-only" target="_blank"> <img src="assets/demo-light.gif#gh-light-mode-only" alt="A bright colored application for finding movies screening near the user"> </a> <a href="https://where2watch.meilisearch.com/#gh-dark-mode-only" target="_blank"> <img src="assets/demo-dark.gif#gh-dark-mode-only" alt="A dark colored application for finding movies screening near the user"> </a> </p> 🔥 [**Try it!**](https://where2watch.meilisearch.com/) 🔥 ## ✨ Features - **Search-as-you-type:** find search results in less than 50 milliseconds - **[Typo tolerance](https://docs.meilisearch.com/learn/getting_started/customizing_relevancy.html#typo-tolerance):** get relevant matches even when queries contain typos and misspellings - **[Filtering and faceted search](https://docs.meilisearch.com/learn/advanced/filtering_and_faceted_search.html):** enhance your user's search experience with custom filters and build a faceted search interface in a few lines of code - **[Sorting](https://docs.meilisearch.com/learn/advanced/sorting.html):** sort results based on price, date, or pretty much anything else your users need - **[Synonym support](https://docs.meilisearch.com/learn/getting_started/customizing_relevancy.html#synonyms):** configure synonyms to include more relevant content in your search results - **[Geosearch](https://docs.meilisearch.com/learn/advanced/geosearch.html):** filter and sort documents based on geographic data - **[Extensive language support](https://docs.meilisearch.com/learn/what_is_meilisearch/language.html):** search datasets in any language, with optimized support for Chinese, Japanese, Hebrew, and languages using the Latin alphabet - **[Security management](https://docs.meilisearch.com/learn/security/master_api_keys.html):** control which users can access what data with API keys that allow fine-grained permissions handling - **[Multi-Tenancy](https://docs.meilisearch.com/learn/security/tenant_tokens.html):** personalize search results for any number of application tenants - **Highly Customizable:** customize Meilisearch to your specific needs or use our out-of-the-box and hassle-free presets - **[RESTful API](https://docs.meilisearch.com/reference/api/overview.html):** integrate Meilisearch in your technical stack with our plugins and SDKs - **Easy to install, deploy, and maintain** ## 📖 Documentation You can consult Meilisearch's documentation at [https://docs.meilisearch.com](https://docs.meilisearch.com/). ## 🚀 Getting started For basic instructions on how to set up Meilisearch, add documents to an index, and search for documents, take a look at our [Quick Start](https://docs.meilisearch.com/learn/getting_started/quick_start.html) guide. You may also want to check out [Meilisearch 101](https://docs.meilisearch.com/learn/getting_started/filtering_and_sorting.html) for an introduction to some of Meilisearch's most popular features. ## ☁️ Meilisearch cloud Let us manage your infrastructure so you can focus on integrating a great search experience. Try [Meilisearch Cloud](https://meilisearch.com/pricing) today. ## 🧰 SDKs & integration tools Install one of our SDKs in your project for seamless integration between Meilisearch and your favorite language or framework! Take a look at the complete [Meilisearch integration list](https://docs.meilisearch.com/learn/what_is_meilisearch/sdks.html). [](https://docs.meilisearch.com/learn/what_is_meilisearch/sdks.html) ## ⚙️ Advanced usage Experienced users will want to keep our [API Reference](https://docs.meilisearch.com/reference/api) close at hand. We also offer a wide range of dedicated guides to all Meilisearch features, such as [filtering](https://docs.meilisearch.com/learn/advanced/filtering_and_faceted_search.html), [sorting](https://docs.meilisearch.com/learn/advanced/sorting.html), [geosearch](https://docs.meilisearch.com/learn/advanced/geosearch.html), [API keys](https://docs.meilisearch.com/learn/security/master_api_keys.html), and [tenant tokens](https://docs.meilisearch.com/learn/security/tenant_tokens.html). Finally, for more in-depth information, refer to our articles explaining fundamental Meilisearch concepts such as [documents](https://docs.meilisearch.com/learn/core_concepts/documents.html) and [indexes](https://docs.meilisearch.com/learn/core_concepts/indexes.html). ## 📊 Telemetry Meilisearch collects **anonymized** data from users to help us improve our product. You can [deactivate this](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html#how-to-disable-data-collection) whenever you want. To request deletion of collected data, please write to us at [[email protected]](mailto:[email protected]). Don't forget to include your `Instance UID` in the message, as this helps us quickly find and delete your data. If you want to know more about the kind of data we collect and what we use it for, check the [telemetry section](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html) of our documentation. ## 📫 Get in touch! Meilisearch is a search engine created by [Meili](https://www.welcometothejungle.com/en/companies/meilisearch), a software development company based in France and with team members all over the world. Want to know more about us? [Check out our blog!](https://blog.meilisearch.com/) 🗞 [Subscribe to our newsletter](https://meilisearch.us2.list-manage.com/subscribe?u=27870f7b71c908a8b359599fb&id=79582d828e) if you don't want to miss any updates! We promise we won't clutter your mailbox: we only send one edition every two months. 💌 Want to make a suggestion or give feedback? Here are some of the channels where you can reach us: - For feature requests, please visit our [product repository](https://github.com/meilisearch/product/discussions) - Found a bug? Open an [issue](https://github.com/meilisearch/meilisearch/issues)! - Want to be part of our Discord community? [Join us!](https://discord.gg/meilisearch) - For everything else, please check [this page listing some of the other places where you can find us](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html) Thank you for your support! ## 👩‍💻 Contributing Meilisearch is, and will always be, open-source! If you want to contribute to the project, please take a look at [our contribution guidelines](CONTRIBUTING.md). ## 📦 Versioning Meilisearch releases and their associated binaries are available [in this GitHub page](https://github.com/meilisearch/meilisearch/releases). The binaries are versioned following [SemVer conventions](https://semver.org/). To know more, read our [versioning policy](https://github.com/meilisearch/engine-team/blob/main/resources/versioning-policy.md). Differently from the binaries, crates in this repository are not currently available on [crates.io](https://crates.io/) and do not follow [SemVer conventions](https://semver.org).

🕵️‍♀️ Validate schema, get schema change notifications, validate operations, find breaking changes, look for similar types, schema coverage

[](https://graphql-inspector.com/) [](https://npmjs.com/package/@graphql-inspector/cli) [](https://hub.docker.com/r/kamilkisiela/graphql-inspector) [](https://github.com/prettier/prettier) [](https://renovateapp.com/) [](https://discord.gg/xud7bH9) **GraphQL Inspector** outputs a list of changes between two GraphQL schemas. Every change is precisely explained and marked as breaking, non-breaking or dangerous. It helps you validate documents and fragments against a schema and even find similar or duplicated types. > You may like [GraphQL Hive](https://graphql-hive.com) as well! > > It's an open-source performance monitoring tool and schema registry for GraphQL. > > GraphQL Hive is currently available as a hosted service but it offers self-hosting as well. Use GraphQL Inspector however you want: - [**GitHub Application**](https://graphql-inspector.com/install) - [**GitHub Action**](https://github.com/marketplace/actions/graphql-inspector) - [**CLI**](https://graphql-inspector.com/docs/installation#cli) - [**Programatic API**](https://graphql-inspector.com/docs/installation#programatic-api) ## Features - **Compares schemas** - **Detect breaking or dangerous changes** - **Schema change notifications** - **Use serverless functions validate changes** - **Validates Operations and Fragments against a schema** - **Finds similar / duplicated types** - **Schema coverage based on Operations and Fragments** - **Serves a GraphQL server with faked data and GraphiQL** - **Docker Image** ## Use on GitHub  ## Use everywhere  ## Installation and Usage Visit our website [**graphql-inspector.com**](https://graphql-inspector.com/) to learn more about the project. ## Documentation Documentation is available at [**graphql-inspector.com/docs/introduction**](https://www.graphql-inspector.com/docs/introduction). ## Related Some part of the library was ported to NodeJS from [Ruby's GraphQL Schema Comparator](https://github.com/xuorig/graphql-schema_comparator) ## Contributions Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR! And if this is your first time contributing to this project, please do read our [Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) before you get started off. ### Code of Conduct Help us keep GraphQL Inspector open and inclusive. Please read and follow our [Code of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/) ## License [MIT](https://github.com/kamilkisiela/graphql-inspector/blob/master/LICENSE) © Kamil Kisiela

This bundle provides tools to build a complete GraphQL API server in your Symfony App.

OverblogGraphQLBundle ======================  [](https://ci.appveyor.com/project/overblog/graphqlbundle/branch/master) [](https://coveralls.io/github/overblog/GraphQLBundle?branch=master) [](https://packagist.org/packages/overblog/graphql-bundle) [](https://packagist.org/packages/overblog/graphql-bundle) [](https://packagist.org/packages/overblog/graphql-bundle) This Symfony bundle provides integration of [GraphQL](https://facebook.github.io/graphql/) using [webonyx/graphql-php](https://github.com/webonyx/graphql-php) and [GraphQL Relay](https://relay.dev/docs/guides/graphql-server-specification/). It also supports: * batching with [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer) * batching with [Apollo GraphQL](https://www.apollographql.com/docs/react/api/link/apollo-link-batch-http/) * upload and batching upload with [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client) Browse your version documentation: * [1.0 (DEV)](https://github.com/overblog/GraphQLBundle/blob/master/README.md) * [0.14 (STABLE)](https://github.com/overblog/GraphQLBundle/blob/0.14/README.md) * [0.13 (STABLE)](https://github.com/overblog/GraphQLBundle/blob/0.13/README.md) * [0.12 (DEPRECATE)](https://github.com/overblog/GraphQLBundle/blob/0.12/README.md) * [0.11 (OBSOLETE)](https://github.com/overblog/GraphQLBundle/blob/0.11/README.md) * [0.10 (OBSOLETE)](https://github.com/overblog/GraphQLBundle/blob/0.10/README.md) * [0.9 (OBSOLETE)](https://github.com/overblog/GraphQLBundle/blob/0.9/README.md) * [0.8 (OBSOLETE)](https://github.com/overblog/GraphQLBundle/blob/0.8/README.md) [Versions requirements](docs/index.md#versions-requirements) Proof of Concept ----------------- * [mcg-web/graphql-symfony-doctrine-sandbox](https://github.com/mcg-web/graphql-symfony-doctrine-sandbox) * [michaelperrin/blog-graphql-upload-demo](https://github.com/michaelperrin/blog-graphql-upload-demo) * [overblog/GraphQLBundleDemo](https://github.com/overblog/GraphQLBundleDemo) * [Samffy/graphql-poc](https://github.com/Samffy/graphql-poc) Documentation ------------- - [Quick start](docs/definitions/quick-start.md) - [Installation](docs/index.md) - [Definitions](docs/definitions/index.md) - [Type System](docs/definitions/type-system/index.md) - [Scalars](docs/definitions/type-system/scalars.md) - [Object](docs/definitions/type-system/object.md) - [Interface](docs/definitions/type-system/interface.md) - [Union](docs/definitions/type-system/union.md) - [Enum](docs/definitions/type-system/enum.md) - [Input Object](docs/definitions/type-system/input-object.md) - [Lists](docs/definitions/type-system/lists.md) - [Non-Null](docs/definitions/type-system/non-null.md) - [Type Inheritance](docs/definitions/type-inheritance.md) - [GraphQL schema language](docs/definitions/graphql-schema-language.md) - [Schema](docs/definitions/schema.md) - [Resolver](docs/definitions/resolver.md) - [Experimental coroutine executor](docs/definitions/coroutine-executor.md) - [Solving N+1 problem](docs/definitions/solving-n-plus-1-problem.md) - [Mutation](docs/definitions/mutation.md) - [Relay](docs/definitions/relay/index.md) - [Connection](docs/definitions/relay/connection.md) - [Relay Pagination helper](docs/helpers/relay-paginator.md) - [Node](docs/definitions/relay/node/index.md) - [Node](docs/definitions/relay/node/node.md) - [Plural](docs/definitions/relay/node/plural.md) - [Global id](docs/definitions/relay/node/global-id.md) - [Mutation](docs/definitions/relay/mutation.md) - [Builders](docs/definitions/builders/index.md) - [Field Builder](docs/definitions/builders/field.md) - [Fields Builder](docs/definitions/builders/fields.md) - [Args Builder](docs/definitions/builders/args.md) - [Expression language](docs/definitions/expression-language.md) - [Debug](docs/definitions/debug/index.md) - [GraphiQL](docs/definitions/graphiql/index.md) - [Upload files](docs/definitions/upload-files.md) - [Data fetching](docs/data-fetching/index.md) - [Query batching](docs/data-fetching/batching.md) - [Promise](docs/data-fetching/promise.md) - [Annotations & PHP 8 Attributes](docs/annotations/index.md) - [Validation](docs/validation/index.md) - [Security](docs/security/index.md) - [Handle CORS](docs/security/handle-cors.md) - [Object access control](docs/security/object-access-control.md) - [Fields access control](docs/security/fields-access-control.md) - [Fields public control](docs/security/fields-public-control.md) - [Limiting query depth](docs/security/limiting-query-depth.md) - [Query complexity analysis](docs/security/query-complexity-analysis.md) - [Disable introspection](docs/security/disable_introspection.md) - [Errors handling](docs/error-handling/index.md) - [Events](docs/events/index.md) - [Profiler](docs/profiler/index.md) Talks and slides to help you start ---------------------------------- * GraphQL in Symfony *by Bernd Alter* - [Twitter](https://twitter.com/bazoo0815) - [Talk about GraphQL and its implementation with Symfony (26.04.2017)](https://www.slideshare.net/berndalter7/graphql-in-symfony) `English` * GraphQL is right in front of us, let's do it! *by Renato Mendes Figueiredo* - [Twitter](https://twitter.com/renatomefi), [GitHub](https://github.com/renatomefi) - [Slides at http://talks.mefi.in/graphql-scotphp17](http://talks.mefi.in/graphql-scotphp17/) `English` - [Video at SymfonyCamp UA 2017](https://www.youtube.com/watch?v=jyoYlnCPNgk) `English` - [Video at DPC 2017](https://www.youtube.com/watch?v=E7MjoCOGSSY) `English` * A GraphQL API: From hype to production *by Aurélien David* - [Twitter](https://twitter.com/spyl94), [GitHub](https://github.com/spyl94) - [Slides at https://cap-collectif.slides.com/spyl/web2day-2019](https://cap-collectif.slides.com/spyl/web2day-2019) `English` * Une API GraphQL: du hype à la prod *by Aurélien David* - [Twitter](https://twitter.com/spyl94), [GitHub](https://github.com/spyl94) - [Video at PHPTour 2017 Nantes](https://www.youtube.com/watch?v=xbipW6fgD6c) `French` * Introduction to Symfony Flex and setting up OverblogGraphQLBundle with it *by Renato Mendes Figueiredo* - [Twitter](https://twitter.com/renatomefi), [GitHub](https://github.com/renatomefi) - [Slides at http://talks.mefi.in/symfony-flex-101-symfonycampua](http://talks.mefi.in/symfony-flex-101-symfonycampua/) `English` - [Video at Symfony Camp UA 2017](https://www.youtube.com/watch?v=lWweoiCI9Hk) `English` Community --------- * Get support on [Symfony devs Slack](https://symfony.com/slack-invite) on the dedicated channel **overblog-graphql**. * Get support in Telegram group [Overblog GraphQL](https://t.me/overblog_graphql) * Follow us on [GitHub](https://github.com/overblog) Contributing ------------ * [See contributing documentation](CONTRIBUTING.md) * [Thanks to all contributors](https://github.com/overblog/GraphQLBundle/graphs/contributors)

JSON for Linked Data

The easy PHP Library for calculating holidays

 [](https://github.com/azuyalabs/yasumi/releases) [](https://packagist.org/packages/azuyalabs/yasumi)    [](LICENSE) # Introduction Yasumi (Japanese for 'Holiday'「休み」) is the easy PHP library that helps you retrieve the dates and names of holidays and other special celebrations from various countries/states. It is calculation and rule driven avoiding the need of a comprehensive database. Many services exist that can provide holiday information, however are either not entirely free or only offer limited information. In addition, no exhaustive PHP library exists today covering a wide range of holidays and countries. [PEAR's Date_Holidays](https://pear.php.net/package/Date_Holidays) library was a similar attempt, however it hasn't been updated for a long time. # Highlights The goal of Yasumi is to be powerful while remaining lightweight, by utilizing PHP native classes wherever possible. Yasumi's calculation is provider-based (i.e. by country/state), making it easy to add new holiday providers that calculate holidays. - Straightforward API - Framework-agnostic - Use of Providers to easily extend and expand new Holidays - Common Holiday Providers - Accounts for the date/time when holidays have been officially established and/or abolished - Filters enabling to easily select certain holiday types (Official, Observed, Bank, Seasonal or Other) - Global Translations - Timezone aware - Implements [ArrayIterator](https://www.php.net/manual/en/class.arrayiterator.php) to easily process a provider's holidays - Fully documented - Fully unit tested - [Composer](https://getcomposer.org) ready, [PSR-12](https://www.php-fig.org/psr/psr-12/) and [PSR-4](https://www.php-fig.org/psr/psr-4/) compliant # Documentation Yasumi’s documentation is available on [https://www.yasumi.dev](https://www.yasumi.dev). You will find all the necessary information how to install Yasumi and also recipes how you can use Yasumi in your project. # Blog Checkout the [blog](https://www.yasumi.dev/blog/) section on documentation site regularly for latest updates. Keeping you informed about any news, releases, etc. in a handy blog post format! # Contributing Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on GitHub :) Create [Github Issues](https://github.com/azuyalabs/yasumi/issues) for bugs and new features and comment on the ones you are interested in. If you enjoy what I am making, an extra cup of coffee is very much appreciated :). Your support helps me to put more time into Open-Source Software projects like this. <a href="https://www.buymeacoffee.com/sachatelgenhof" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a> # License Yasumi is open-source software licensed under the MIT License (MIT). Please see [LICENSE](LICENSE) for more information.

Build beautiful API integrations and SDKs with Saloon 🤠

Create GraphQL schema and resolvers with TypeScript, using classes and decorators!

 # TypeGraphQL [](https://badge.fury.io/js/type-graphql) [](https://github.com/MichalLytek/type-graphql/actions/workflows/main.yml?query=branch%3Amaster) [](https://codecov.io/gh/MichalLytek/type-graphql)  [](<(https://opencollective.com/typegraphql)>) [](https://packagephobia.now.sh/result?p=type-graphql) Create GraphQL schema and resolvers with TypeScript, using classes and decorators! [**https://typegraphql.com/**](https://typegraphql.com/) <br> <br> [](https://opencollective.com/typegraphql) ## Introduction **TypeGraphQL** makes developing GraphQL APIs an enjoyable process, i.e. by defining the schema using only classes and a bit of decorator magic. So, to create types like object type or input type, we use a kind of DTO classes. For example, to declare `Recipe` type we simply create a class and annotate it with decorators: ```ts @ObjectType() class Recipe { @Field(type => ID) id: string; @Field() title: string; @Field(type => [Rate]) ratings: Rate[]; @Field({ nullable: true }) averageRating?: number; } ``` And we get the corresponding part of the schema in SDL: ```graphql type Recipe { id: ID! title: String! ratings: [Rate!]! averageRating: Float } ``` Then we can create queries, mutations and field resolvers. For this purpose we use controller-like classes that are called "resolvers" by convention. We can also use awesome features like dependency injection and auth guards: ```ts @Resolver(Recipe) class RecipeResolver { // dependency injection constructor(private recipeService: RecipeService) {} @Query(returns => [Recipe]) recipes() { return this.recipeService.findAll(); } @Mutation() @Authorized(Roles.Admin) // auth guard removeRecipe(@Arg("id") id: string): boolean { return this.recipeService.removeById(id); } @FieldResolver() averageRating(@Root() recipe: Recipe) { return recipe.ratings.reduce((a, b) => a + b, 0) / recipe.ratings.length; } } ``` And in this simple way we get this part of the schema in SDL: ```graphql type Query { recipes: [Recipe!]! } type Mutation { removeRecipe(id: String!): Boolean! } ``` ## Motivation We all know that GraphQL is great and solves many problems we have with REST APIs, like overfetching and underfetching. But developing a GraphQL API in Node.js with TypeScript is sometimes a bit of a pain. Why? Let's take a look at the steps we usually have to take. First, we create all the GraphQL types in `schema.gql` using SDL. Then we create our data models using [ORM classes](https://github.com/typeorm/typeorm), which represent our db entities. Then we start to write resolvers for our queries, mutations and fields, but this forces us to first create TS interfaces for all arguments, inputs, and even object types. Only then can we actually implement the resolvers using weird generic signatures and manually performing common tasks, like validation, authorization and loading dependencies: ```ts export const getRecipesResolver: GraphQLFieldResolver<void, Context, GetRecipesArgs> = async ( _, args, ctx, ) => { // common tasks repeatable for almost every resolver const repository = TypeORM.getRepository(Recipe); const auth = Container.get(AuthService); await joi.validate(getRecipesSchema, args); if (!auth.check(ctx.user)) { throw new NotAuthorizedError(); } // our business logic, e.g.: return repository.find({ skip: args.offset, take: args.limit }); }; ``` The biggest problem is redundancy in our codebase, which makes it difficult to keep things in sync. To add a new field to our entity, we have to jump through all the files - modify an entity class, the schema, as well as the interface. The same goes for inputs or arguments. It's easy to forget to update one piece or make a mistake with a single type. Also, what if we've made a typo in field name? The rename feature (F2) won't work correctly. Tools like [GraphQL Code Generator](https://github.com/dotansimha/graphql-code-generator) or [graphqlgen](https://github.com/prisma/graphqlgen) only solve the first part - they generate the corresponding interfaces (and resolvers skeletons) for our GraphQL schema but they don't fix the schema <--> models redundancy and developer experience (F2 rename won't work, you have to remember about the codegen watch task in background, etc.), as well as common tasks like validation, authorization, etc. **TypeGraphQL** comes to address these issues, based on experience from a few years of developing GraphQL APIs in TypeScript. The main idea is to have only one source of truth by defining the schema using classes and some help from decorators. Additional features like dependency injection, validation and auth guards help with common tasks that normally we would have to handle ourselves. ## Documentation The documentation, installation guide, detailed description of the API and all of its features is [available on the website](https://typegraphql.com/). ### Getting started A full getting started guide with a simple walkthrough (tutorial) can be found at [getting started docs](https://typegraphql.com/docs/getting-started.html). ### Video tutorial If you prefer video tutorials, you can watch [Ben Awad](https://github.com/benawad)'s [TypeGraphQL video series](https://www.youtube.com/playlist?list=PLN3n1USn4xlma1bBu3Tloe4NyYn9Ko8Gs) on YouTube. ### Examples You can also check the [examples folder](https://github.com/MichalLytek/type-graphql/tree/master/examples) in this repository for more examples of usage: simple fields resolvers, DI Container support, TypeORM integration, automatic validation, etc. The [Tests folder](https://github.com/MichalLytek/type-graphql/tree/master/tests) might also give you some tips how to get various things done. ## The future The currently released version is a stable 1.0.0 release. It is well tested (95% coverage, 428 test cases) and has most of the planned features already implemented. Plenty of companies and independent developers are using it in production with success. However, there are also plans for a lot more features like better TypeORM, Prisma and dataloader integration, custom decorators and metadata annotations support - [the full list of ideas](https://github.com/MichalLytek/type-graphql/issues?q=is%3Aissue+is%3Aopen+label%3A"Enhancement+%3Anew%3A") is available on the GitHub repo. You can also keep track of [development's progress on project board](https://github.com/MichalLytek/type-graphql/projects/1). If you have any interesting feature requests, feel free to open an issue on GitHub so we can discuss that! ## Support TypeGraphQL is an MIT-licensed open source project. This framework is a result of the tremendous amount of work - sleepless nights, busy evenings and weekends. It doesn't have a large company that sits behind - its ongoing development is possible only thanks to the support by the community. [](https://opencollective.com/typegraphql) ### Gold Sponsors 🏆 > Please ask your company to support this open source project by [becoming a gold sponsor](https://opencollective.com/typegraphql/contribute/gold-sponsors-8340) and getting a premium technical support from our core contributors. ### Silver Sponsors 🥈 | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/lovd.png" width="150">](https://www.lovd.com/) | | :-----------------------------------------------------------------------------------------------------------------------------: | | [**Lovd**](https://www.lovd.com/) | ### Bronze Sponsors 🥉 | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/live-graphics-system.png" width="55">](https://www.ligrsystems.com/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/lifex.png" width="60">](https://www.joinlifex.com/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/instinctools.svg" width="100">](https://instinctools.com/manufacturing/) | [<img src="https://raw.githubusercontent.com/MichalLytek/type-graphql/master/img/vps-server.png" width="125">](https://www.vpsserver.com/) | | :---------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------: | | [**Live Graphic Systems**](https://www.ligrsystems.com/) | [**LifeX Aps**](https://www.joinlifex.com/) | [**\*instinctools**](https://instinctools.com/manufacturing/) | [**VPS Server**](https://www.vpsserver.com/) | [](https://opencollective.com/typegraphql) ### Members 💪 [](https://opencollective.com/typegraphql#contributors) ### Backers ☕ [](https://opencollective.com/typegraphql#contributors) ## Want to help? Want to file a bug, contribute some code, or improve documentation? Great! Please read our guidelines for [contributing][contributing] and then check out one of our [help wanted issues](https://github.com/MichalLytek/type-graphql/labels/Help%20Wanted%20%3Asos%3A). [contributing]: https://github.com/MichalLytek/type-graphql/blob/master/CONTRIBUTING.md

:sparkles: Python library and CLI to upload photo and video on Instagram. W/o a phone!

# **instapy-cli** :zap: Publish *photos* and *videos* (NEW!) on Instagram, without a phone! You can upload **posts** and even **stories** on Instagram. You can upload a local file or use a link, it does everything for you automagically. <p align="center"> <img src="https://raw.githubusercontent.com/instagrambot/instapy-cli/master/docs/instagram-private-banner.png" alt="instapy-cli instagram-private-api" width="650px"> </p> --- [](https://paypal.me/b3nab) [](https://pypi.org/project/instapy-cli) [](https://travis-ci.org/b3nab/instapy-cli) [](https://github.com/b3nab/instapy-cli/blob/master/LICENSE) [](https://github.com/b3nab/instapy-cli/issues) [](https://github.com/b3nab/instapy-cli/network) [](https://github.com/b3nab/instapy-cli/stargazers) ## Introduction There are plenty of libraries written in Python specialized on working on Instagram APIs (either public or private), but most of them have lots of unsolved issues and PRs not maintained for a long time. > Lots of developers want a simple and effective way to upload photos or videos (NEW!) directly to Instagram **programmatically**. Some may want to publish a simple post, others want to publish a story. All this can be achieved with `instapy-cli`. :tada: I dedided to start this repo and open-source it with :heart: ### Installation <!-- **Install** --> ```shell pip install instapy-cli ``` ### Usage #### Use as Library You can check the folder `examples` to see working codes to use instapy-cli programmatically. If you want to use instapy-cli via shell continue reading. #### Use as CLI **Use** ```shell instapy -u USR -p PSW -f FILE/LINK -t 'TEXT CAPTION' ``` **CLI Options** | option | required | default | description | | --- | --- | --- | --- | | -u | **yes** | - | username | | -p | **yes** | - | password | | -f | **yes** | - | file/media to upload | | -t | *optional* | - | text caption for post | | -s | *optional* | - | upload a story | **Help** ```shell instapy --help ``` #### Hints ##### Cookie You can avoid to re-login, by using a cookie that instapy-cli generate for you. By default instapy-cli use the cookie created in current working directory with the name 'USERNAME_ig.json'. If you don't want to store the cookie in your filesystem you need to pass the parameter `cookie`: ```python with client(username, password, cookie) as cli: # do stuffs with cli ``` This is feature is not well tested, be carefull using it. ##### Image Format instapy-cli support images in the format of JPG/JPEG/PNG. ##### Aspect Ratio The images need to have an aspect ratio of 1:1, that is squared size. You can use other aspect-ratio other than 1:1, but be carefull to stay inside Instagram limits. Otherwise, if you don't respect the aspect ratio, the media will be posted but stretched or cropped. ### Why instapy-cli? First, long story short: instapy-cli is a fork of pynstagram, with the aim of extending its functionality and fixing all unresolved bugs. ##### Move this project to a better place :arrow_right_hook: Anyone that wants to collaborate, I promise to be a good repo manager and merge all your pull requests as soon as possible. I have some ideas to improve this but I need collaboration. Join and support! :bulb: ##### But, wait! Instagram doesn't allow uploading content except from the app (of course :trollface:) Short answer: > Yes, you are right. Long answer: > Every connection from a mobile phone could be intercepted. Someone has done the hard work to sniff the packets sent from the phone to Instagram and "spread the news". You can do a quick research. ## Code Requirements #### This packages will be installed automatically with *instapy-cli* | package | Source Link | | :---: | :---: | | requests | https://github.com/requests/requests | | filetype | https://github.com/h2non/filetype.py | | instagram-private-api | https://github.com/ping/instagram_private_api | | instagram-private-api-extensions | https://github.com/ping/instagram_private_api_extensions | ## Contribute To help `instapy-cli` developers to build and maintain this project, go to **[docs/CONTRIBUTING.md](/docs/CONTRIBUTING.md)** > instructions soon (Write it and collaborate! :wink:) ## License MIT ## Support the project and the author Offer me a coffe or a beer and support instapy-cli. :tada: Click the button here > [](https://paypal.me/b3nab)

REST API Client Library

# Purest [![npm-version]][npm] [![test-ci-img]][test-ci-url] [![test-cov-img]][test-cov-url] [![snyk-vulnerabilities]][snyk] > _REST API Client Library_ ```js var purest = require('purest') var google = purest({provider: 'google'}) await google .query('youtube') .select('channels') .where({forUsername: 'GitHub'}) .auth(token) .request() ``` ## Table of Contents > _This is Purest **v4**, for older releases take a look at [v3] and [v2]_ - **[Introduction](#introduction)** - **[Purest Options](#purest-options)** - **[Request Options](#request-options)** - **[Examples](#examples)** - **[Article]** --- ## Introduction > _**Purest** is a tool for building **expressive** REST API clients_ ### Default Endpoint Here is a basic configuration for Google: ```json { "google": { "default": { "origin": "https://www.googleapis.com", "path": "{path}", "headers": { "authorization": "Bearer {auth}" } } } } ``` The above configuration can be used to instantiate that provider: ```js var google = purest({provider: 'google', config}) ``` Then we can request some data from YouTube: ```js var {res, body} = await google .get('youtube/v3/channels') .qs({forUsername: 'GitHub'}) .auth(token) .request() ``` ### Explicit Endpoint We can define explicit endpoint for accessing the YouTube API: ```json { "google": { "default": { "origin": "https://www.googleapis.com", "path": "{path}", "headers": { "authorization": "Bearer {auth}" } }, "youtube": { "origin": "https://www.googleapis.com", "path": "youtube/{version}/{path}", "version": "v3", "headers": { "authorization": "Bearer {auth}" } } } } ``` And then request the same data: ```js var {res, body} = await google('youtube') .get('channels') .qs({forUsername: 'GitHub'}) .auth(token) .request() ``` ### Defaults Every method in Purest can also be preconfigured with a value: ```js var google = purest({provider: 'google', config, defaults: {auth: token} }) ``` Then we no longer need to set the access token on each request: ```js var {res, body} = await google('youtube') .get('channels') .qs({forUsername: 'GitHub'}) .request() ``` ### Method Aliases Each method in Purest can have multiple aliases defined for it: ```js var google = purest({provider: 'google', config, defaults: {auth: token}, methods: {get: ['select'], qs: ['where']} }) ``` And then use it like this: ```js var {res, body} = await google('youtube') .select('channels') .where({forUsername: 'GitHub'}) .request() ``` --- ## Purest Options > _**Purest** is a flexible tool for **abstracting** out REST APIs_ ```js var google = purest({config: {}, provider: 'google', defaults: {}, methods: {}}) ``` | Key | Type | Description | :- | :-: | :- | **`provider`** | `''` | Provider name to initialize from the list of providers found in `config` | **`config`** | `{}` | Providers configuration to use | **`defaults`** | `{}` | Any supported configuration option set by default, see below | **`methods`** | `{}` | List of methods and their aliases to use with this instance --- ## Request Options > _**Purest** is built on top of a **[powerful HTTP Client][request-compose]**_ ### URL Options | Option | Description | :- | :- | `origin` | The protocol and domain part of the URL, can contain `{subdomain}` token | `path` | The path part of the URL, can contain `{version}`, `{path}` and `{type}` tokens | `subdomain` | Subdomain part of the URL to replace in `origin` | `version` | Version string to replace in `path` | `type` | Type string to replace in `path`, typically `json` or `xml` ### HTTP Methods All HTTP methods `get` `head` `post` `put` `patch` `options` `delete` `trace` `connect` accept a string to replace the `{path}` configuration token with, or absolute URL to set the entire `url`. ### Request Options | Option | Type | Description | :-- | :-- | :-- | `method` | `'string'` | Request method, implicitly set if one of the above HTTP Methods is used | `url` | `'string'` [`url object`][url-parse] | Absolute URL, automatically constructed if the URL Options above are being used, or absolute URL is passed to any of the HTTP Methods above | `proxy` | `'string'` [`url object`][url-parse] | Proxy URL; for HTTPS you have to use [tunneling][tunnel-agent] [agent][proxy-agent] instead | `qs` | `{object}` `'string'` | URL querystring | `headers` | `{object}` | Request headers | `form` | `{object}` `'string'` | `application/x-www-form-urlencoded` request body | `json` | `{object}` `'string'` | JSON encoded request body | `multipart`| `{object}` `[array]` | `multipart/form-data` as object or `multipart/related` as array request body using [request-multipart] | `body` | `'string'` [`Buffer`][buffer] [`Stream`][stream-readable] | Raw request body | `auth` | `'string'` `['string', 'string']` `{user, pass}` | String or array of strings to replace the `{auth}` configuration token with, or Basic authorization as object | `oauth` | `{object}` | OAuth 1.0a authorization using [request-oauth] | `encoding` | [`'string'`][buffer-encoding] | Response body encoding | `redirect` | `{object}` | HTTP redirect [configuration][redirect-config] | `timeout` | `number` | Request timeout in milliseconds | `agent` | [`Agent`][agent] | HTTP agent ### Response Options #### `request` - buffers the response body - decompresses `gzip` and `deflate` encoded bodies with valid `content-encoding` header - converts the response body to string using `utf8` encoding by default - tries to parse `JSON` and `querystring` encoded bodies with valid `content-type` header Returns either String or Object. #### `buffer` - buffers the response body - decompresses `gzip` and `deflate` encoded bodies with valid `content-encoding` header Returns [Buffer][buffer]. #### `stream` Returns the response [Stream][stream-incoming-message]. ### Node Core Options Any other HTTP request option not explicitly exposed in Purest can be set using any of the response methods: ```js await google.request({socketPath: ''}) await google.buffer({socketPath: ''}) await google.stream({socketPath: ''}) ``` ### Endpoint The explicit `endpoint` configuration can be accessed in various ways: ```js // as argument to the Purest instance await google('youtube') // using the option name await google.endpoint('youtube') // or the default method alias defined for it await google.query('youtube') ``` --- ## Examples > _**Purest** comes with a **[fancy logger][request-logs]**_ ```bash npm i --save-dev request-logs ``` ```bash DEBUG=req,res,body,json node examples/file-name.js 'example name' ``` | Category | Topic | Providers | Example | :- | :- | :- | :- | **OAuth 2.0** | _Refresh Access Tokens_ | `box` `google` `twitch` | [Refresh access tokens][refresh-token] | **OpenID Connect** | *Verify id_token* | `auth0` `google` `microsoft` | [Discover public keys and verify id_token signature][openid-connect] | **OAuth 1.0a** | _OAuth 1.0a_ | `flickr` `trello` `twitter` | [Get user profile][oauth-1] | **Storage** | _Multipart, Streams_ | `box` `dropbox` `drive` | [Upload files][file-stream] | **Storage** | _HTTP Streams_ | `box` `dropbox` | [Stream file from DropBox to Box][http-stream] > _Get access tokens using **[Grant]**_ [npm-version]: https://img.shields.io/npm/v/purest.svg?style=flat-square (NPM Version) [test-ci-img]: https://img.shields.io/travis/simov/purest/master.svg?style=flat-square (Build Status) [test-cov-img]: https://img.shields.io/coveralls/simov/purest.svg?style=flat-square (Test Coverage) [snyk-vulnerabilities]: https://img.shields.io/snyk/vulnerabilities/npm/purest.svg?style=flat-square (Vulnerabilities) [npm]: https://www.npmjs.com/package/purest [test-ci-url]: https://github.com/simov/purest/actions/workflows/test.yml [test-cov-url]: https://coveralls.io/r/simov/purest?branch=master [snyk]: https://snyk.io/test/npm/purest [v3]: https://github.com/simov/purest/tree/3.x [v2]: https://github.com/simov/purest/tree/2.x [article]: https://dev.to/simov/purest-53k0 [request-compose]: https://github.com/simov/request-compose [request-oauth]: https://github.com/simov/request-oauth [request-multipart]: https://github.com/simov/request-multipart [request-cookie]: https://github.com/simov/request-cookie [request-logs]: https://github.com/simov/request-logs [grant]: https://github.com/simov/grant [redirect-config]: https://github.com/simov/request-compose#redirect [tunnel-agent]: https://github.com/simov/request-compose/blob/master/examples/misc-tunnel-agent.js [proxy-agent]: https://github.com/simov/request-compose/blob/master/examples/misc-proxy-agent.js [methods.json]: https://github.com/simov/purest/blob/master/config/methods.json [refresh-token]: https://github.com/simov/purest/blob/master/examples/refresh-token.js [openid-connect]: https://github.com/simov/purest/blob/master/examples/openid-connect.js [oauth-1]: https://github.com/simov/purest/blob/master/examples/oauth-1.js [file-stream]: https://github.com/simov/purest/blob/master/examples/file-stream.js [http-stream]: https://github.com/simov/purest/blob/master/examples/http-stream.js [url-parse]: https://nodejs.org/dist/latest-v10.x/docs/api/url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost [buffer]: https://nodejs.org/dist/latest-v10.x/docs/api/buffer.html [buffer-encoding]: https://nodejs.org/dist/latest-v10.x/docs/api/buffer.html#buffer_buffers_and_character_encodings [stream-readable]: https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_class_stream_readable [stream-incoming-message]: https://nodejs.org/dist/latest-v10.x/docs/api/http.html#http_class_http_incomingmessage [agent]: https://nodejs.org/docs/latest-v10.x/api/http.html#http_class_http_agent

Modern Open Source Flat Files Content Management System.

<img src="https://images2.imgbox.com/49/8d/4ipHqUcj_o.jpg" alt="Flextype" align="center"> <p align="center"> <img src="https://img.shields.io/badge/license-MIT-blue.svg?label=License" alt="License MIT"> <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/flextype/flextype?label=Stars"> <img alt="GitHub forks" src="https://img.shields.io/github/forks/flextype/flextype?label=Forks"> <a href="https://hitsofcode.com"><img alt="Hits of Code" src="https://hitsofcode.com/github/flextype/flextype?branch=1.x"></a> </p> <br> <br> ## INTRODUCTION **Flextype** is an open-source **Hybrid Content Management System** with the freedom of a headless CMS and with the full functionality of a traditional CMS. Building this Content Management System, we focused on simplicity. To achieve this, we implemented a simple but powerful API's. With Flextype, you are in complete control. Design your data structure the way you want. Update and share your data with others and teams using version control. Flextype does not require MySQL database, because all the data are collected in a simple files. Perfect portability when changing your hosting provider. Just copy all the files from one server to another. The underlying architecture of Flextype is built using well established and best-in-class technologies. This is to ensure that Flextype is simple to use and easy to extend. ## REQUIREMENTS #### SYSTEM REQUIREMENTS Make sure your server meets the following requirements. * Webserver (Apache, Nginx, etc.) * PHP 8.1 or higher #### PHP EXTENSIONS Flextype needs the following PHP extensions to be enabled: * PHP [mbstring](http://php.net/manual/en/book.mbstring.php) module for full UTF-8 support. * PHP [gd](http://php.net/manual/en/book.image.php) or [ImageMagick](http://php.net/manual/en/book.imagick.php) module for image processing. * PHP [json](https://php.net/manual/en/book.json.php) module for JSON manipulation. * PHP [Fileinfo](https://www.php.net/manual/en/book.fileinfo.php) * PHP [SPL](https://www.php.net/manual/en/book.spl.php) * PHP [DOM](https://www.php.net/manual/ru/class.domdocument.php) Although it is optional, we strongly recommend enabling the following PHP extensions: APC, APCu, XCache, Memcached, or Redis for better performance. ## QUICK INSTALLATION 1. [Download the latest version of Flextype](https://awilum.github.io/flextype/downloads). 2. Unzip the contents to a new folder on your local computer, and upload to your webhost using the (S)FTP client of your choice. After you’ve done this, create directory <code>project</code> and be sure to chmod the following directory to <code>755</code> (or <code>777</code>), so it is readable and writable by Flextype. [read the documentation](https://awilum.github.io/flextype/documentation) ## COMMUNITY Flextype is open source, community driven project, and maintained by community! #### [Github](https://github.com/flextype) You may use GitHub Discussions to start discussion about core, plugin and themes development or If you want to report a bug, you can use the GitHub Issues. #### [Twitter](https://twitter.com/_flextype) Follow Flextype on Twitter to get real-time news regarding the development and all events we are attending. ## SUPPORTING Flextype Flextype is an open source project and community contributions are essential to its growing and success. Contributing to the Flextype is easy and you can give as little or as much time as you want. ### FINANCIAL SUPPORT Flextype is an MIT-licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support it's ongoing development by being a project backer or a sponsor: * [Visit Sponsors page](https://awilum.github.io/sponsors) ### PLATFORM CONTRIBUTIONS Another excellent way to help out is by contributing your time or services. #### BUG REPORTING We are using GitHub Issues to manage our public bugs. We keep a close eye on this so before filing a new issue, try to make sure the problem does not already exist. #### PULL REQUESTS We actively welcome your pull requests! If you need help with Git or our workflow, please ask in our community chat. We want your contributions even if you're just learning Git. Our maintainers are happy to help! #### DOCS You may help us to create amazing knowledge base for Flextype. Fix spelling, add code examples, help organize, write new articles, and etc... ## LICENSE [The MIT License (MIT)](https://github.com/flextype/flextype/blob/1.x/LICENSE.txt) Copyright (c) [Sergey Romanenko](https://awilum.github.io)

Execute one command (or mount one Node.js middleware) and get an instant high-performance GraphQL API for your PostgreSQL database!

<img width="120" height="120" title="PostGraphile logo" src="https://cdn.rawgit.com/graphile/graphile.github.io/a6225f8c3052df5c276ecef28aeb0cade1aec16a/logos/postgraphile.optimized.svg" /> # PostGraphile [](https://github.com/sponsors/benjie) [](https://patreon.com/benjie) [](http://discord.gg/graphile) [](https://www.npmjs.com/package/postgraphile)  [](https://twitter.com/GraphileHQ) _**Instant lightning-fast GraphQL API backed primarily by your PostgreSQL database. Highly customisable and extensible thanks to incredibly powerful plugin system.**_ _Formerly "PostGraphQL"._ ## Documentation: [graphile.org/postgraphile](https://graphile.org/postgraphile) <!-- SPONSORS_BEGIN --> ## Crowd-funded open-source software To help us develop this software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship. ### [Click here to find out more about sponsors and sponsorship.](https://www.graphile.org/sponsor/) And please give some love to our featured sponsors 🤩: <table><tr> <td align="center"><a href="https://surge.io/"><img src="https://graphile.org/images/sponsors/surge.png" width="90" height="90" alt="Surge" /><br />Surge</a> *</td> <td align="center"><a href="https://www.netflix.com/"><img src="https://graphile.org/images/sponsors/Netflix.png" width="90" height="90" alt="Netflix" /><br />Netflix</a> *</td> <td align="center"><a href="https://qwick.com/"><img src="https://graphile.org/images/sponsors/qwick.png" width="90" height="90" alt="Qwick" /><br />Qwick</a> *</td> <td align="center"><a href="https://www.the-guild.dev/"><img src="https://graphile.org/images/sponsors/theguild.png" width="90" height="90" alt="The Guild" /><br />The Guild</a> *</td> </tr><tr> <td align="center"><a href="http://chads.website"><img src="https://graphile.org/images/sponsors/chadf.png" width="90" height="90" alt="Chad Furman" /><br />Chad Furman</a> *</td> <td align="center"><a href="https://www.fanatics.com/"><img src="https://graphile.org/images/sponsors/fanatics.png" width="90" height="90" alt="Fanatics" /><br />Fanatics</a> *</td> <td align="center"><a href="https://dovetailapp.com/"><img src="https://graphile.org/images/sponsors/dovetail.png" width="90" height="90" alt="Dovetail" /><br />Dovetail</a> *</td> <td align="center"><a href="https://www.enzuzo.com/"><img src="https://graphile.org/images/sponsors/enzuzo.png" width="90" height="90" alt="Enzuzo" /><br />Enzuzo</a> *</td> </tr><tr> <td align="center"><a href="https://stellate.co/"><img src="https://graphile.org/images/sponsors/Stellate.png" width="90" height="90" alt="Stellate" /><br />Stellate</a> *</td> <td align="center"><a href="https://politicsrewired.com/"><img src="https://graphile.org/images/sponsors/politics-rewired.png" width="90" height="90" alt="Politics Rewired" /><br />Politics Rewired</a></td> <td align="center"><a href="https://iasql.com/"><img src="https://graphile.org/images/sponsors/IaSQL.png" width="90" height="90" alt="IaSQL" /><br />IaSQL</a></td> </tr></table> <em>\* Sponsors the entire Graphile suite</em> <!-- SPONSORS_END --> ## About **GraphQL** is a new way of communicating with your server. It eliminates the problems of over- and under-fetching, incorporates strong data types, has built-in introspection, documentation and deprecation capabilities, and is implemented in many programming languages. This all leads to gloriously low-latency user experiences, better developer experiences, and much increased productivity. Because of all this, GraphQL is typically used as a replacement for (or companion to) RESTful API services. **PostgreSQL** is the self-proclaimed “world’s most advanced open source database,” with each new release bringing more amazing features and performance gains. Thinking of your database as a plain CRUD store is now an archaic viewpoint as modern PostgreSQL can do so much for you &mdash; from authorization with Row-Level Security (RLS, introduced in PG9.5), through Foreign Data Wrappers (FDW), to real time notifications with `LISTEN`/`NOTIFY`. **PostGraphile** pairs these two incredible technologies together, helping you not only build applications more rapidly, but to build lightning-fast applications. PostGraphile allows you to access the power of PostgreSQL through a well designed, extensible, customisable and incredibly performant GraphQL server. It automatically detects tables, columns, indexes, relationships, views, types, functions, comments, and more - providing a GraphQL server that is highly intelligent about your data, and that automatically updates itself without restarting when you change your database schema. With PostGraphile, a well designed database schema should serve the basis for a well thought out API. PostgreSQL already has amazing authorization and relationship infrastructure, _why duplicate that logic_ in a custom API? A PostGraphile API is likely to provide a more performant and standards compliant GraphQL API than any created in-house, and can be built in a fraction of the time. Focus on your product and let PostGraphile worry about the API layer. Once you need to expand beyond this, we have a powerful plugin system including many [community contributed plugins](https://www.graphile.org/postgraphile/community-plugins/). For a critical evaluation of PostGraphile to determine if it fits in your tech stack, read [evaluating PostGraphile for your project](https://www.graphile.org/postgraphile/evaluating/). ## Introduction Watch a talk by the original author [Caleb](https://twitter.com/calebmer) at GraphQL Summit for a walk-through of building an application with PostGraphile in under 7 minutes. This was using v2 (then called PostGraphQL); we're now up to v4 which has many more bells and whistles! [](https://www.youtube.com/watch?v=b3pwlCDy6vY) Hear from the current maintainer [Benjie](https://twitter.com/benjie) at GraphQL Finland about the benefits of Database-Driven GraphQL Development: [](https://www.youtube.com/watch?v=XDOrhTXd4pE) ## Usage **Documentation: [graphile.org/postgraphile](https://graphile.org/postgraphile)** You can use PostGraphile via the CLI, as a Node.js middleware, or use the GraphQL schema directly. Make sure to check out the **[full usage instructions](https://graphile.org/postgraphile/usage/)** on the documentation website. We also have a [PostgreSQL schema design guide](https://www.graphile.org/postgraphile/postgresql-schema-design/) you can follow to build a fully functional PostGraphile API. ### CLI To get started you can install PostGraphile globally: ```bash npm install -g postgraphile ``` …and then just run it! By default, PostGraphile will connect to your local database at `postgres://localhost:5432` and introspect the `public` schema. See [the available CLI flags](https://www.graphile.org/postgraphile/usage-cli/) with: ```bash postgraphile --help ``` When you're ready to use PostGraphile for your own project, you're advised to install it locally with `yarn`, and run it with `npx`: ```bash yarn add postgraphile npx postgraphile --help ``` **macOS users**: PostGraphile has used port 5000 by default for 5+ years; recently Apple decided to bind the AirPlay service to port 5000 causing a conflict. Please use the `--port` option to bind to a different port. ### Middleware You can also use PostGraphile as [native HTTP, Connect, Express, or Koa (experimental) middleware](https://www.graphile.org/postgraphile/usage-library/), e.g.: ```bash yarn add postgraphile ``` ```js import { createServer } from 'http'; import postgraphile from 'postgraphile'; createServer(postgraphile()); ``` Check out [hapi-postgraphile](https://github.com/mshick/hapi-postgraphile) if you're interested in using PostGraphile as a [hapi](https://github.com/hapijs/hapi) server plugin. ### Docker To run via Docker, simply pass the [CLI options](https://www.graphile.org/postgraphile/usage-cli/) to the Docker container: ```bash docker pull graphile/postgraphile docker run --init graphile/postgraphile --help ``` E.g. you might run this command (substituting the relevant variables): ```bash docker run --init -p 5000:5000 graphile/postgraphile --connection postgres://POSTGRES_USER:POSTGRES_PASSWORD@POSTGRES_HOST:POSTGRES_PORT/POSTGRES_DATABASE --schema app_public --watch ``` **macOS users**: Please use a different port to avoid conflict with AirPlay. ## Read More **Full documentation for PostGraphile is located at [graphile.org/postgraphile](https://graphile.org/postgraphile).** PostGraphile features include: - Authorization (security) provided by PostgreSQL: - [role-based access control (RBAC)](https://www.postgresql.org/docs/10/static/sql-grant.html) - [row-level security (RLS)][row-level-security] - [Automatic GraphQL relations from SQL relations](https://www.graphile.org/postgraphile/relations/) - [PostgreSQL procedure support][procedure documentation]: - [Custom queries][advanced queries documentation] - [Custom mutations](https://www.graphile.org/postgraphile/custom-mutations/) - [Computed columns](https://www.graphile.org/postgraphile/computed-columns/) - Development UI (GraphiQL) built in - `--watch` mode, auto-detects changes in SQL schema, hot-reloads changes into GraphiQL - [Automatic documentation, enhanced by PostgreSQL `COMMENT`s](http://www.postgresql.org/docs/current/static/sql-comment.html) - [Schema customisation through smart comments](https://www.graphile.org/postgraphile/smart-comments/) - [Simple JWT authentication straight from the database](https://www.graphile.org/postgraphile/security/) - [Cursor-based pagination, Relay (classic & modern) compatible](https://www.graphile.org/postgraphile/connections/) - Global object identifiers (`nodeId` by default, but Relay-favoured `id` with `--classic-ids`) - Relay-compatible mutations - [Use direct from the CLI](https://www.graphile.org/postgraphile/usage-cli/) - [Use as Express, Connect, or Koa middleware](https://www.graphile.org/postgraphile/usage-library/) - [Just use the generated GraphQL schema](https://www.graphile.org/postgraphile/usage-schema/) [procedure documentation]: https://www.graphile.org/postgraphile/procedures/ [advanced queries documentation]: https://www.graphile.org/postgraphile/custom-queries/ [row-level-security]: http://www.postgresql.org/docs/current/static/ddl-rowsecurity.html ## Requirements [Full requirements are on the website](https://www.graphile.org/postgraphile/requirements/), but a basic summary is: - Node v8.6+ - PostgreSQL 9.6+ (officially; but currently works with 9.4+) - Linux, macOS or Windows Caveats: - PostGraphile does not have automated tests on Windows, if you notice any issues please file them (or send a PR!) ## Supporting PostGraphile The fastest and easiest way you can help PostGraphile thrive is by [sponsoring ongoing development and maintenance](https://graphile.org/sponsor/). Want to help testing and developing PostGraphile? Check out the [contributing document](CONTRIBUTING.md) to get started quickly! Commercial support, consultancy and development services are available direct from the maintainer; see [Professional Services](https://www.graphile.org/support/) for more information, or get in touch! The maintainer of this project is [@Benjie](https://twitter.com/benjie) - follow him on Twitter! ## Thanks Huge thanks to [the individuals and companies who sponsor PostGraphile's development](SPONSORS.md) - their financial contributions enable more time to be spent on the project: from bug fixes, to code review, to new features! If you want to help the project advance more rapidly, please join them in [supporting this project](https://graphile.org/sponsor/) 🙏 A humongous, heart-felt, thank you to the original author of PostGraphile - [Caleb Meredith](https://twitter.com/calebmer) - for everything he put into PostGraphile! He's now graduated from the project and we all wish him the best for his future ventures! Thanks also to the people working on [PostgREST](https://github.com/begriffs/postgrest) which was a huge inspiration for this project! Thanks and enjoy 👍

APISIX Ingress Controller for Kubernetes

<!-- # # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # --> # Apache APISIX for Kubernetes [](https://goreportcard.com/report/github.com/apache/apisix-ingress-controller) [](https://apisix.apache.org/slack) Use [Apache APISIX](https://github.com/apache/apisix#apache-apisix) for Kubernetes [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/). All configurations in `apisix-ingress-controller` are defined with Kubernetes CRDs (Custom Resource Definitions). Support configuring [plugins](https://github.com/apache/apisix/blob/master/docs/en/latest/plugins), service registration discovery mechanism for upstreams, load balancing and more in Apache APISIX. `apisix-ingress-controller` is an Apache APISIX control plane component. Currently it serves for Kubernetes clusters. In the future, we plan to separate the submodule to adapt to more deployment modes, such as virtual machine clusters. The technical architecture of `apisix-ingress-controller`: <img src="./docs/assets/images/module-0.png" alt="Architecture" width="743" height="559" /> ## Status This project is currently general availability. ## Features * Declarative configuration for Apache APISIX with Custom Resource Definitions(CRDs), using k8s yaml struct with minimum learning curve. * Hot-reload during yaml apply. * Native Kubernetes Ingress (both `v1` and `v1beta1`) support. * Auto register k8s endpoint to upstream (Apache APISIX) node. * Support load balancing based on pod (upstream nodes). * Out of box support for node health check. * Plug-in extension supports hot configuration and immediate effect. * Support SSL and mTLS for routes. * Support traffic split and canary deployments. * Support TCP 4 layer proxy. * Ingress controller itself as a pluggable hot-reload component. * Multi-cluster configuration distribution. [More about comparison among multiple Ingress Controllers.](https://docs.google.com/spreadsheets/d/191WWNpjJ2za6-nbG4ZoUMXMpUK8KlCIosvQB0f-oq3k/edit?ts=5fd6c769#gid=907731238) ## Get started * [How to install](./install.md) * [Get Started](./docs/en/latest/getting-started.md) * [Design introduction](./docs/en/latest/design.md) * [FAQ](./docs/en/latest/FAQ.md) ## Prerequisites Apisix ingress controller requires Kubernetes version 1.16+. Because we used `CustomResourceDefinition` v1 stable API. From the version 1.0.0, APISIX-ingress-controller need to work with Apache APISIX version 2.7+. ## Works with APISIX Dashboard Currently, APISIX Ingress Controller automatically manipulates some APISIX resources, which is not very compatible with APISIX Dashboard. In addition, users should not modify resources labeled `managed-by: apisix-ingress-controllers` via APISIX Dashboard. ## Internal Architecture <img src="./docs/assets/images/apisix-ingress-controller-arch.png" alt="module" width="74.3%" height="55.9%" /> ## Apache APISIX Ingress vs. Kubernetes Ingress Nginx * The control plane and data plane are separated, which can improve security and deployment flexibility. * Hot-reload during yaml apply. * [More convenient canary deployment.](./docs/en/latest/concepts/apisix_route.md) * Verify the correctness of the configuration, safe and reliable. * [Rich plugins and ecology.](https://github.com/apache/apisix/tree/master/docs/en/latest/plugins) * Supports APISIX custom resources and Kubernetes native Ingress resources. ## Contributing We welcome all kinds of contributions from the open-source community, individuals and partners. * [Contributing Guide](./docs/en/latest/contribute.md) ### How to contribute Most of the contributions that we receive are code contributions, but you can also contribute to the documentation or simply report solid bugs for us to fix. For new contributors, please take a look at issues with a tag called [Good first issue](https://github.com/apache/apisix-ingress-controller/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [Help wanted](https://github.com/apache/apisix-ingress-controller/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). ### How to report a bug * **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/apisix-ingress-controller/issues). * If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/apisix-ingress-controller/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. ### Contributor over time [](https://git-contributor.com/?chart=contributorOverTime&repo=apache/apisix-ingress-controller) ## Community * Mailing List: Mail to [email protected], follow the reply to subscribe the mailing list. * QQ Group - 578997126 *  - follow and interact with us using hashtag `#ApacheAPISIX` * [Bilibili video](https://space.bilibili.com/551921247) ## Todos * More todos will display in [issues](https://github.com/apache/apisix-ingress-controller/issues?q=is%3Aopen+is%3Aissue+label%3Atriage%2Faccepted) ## User stories - [How Does Zoom Use APISIX Ingress in Its Continuous Delivery Pipeline? - API7.ai](https://api7.ai/blog/zoom-uses-apisix-ingress) - [Copernicus Reference System Software](https://github.com/COPRS/infrastructure/wiki/Networking-trade-off) - [From Traefik to APISIX, Horizon Robotics's Exploration in Ingress Controller - API7.ai](https://api7.ai/blog/why-horizon-robotics-migrated-from-traefik-to-apche-apisix) - [Why Jiakaobaodian Chooses APISIX Ingress Controller - API7.ai](https://api7.ai/blog/why-jiakaobaodian-chooses-apisix-ingress-controller) - [Why AISpeech Chooses Apache APISIX Instead of NGINX as k8s Ingress Controller - API7.ai](https://api7.ai/blog/why-aispeech-chooses-apache-apisix-instead-of-nginx-as-k8s-ingress-controller) - [Tencent Cloud: Why choose Apache APISIX to implement the k8s ingress controller?(Chinese)](https://cloud.tencent.com/developer/article/1592281) - [aispeech: Why we create a new k8s ingress controller?(Chinese)](https://mp.weixin.qq.com/s/bmm2ibk2V7-XYneLo9XAPQ) If you are willing to share with us some scenarios and use cases when you use APISIX Ingress, please reply to the [issue](https://github.com/apache/apisix-ingress-controller/issues/501), or submit PR to update [Powered-BY](./powered-by.md) file ## Who Uses APISIX Ingress? A wide variety of companies and organizations use APISIX Ingress for research, production and commercial product, below are some of them: - AISpeech - European Copernicus Reference System - Jiakaobaodian(驾考宝典) - Horizon Robotics(地平线) - Tencent Cloud - UPYUN - Zoom ## Milestone * [Milestone](https://github.com/apache/apisix-ingress-controller/milestones) ## Terminology * APISIX Ingress: the whole service that contains the proxy ([Apache APISIX](https://apisix.apache.org)) and ingress controller (apisix-ingress-controller). * apisix-ingress-controller: the ingress controller component.

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

<h1 align="center">OpenAPI Generator</h1> <div align="center"> [](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.openapitools%22%20AND%20a%3A%22openapi-generator%22) [](./LICENSE) [](https://opencollective.com/openapi_generator) [](https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g) [](https://twitter.com/oas_generator) [](https://gitpod.io/#https://github.com/OpenAPITools/openapi-generator) [](https://conan.io/center/openapi-generator) </div> <div align="center"> [Master](https://github.com/OpenAPITools/openapi-generator/tree/master) (`6.4.0`): [](https://travis-ci.com/OpenAPITools/openapi-generator) [](https://circleci.com/gh/OpenAPITools/openapi-generator) [](https://ci.appveyor.com/project/WilliamCheng/openapi-generator) [](https://app.bitrise.io/app/4a2b10a819d12b67) [7.0.x](https://github.com/OpenAPITools/openapi-generator/tree/7.0.x) (`7.0.x`): [](https://travis-ci.com/OpenAPITools/openapi-generator) [](https://circleci.com/gh/OpenAPITools/openapi-generator) [](https://ci.appveyor.com/project/WilliamCheng/openapi-generator) [](https://app.bitrise.io/app/4a2b10a819d12b67) </div> <div align="center"> :star::star::star: If you would like to contribute, please refer to [guidelines](CONTRIBUTING.md) and a list of [open tasks](https://github.com/openapitools/openapi-generator/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).:star::star::star: :bangbang: To migrate from Swagger Codegen to OpenAPI Generator, please refer to the [migration guide](docs/migration-from-swagger-codegen.md) :bangbang: :notebook_with_decorative_cover: For more information, please refer to the [Wiki page](https://github.com/openapitools/openapi-generator/wiki) and [FAQ](https://github.com/openapitools/openapi-generator/wiki/FAQ) :notebook_with_decorative_cover: :notebook_with_decorative_cover: The eBook [A Beginner's Guide to Code Generation for REST APIs](https://gum.co/openapi_generator_ebook) is a good starting point for beginners :notebook_with_decorative_cover: :warning: If the OpenAPI spec, templates or any input (e.g. options, environment variables) is obtained from an untrusted source or environment, please make sure you've reviewed these inputs before using OpenAPI Generator to generate the API client, server stub or documentation to avoid potential security issues (e.g. [code injection](https://en.wikipedia.org/wiki/Code_injection)). For security vulnerabilities, please contact [[email protected]](mailto:[email protected]). :warning: :bangbang: Both "OpenAPI Tools" (https://OpenAPITools.org - the parent organization of OpenAPI Generator) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI) :bangbang: </div> ## Sponsors If you find OpenAPI Generator useful for work, please consider asking your company to support this Open Source project by [becoming a sponsor](https://opencollective.com/openapi_generator). You can also individually sponsor the project by [becoming a backer](https://opencollective.com/openapi_generator). #### Thank you to our bronze sponsors! [](https://www.namsor.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [](https://www.lightbow.net/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/docspring.png" width="128" height="128">](https://docspring.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/datadog.png" width="128" height="128">](https://datadoghq.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/thales.jpg" width="128" height="128">](https://cpl.thalesgroup.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/apideck.jpg" width="128" height="128">](https://www.apideck.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/pexa.png" width="128" height="128">](https://www.pexa.com.au/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/numary.png" width="128" height="128">](https://www.numary.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/onesignal.png" width="128" height="128">](https://www.onesignal.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/virtualansoftware.png" width="128" height="128">](https://www.virtualansoftware.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/mergedev.jpeg" width="128" height="128">](https://www.merge.dev/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/burkert.jpg" width="128" height="128">](https://www.burkert.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/finbourne.png" width="128" height="128">](https://www.finbourne.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://openapi-generator.tech/img/companies/bumpsh.png" width="128" height="128">](https://bump.sh/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) #### Thank you GoDaddy for sponsoring the domain names, Linode for sponsoring the VPS and Checkly for sponsoring the API monitoring [<img src="https://openapi-generator.tech/img/companies/godaddy.png" width="150">](https://www.godaddy.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [](https://www.linode.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) [<img src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcRAhEYadUyZYzGUotZiSdXkVMqqLGuohyixLl4eUpUV6pAbUULL" width="150">](https://checklyhq.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor) ## Overview OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification) (both 2.0 and 3.0 are supported). Currently, the following languages/frameworks are supported: | | Languages/Frameworks | | -------------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **API clients** | **ActionScript**, **Ada**, **Apex**, **Bash**, **C**, **C#** (.net 2.0, 3.5 or later, .NET Standard 1.3 - 2.1, .NET Core 3.1, .NET 5.0. Libraries: RestSharp, GenericHost, HttpClient), **C++** (Arduino, cpp-restsdk, Qt5, Tizen, Unreal Engine 4), **Clojure**, **Crystal**, **Dart**, **Elixir**, **Elm**, **Eiffel**, **Erlang**, **Go**, **Groovy**, **Haskell** (http-client, Servant), **Java** (Apache HttpClient, Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured, Spring 5 Web Client, MicroProfile Rest Client, Helidon), **Jetbrains HTTP Client**, **Julia**, **k6**, **Kotlin**, **Lua**, **Nim**, **Node.js/JavaScript** (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types, Apollo GraphQL DataStore), **Objective-C**, **OCaml**, **Perl**, **PHP**, **PowerShell**, **Python**, **R**, **Ruby**, **Rust** (hyper, reqwest, rust-server), **Scala** (akka, http4s, scalaz, sttp, swagger-async-httpclient), **Swift** (2.x, 3.x, 4.x, 5.x), **Typescript** (AngularJS, Angular (2.x - 13.x), Aurelia, Axios, Fetch, Inversify, jQuery, Nestjs, Node, redux-query, Rxjs) | | **Server stubs** | **Ada**, **C#** (ASP.NET Core, Azure Functions), **C++** (Pistache, Restbed, Qt5 QHTTPEngine), **Erlang**, **F#** (Giraffe), **Go** (net/http, Gin, Echo), **Haskell** (Servant, Yesod), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, Jersey, RestEasy, Play Framework, [PKMST](https://github.com/ProKarma-Inc/pkmst-getting-started-examples), [Vert.x](https://vertx.io/), [Apache Camel](https://camel.apache.org/), [Helidon](https://helidon.io/)), **Julia**, **Kotlin** (Spring Boot, Ktor, Vertx), **PHP** (Laravel, Lumen, [Mezzio (fka Zend Expressive)](https://github.com/mezzio/mezzio), Slim, Silex, [Symfony](https://symfony.com/)), **Python** (FastAPI, Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Rust** ([rust-server](https://openapi-generator.tech/docs/generators/rust-server/)), **Scala** (Akka, [Finch](https://github.com/finagle/finch), [Lagom](https://github.com/lagom/lagom), [Play](https://www.playframework.com/), Scalatra) | | **API documentation generators** | **HTML**, **Confluence Wiki**, **Asciidoc**, **Markdown**, **PlantUML** | | **Configuration files** | [**Apache2**](https://httpd.apache.org/) | | **Others** | **GraphQL**, **JMeter**, **Ktorm**, **MySQL Schema**, **Protocol Buffer**, **WSDL** | ## Table of contents - [OpenAPI Generator](#openapi-generator) - [Overview](#overview) - [Table of Contents](#table-of-contents) - [1 - Installation](#1---installation) - [1.1 - Compatibility](#11---compatibility) - [1.2 - Artifacts on Maven Central](#12---artifacts-on-maven-central) - [1.3 - Download JAR](#13---download-jar) - [1.4 - Build Projects](#14---build-projects) - [1.5 - Homebrew](#15---homebrew) - [1.6 - Docker](#16---docker) - [1.7 - NPM](#17---npm) - [2 - Getting Started](#2---getting-started) - [3 - Usage](#3---usage) - [3.1 - Customization](#31---customization) - [3.2 - Workflow Integration](#32---workflow-integration-maven-gradle-github-cicd) - [3.3 - Online Generators](#33---online-openapi-generator) - [3.4 - License Information on Generated Code](#34---license-information-on-generated-code) - [3.5 - IDE Integration](#35---ide-integration) - [4 - Companies/Projects using OpenAPI Generator](#4---companiesprojects-using-openapi-generator) - [5 - Presentations/Videos/Tutorials/Books](#5---presentationsvideostutorialsbooks) - [6 - About Us](#6---about-us) - [6.1 - OpenAPI Generator Core Team](#61---openapi-generator-core-team) - [6.2 - OpenAPI Generator Technical Committee](#62---openapi-generator-technical-committee) - [6.3 - History of OpenAPI Generator](#63---history-of-openapi-generator) - [7 - License](#7---license) ## [1 - Installation](#table-of-contents) ### [1.1 - Compatibility](#table-of-contents) The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The openapi-generator project has the following compatibilities with the OpenAPI Specification: | OpenAPI Generator Version | Release Date | Notes | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------------- | | 7.0.0 (upcoming major release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.0.0-SNAPSHOT/) | Feb/Mar 2023 | Major release with breaking changes (no fallback) | | 6.4.0 (upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/6.3.0-SNAPSHOT/) | 05.12.2022 | Minor release with breaking changes (with fallback) | | [6.3.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v6.3.0) (latest stable release) | 01.02.2023 | Minor release with breaking changes (with fallback) | | [5.4.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v5.4.0) | 31.01.2022 | Minor release with breaking changes (with fallback) | | [4.3.1](https://github.com/OpenAPITools/openapi-generator/releases/tag/v4.3.1) | 06.05.2020 | Patch release (enhancements, bug fixes, etc) | OpenAPI Spec compatibility: 1.0, 1.1, 1.2, 2.0, 3.0 For old releases, please refer to the [**Release**](https://github.com/OpenAPITools/openapi-generator/releases) page. For decomissioned generators/libraries/frameworks, please refer to [the "Decommission" label](https://github.com/OpenAPITools/openapi-generator/issues?q=label%3ADecommission+is%3Amerged+) in the pull request page. ## [1.2 - Artifacts on Maven Central](#table-of-contents) You can find our released artifacts on maven central: **Core:** ```xml <dependency> <groupId>org.openapitools</groupId> <artifactId>openapi-generator</artifactId> <version>${openapi-generator-version}</version> </dependency> ``` See the different versions of the [openapi-generator](https://search.maven.org/artifact/org.openapitools/openapi-generator) artifact available on maven central. **Cli:** ```xml <dependency> <groupId>org.openapitools</groupId> <artifactId>openapi-generator-cli</artifactId> <version>${openapi-generator-version}</version> </dependency> ``` See the different versions of the [openapi-generator-cli](https://search.maven.org/artifact/org.openapitools/openapi-generator-cli) artifact available on maven central. **Maven plugin:** ```xml <dependency> <groupId>org.openapitools</groupId> <artifactId>openapi-generator-maven-plugin</artifactId> <version>${openapi-generator-version}</version> </dependency> ``` * See the different versions of the [openapi-generator-maven-plugin](https://search.maven.org/artifact/org.openapitools/openapi-generator-maven-plugin) artifact available on maven central. * [Readme](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-maven-plugin/README.md) **Gradle plugin:** ```xml <dependency> <groupId>org.openapitools</groupId> <artifactId>openapi-generator-gradle-plugin</artifactId> <version>${openapi-generator-version}</version> </dependency> ``` * See the different versions of the [openapi-generator-gradle-plugin](https://search.maven.org/artifact/org.openapitools/openapi-generator-gradle-plugin) artifact available on maven central. * [Readme](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc) ### [1.3 - Download JAR](#table-of-contents) <!-- RELEASE_VERSION --> If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum): JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.0.jar` For **Mac/Linux** users: ```sh wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.0.jar -O openapi-generator-cli.jar ``` For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g. ``` Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.0.jar ``` After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage. For Mac users, please make sure Java 8 is installed (Tips: run `java -version` to check the version), and export `JAVA_HOME` in order to use the supported Java version: ```sh export JAVA_HOME=`/usr/libexec/java_home -v 1.8` export PATH=${JAVA_HOME}/bin:$PATH ``` <!-- /RELEASE_VERSION --> ### Launcher Script One downside to manual jar downloads is that you don't keep up-to-date with the latest released version. We have a Bash launcher script at [bin/utils/openapi-generator.cli.sh](./bin/utils/openapi-generator-cli.sh) which resolves this issue. To install the launcher script, copy the contents of the script to a location on your path and make the script executable. An example of setting this up (NOTE: Always evaluate scripts curled from external systems before executing them). ``` mkdir -p ~/bin/openapitools curl https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/bin/utils/openapi-generator-cli.sh > ~/bin/openapitools/openapi-generator-cli chmod u+x ~/bin/openapitools/openapi-generator-cli export PATH=$PATH:~/bin/openapitools/ ``` Now, `openapi-generator-cli` is "installed". On invocation, it will query the GitHub repository for the most recently released version. If this matches the last downloaded jar, it will execute as normal. If a newer version is found, the script will download the latest release and execute it. If you need to invoke an older version of the generator, you can define the variable `OPENAPI_GENERATOR_VERSION` either ad hoc or globally. You can export this variable if you'd like to persist a specific release version. Examples: ``` # Execute latest released openapi-generator-cli openapi-generator-cli version # Execute version 4.1.0 for the current invocation, regardless of the latest released version OPENAPI_GENERATOR_VERSION=4.1.0 openapi-generator-cli version # Execute version 4.1.0-SNAPSHOT for the current invocation OPENAPI_GENERATOR_VERSION=4.1.0-SNAPSHOT openapi-generator-cli version # Execute version 4.0.2 for every invocation in the current shell session export OPENAPI_GENERATOR_VERSION=4.0.2 openapi-generator-cli version # is 4.0.2 openapi-generator-cli version # is also 4.0.2 # To "install" a specific version, set the variable in .bashrc/.bash_profile echo "export OPENAPI_GENERATOR_VERSION=4.0.2" >> ~/.bashrc source ~/.bashrc openapi-generator-cli version # is always 4.0.2, unless any of the above overrides are done ad hoc ``` ### [1.4 - Build Projects](#table-of-contents) To build from source, you need the following installed and available in your `$PATH:` * [Java 8](https://www.oracle.com/technetwork/java/index.html) * [Apache Maven 3.3.4 or greater](https://maven.apache.org/) After cloning the project, you can build it from source with this command: ```sh mvn clean install ``` If you don't have maven installed, you may directly use the included [maven wrapper](https://github.com/takari/maven-wrapper), and build with the command: ```sh ./mvnw clean install ``` The default build contains minimal static analysis (via CheckStyle). To run your build with PMD and Spotbugs, use the `static-analysis` profile: ```sh mvn -Pstatic-analysis clean install ``` ### [1.5 - Homebrew](#table-of-contents) To install, run `brew install openapi-generator` Here is an example usage to generate a Ruby client: ```sh openapi-generator generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g ruby -o /tmp/test/ ``` To reinstall with the latest master, run `brew uninstall openapi-generator && brew install --HEAD openapi-generator` To install OpenJDK (pre-requisites), please run ```sh brew tap AdoptOpenJDK/openjdk brew install --cask adoptopenjdk12 export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-12.0.2.jdk/Contents/Home/ ``` To install Maven, please run ```sh brew install maven ``` ### [1.6 - Docker](#table-of-contents) #### Public Pre-built Docker images - [https://hub.docker.com/r/openapitools/openapi-generator-cli/](https://hub.docker.com/r/openapitools/openapi-generator-cli/) (official CLI) - [https://hub.docker.com/r/openapitools/openapi-generator-online/](https://hub.docker.com/r/openapitools/openapi-generator-online/) (official web service) #### OpenAPI Generator CLI Docker Image The OpenAPI Generator image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version. To generate code with this image, you'll need to mount a local location as a volume. Example: ```sh docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate \ -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml \ -g go \ -o /local/out/go ``` The generated code will be located under `./out/go` in the current directory. #### OpenAPI Generator Online Docker Image The openapi-generator-online image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code. Example usage: ```sh # Start container at port 8888 and save the container id > CID=$(docker run -d -p 8888:8080 openapitools/openapi-generator-online) # allow for startup > sleep 10 # Get the IP of the running container (optional) GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}' $CID) # Execute an HTTP request to generate a Ruby client > curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' \ -d '{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml"}' \ 'http://localhost:8888/api/gen/clients/ruby' {"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"} # Download the generated zip file > wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8 # Unzip the file > unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8 # Shutdown the openapi generator image > docker stop $CID && docker rm $CID ``` #### Development in docker You can use `run-in-docker.sh` to do all development. This script maps your local repository to `/gen` in the docker container. It also maps `~/.m2/repository` to the appropriate container location. To execute `mvn package`: ```sh git clone https://github.com/openapitools/openapi-generator cd openapi-generator ./run-in-docker.sh mvn package ``` Build artifacts are now accessible in your working directory. Once built, `run-in-docker.sh` will act as an executable for openapi-generator-cli. To generate code, you'll need to output to a directory under `/gen` (e.g. `/gen/out`). For example: ```sh ./run-in-docker.sh help # Executes 'help' command for openapi-generator-cli ./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli ./run-in-docker.sh /gen/bin/go-petstore.sh # Builds the Go client ./run-in-docker.sh generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml \ -g go -o /gen/out/go-petstore -p packageName=petstore # generates go client, outputs locally to ./out/go-petstore ``` ##### Troubleshooting If an error like this occurs, just execute the **mvn clean install -U** command: > org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project openapi-generator: A type incompatibility occurred while executing org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test: java.lang.ExceptionInInitializerError cannot be cast to java.io.IOException ```sh ./run-in-docker.sh mvn clean install -U ``` > Failed to execute goal org.fortasoft:gradle-maven-plugin:1.0.8:invoke (default) on project openapi-generator-gradle-plugin-mvn-wrapper: org.gradle.tooling.BuildException: Could not execute build using Gradle distribution 'https://services.gradle.org/distributions/gradle-4.7-bin.zip' Right now: no solution for this one :| #### Run Docker in Vagrant Prerequisite: install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads). ```sh git clone https://github.com/openapitools/openapi-generator.git cd openapi-generator vagrant up vagrant ssh cd /vagrant ./run-in-docker.sh mvn package ``` ### [1.7 - NPM](#table-of-contents) There is also an [NPM package wrapper](https://www.npmjs.com/package/@openapitools/openapi-generator-cli) available for different platforms (e.g. Linux, Mac, Windows). (JVM is still required) Please see the [project's README](https://github.com/openapitools/openapi-generator-cli) there for more information. Install it globally to get the CLI available on the command line: ```sh npm install @openapitools/openapi-generator-cli -g openapi-generator-cli version ``` <!-- RELEASE_VERSION --> To use a specific version of "openapi-generator-cli" ```sh openapi-generator-cli version-manager set 6.3.0 ``` Or install it as dev-dependency: ```sh npm install @openapitools/openapi-generator-cli -D ``` <!-- /RELEASE_VERSION --> ## [2 - Getting Started](#table-of-contents) To generate a PHP client for [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml), please run the following ```sh git clone https://github.com/openapitools/openapi-generator cd openapi-generator mvn clean package java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \ -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml \ -g php \ -o /var/tmp/php_api_client ``` (if you're on Windows, replace the last command with `java -jar modules\openapi-generator-cli\target\openapi-generator-cli.jar generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g php -o c:\temp\php_api_client`) <!-- RELEASE_VERSION --> You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/6.3.0/openapi-generator-cli-6.3.0.jar) <!-- /RELEASE_VERSION --> To get a list of **general** options available, please run `java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help generate` To get a list of PHP specified options (which can be passed to the generator with a config file via the `-c` option), please run `java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g php` ## [3 - Usage](#table-of-contents) ### To generate a sample client library You can build a client against the [Petstore API](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml) as follows: ```sh ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml ``` (On Windows, please install [GIT Bash for Windows](https://gitforwindows.org/) to run the command above) This script uses the default library, which is `okhttp-gson`. It will run the generator with this command: ```sh java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \ -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml \ -g java \ -t modules/openapi-generator/src/main/resources/Java \ --additional-properties artifactId=petstore-okhttp-gson,hideGenerationTimestamp:true \ -o samples/client/petstore/java/okhttp-gson ``` with a number of options. [The java options are documented here.](docs/generators/java.md) You can also get the options with the `help generate` command (below only shows partial results): ``` NAME openapi-generator-cli generate - Generate code with the specified generator. SYNOPSIS openapi-generator-cli generate [(-a <authorization> | --auth <authorization>)] [--api-name-suffix <api name suffix>] [--api-package <api package>] [--artifact-id <artifact id>] [--artifact-version <artifact version>] [(-c <configuration file> | --config <configuration file>)] [--dry-run] [(-e <templating engine> | --engine <templating engine>)] [--enable-post-process-file] [(-g <generator name> | --generator-name <generator name>)] [--generate-alias-as-model] [--git-host <git host>] [--git-repo-id <git repo id>] [--git-user-id <git user id>] [--global-property <global properties>...] [--group-id <group id>] [--http-user-agent <http user agent>] [(-i <spec file> | --input-spec <spec file>)] [--ignore-file-override <ignore file override location>] [--import-mappings <import mappings>...] [--instantiation-types <instantiation types>...] [--invoker-package <invoker package>] [--language-specific-primitives <language specific primitives>...] [--legacy-discriminator-behavior] [--library <library>] [--log-to-stderr] [--minimal-update] [--model-name-prefix <model name prefix>] [--model-name-suffix <model name suffix>] [--model-package <model package>] [(-o <output directory> | --output <output directory>)] [(-p <additional properties> | --additional-properties <additional properties>)...] [--package-name <package name>] [--release-note <release note>] [--remove-operation-id-prefix] [--reserved-words-mappings <reserved word mappings>...] [(-s | --skip-overwrite)] [--server-variables <server variables>...] [--skip-validate-spec] [--strict-spec <true/false strict behavior>] [(-t <template directory> | --template-dir <template directory>)] [--type-mappings <type mappings>...] [(-v | --verbose)] OPTIONS -a <authorization>, --auth <authorization> adds authorization headers when fetching the OpenAPI definitions remotely. Pass in a URL-encoded string of name:header with a comma separating multiple values ...... (results omitted) -v, --verbose verbose mode ``` You can then compile and run the client, as well as unit tests against it: ```sh cd samples/client/petstore/java/okhttp-gson mvn package ``` Other generators have [samples](https://github.com/OpenAPITools/openapi-generator/tree/master/samples) too. ### [3.1 - Customization](#table-of-contents) Please refer to [customization.md](docs/customization.md) on how to customize the output (e.g. package name, version) ### [3.2 - Workflow Integration (Maven, Gradle, Github, CI/CD)](#table-of-contents) Please refer to [integration.md](docs/integration.md) on how to integrate OpenAPI generator with Maven, Gradle, sbt, Bazel, Github and CI/CD. ### [3.3 - Online OpenAPI generator](#table-of-contents) Here are the public online services: - latest stable version: https://api.openapi-generator.tech - latest master: https://api-latest-master.openapi-generator.tech (updated with latest master every hour) The server is sponsored by [Linode](https://www.linode.com/) [](https://www.linode.com/) (These services are beta and do not have any guarantee on service level) Please refer to [online.md](docs/online.md) on how to run and use the `openapi-generator-online` - a web service for `openapi-generator`. ### [3.4 - License information on Generated Code](#table-of-contents) The OpenAPI Generator project is intended as a benefit for users of the Open API Specification. The project itself has the [License](#license) as specified. In addition, please understand the following points: * The templates included with this project are subject to the [License](#license). * Generated code is intentionally _not_ subject to the parent project license When code is generated from this project, it shall be considered **AS IS** and owned by the user of the software. There are no warranties--expressed or implied--for generated code. You can do what you wish with it, and once generated, the code is your responsibility and subject to the licensing terms that you deem appropriate. ### [3.5 - IDE Integration](#table-of-contents) Here is a list of community-contributed IDE plug-ins that integrate with OpenAPI Generator: - Eclipse: [Codewind OpenAPI Tools for Eclipse](https://www.eclipse.org/codewind/open-api-tools-for-eclipse.html) by [IBM](https://www.ibm.com) - IntelliJ IDEA: [OpenAPI Generator](https://plugins.jetbrains.com/plugin/8433-openapi-generator) by [Jim Schubert](https://jimschubert.us/#/) - IntelliJ IDEA: [Senya Editor](https://plugins.jetbrains.com/plugin/10690-senya-editor) by [senya.io](https://senya.io) - [RepreZen API Studio](https://www.reprezen.com/) - Visual Studio: [REST API Client Code Generator](https://marketplace.visualstudio.com/items?itemName=ChristianResmaHelle.ApiClientCodeGenerator) by [Christian Resma Helle](https://christian-helle.blogspot.com/) - Visual Studio Code: [Codewind OpenAPI Tools](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools) by [IBM](https://marketplace.visualstudio.com/publishers/IBM) ## [4 - Companies/Projects using OpenAPI Generator](#table-of-contents) Here are some companies/projects (alphabetical order) using OpenAPI Generator in production. To add your company/project to the list, please visit [README.md](README.md) and click on the icon to edit the page. - [Aalborg University](https://www.aau.dk) - [Adaptant Solutions AG](https://www.adaptant.io/) - [adesso SE](https://www.adesso.de/) - [Adyen](https://www.adyen.com/) - [Agoda](https://www.agoda.com/) - [Airthings](https://www.airthings.com/) - [Allianz](https://www.allianz.com) - [Angular.Schule](https://angular.schule/) - [Aqovia](https://aqovia.com/) - [Australia and New Zealand Banking Group (ANZ)](http://www.anz.com/) - [ASKUL](https://www.askul.co.jp) - [Arduino](https://www.arduino.cc/) - [b<>com](https://b-com.com/en) - [百度营销](https://e.baidu.com) - [Bandwidth](https://dev.bandwidth.com) - [Banzai Cloud](https://banzaicloud.com) - [BIMData.io](https://bimdata.io) - [Bithost GmbH](https://www.bithost.ch) - [Bosch Connected Industry](https://www.bosch-connected-industry.com) - [Boxever](https://www.boxever.com/) - [Brevy](https://www.brevy.com) - [Bunker Holding Group](https://www.bunker-holding.com/) - [California State University, Northridge](https://www.csun.edu) - [CAM](https://www.cam-inc.co.jp/) - [Camptocamp](https://www.camptocamp.com/en) - [Cisco](https://www.cisco.com/) - [codecentric AG](https://www.codecentric.de/) - [CoinAPI](https://www.coinapi.io/) - [Commencis](https://www.commencis.com/) - [Crossover Health](https://crossoverhealth.com/) - [Cupix](https://www.cupix.com/) - [Datadog](https://www.datadoghq.com) - [DB Systel](https://www.dbsystel.de) - [Deeporute.ai](https://www.deeproute.ai/) - [Devsupply](https://www.devsupply.com/) - [DocSpring](https://docspring.com/) - [dwango](https://dwango.co.jp/) - [Edge Impulse](https://www.edgeimpulse.com/) - [Element AI](https://www.elementai.com/) - [Embotics](https://www.embotics.com/) - [emineo](https://www.emineo.ch) - [fastly](https://www.fastly.com/) - [Fenergo](https://www.fenergo.com/) - [freee](https://corp.freee.co.jp/en/) - [FreshCells](https://www.freshcells.de/) - [Fuse](https://www.fuse.no/) - [Gantner](https://www.gantner.com) - [GenFlow](https://github.com/RepreZen/GenFlow) - [GetYourGuide](https://www.getyourguide.com/) - [Glovo](https://glovoapp.com/) - [GMO Pepabo](https://pepabo.com/en/) - [GoDaddy](https://godaddy.com) - [Gumtree](https://gumtree.com) - [Here](https://developer.here.com/) - [IBM](https://www.ibm.com/) - [Instana](https://www.instana.com) - [Interxion](https://www.interxion.com) - [Inquisico](https://inquisico.com) - [JustStar](https://www.juststarinfo.com) - [k6.io](https://k6.io/) - [Klarna](https://www.klarna.com/) - [Kronsoft Development](https://www.kronsoft.ro/home/) - [Kubernetes](https://kubernetes.io) - [Linode](https://www.linode.com/) - [Logicdrop](https://www.logicdrop.com) - [Lumeris](https://www.lumeris.com) - [LVM Versicherungen](https://www.lvm.de) - [MailSlurp](https://www.mailslurp.com) - [Manticore Search](https://manticoresearch.com) - [Mastercard](https://developers.mastercard.com) - [Médiavision](https://www.mediavision.fr/) - [Metaswitch](https://www.metaswitch.com/) - [MoonVision](https://www.moonvision.io/) - [Myworkout](https://myworkout.com) - [NamSor](https://www.namsor.com/) - [Neverfail](https://www.neverfail.com/) - [NeuerEnergy](https://neuerenergy.com) - [Nokia](https://www.nokia.com/) - [OneSignal](https://www.onesignal.com/) - [Options Clearing Corporation (OCC)](https://www.theocc.com/) - [Openet](https://www.openet.com/) - [openVALIDATION](https://openvalidation.io/) - [Oracle](https://www.oracle.com/) - [Paxos](https://www.paxos.com) - [Plaid](https://plaid.com) - [PLAID, Inc.](https://plaid.co.jp/) - [Ponicode](https://ponicode.dev/) - [Pricefx](https://www.pricefx.com/) - [PrintNanny](https://www.print-nanny.com/) - [Prometheus/Alertmanager](https://github.com/prometheus/alertmanager) - [Qavar](https://www.qavar.com) - [QEDIT](https://qed-it.com) - [Qovery](https://qovery.com) - [Qulix Systems](https://www.qulix.com) - [Raksul](https://corp.raksul.com) - [Raiffeisen Schweiz Genossenschaft](https://www.raiffeisen.ch) - [RedHat](https://www.redhat.com) - [RepreZen API Studio](https://www.reprezen.com/swagger-openapi-code-generation-api-first-microservices-enterprise-development) - [REST United](https://restunited.com) - [Robotinfra](https://www.robotinfra.com) - [SmartHR](https://smarthr.co.jp/) - [Sony Interactive Entertainment](https://www.sie.com/en/index.html) - [Splitit](https://www.splitit.com/) - [Stingray](http://www.stingray.com) - [Suva](https://www.suva.ch/) - [Telstra](https://dev.telstra.com) - [Tencent](https://www.tencent.com) - [The University of Aizu](https://www.u-aizu.ac.jp/en/) - [Translucent ApS](https://www.translucent.dk) - [TravelTime platform](https://www.traveltimeplatform.com/) - [TribalScale](https://www.tribalscale.com) - [Trifork](https://trifork.com) - [TUI InfoTec GmbH](http://www.tui-infotec.com/) - [Twilio](https://www.twilio.com/) - [Twitter](https://twitter.com) - [unblu inc.](https://www.unblu.com/) - [Veamly](https://www.veamly.com/) - [VMWare](https://www.vmware.com/) - [wbt-solutions](https://www.wbt-solutions.de/) - [Woleet](https://www.woleet.io/) - [WSO2](https://wso2.com/) - [Vouchery.io](https://vouchery.io) - [Xero](https://www.xero.com/) - [Yahoo Japan](https://www.yahoo.co.jp/) - [viadee](https://www.viadee.de/) - [Vonage](https://vonage.com) - [YITU Technology](https://www.yitutech.com/) - [Yelp](https://www.yelp.com/) - [Zalando](https://www.zalando.com) - [3DS Outscale](https://www.outscale.com/) ## [5 - Presentations/Videos/Tutorials/Books](#table-of-contents) - 2018/05/12 - [OpenAPI Generator - community drivenで成長するコードジェネレータ](https://ackintosh.github.io/blog/2018/05/12/openapi-generator/) by [中野暁人](https://github.com/ackintosh) - 2018/05/15 - [Starting a new open-source project](http://jmini.github.io/blog/2018/2018-05-15_new-open-source-project.html) by [Jeremie Bresson](https://github.com/jmini) - 2018/05/15 - [REST API仕様からAPIクライアントやスタブサーバを自動生成する「OpenAPI Generator」オープンソースで公開。Swagger Codegenからのフォーク](https://www.publickey1.jp/blog/18/rest_apiapiopenapi_generatorswagger_generator.html) by [Publickey](https://www.publickey1.jp) - 2018/06/08 - [Swagger Codegen is now OpenAPI Generator](https://angular.schule/blog/2018-06-swagger-codegen-is-now-openapi-generator) by [JohannesHoppe](https://github.com/JohannesHoppe) - 2018/06/21 - [Connect your JHipster apps to the world of APIs with OpenAPI and gRPC](https://fr.slideshare.net/chbornet/jhipster-conf-2018-connect-your-jhipster-apps-to-the-world-of-apis-with-openapi-and-grpc) by [Christophe Bornet](https://github.com/cbornet) at [JHipster Conf 2018](https://jhipster-conf.github.io/) - 2018/06/22 - [OpenAPI Generator で Gatling Client を生成してみた](https://rohki.hatenablog.com/entry/2018/06/22/073000) at [ソモサン](https://rohki.hatenablog.com/) - 2018/06/27 - [Lessons Learned from Leading an Open-Source Project Supporting 30+ Programming Languages](https://speakerdeck.com/wing328/lessons-learned-from-leading-an-open-source-project-supporting-30-plus-programming-languages) - [William Cheng](https://github.com/wing328) at [LinuxCon + ContainerCon + CloudOpen China 2018](http://bit.ly/2waDKKX) - 2018/07/19 - [OpenAPI Generator Contribution Quickstart - RingCentral Go SDK](https://medium.com/ringcentral-developers/openapi-generator-for-go-contribution-quickstart-8cc72bf37b53) by [John Wang](https://github.com/grokify) - 2018/08/22 - [OpenAPI Generatorのプロジェクト構成などのメモ](https://yinm.info/20180822/) by [Yusuke Iinuma](https://github.com/yinm) - 2018/09/12 - [RepreZen and OpenAPI 3.0: Now is the Time](https://www.reprezen.com/blog/reprezen-openapi-3.0-upgrade-now-is-the-time) by [Miles Daffin](https://www.reprezen.com/blog/author/miles-daffin) - 2018/10/31 - [A node package wrapper for openapi-generator](https://github.com/HarmoWatch/openapi-generator-cli) - 2018/11/03 - [OpenAPI Generator + golang + Flutter でアプリ開発](http://ryuichi111std.hatenablog.com/entry/2018/11/03/214005) by [Ryuichi Daigo](https://github.com/ryuichi111) - 2018/11/15 - [基于openapi3.0的yaml文件生成java代码的一次实践](https://blog.csdn.net/yzy199391/article/details/84023982) by [焱魔王](https://me.csdn.net/yzy199391) - 2018/11/18 - [Generating PHP library code from OpenAPI](https://lornajane.net/posts/2018/generating-php-library-code-from-openapi) by [Lorna Jane](https://lornajane.net/) at [LORNAJANE Blog](https://lornajane.net/blog) - 2018/11/19 - [OpenAPIs are everywhere](https://youtu.be/-lDot4Yn7Dg) by [Jeremie Bresson (Unblu)](https://github.com/jmini) at [EclipseCon Europe 2018](https://www.eclipsecon.org/europe2018) - 2018/12/09 - [openapi-generator をカスタマイズする方法](https://qiita.com/watiko/items/0961287c02eac9211572) by [@watiko](https://qiita.com/watiko) - 2019/01/03 - [Calling a Swagger service from Apex using openapi-generator](https://lekkimworld.com/2019/01/03/calling-a-swagger-service-from-apex-using-openapi-generator/) by [Mikkel Flindt Heisterberg](https://lekkimworld.com) - 2019/01/13 - [OpenAPI GeneratorでRESTful APIの定義書から色々自動生成する](https://ky-yk-d.hatenablog.com/entry/2019/01/13/234108) by [@ky_yk_d](https://twitter.com/ky_yk_d) - 2019/01/20 - [Contract-First API Development with OpenAPI Generator and Connexion](https://medium.com/commencis/contract-first-api-development-with-openapi-generator-and-connexion-b21bbf2f9244) by [Anil Can Aydin](https://github.com/anlcnydn) - 2019/01/30 - [Rapid Application Development With API First Approach Using Open-API Generator](https://dzone.com/articles/rapid-api-development-using-open-api-generator) by [Milan Sonkar](https://dzone.com/users/828329/milan_sonkar.html) - 2019/02/02 - [平静を保ち、コードを生成せよ 〜 OpenAPI Generator誕生の背景と軌跡 〜](https://speakerdeck.com/akihito_nakano/gunmaweb34) by [中野暁人](https://github.com/ackintosh) at [Gunma.web #34 スキーマ駆動開発](https://gunmaweb.connpass.com/event/113974/) - 2019/02/20 - [An adventure in OpenAPI V3 code generation](https://mux.com/blog/an-adventure-in-openapi-v3-api-code-generation/) by [Phil Cluff](https://mux.com/blog/author/philc/) - 2019/02/26 - [Building API Services: A Beginner’s Guide](https://medium.com/google-cloud/building-api-services-a-beginners-guide-7274ae4c547f) by [Ratros Y.](https://medium.com/@ratrosy) in [Google Cloud Platform Blog](https://medium.com/google-cloud) - 2019/02/26 - [Building APIs with OpenAPI: Continued](https://medium.com/@ratrosy/building-apis-with-openapi-continued-5d0faaed32eb) by [Ratros Y.](https://medium.com/@ratrosy) in [Google Cloud Platform Blog](https://medium.com/google-cloud) - 2019-03-07 - [OpenAPI Generator で Spring Boot と Angular をタイプセーフに繋ぐ](https://qiita.com/chibato/items/e4a748db12409b40c02f) by [Tomofumi Chiba](https://github.com/chibat) - 2019-03-16 - [A Quick introduction to manual OpenAPI V3](https://vadosware.io/post/quick-intro-to-manual-openapi-v3/) by [vados](https://github.com/t3hmrman) at [VADOSWARE](https://vadosware.io) - 2019-03-25 - [Access any REST service with the SAP S/4HANA Cloud SDK](https://blogs.sap.com/2019/03/25/integrate-sap-s4hana-cloud-sdk-with-open-api/) by [Alexander Duemont](https://people.sap.com/alexander.duemont) - 2019-03-25 - [OpenAPI generatorを試してみる](https://qiita.com/amuyikam/items/e8a45daae59c68be0fc8) by [@amuyikam](https://twitter.com/amuyikam) - 2019-03-27 - [OpenAPI3を使ってみよう！Go言語でクライアントとスタブの自動生成まで！](https://techblog.zozo.com/entry/openapi3/go) by [@gold_kou](https://twitter.com/gold_kou) - 2019-04-17 - [OpenAPIによるスキーマファースト開発の実施サンプルとCloud Runについて](https://tech-blog.optim.co.jp/entry/2019/04/17/174000) by [@yukey1031](https://twitter.com/yukey1031) - 2019-04-18 - [How to use OpenAPI3 for API developer (RubyKaigi 2019)](https://speakerdeck.com/ota42y/how-to-use-openapi3-for-api-developer) by [@ota42y](https://twitter.com/ota42y) at [RubyKaigi 2019](https://rubykaigi.org/2019) - 2019-04-29 - [A Beginner's Guide to Code Generation for REST APIs (OpenAPI Generator)](https://gum.co/openapi_generator_ebook) by [William Cheng](https://twitter.com/wing328) - 2019-05-01 - [Design and generate a REST API from Swagger / OpenAPI in Java, Python, C# and more](https://simply-how.com/design-and-generate-api-code-from-openapi) by [Simply How](https://simply-how.com/) - 2019-05-17 - [Generate Spring Boot REST API using Swagger/OpenAPI](https://www.47northlabs.com/knowledge-base/generate-spring-boot-rest-api-using-swagger-openapi/) by [Antonie Zafirov](https://www.47northlabs.com/author/antonie-zafirov/) - 2019-05-22 - [REST APIs代码生成指南(OpenAPI Generator)](https://gum.co/openapi_generator_ebook_gb) by [William Cheng](https://twitter.com/wing328), [Xin Meng](https://github.com/xmeng1) - 2019-05-24 - [REST API 代碼生成指南 (OpenAPI Generator)](https://gum.co/openapi_generator_ebook_big5) by [William Cheng](https://twitter.com/wing328) - 2019-06-24 - [Kubernetes Clients and OpenAPI Generator](https://speakerdeck.com/wing328/kubernetes-clients-and-openapi-generator) by [William Cheng](https://twitter.com/wing328) at [Kubernetes Contributor Summits Shanghai 2019](https://www.lfasiallc.com/events/contributors-summit-china-2019/) - 2019-06-28 [Codewind OpenAPI Tools](https://marketplace.eclipse.org/content/codewind-openapi-tools) in [Eclipse Marketplace](https://marketplace.eclipse.org/) by IBM - 2019-06-29 [Codewind OpenAPI Tools](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools) in [Visual Studio Marketplace](https://marketplace.visualstudio.com/) by IBM - 2019-07-04 - [REST API のためのコード生成入門 (OpenAPI Generator)](https://gum.co/openapi_generator_ebook_big5) by [William Cheng](https://twitter.com/wing328), [中野暁人](https://github.com/ackintosh), [和田拓朗](https://github.com/taxpon) - 2019-07-08 - [OpenAPI Generator にコントリビュートしたら社名が載った話。(CAM) - CAM TECH BLOG](https://tech.cam-inc.co.jp/entry/2019/07/08/140000) by [CAM, Inc.](https://www.cam-inc.co.jp/) - 2019-07-14 - [OpenAPI GeneratorでPythonのクライアントライブラリを作成した](https://qiita.com/yuji38kwmt/items/dfb929316a1335a161c0) by [yuji38kwmt](https://qiita.com/yuji38kwmt) - 2019-07-19 - [Developer Experience (DX) for Open-Source Projects: How to Engage Developers and Build a Growing Developer Community](https://speakerdeck.com/wing328/developer-experience-dx-for-open-source-projects-english-japanese) by [William Cheng](https://twitter.com/wing328), [中野暁人](https://github.com/ackintosh) at [Open Source Summit Japan 2019](https://events.linuxfoundation.org/events/open-source-summit-japan-2019/) - 2019-08-14 - [Our OpenAPI journey with Standardizing SDKs](https://bitmovin.com/our-openapi-journey-with-standardizing-sdks/) by [Sebastian Burgstaller](https://bitmovin.com/author/sburgstaller/) at [Bitmovin](https://www.bitmovin.com) - 2019-08-15 - [APIのコードを自動生成させたいだけならgRPCでなくてもよくない?](https://www.m3tech.blog/entry/2019/08/15/110000) by [M3, Inc.](https://corporate.m3.com/) - 2019-08-22 - [マイクロサービスにおけるWeb APIスキーマの管理─ GraphQL、gRPC、OpenAPIの特徴と使いどころ](https://employment.en-japan.com/engineerhub/entry/2019/08/22/103000) by [@ota42y](https://twitter.com/ota42y) - 2019-08-24 - [SwaggerドキュメントからOpenAPI Generatorを使ってモックサーバー作成](https://qiita.com/masayoshi0222/items/4845e4c715d04587c104) by [坂本正義](https://qiita.com/masayoshi0222) - 2019-08-29 - [OpenAPI初探](https://cloud.tencent.com/developer/article/1495986) by [peakxie](https://cloud.tencent.com/developer/user/1113152) at [腾讯云社区](https://cloud.tencent.com/developer) - 2019-08-29 - [全面进化：Kubernetes CRD 1.16 GA前瞻](https://www.servicemesher.com/blog/kubernetes-1.16-crd-ga-preview/) by [Min Kim](https://github.com/yue9944882) at [ServiceMesher Blog](https://www.servicemesher.com/blog/) - 2019-09-01 - [Creating a PHP-Slim server using OpenAPI (Youtube video)](https://www.youtube.com/watch?v=5cJtbIrsYkg) by [Daniel Persson](https://www.youtube.com/channel/UCnG-TN23lswO6QbvWhMtxpA) - 2019-09-06 - [Vert.x and OpenAPI](https://wissel.net/blog/2019/09/vertx-and-openapi.html) by [Stephan H Wissel](https://twitter.com/notessensei) at [wissel.net blog](https://wissel.net) - 2019-09-09 - [Cloud-native development - Creating RESTful microservices](https://cloud.ibm.com/docs/cloud-native?topic=cloud-native-rest-api) in [IBM Cloud Docs](https://cloud.ibm.com/docs) - 2019-09-14 - [Generating and Configuring a Mastercard API Client](https://developer.mastercard.com/platform/documentation/generating-and-configuring-a-mastercard-api-client/) at [Mastercard Developers Platform](https://developer.mastercard.com/platform/documentation/) - 2019-09-15 - [OpenAPI(Swagger)導入下調べ](https://qiita.com/ShoichiKuraoka/items/f1f7a3c2376f7cd9c56a) by [Shoichi Kuraoka](https://qiita.com/ShoichiKuraoka) - 2019-09-17 - [Tutorial: Documenting http4k APIs with OpenApi3](https://www.http4k.org/tutorials/documenting_apis_with_openapi/) by [http4k](https://www.http4k.org/) - 2019-09-22 - [OpenAPI 3を完全に理解できる本](https://booth.pm/ja/items/1571902) by [@ota42y](https://twitter.com/ota42y) - 2019-09-22 - [RESTful APIs: Tutorial of OpenAPI Specification](https://medium.com/@amirm.lavasani/restful-apis-tutorial-of-openapi-specification-eeada0e3901d) by [Amir Lavasani](https://medium.com/@amirm.lavasani) - 2019-09-22 - [Redefining SDKs as software diversity kits](https://devrel.net/dev-rel/redefining-sdks-as-software-diversity-kits) by [Sid Maestre (Xero)](https://twitter.com/sidneyallen) at [DevRelCon San Francisco 2019](https://sf2019.devrel.net/) - 2019-09-23 - [swaggerからOpenApi GeneratorでSpringのコードを自動生成](https://qiita.com/littleFeet/items/492df2ad68a0799a5e5e) by [@littleFeet](https://qiita.com/littleFeet) at [Qiita](https://qiita.com/) - 2019-09-24 - [Eine Stunde was mit Api First!](https://www.slideshare.net/JanWeinschenker/eine-stunde-was-mit-api-first) by [@janweinschenker](https://twitter.com/janweinschenker) at [Java Forum Nord](https://javaforumnord.de/) - 2019-10-09 - [openapi-generator で生成した Go クライアントで Bearer 認証をする](https://autopp-tech.hatenablog.com/entry/2019/10/09/222039) by [Akira Tanimura](https://github.com/autopp) - 2019-10-10 - [Automatic Generation of REST Clients](https://www.meetup.com/fr-FR/Criteo-Labs-Tech-Talks/events/264775768/) by Thomas Peyrard, Senior Software Engineer at Criteo in [Full-Stack Tech Talks (Meetup)](https://www.meetup.com/fr-FR/Criteo-Labs-Tech-Talks/events/264775768/) - 2019-10-12 - [OpenApi自动生成client](https://blog.csdn.net/wxid2798226/article/details/102527467) by [郑泽洲](https://me.csdn.net/wxid2798226) - 2019-10-16 - [How to ship APIs faster?](https://medium.com/@accounts_76224/how-to-ship-apis-faster-cabef2f819e4) by [Simon Guilliams @ PoniCode](https://ponicode.dev) - 2019-10-22 - [OpenAPI + Spring Boot(Kotlin)でファイルダウンロードAPIを作成する](https://qiita.com/boronngo/items/4b78b92526209daeaee9) by [Yuki Furukawa](https://twitter.com/yuki_furukawa5) - 2019-10-24 - [Microprofile OpenAPI - Code First or Design First?](https://github.com/pe-st/apidocs/blob/master/MicroProfile-OpenAPI-all-slides.pdf) by [Peter [pɛʃə] Steiner](https://twitter.com/pesche) at [eclipsecon Europe 2019](https://www.eclipsecon.org/europe2019/sessions/microprofile-openapi-code-first-or-design-first) - 2019-11-06 - [Generating API clients based on OpenAPI v3 specifications](https://98elements.com/blog/generating-api-clients-based-on-openapi-v3-specifications) by [Dominik Jastrzębski @ 98elements](https://98elements.com) - 2019-11-06 - [OpenAPIを利用して自前のAPIサーバー(Sinatra)を移植した時のメモ](https://qiita.com/YasuhiroABE/items/c73920eab2d9d6e97fd9) by [Yasuhiro ABE](https://twitter.com/YasuhiroABE) - 2019-11-07 - [API First development with OpenAPI - You should you practise it !?](https://www.youtube.com/watch?v=F9iF3a1Z8Y8) by [Nick Van Hoof](https://www.nickvanhoof.com/) at [Devoxx Belgium 2019](https://devoxx.be/) - 2019-11-08 - [JHipster beyond CRUD - API-First for Enterprises by Enrico Costanzi](https://www.youtube.com/watch?v=m28JFovKQ20) by [Enrico Costanzi](https://twitter.com/enricocostanzi) at [JHipster Conf 2019 in Paris](https://jhipster-conf.github.io/) - 2019-11-11 - [TypeScript REST APIクライアント](https://qiita.com/unhurried/items/7b74f7d3c43545dadd2b) by [@unhurried](https://qiita.com/unhurried) - 2019-11-11 - [One Spec to Rule them all - OpenAPI in Action](https://www.youtube.com/watch?v=MMay_nht8ec) by [Andreas Litt](https://github.com/littldr) at [code.talks 2019](https://www.codetalks.com/) - 2019-11-13 - [OpenAPI 3.0 Editor And Generator With A Spring Boot Example](https://simply-how.com/design-and-generate-api-code-from-openapi) at [Simply How](https://simply-how.com/) - 2019-11-17 - [OpenAPI Generator YouTube playlist](https://www.youtube.com/playlist?list=PLtJyHVMdzfF6fBkOUV5VDVErP23CGgHIy) at [YouTube](https://www.youtube.com) - 2019-11-20 - [Introduction to OpenAPI](https://noti.st/lornajane/HvDH7U/introduction-to-openapi) by [Lorna Mitchell](https://twitter.com/lornajane) at [GOTO Copenhagen 2019](https://gotocph.com/2019/) - 2019-11-20 - [How to Generate Angular code from OpenAPI specifications](https://dotnetthoughts.net/how-to-generate-angular-code-from-openapi-specifications/) by Anuraj - 2019-11-23 - [Swagger ではない OpenAPI Specification 3.0 による API サーバー開発](https://www.slideshare.net/techblogyahoo/swagger-openapi-specification-30-api) by [Tetsuya Morimoto](https://github.com/t2y) at [JJUG CCC 2019 Fall](https://ccc2019fall.java-users.jp/) - 2019-11-24 - [Accelerate Flutter development with OpenAPI and Dart code generation](https://medium.com/@irinasouthwell_220/accelerate-flutter-development-with-openapi-and-dart-code-generation-1f16f8329a6a) by [Irina Southwell](https://medium.com/@irinasouthwell_220) - 2019-11-25 - [openapi-generatorで手軽にスタブサーバとクライアントの生成](https://qiita.com/pochopocho13/items/8db662e1934fb2b408b8) by [@pochopocho13](https://twitter.com/pochopocho13) - 2019-11-26 - [CordaCon 2019 Highlights: Braid Server and OpenAPI Generator for Corda Client API’s](https://blog.b9lab.com/cordacon-2019-highlights-braid-server-and-openapi-generator-for-corda-flows-api-s-d24179ccb27c) by [Adel Rustum](https://blog.b9lab.com/@adelrestom) at [B9lab](https://blog.b9lab.com/) - 2019-12-03 - [A Road to Less Coding: Auto-Generate APILibrary](https://www.corda.net/blog/a-road-to-less-coding-auto-generate-apilibrary/) at [Corda Blog](https://www.corda.net/blog/) - 2019-12-04 - [Angular＋NestJS＋OpenAPI（Swagger）でマイクロサービスを視野に入れた環境を考える](https://qiita.com/teracy55/items/0327c7a170ec772970c6) by [てらしー](https://twitter.com/teracy55) - 2019-12-05 - [Code generation on the Java VM](https://speakerdeck.com/sullis/code-generation-on-the-java-vm-2019-12-05) by [Sean Sullivan](https://speakerdeck.com/sullis) - 2019-12-17 - [OpenAPI Generator で OAuth2 アクセストークン発行のコードまで生成してみる](https://www.techscore.com/blog/2019/12/17/openapi-generator-oauth2-accesstoken/) by [TECHSCORE](https://www.techscore.com/blog/) - 2019-12-23 - [Use Ada for Your Web Development](https://www.electronicdesign.com/technologies/embedded-revolution/article/21119177/use-ada-for-your-web-development) by [Stephane Carrez](https://github.com/stcarrez) - 2019-12-23 - [OpenAPIのスキーマを分割・構造化していく方法](https://gift-tech.co.jp/articles/structured-openapi-schema) by [小飯塚達也](https://github.com/t2h5) at [GiFT, Inc](https://gift-tech.co.jp/) - 2020-01-17 - [OpenAPI demo for Pulp 3.0 GA](https://www.youtube.com/watch?v=mFBP-M0ZPfw&t=178s) by [Pulp](https://www.youtube.com/channel/UCI43Ffs4VPDv7awXvvBJfRQ) at [Youtube](https://www.youtube.com/) - 2020-01-19 - [Why document a REST API as code?](https://dev.to/rolfstreefkerk/why-document-a-rest-api-as-code-5e7p) by [Rolf Streefkerk](https://github.com/rpstreef) at [DEV Community](https://dev.to) - 2020-01-28 - [Get Your Serverless Swagger Back with OpenAPI](https://dev.to/matttyler/get-your-serverless-swagger-back-with-openapi-48gc) by [Matt Tyler](https://dev.to/matttyler) - 2020-01-30 - [OpenAPI Generatorへのコントリビュート](https://www.yutaka0m.work/entry/2020/01/30/163905) by [yutaka0m](https://github.com/yutaka0m) - 2020-02-01 - [Using OpenAPI to Maximise Your Pulp 3 Experience](https://fosdem.org/2020/schedule/event/openapi/) by [Dennis Kliban](https://github.com/dkliban/) at [FOSDEM](https://fosdem.org/) - 2020-02-07 - [Why you should use OpenAPI for your API design](https://www.youtube.com/watch?v=zhb7vUApLW8&t=927s) by [Nick Van Hoof](https://apiconference.net/speaker/nick-van-hoof/) at [API Conference](https://apiconference.net/) - 2020-02-17 - [Rubynetes: using OpenAPI to validate Kubernetes configs](https://www.brightbox.com/blog/2020/02/17/using-openapi-to-validate-kubernetes-configs/) by Neil Wilson at [Brightbox](https://www.brightbox.com/) - 2020-02-20 - [Building SDKs for the future](https://devblog.xero.com/building-sdks-for-the-future-b79ff726dfd6) by [Sid Maestre (Xero)](https://twitter.com/sidneyallen) - 2020-02-27 - [Nuxt利用プロダクトでIE11と仲良くするためのE2E](https://tech.medpeer.co.jp/entry/e2e-ie11) at [Medpeer.co.jp Tech Blog](https://tech.medpeer.co.jp/) - 2020-02-29 - [Providing Support to IoT Devices Deployed in Disconnected Rural Environment (Conference paper)](https://link.springer.com/chapter/10.1007/978-3-030-41494-8_14) by Sergio Laso, Daniel Flores-Martín, Juan Luis HerreraCarlos, CanalJuan Manuel, MurilloJavier Berrocal - 2020-03-02 - [How To Generate Angular & Spring Code From OpenAPI Specification](https://www.mokkapps.de/blog/how-to-generate-angular-and-spring-code-from-open-api-specification/) by [Michael Hoffmann](https://www.mokkapps.de/) - 2020-03-02 - [OpenAPI Generator + TypeScript で始める自動生成の型に守られた豊かなクライアント生活](https://gift-tech.co.jp/articles/openapi-generator-typescript) by [五百蔵 直樹](https://gift-tech.co.jp/members/naokiioroi) at [GiFT株式会社](https://gift-tech.co.jp/) - 2020-03-10 - [OpenAPI Generator Meetup #1](https://speakerdeck.com/akihito_nakano/openapi-generator-meetup-number-1) by [中野暁人](https://github.com/ackintosh) at [OpenAPI Generator Meetup #1](https://openapi-generator-meetup.connpass.com/event/168187/) - 2020-03-15 - [Load Testing Your API with Swagger/OpenAPI and k6](https://k6.io/blog/load-testing-your-api-with-swagger-openapi-and-k6) - 2020-04-13 - [俺的【OAS】との向き合い方 (爆速でOpenAPIと友達になろう)](https://tech-blog.optim.co.jp/entry/2020/04/13/100000) in [OPTim Blog](https://tech-blog.optim.co.jp/) - 2020-04-22 - [Introduction to OpenAPI Generator](https://nordicapis.com/introduction-to-openapi-generator/) by [Kristopher Sandoval](https://nordicapis.com/author/sandovaleffect/) in [Nordic APIs](https://nordicapis.com/) - 2020-04-27 - [How we use Open API v3 specification to auto-generate API documentation, code-snippets and clients](https://medium.com/pdf-generator-api/how-we-use-open-api-v3-specification-to-auto-generate-api-documentation-code-snippets-and-clients-d127a3cea784) by [Tanel Tähepõld](https://medium.com/@tanel.tahepold) - 2020-05-09 - [OpenAPIでお手軽にモックAPIサーバーを動かす](https://qiita.com/kasa_le/items/97ca6a8dd4605695c25c) by [Sachie Kamba](https://qiita.com/kasa_le) - 2020-05-18 - [Spring Boot REST with OpenAPI 3](https://dev.to/alfonzjanfrithz/spring-boot-rest-with-openapi-3-59jm) by [Alfonz Jan Frithz](https://dev.to/alfonzjanfrithz) - 2020-05-19 - [Dead Simple APIs with Open API](https://www.youtube.com/watch?v=sIaXmR6xRAw) by [Chris Tankersley](https://github.com/dragonmantank) at [Nexmo](https://developer.nexmo.com/) - 2020-05-22 - [TypeScript REST API Client](https://dev.to/unhurried/typescript-rest-api-client-4in3) by ["unhurried"](https://dev.to/unhurried) - 2020-05-28 - [【使用 lotify + Swagger 建置可共用的 LINE Notify bot】 - #NiJia @ Chatbot Developer Taiwan 第 #19 小聚](https://www.youtube.com/watch?v=agYVz6dzh1I) by [Chatbot Developer Taiwan](https://www.youtube.com/channel/UCxeYUyZNnHmpX23YNF-ewvw) - 2020-05-28 - [Building APIs with Laravel using OpenAPI](https://www.youtube.com/watch?v=xexLvQqAhiA) by [Chris Tankersley](https://github.com/dragonmantank) at [Laracon EU](https://laracon.eu/) - 2020-06-12 - [Interoperability by construction: code generation for Arrowhead Clients](https://ieeexplore.ieee.org/document/9274746) by Michele Albano, Brian Nielsen at [2020 IEEE Conference on Industrial Cyberphysical Systems (ICPS)](https://ieeexplore.ieee.org/xpl/conhome/9274544/proceeding) - 2020-06-23 - [新規サーバーアプリケーションにTypeScriptを採用してみた](https://www.cam-inc.co.jp/news/20200623) at [CAM Tech Blog](https://www.cam-inc.co.jp/news/tech-blog/) - 2020-06-29 - [Artifact Abstract: Deployment of APIs on Android Mobile Devices and Microcontrollers](https://ieeexplore.ieee.org/document/9127353) by [Sergio Laso ; Marino Linaje ; Jose Garcia-Alonso ; Juan M. Murillo ; Javier Berrocal](https://ieeexplore.ieee.org/document/9127353/authors#authors) at [2020 IEEE International Conference on Pervasive Computing and Communications (PerCom)](https://ieeexplore.ieee.org/xpl/conhome/9125449/proceeding) - 2020-07-07 - [5 Best API Documentation Tools](https://blog.dreamfactory.com/5-best-api-documentation-tools/) by Susanna Bouse at [DreamFactory Blog](https://blog.dreamfactory.com/) - 2020-07-12 - [Open API 3.0の定義からgolangのサーバコードのスケルトンを作成する](https://qiita.com/professor/items/4cbd04ec084d13057bc2) by [@professor (Qiita Blog)](https://qiita.com/professor) - 2020-07-20 - [Datadog API client libraries now available for Java and Go](https://www.datadoghq.com/blog/java-go-libraries/) by Jordan Obey at [Datadog Blog](https://www.datadoghq.com/blog) - 2020-07-23 - [Generate Client SDK for .NET Core using Open Api](https://dev.to/no0law1/generate-client-sdk-for-net-core-using-open-api-2dgh) by [Nuno Reis](https://dev.to/no0law1) - 2020-07-26 - [Dartのhttp_interceptorライブラリを使うと配列のクエリパラメータが消えてしまう件の応急処置](https://qiita.com/gyamoto/items/eeeff81b6770487319ed) by [@gyamoto](https://qiita.com/gyamoto) - 2020-08-01 - [Generate Angular ReactiveForms from Swagger/OpenAPI](https://dev.to/martinmcwhorter/generate-angular-reactiveforms-from-swagger-openapi-35h9) by [Martin McWhorter](https://dev.to/martinmcwhorter) - 2020-08-03 - [Criando Bibliotecas para APIs RESTful com OpenAPI, Swagger Editor e OpenAPI Generator](https://medium.com/@everisBrasil/criando-bibliotecas-para-apis-restful-com-openapi-swagger-editor-e-openapi-generator-75349a6420fd) by [everis Brasil (an NTT DATA Company)](https://medium.com/@everisBrasil) - 2020-08-19 - [マイクロサービスを連携してみよう](https://thinkit.co.jp/article/17704) by [岡井 裕矢(おかい ゆうや)](https://thinkit.co.jp/author/17588), [泉 勝(いずみ まさる)](https://thinkit.co.jp/author/17705) at [Think IT（シンクイット）](https://thinkit.co.jp/) - 2020-08-25 - [OpenAPI Generator と TypeScript で型安全にフロントエンド開発をしている話](https://tech.smarthr.jp/entry/2020/08/25/135631) at [SmartHR Tech Blog](https://tech.smarthr.jp/) - 2020-09-10 - [Introduction to OpenAPI with Instana](https://www.instana.com/blog/introduction-to-openapi-with-instana/) by [Cedric Ziel](https://www.instana.com/blog/author/cedricziel/) at [Instana Blog](https://www.instana.com/blog/) - 2020-09-17 - [Generate PowerShellSDK using openapi-generator](https://medium.com/@ghufz.learn/generate-powershellsdk-using-openapi-generator-33b700891e33) by [Ghufran Zahidi](https://medium.com/@ghufz.learn) - 2020-09-24 - [How to automate API code generation (OpenAPI/Swagger) and boost productivity - Tutorial with React Native featuring TypeScript](https://medium.com/@sceleski/how-to-automate-api-code-generation-openapi-swagger-and-boost-productivity-1176a0056d8a) by [Sanjin Celeski](https://medium.com/@sceleski) - 2020-09-25 - [Generate OpenAPI Angular Client](https://medium.com/@pguso/generate-openapi-angular-client-8c9288e8bbd4) by [Patric](https://medium.com/@pguso) - 2020-10-24 - [Working with Microsoft Identity - React Native Client](https://www.josephguadagno.net/2020/10/24/working-with-microsoft-identity-react-native-client) by [Joseph Guadagno](https://www.josephguadagno.net/) - 2020-10-31 - [[B2] OpenAPI Specification으로 타입-세이프하게 API 개발하기: 희망편 VS 절망편](https://www.youtube.com/watch?v=J4JHLESAiFk) by 최태건 at [FEConf 2020](https://2020.feconf.kr/) - 2020-11-05 - [Automated REST-Api Code Generation: Wie IT-Systeme miteinander sprechen](https://www.massiveart.com/blog/automated-rest-api-code-generation-wie-it-systeme-miteinander-sprechen) by Stefan Rottensteiner at [MASSIVE ART Blog](https://www.massiveart.com/blog) - 2020-12-01 - [OpenAPI GeneratorでGoのAPIサーバー/クライアントコードを自動生成する](https://qiita.com/saki-engineering/items/b20d8b6074c4da9664a5) by [@saki-engineering](https://qiita.com/saki-engineering) - 2020-12-04 - [Scaling the Test Coverage of OpenAPI Generator for 30+ Programming Languages](https://www.youtube.com/watch?v=7Lke9dHRqT0) by [William Cheng](https://github.com/wing328) at [Open Source Summit Japan + Automotive Linux Summit 2020](https://events.linuxfoundation.org/archive/2020/open-source-summit-japan/) ([Slides](https://speakerdeck.com/wing328/scaling-the-test-coverage-of-openapi-generator-for-30-plus-programming-languages)) - 2020-12-09 - [プロジェクトにOpenAPI Generatorで自動生成された型付きAPI Clientを導入した話](https://qiita.com/yoshifujiT/items/905c18700ede23f40840) by [@yoshifujiT](https://github.com/yoshifujiT) - 2020-12-15 - [Next.js + NestJS + GraphQLで変化に追従するフロントエンドへ 〜 ショッピングクーポンの事例紹介](https://techblog.yahoo.co.jp/entry/2020121530052952/) by [小倉 陸](https://github.com/ogugu9) at [Yahoo! JAPAN Tech Blog](https://techblog.yahoo.co.jp/) - 2021-01-08 - [Hello, New API – Part 1](https://www.nginx.com/blog/hello-new-api-part-1/) by [Jeremy Schulman](https://www.nginx.com/people/jeremy-schulman/) at [Major League Baseball](https://www.mlb.com) - 2021-01-18 - [「アプリ開発あるある」を疑うことから始まった、API Clientコードの自動生成【デブスト2020】](https://codezine.jp/article/detail/13406?p=2) by [CodeZine編集部](https://codezine.jp/author/1) - 2021-02-05 - [REST-API-Roundtrip with SpringDoc and OpenAPI Generator](https://blog.viadee.de/en/rest-api-roundtrip) by [Benjamin Klatt](https://twitter.com/benklatt) at [viadee](https://www.viadee.de/en/) - 2021-02-17 - [REST-API-Roundtrip with SpringDoc and OpenAPI Generator](https://medium.com/nerd-for-tech/rest-api-roundtrip-with-springdoc-and-openapi-generator-30bd27ccf698) by [cloud @viadee](https://cloud-viadee.medium.com/) - 2021-03-08 - [OpenAPI Generator 工具的躺坑尝试](https://blog.csdn.net/u013019701/article/details/114531975) by [独家雨天](https://blog.csdn.net/u013019701) at [CSDN官方博客](https://blog.csdn.net/) - 2021-03-16 - [如何基于 Swagger 使用 OpenAPI Generator 生成 JMeter 脚本？](https://cloud.tencent.com/developer/article/1802704) by [高楼Zee](https://cloud.tencent.com/developer/user/5836255) at [腾讯云专栏](https://cloud.tencent.com/developer/column) - 2021-03-24 - [openapi-generator-cli による TypeScript 型定義](https://zenn.dev/takepepe/articles/openapi-generator-cli-ts) by [Takefumi Yoshii](https://zenn.dev/takepepe) - 2021-03-28 - [Trying out NestJS part 4: Generate Typescript clients from OpenAPI documents](https://dev.to/arnaudcortisse/trying-out-nestjs-part-4-generate-typescript-clients-from-openapi-documents-28mk) by [Arnaud Cortisse](https://dev.to/arnaudcortisse) - 2021-03-31 - [Open API Server Implementation Using OpenAPI Generator](https://www.baeldung.com/java-openapi-generator-server) at [Baeldung](https://www.baeldung.com/) - 2021-03-31 - [使用OpenAPI Generator實現Open API Server](https://www.1ju.org/article/java-openapi-generator-server) at [億聚網](https://www.1ju.org/) - 2021-04-19 - [Introducing Twilio’s OpenAPI Specification Beta](https://www.twilio.com/blog/introducing-twilio-open-api-specification-beta) by [GARETH PAUL JONES](https://www.twilio.com/blog/author/gpj) at [Twilio Blog](https://www.twilio.com/blog) - 2021-04-22 - [Leveraging OpenApi strengths in a Micro-Service environment](https://medium.com/unibuddy-technology-blog/leveraging-openapi-strengths-in-a-micro-service-environment-3d7f9e7c26ff) by Nicolas Jellab at [Unibuddy Technology Blog](https://medium.com/unibuddy-technology-blog) - 2021-04-27 - [From zero to publishing PowerShell API clients in PowerShell Gallery within minutes](https://speakerdeck.com/wing328/from-zero-to-publishing-powershell-api-clients-in-powershell-gallery-within-minutes) by [William Cheng](https://github.com/wing328) at [PowerShell + DevOps Global Summit 2021](https://events.devopscollective.org/event/powershell-devops-global-summit-2021/) - 2021-05-31 - [FlutterでOpen Api Generator(Swagger)を使う](https://aakira.app/blog/2021/05/flutter-open-api/) by [AAkira](https://twitter.com/_a_akira) - 2021-06-22 - [Rest API Documentation and Client Generation With OpenAPI](https://dzone.com/articles/rest-api-documentation-and-client-generation-with) by [Prasanth Gullapalli](https://dzone.com/users/1011797/[email protected]) - 2021-07-16 - [銀行事業のサーバーサイド開発について / LINE 京都開発室 エンジニア採用説明会](https://www.youtube.com/watch?v=YrrKQHxLPpQ) by 野田誠人, Robert Mitchell - 2021-07-19 - [OpenAPI code generation with kotlin](https://sylhare.github.io/2021/07/19/Openapi-swagger-codegen-with-kotlin.html) by [sylhare](https://github.com/sylhare) - 2021-07-29 - [How To Rewrite a Huge Codebase](https://dzone.com/articles/how-to-rewrite-a-huge-code-base) by [Curtis Poe](https://dzone.com/users/4565446/publiusovidius.html) - 2021-08-21 - [Generating Client APIs using Swagger Part 1](https://medium.com/@flowsquad/generating-client-apis-using-swagger-part-1-2d46f13f5e92) by [FlowSquad.io](https://medium.com/@flowsquad) - 2021-09-11 - [Invoking AWS ParallelCluster API](https://docs.aws.amazon.com/parallelcluster/latest/ug/api-reference-v3.html) at [AWS ParallelCluster API official documentation](https://docs.aws.amazon.com/parallelcluster/latest/ug/api-reference-v3.html) - 2021-09-20 - [OpenAPI Generator - The Babel Fish of the API World](https://www.youtube.com/watch?v=s2zMtwd5klg) by [Cliffano Subagio (Principal Engineer at Shine Solutions)](https://github.com/cliffano) at [Apidays LIVE Australia 2021](https://www.apidays.global/australia2021/) - 2021-10-02 - [How to Write Fewer Lines of Code with the OpenAPI Generator](https://hackernoon.com/how-to-write-fewer-lines-of-code-with-the-openapi-generator) by [Mikhail Alfa](https://hackernoon.com/u/alphamikle) - 2021-10-12 - [OpenAPI Generator : 4000 étoiles sur GitHub et des spaghettis](https://www.youtube.com/watch?v=9hEsNBSqTFk) by [Jérémie Bresson](https://github.com/jmini) at [Devoxx FR 2021](https://cfp.devoxx.fr/2021/speaker/jeremie_bresson) - 2021-10-17 - [Generate a TypeScript HTTP Client From An OpenAPI Spec In DotNET 5](https://richardwillis.info/blog/generate-a-type-script-http-client-from-an-open-api-spec-in-dot-net-5) by [Richard Willis](https://github.com/badsyntax) - 2021-11-06 - [スタートアップの開発で意識したこと](https://zenn.dev/woo_noo/articles/5cb09f8e2899ae782ad1) by [woo-noo](https://zenn.dev/woo_noo) - 2021-11-09 - [Effective Software Development using OpenAPI Generator](https://apexlabs.ai/post/effective-software-development-using-openapi-generator) by Ajil Oomme - 2021-12-07 - [An Introduction to OpenAPI](https://betterprogramming.pub/4-use-cases-of-openapi-which-are-good-to-know-1a041f4ad71e) by [Na'aman Hirschfeld](https://naamanhirschfeld.medium.com/) - 2022-01-02 - [Towards a secure API client generator for IoT devices](https://arxiv.org/abs/2201.00270) by Anders Aaen Springborg, Martin Kaldahl Andersen, Kaare Holland Hattel, Michele Albano - 2022-02-02 - [Use OpenApi generator to share your models between Flutter and your backend](https://www.youtube.com/watch?v=kPW7ccu9Yvk) by [Guillaume Bernos](https://feb2022.fluttervikings.com/speakers/guillaume_bernos) at [Flutter Vikings Conference 2022 (Hybrid)](https://feb2022.fluttervikings.com/) - 2022-03-15 - [OpenAPI Specでハイフン区切りのEnum値をOpenAPI Generatorで出力すると、ハイフン区切りのまま出力される](https://qiita.com/yuji38kwmt/items/824d74d4889055ab37d8) by [yuji38kwmt](https://qiita.com/yuji38kwmt) - 2022-04-01 - [OpenAPI Generatorのコード生成とSpring Frameworkのカスタムデータバインディングを共存させる](https://techblog.zozo.com/entry/coexistence-of-openapi-and-spring) in [ZOZO Tech Blog](https://techblog.zozo.com/) - 2022-04-06 - [Effective Software Development using OpenAPI Generator](https://apexlabs.ai/post/openapi-generator) by Ajil Oommen (Senior Flutter Developer) - 2022-05-13 - [A Path From an API To Client Libraries](https://www.youtube.com/watch?v=XC8oVn_efTw) by [Filip Srnec](https://www.devoxx.co.uk/talk/?id=11211) at Infobip - 2022-06-01 - [API First, using OpenAPI and Spring Boot](https://medium.com/xgeeks/api-first-using-openapi-and-spring-boot-2602c04bb0d3) by [Micael Estrázulas Vianna](https://estrazulas.medium.com/) - 2022-07-01 - [Generate API contract using OpenAPI Generator Maven plugin](https://huongdanjava.com/generate-api-contract-using-openapi-generator-maven-plugin.html) by [Khanh Nguyen](https://huongdanjava.com/) - 2022-07-22 - [使用OpenAPI Generator Maven plugin开发api优先的java客户端和服务端代码](https://blog.roccoshi.top/2022/java/openapi-generator%E7%9A%84%E4%BD%BF%E7%94%A8/) by [Lincest](https://github.com/Lincest) - 2022-08-01 - [Tutorial: Etsy Open API v3 (ruby)](https://blog.tjoyal.dev/etsy-open-api-v3/) by [Thierry Joyal](https://github.com/tjoyal) - 2022-09-03 - [OpenAPI Generator For Go Web Development](https://blog.kevinhu.me/2022/09/03/03-openapi-generator/) by [Kevin Hu](https://twitter.com/Oldgunix) - 2022-10-01 - [OpenAPI Generatorをカスタマイズしたコードを生成する（Swagger Codegenとほぼ同じ）](https://nainaistar.hatenablog.com/entry/2022/10/03/120000) by [きり丸](https://twitter.com/nainaistar) - 2022-10-21 - [Kotlin（Spring Boot）の API を OpenAPI Generator で自動生成](https://zenn.dev/msksgm/articles/20221021-kotlin-spring-openapi-generator) by [msksgm](https://zenn.dev/msksgm) - 2022-10-26 - [Quarkus Insights #106: Quarkiverse Extension Spotlight: OpenApi Generator](https://www.youtube.com/watch?v=_s_if69t2iQ) by [Quarkusio](https://www.youtube.com/c/Quarkusio) - 2022-11-28 - [The REST API implementation flow](https://tmsvr.com/openapi-code-generation-for-rest-apis/) by [Imre Tömösvári](https://tmsvr.com/author/imre/) - 2022-12-13 - [API-First with Spring WebFlux and OpenAPI Generator](https://boottechnologies-ci.medium.com/api-first-with-spring-webflux-and-openapi-generator-38b7804c4ed4) by [Eric Anicet](https://boottechnologies-ci.medium.com/) - 2023-01-06 - [Major Improvements with Helidon and OpenAPI](https://medium.com/helidon/major-improvements-with-helidon-and-openapi-f76a0951508e) by [Tim Quinn](https://medium.com/@tquinno600) - 2023-02-02 - [Replacing Postman with the Jetbrains HTTP Client](https://lengrand.fr/replacing-postman-in-seconds-with-the-jetbrains-http-client/) by [julien Lengrand-Lambert](https://github.com/jlengrand) ## [6 - About Us](#table-of-contents) What's the design philosophy or principle behind OpenAPI Generator? We focus on developer experience. The generators should produce code, config, documentation, and more that are easily understandable and consumable by users. We focused on simple use cases to start with (bottom-up approach). Since then the project and the community have grown a lot: 300k weekly downloads via NPM CLI wrapper, 20M downloads via openapi-generator-cli docker image just to highlight a few. We've gradually supported more features (e.g. oneOf, anyOf introduced in OpenAPI 3.0) in various generators and we will continue this approach to deliver something based on our understanding of user demand and what they want, and continue to add support of new features introduced in OpenAPI specification (such as v3.1 and future versions of the OpenAPI specification). ### [6.1 - OpenAPI Generator Core Team](#table-of-contents) OpenAPI Generator core team members are contributors who have been making significant contributions (review issues, fix bugs, make enhancements, etc) to the project on a regular basis. #### Core Team Members * [@wing328](https://github.com/wing328) (2015/07) [:heart:](https://www.patreon.com/wing328) * [@jimschubert](https://github.com/jimschubert) (2016/05) [:heart:](https://www.patreon.com/jimschubert) * [@cbornet](https://github.com/cbornet) (2016/05) * [@jmini](https://github.com/jmini) (2018/04) [:heart:](https://www.patreon.com/jmini) * [@etherealjoy](https://github.com/etherealjoy) (2019/06) * [@spacether](https://github.com/spacether) (2020/05) [:heart:][spacether sponsorship] :heart: = Link to support the contributor directly [spacether sponsorship]: https://github.com/sponsors/spacether/ #### Template Creator **NOTE**: Embedded templates are only supported in _Mustache_ format. Support for all other formats is experimental and subject to change at any time. Here is a list of template creators: * API Clients: * Ada: @stcarrez * Apex: @asnelling * Bash: @bkryza * C: @PowerOfCreation @zhemant [:heart:](https://www.patreon.com/zhemant) * C++ REST: @Danielku15 * C++ Tiny: @AndersSpringborg @kaareHH @michelealbano @mkakbas * C++ UE4: @Kahncode * C# (.NET 2.0): @who * C# (.NET Standard 1.3 ): @Gronsak * C# (.NET 4.5 refactored): @jimschubert [:heart:](https://www.patreon.com/jimschubert) * C# (GenericHost): @devhl-labs * C# (HttpClient): @Blackclaws * Clojure: @xhh * Crystal: @wing328 * Dart: @yissachar * Dart (refactor): @joernahrens * Dart 2: @swipesight * Dart (Jaguar): @jaumard * Dart (Dio): @josh-burton * Elixir: @niku * Elm: @eriktim * Eiffel: @jvelilla * Erlang: @tsloughter * Erlang (PropEr): @jfacorro @robertoaloi * Groovy: @victorgit * Go: @wing328 [:heart:](https://www.patreon.com/wing328) * Go (rewritten in 2.3.0): @antihax * Haskell (http-client): @jonschoning * Java (Feign): @davidkiss * Java (Retrofit): @0legg * Java (Retrofit2): @emilianobonassi * Java (Jersey2): @xhh * Java (okhttp-gson): @xhh * Java (RestTemplate): @nbruno * Java (Spring 5 WebClient): @daonomic * Java (RESTEasy): @gayathrigs * Java (Vertx): @lopesmcc * Java (Google APIs Client Library): @charlescapps * Java (Rest-assured): @viclovsky * Java (Java 11 Native HTTP client): @bbdouglas * Java (Apache HttpClient): @harrywhite4 * Java (Helidon): @spericas @tjquinno @tvallin * Javascript/NodeJS: @jfiala * JavaScript (Apollo DataSource): @erithmetic * JavaScript (Closure-annotated Angular) @achew22 * JavaScript (Flow types) @jaypea * Jetbrains HTTP Client : @jlengrand * JMeter: @davidkiss * Julia: @tanmaykm * Kotlin: @jimschubert [:heart:](https://www.patreon.com/jimschubert) * Kotlin (MultiPlatform): @andrewemery * Kotlin (Volley): @alisters * Lua: @daurnimator * Nim: @hokamoto * OCaml: @cgensoul * Perl: @wing328 [:heart:](https://www.patreon.com/wing328) * PHP (Guzzle): @baartosz * PHP (with Data Transfer): @Articus * PowerShell: @beatcracker * PowerShell (refactored in 5.0.0): @wing328 * Python: @spacether [:heart:][spacether sponsorship] * Python-Experimental: @spacether [:heart:][spacether sponsorship] * R: @ramnov * Ruby (Faraday): @meganemura @dkliban * Rust: @farcaller * Rust (rust-server): @metaswitch * Scala (scalaz & http4s): @tbrown1979 * Scala (Akka): @cchafer * Scala (sttp): @chameleon82 * Swift: @tkqubo * Swift 3: @hexelon * Swift 4: @ehyche * Swift 5: @4brunu * TypeScript (Angular1): @mhardorf * TypeScript (Angular2): @roni-frantchi * TypeScript (Angular6): @akehir * TypeScript (Angular7): @topce * TypeScript (Axios): @nicokoenig * TypeScript (Fetch): @leonyu * TypeScript (Inversify): @gualtierim * TypeScript (jQuery): @bherila * TypeScript (Nestjs): @vfrank66 * TypeScript (Node): @mhardorf * TypeScript (Rxjs): @denyo * TypeScript (redux-query): @petejohansonxo * Server Stubs * Ada: @stcarrez * C# ASP.NET 5: @jimschubert [:heart:](https://www.patreon.com/jimschubert) * C# ASP.NET Core 3.0: @A-Joshi * C# APS.NET Core 3.1: @phatcher * C# Azure functions: @Abrhm7786 * C# NancyFX: @mstefaniuk * C++ (Qt5 QHttpEngine): @etherealjoy * C++ Pistache: @sebymiano * C++ Restbed: @stkrwork * Erlang Server: @galaxie * F# (Giraffe) Server: @nmfisher * Go Server: @guohuang * Go (Echo) Server: @ph4r5h4d * Go (Gin) Server: @kemokemo * GraphQL Express Server: @renepardon * Haskell Servant: @algas * Haskell Yesod: @yotsuya * Java Camel: @carnevalegiacomo * Java MSF4J: @sanjeewa-malalgoda * Java Spring Boot: @diyfr * Java Undertow: @stevehu * Java Play Framework: @JFCote * Java PKMST: @anshu2185 @sanshuman @rkumar-pk @ninodpillai * Java Vert.x: @lwlee2608 * Java Micronaut: @andriy-dmytruk * Java Helidon: @spericas @tjquinno @tvallin * JAX-RS RestEasy: @chameleon82 * JAX-RS CXF: @hiveship * JAX-RS CXF (CDI): @nickcmaynard * JAX-RS RestEasy (JBoss EAP): @jfiala * Julia: @tanmaykm * Kotlin: @jimschubert [:heart:](https://www.patreon.com/jimschubert) * Kotlin (Spring Boot): @dr4ke616 * Kotlin (Vertx): @Wooyme * Kotlin (JAX-RS): @anttileppa * NodeJS Express: @YishTish * PHP Laravel: @renepardon * PHP Lumen: @abcsun * PHP Mezzio (with Path Handler): @Articus * PHP Slim: @jfastnacht * PHP Slim4: [@ybelenko](https://github.com/ybelenko) * PHP Symfony: @ksm2 * PHP Symfony6: @BenjaminHae * Python FastAPI: @krjakbrjak * Python AIOHTTP: * Ruby on Rails 5: @zlx * Rust (rust-server): @metaswitch * Scala Akka: @Bouillie * Scala Finch: @jimschubert [:heart:](https://www.patreon.com/jimschubert) * Scala Lagom: @gmkumar2005 * Scala Play: @adigerber * Documentation * AsciiDoc: @man-at-home * HTML Doc 2: @jhitchcock * Confluence Wiki: @jhitchcock * PlantUML: @pburls * Configuration * Apache2: @stkrwork * k6: @mostafa * Schema * Avro: @sgadouar * GraphQL: @wing328 [:heart:](https://www.patreon.com/wing328) * Ktorm: @Luiz-Monad * MySQL: [@ybelenko](https://github.com/ybelenko) * Protocol Buffer: @wing328 * WSDL @adessoDpd :heart: = Link to support the contributor directly #### How to join the core team Here are the requirements to become a core team member: - rank within top 50 in https://github.com/openapitools/openapi-generator/graphs/contributors - to contribute, here are some good [starting points](https://github.com/openapitools/openapi-generator/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) - regular contributions to the project - about 3 hours per week - for contribution, it can be addressing issues, reviewing PRs submitted by others, submitting PR to fix bugs or make enhancements, etc - must be active in the past 3 months at the time of application To join the core team, please reach out to [email protected] for more information. To become a Template Creator, simply submit a PR for new API client (e.g. Rust, Elixir) or server stub (e.g. Ruby Grape) generator. ### [6.2 - OpenAPI Generator Technical Committee](#table-of-contents) Members of the OpenAPI Generator technical committee shoulder the following responsibilities: - Provides guidance and direction to other users - Reviews pull requests and issues - Improves the generator by making enhancements, fixing bugs or updating documentations - Sets the technical direction of the generator Who is eligible? Those who want to join must have at least 3 PRs merged into a generator. (Exceptions can be granted to template creators or contributors who have made a lot of code changes with less than 3 merged PRs) If you want to join the committee, please kindly apply by sending an email to [email protected] with your Github ID. #### Members of Technical Committee | Languages/Generators | Member (join date) | |:----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ActionScript | | | Ada | @stcarrez (2018/02) @michelealbano (2018/02) | | Android | @jaz-ah (2017/09) | | Apex | | | Bash | @frol (2017/07) @bkryza (2017/08) @kenjones-cisco (2017/09) | | C | @zhemant (2018/11) @ityuhui (2019/12) @michelealbano (2020/03) | | C++ | @ravinikam (2017/07) @stkrwork (2017/07) @etherealjoy (2018/02) @martindelille (2018/03) @muttleyxd (2019/08) | | C# | @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05) | | Clojure | | | Crystal | @cyangle (2021/01) | | Dart | @jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08) | | Eiffel | @jvelilla (2017/09) | | Elixir | @mrmstn (2018/12) | | Elm | @eriktim (2018/09) | | Erlang | @tsloughter (2017/11) @jfacorro (2018/10) @robertoaloi (2018/10) | | F# | @nmfisher (2019/05) | | Go | @antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04) | | GraphQL | @renepardon (2018/12) | | Groovy | | | Haskell | | | Java | @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) | | Java Spring | @cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) | | JMeter | @kannkyo (2021/01) | | Jetbrains HTTP Client | @jlengrand (2023/01) | | Julia | @tanmaykm (2023/01) | | Kotlin | @jimschubert (2017/09) [:heart:](https://www.patreon.com/jimschubert), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) | | Lua | @daurnimator (2017/08) | | Nim | | | NodeJS/Javascript | @CodeNinjai (2017/07) @frol (2017/07) @cliffano (2017/07) | | ObjC | | | OCaml | @cgensoul (2019/08) | | Perl | @wing328 (2017/07) [:heart:](https://www.patreon.com/wing328) @yue9944882 (2019/06) | | PHP | @jebentier (2017/07), @dkarlovi (2017/07), @mandrean (2017/08), @jfastnacht (2017/09), [@ybelenko](https://github.com/ybelenko) (2018/07), @renepardon (2018/12) | | PowerShell | @wing328 (2020/05) | | Python | @spacether (2019/11) [:heart:][spacether sponsorship] @krjakbrjak (2023/02) | | R | @Ramanth (2019/07) @saigiridhar21 (2019/07) | | Ruby | @cliffano (2017/07) @zlx (2017/09) @autopp (2019/02) | | Rust | @frol (2017/07) @farcaller (2017/08) @richardwhiuk (2019/07) @paladinzh (2020/05) @jacob-pro (2022/10) | | Scala | @clasnake (2017/07), @jimschubert (2017/09) [:heart:](https://www.patreon.com/jimschubert), @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04) | | Swift | @jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @4brunu (2019/11) | | TypeScript | @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) | Past Members of Technical Committee: | Languages/Generators | Member (join date) | | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Python | @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @arun-nalla (2019/11) | :heart: = Link to support the contributor directly ### [6.3 - History of OpenAPI Generator](#table-of-contents) OpenAPI Generator is a fork of [Swagger Codegen](https://github.com/swagger-api/swagger-codegen). In view of the issues with the Swagger Codegen 3.0.0 (beta) release and the disagreement on the project's direction, more than 40 top contributors and template creators of Swagger Codegen decided to fork Swagger Codegen and maintain a community-driven version called "OpenAPI Generator". Please refer to the [Q&A](docs/qna.md) for more information. #### Founding Members (alphabetical order): - [Akihito Nakano](https://github.com/ackintosh) - [Artem Ocheredko](https://github.com/galaxie) - [Arthur Mogliev](https://github.com/Articus) - [Bartek Kryza](https://github.com/bkryza) - [Ben Wells](https://github.com/bvwells) - [Benjamin Gill](https://github.com/bjgill) - [Christophe Bornet](https://github.com/cbornet) - [Cliffano Subagio](https://github.com/cliffano) - [Daiki Matsudate](https://github.com/d-date) - [Daniel](https://github.com/Danielku15) - [Emiliano Bonassi](https://github.com/emilianobonassi) - [Erik Timmers](https://github.com/eriktim) - [Esteban Gehring](https://github.com/macjohnny) - [Gustavo Paz](https://github.com/gustavoapaz) - [Javier Velilla](https://github.com/jvelilla) - [Jean-François Côté](https://github.com/JFCote) - [Jim Schubert](https://github.com/jimschubert) - [Jon Schoning](https://github.com/jonschoning) - [Jérémie Bresson](https://github.com/jmini) [:heart:](https://www.patreon.com/jmini) - [Jörn Ahrens](https://github.com/jayearn) - [Keni Steward](https://github.com/kenisteward) - [Marcin Stefaniuk](https://github.com/mstefaniuk) - [Martin Delille](https://github.com/MartinDelille) - [Masahiro Yamauchi](https://github.com/algas) - [Michele Albano](https://github.com/michelealbano) - [Ramzi Maalej](https://github.com/ramzimaalej) - [Ravindra Nikam](https://github.com/ravinikam) - [Ricardo Cardona](https://github.com/ricardona) - [Sebastian Haas](https://github.com/sebastianhaas) - [Sebastian Mandrean](https://github.com/mandrean) - [Sreenidhi Sreesha](https://github.com/sreeshas) - [Stefan Krismann](https://github.com/stkrwork) - [Stephane Carrez](https://github.com/stcarrez) - [Takuro Wada](https://github.com/taxpon) - [Tomasz Prus](https://github.com/tomplus) - [Tristan Sloughter](https://github.com/tsloughter) - [Victor Orlovsky](https://github.com/viclovsky) - [Victor Trakhtenberg](https://github.com/victorgit) - [Vlad Frolov](https://github.com/frol) - [Vladimir Pouzanov](https://github.com/farcaller) - [William Cheng](https://github.com/wing328) - [Xin Meng](https://github.com/xmeng1) [:heart:](https://www.patreon.com/user/overview?u=16435385) - [Xu Hui Hui](https://github.com/xhh) - [antihax](https://github.com/antihax) - [beatcracker](https://github.com/beatcracker) - [daurnimator](https:/github.com/daurnimator) - [etherealjoy](https://github.com/etherealjoy) - [jfiala](https://github.com/jfiala) - [lukoyanov](https://github.com/lukoyanov) :heart: = Link to support the contributor directly ## [7 - License](#table-of-contents) ------- Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech) Copyright 2018 SmartBear Software Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0) Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ---

💡 Build AI-powered semantic search applications

<p align="center"> <img src="https://raw.githubusercontent.com/neuml/txtai/master/logo.png"/> </p> <h3 align="center"> <p>Build AI-powered semantic search applications</p> </h3> <p align="center"> <a href="https://github.com/neuml/txtai/releases"> <img src="https://img.shields.io/github/release/neuml/txtai.svg?style=flat&color=success" alt="Version"/> </a> <a href="https://github.com/neuml/txtai"> <img src="https://img.shields.io/github/last-commit/neuml/txtai.svg?style=flat&color=blue" alt="GitHub last commit"/> </a> <a href="https://github.com/neuml/txtai/issues"> <img src="https://img.shields.io/github/issues/neuml/txtai.svg?style=flat&color=success" alt="GitHub issues"/> </a> <a href="https://join.slack.com/t/txtai/shared_invite/zt-1cagya4yf-DQeuZbd~aMwH5pckBU4vPg"> <img src="https://img.shields.io/badge/slack-join-blue?style=flat&logo=slack&logocolor=white" alt="Join Slack"/> </a> <a href="https://github.com/neuml/txtai/actions?query=workflow%3Abuild"> <img src="https://github.com/neuml/txtai/workflows/build/badge.svg" alt="Build Status"/> </a> <a href="https://coveralls.io/github/neuml/txtai?branch=master"> <img src="https://img.shields.io/coverallsCoverage/github/neuml/txtai" alt="Coverage Status"> </a> </p> ------------------------------------------------------------------------------------------------------------------------------------------------------- txtai executes machine-learning workflows to transform data and build AI-powered semantic search applications.  Traditional search systems use keywords to find data. Semantic search applications have an understanding of natural language and identify results that have the same meaning, not necessarily the same keywords.   Backed by state-of-the-art machine learning models, data is transformed into vector representations for search (also known as embeddings). Innovation is happening at a rapid pace, models can understand concepts in documents, audio, images and video. Summary of txtai features: - 🔎 Large-scale similarity search with multiple index backends ([Faiss](https://github.com/facebookresearch/faiss), [Annoy](https://github.com/spotify/annoy), [Hnswlib](https://github.com/nmslib/hnswlib)) and support for external vector databases - 📄 Create embeddings for text snippets, documents, audio, images and video - 💡 Machine-learning pipelines that run question-answering, labeling, transcription, translation, summarization, LLM prompts and more - ↪️️ Workflows to join pipelines together and aggregate business logic. txtai processes can be microservices or full-fledged indexing workflows. - ⚙️ Build with Python or YAML. API bindings available for [JavaScript](https://github.com/neuml/txtai.js), [Java](https://github.com/neuml/txtai.java), [Rust](https://github.com/neuml/txtai.rs) and [Go](https://github.com/neuml/txtai.go). - ☁️ Cloud-native architecture that scales out with container orchestration systems (e.g. Kubernetes) Applications range from similarity search to NLP-driven data extractions that generate structured data. Semantic workflows transform and find data driven by user intent.   The following applications are powered by txtai.  | Application | Description | |:----------|:-------------| | [paperai](https://github.com/neuml/paperai) | Semantic search and workflows for medical/scientific papers | | [codequestion](https://github.com/neuml/codequestion) | Semantic search for developers | | [tldrstory](https://github.com/neuml/tldrstory) | Semantic search for headlines and story text | | [neuspo](https://neuspo.com) | Fact-driven, real-time sports event and news site | txtai is built with Python 3.7+, [Hugging Face Transformers](https://github.com/huggingface/transformers), [Sentence Transformers](https://github.com/UKPLab/sentence-transformers) and [FastAPI](https://github.com/tiangolo/fastapi) ## Why txtai?   In addition to traditional search systems, a growing number of semantic search solutions are available, so why txtai? - Up and running in minutes with [pip](https://neuml.github.io/txtai/install/) or [Docker](https://neuml.github.io/txtai/cloud/) ```python # Get started in a couple lines from txtai.embeddings import Embeddings embeddings = Embeddings({"path": "sentence-transformers/all-MiniLM-L6-v2"}) embeddings.index([(0, "Correct", None), (1, "Not what we hoped", None)]) embeddings.search("positive", 1) #[(0, 0.2986203730106354)] ``` - Build applications in your programming language of choice via the API ```yaml # app.yml embeddings: path: sentence-transformers/all-MiniLM-L6-v2 ``` ```bash CONFIG=app.yml uvicorn "txtai.api:app" curl -X GET "http://localhost:8000/search?query=positive" ``` - Connect machine learning models together to build intelligent data processing workflows - Works with both small and big data - scale when needed - Supports micromodels all the way up to large language models (LLMs) - Low footprint - install additional dependencies when you need them - [Learn by example](#examples) - notebooks cover all available functionality ## Installation   The easiest way to install is via pip and PyPI ``` pip install txtai ``` Python 3.7+ is supported. Using a Python [virtual environment](https://docs.python.org/3/library/venv.html) is recommended. See the detailed [install instructions](https://neuml.github.io/txtai/install) for more information covering [optional dependencies](https://neuml.github.io/txtai/install/#optional-dependencies), [environment specific prerequisites](https://neuml.github.io/txtai/install/#environment-specific-prerequisites), [installing from source](https://neuml.github.io/txtai/install/#install-from-source), [conda support](https://neuml.github.io/txtai/install/#conda) and how to [run with containers](https://neuml.github.io/txtai/cloud). ## Examples   The examples directory has a series of notebooks and applications giving an overview of txtai. See the sections below. ### Semantic Search Build semantic/similarity/vector/neural search applications. | Notebook | Description | | |:----------|:-------------|------:| | [Introducing txtai](https://github.com/neuml/txtai/blob/master/examples/01_Introducing_txtai.ipynb) [▶️](https://www.youtube.com/watch?v=SIezMnVdmMs) | Overview of the functionality provided by txtai | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/01_Introducing_txtai.ipynb) | | [Build an Embeddings index with Hugging Face Datasets](https://github.com/neuml/txtai/blob/master/examples/02_Build_an_Embeddings_index_with_Hugging_Face_Datasets.ipynb) | Index and search Hugging Face Datasets | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/02_Build_an_Embeddings_index_with_Hugging_Face_Datasets.ipynb) | | [Build an Embeddings index from a data source](https://github.com/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source.ipynb) | Index and search a data source with word embeddings | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/03_Build_an_Embeddings_index_from_a_data_source.ipynb) | | [Add semantic search to Elasticsearch](https://github.com/neuml/txtai/blob/master/examples/04_Add_semantic_search_to_Elasticsearch.ipynb) | Add semantic search to existing search systems | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/04_Add_semantic_search_to_Elasticsearch.ipynb) | | [Similarity search with images](https://github.com/neuml/txtai/blob/master/examples/13_Similarity_search_with_images.ipynb) | Embed images and text into the same space for search | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/13_Similarity_search_with_images.ipynb) | | [Distributed embeddings cluster](https://github.com/neuml/txtai/blob/master/examples/15_Distributed_embeddings_cluster.ipynb) | Distribute an embeddings index across multiple data nodes | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/15_Distributed_embeddings_cluster.ipynb) | | [What's new in txtai 4.0](https://github.com/neuml/txtai/blob/master/examples/24_Whats_new_in_txtai_4_0.ipynb) | Content storage, SQL, object storage, reindex and compressed indexes | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/24_Whats_new_in_txtai_4_0.ipynb) | | [Anatomy of a txtai index](https://github.com/neuml/txtai/blob/master/examples/29_Anatomy_of_a_txtai_index.ipynb) | Deep dive into the file formats behind a txtai embeddings index | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/29_Anatomy_of_a_txtai_index.ipynb) | | [Custom Embeddings SQL functions](https://github.com/neuml/txtai/blob/master/examples/30_Embeddings_SQL_custom_functions.ipynb) | Add user-defined functions to Embeddings SQL | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/30_Embeddings_SQL_custom_functions.ipynb) | | [Model explainability](https://github.com/neuml/txtai/blob/master/examples/32_Model_explainability.ipynb) | Explainability for semantic search | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/32_Model_explainability.ipynb) | | [Query translation](https://github.com/neuml/txtai/blob/master/examples/33_Query_translation.ipynb) | Domain-specific natural language queries with query translation | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/33_Query_translation.ipynb) | | [Build a QA database](https://github.com/neuml/txtai/blob/master/examples/34_Build_a_QA_database.ipynb) | Question matching with semantic search | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/34_Build_a_QA_database.ipynb) | | [Embeddings components](https://github.com/neuml/txtai/blob/master/examples/37_Embeddings_index_components.ipynb) | Composable search with vector, SQL and scoring components | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/37_Embeddings_index_components.ipynb) | | [Semantic Graphs](https://github.com/neuml/txtai/blob/master/examples/38_Introducing_the_Semantic_Graph.ipynb) | Explore topics, data connectivity and run network analysis| [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/38_Introducing_the_Semantic_Graph.ipynb) | | [Topic Modeling with BM25](https://github.com/neuml/txtai/blob/master/examples/39_Classic_Topic_Modeling_with_BM25.ipynb) | Topic modeling backed by a BM25 index | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/39_Classic_Topic_Modeling_with_BM25.ipynb) | | [Prompt-driven search with LLMs](https://github.com/neuml/txtai/blob/master/examples/42_Prompt_driven_search_with_LLMs.ipynb) | Embeddings-guided and Prompt-driven search with Large Language Models (LLMs) | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/42_Prompt_driven_search_with_LLMs.ipynb) | ### Pipelines Transform data with NLP-backed pipelines. | Notebook | Description | | |:----------|:-------------|------:| | [Extractive QA with txtai](https://github.com/neuml/txtai/blob/master/examples/05_Extractive_QA_with_txtai.ipynb) | Introduction to extractive question-answering with txtai | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/05_Extractive_QA_with_txtai.ipynb) | | [Extractive QA with Elasticsearch](https://github.com/neuml/txtai/blob/master/examples/06_Extractive_QA_with_Elasticsearch.ipynb) | Run extractive question-answering queries with Elasticsearch | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/06_Extractive_QA_with_Elasticsearch.ipynb) | | [Extractive QA to build structured data](https://github.com/neuml/txtai/blob/master/examples/20_Extractive_QA_to_build_structured_data.ipynb) | Build structured datasets using extractive question-answering | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/20_Extractive_QA_to_build_structured_data.ipynb) | | [Apply labels with zero shot classification](https://github.com/neuml/txtai/blob/master/examples/07_Apply_labels_with_zero_shot_classification.ipynb) | Use zero shot learning for labeling, classification and topic modeling | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/07_Apply_labels_with_zero_shot_classification.ipynb) | | [Building abstractive text summaries](https://github.com/neuml/txtai/blob/master/examples/09_Building_abstractive_text_summaries.ipynb) | Run abstractive text summarization | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/09_Building_abstractive_text_summaries.ipynb) | | [Extract text from documents](https://github.com/neuml/txtai/blob/master/examples/10_Extract_text_from_documents.ipynb) | Extract text from PDF, Office, HTML and more | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/10_Extract_text_from_documents.ipynb) | | [Text to speech generation](https://github.com/neuml/txtai/blob/master/examples/40_Text_to_Speech_Generation.ipynb) | Generate speech from text | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/40_Text_to_Speech_Generation.ipynb) | | [Transcribe audio to text](https://github.com/neuml/txtai/blob/master/examples/11_Transcribe_audio_to_text.ipynb) | Convert audio files to text | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/11_Transcribe_audio_to_text.ipynb) | | [Translate text between languages](https://github.com/neuml/txtai/blob/master/examples/12_Translate_text_between_languages.ipynb) | Streamline machine translation and language detection | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/12_Translate_text_between_languages.ipynb) | | [Generate image captions and detect objects](https://github.com/neuml/txtai/blob/master/examples/25_Generate_image_captions_and_detect_objects.ipynb) | Captions and object detection for images | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/25_Generate_image_captions_and_detect_objects.ipynb) | | [Near duplicate image detection](https://github.com/neuml/txtai/blob/master/examples/31_Near_duplicate_image_detection.ipynb) | Identify duplicate and near-duplicate images | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/31_Near_duplicate_image_detection.ipynb) | | [API Gallery](https://github.com/neuml/txtai/blob/master/examples/08_API_Gallery.ipynb) | Using txtai in JavaScript, Java, Rust and Go | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/08_API_Gallery.ipynb) | ### Workflows Efficiently process data at scale. | Notebook | Description | | |:----------|:-------------|------:| | [Run pipeline workflows](https://github.com/neuml/txtai/blob/master/examples/14_Run_pipeline_workflows.ipynb) [▶️](https://www.youtube.com/watch?v=UBMPDCn1gEU) | Simple yet powerful constructs to efficiently process data | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/14_Run_pipeline_workflows.ipynb) | | [Transform tabular data with composable workflows](https://github.com/neuml/txtai/blob/master/examples/22_Transform_tabular_data_with_composable_workflows.ipynb) | Transform, index and search tabular data | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/22_Transform_tabular_data_with_composable_workflows.ipynb) | | [Tensor workflows](https://github.com/neuml/txtai/blob/master/examples/23_Tensor_workflows.ipynb) | Performant processing of large tensor arrays | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/23_Tensor_workflows.ipynb) | | [Entity extraction workflows](https://github.com/neuml/txtai/blob/master/examples/26_Entity_extraction_workflows.ipynb) | Identify entity/label combinations | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/26_Entity_extraction_workflows.ipynb) | | [Workflow Scheduling](https://github.com/neuml/txtai/blob/master/examples/27_Workflow_scheduling.ipynb) | Schedule workflows with cron expressions | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/27_Workflow_scheduling.ipynb) | | [Push notifications with workflows](https://github.com/neuml/txtai/blob/master/examples/28_Push_notifications_with_workflows.ipynb) | Generate and push notifications with workflows | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/28_Push_notifications_with_workflows.ipynb) | | [Pictures are a worth a thousand words](https://github.com/neuml/txtai/blob/master/examples/35_Pictures_are_worth_a_thousand_words.ipynb) | Generate webpage summary images with DALL-E mini | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/35_Pictures_are_worth_a_thousand_words.ipynb) | | [Run txtai with native code](https://github.com/neuml/txtai/blob/master/examples/36_Run_txtai_in_native_code.ipynb) | Execute workflows in native code with the Python C API | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/36_Run_txtai_in_native_code.ipynb) | ### Model Training Train NLP models. | Notebook | Description | | |:----------|:-------------|------:| | [Train a text labeler](https://github.com/neuml/txtai/blob/master/examples/16_Train_a_text_labeler.ipynb) | Build text sequence classification models | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/16_Train_a_text_labeler.ipynb) | | [Train without labels](https://github.com/neuml/txtai/blob/master/examples/17_Train_without_labels.ipynb) | Use zero-shot classifiers to train new models | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/17_Train_without_labels.ipynb) | | [Train a QA model](https://github.com/neuml/txtai/blob/master/examples/19_Train_a_QA_model.ipynb) | Build and fine-tune question-answering models | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/19_Train_a_QA_model.ipynb) | | [Train a language model from scratch](https://github.com/neuml/txtai/blob/master/examples/41_Train_a_language_model_from_scratch.ipynb) | Build new language models | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/41_Train_a_language_model_from_scratch.ipynb) | | [Export and run models with ONNX](https://github.com/neuml/txtai/blob/master/examples/18_Export_and_run_models_with_ONNX.ipynb) | Export models with ONNX, run natively in JavaScript, Java and Rust | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/18_Export_and_run_models_with_ONNX.ipynb) | | [Export and run other machine learning models](https://github.com/neuml/txtai/blob/master/examples/21_Export_and_run_other_machine_learning_models.ipynb) | Export and run models from scikit-learn, PyTorch and more | [](https://colab.research.google.com/github/neuml/txtai/blob/master/examples/21_Export_and_run_other_machine_learning_models.ipynb) | ### Applications Series of example applications with txtai. Links to hosted versions on [Hugging Face Spaces](https://hf.co/spaces) also provided. | Application | Description | | |:-------------|:-------------|------:| | [Basic similarity search](https://github.com/neuml/txtai/blob/master/examples/similarity.py) | Basic similarity search example. Data from the original txtai demo. |[🤗](https://hf.co/spaces/NeuML/similarity)| | [Book search](https://github.com/neuml/txtai/blob/master/examples/books.py) | Book similarity search application. Index book descriptions and query using natural language statements. |*Local run only*| | [Image search](https://github.com/neuml/txtai/blob/master/examples/images.py) | Image similarity search application. Index a directory of images and run searches to identify images similar to the input query. |[🤗](https://hf.co/spaces/NeuML/imagesearch)| | [Summarize an article](https://github.com/neuml/txtai/blob/master/examples/article.py) | Summarize an article. Workflow that extracts text from a webpage and builds a summary. |[🤗](https://hf.co/spaces/NeuML/articlesummary)| | [Wiki search](https://github.com/neuml/txtai/blob/master/examples/wiki.py) | Wikipedia search application. Queries Wikipedia API and summarizes the top result. |[🤗](https://hf.co/spaces/NeuML/wikisummary)| | [Workflow builder](https://github.com/neuml/txtai/blob/master/examples/workflows.py) | Build and execute txtai workflows. Connect summarization, text extraction, transcription, translation and similarity search pipelines together to run unified workflows. |[🤗](https://hf.co/spaces/NeuML/txtai)| ### Documentation [Full documentation on txtai](https://neuml.github.io/txtai) including configuration settings for pipelines, workflows, indexing and the API. ### Further Reading  - [Introducing txtai, AI-powered semantic search built on Transformers](https://medium.com/neuml/introducing-txtai-an-ai-powered-search-engine-built-on-transformers-37674be252ec) - [Tutorial series on Hashnode](https://neuml.hashnode.dev/series/txtai-tutorial) | [dev.to](https://dev.to/neuml/tutorial-series-on-txtai-ibg) - [What's new in txtai 5.0](https://medium.com/neuml/whats-new-in-txtai-5-0-e5c75a13b101) | [4.0](https://medium.com/neuml/whats-new-in-txtai-4-0-bbc3a65c3d1c) - [Getting started with semantic search](https://medium.com/neuml/getting-started-with-semantic-search-a9fd9d8a48cf) | [workflows](https://medium.com/neuml/getting-started-with-semantic-workflows-2fefda6165d9) - [Run machine-learning workflows to transform data and build AI-powered semantic search applications with txtai](https://medium.com/neuml/run-machine-learning-workflows-to-transform-data-and-build-ai-powered-text-indices-with-txtai-43d769b566a7) - [Semantic search on the cheap](https://medium.com/neuml/semantic-search-on-the-cheap-55940c0fcdab) - [Serverless vector search with txtai](https://medium.com/neuml/serverless-vector-search-with-txtai-96f6163ab972) - [Insights from the txtai console](https://medium.com/neuml/insights-from-the-txtai-console-d307c28e149e) - [The big and small of txtai](https://medium.com/neuml/the-big-and-small-of-txtai-4ca405c1b82) ### Contributing For those who would like to contribute to txtai, please see [this guide](https://github.com/neuml/.github/blob/master/CONTRIBUTING.md).

Serverless API Gateway for GraphQL, REST, gRPC, Kafka and more with a focus on API Composition & Integration.

<div align="center"> [](https://github.com/wundergraph/wundergraph/blob/main/CONTRIBUTING.md) [](https://github.com/wundergraph/wundergraph/blob/main/LICENSE) [](https://form.typeform.com/to/fuRWxErj?typeform-embed-id=8749569972809419&typeform-embed=popup-blank&typeform-source=wundergraph.com&typeform-medium=embed-sdk&typeform-medium-version=next) [Quickstart](https://docs.wundergraph.com/getting-started) <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> [Website](https://wundergraph.com/) <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> [Docs](https://docs.wundergraph.com/docs) <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> [Examples](https://docs.wundergraph.com/docs/examples) <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> [Blog](https://wundergraph.com/blog) [<img height="auto" src="./assets/logo2.png">](https://wundergraph.com/) [](https://discord.com/invite/Jjmc8TC) [](https://twitter.com/wundergraphcom) </div> > **Note**: 🌍 We are working on a serverless version of WunderGraph. If you're interested, please see [here](https://wundergraph.com/pricing). ## What is WunderGraph? WunderGraph is the **Serverless API Developer Platform** with a focus on Developer Experience. At its core, WunderGraph combines the [API Gateway pattern](https://microservices.io/patterns/apigateway.html) with the [Backend for Frontend (BFF)](https://samnewman.io/patterns/architectural/bff/) pattern to create the perfect Developer Experience for working with APIs. Take all your (micro-)services, Databases, File Storages, Identity Providers as well as 3rd party APIs and combine them into your own Firebase-like Developer Toolkit, without getting locked into a specific vendor. Imagine that each of your applications could have its own dedicated BFF, while being able to share common logic across all your applications, that's the WunderGraph Experience. ## Getting started The fastest way to get started with WunderGraph is to open a Gitpod. After bootstrapping the [examples/simple](examples/simple) is started. [](https://gitpod.io/#https://github.com/wundergraph/wundergraph) You can also follow the [**Quickstart (5 min)**](https://wundergraph.com/docs/guides/getting_started/quickstart) if you don't want to use Gitpod. ## Examples: - [Simple Starter](/examples/simple) - [NextJS](/examples/nextjs) - [FaunaDB Starter](/examples/faunadb-nextjs) - [PostgreSQL](/examples/postgres) - [Hook into the request lifecycle](/examples/hooks) - [Add Webhooks e.g. for GitHub, Stripe](./examples/webhooks) - [HTTP & Server-Side Caching](/examples/caching) - [NextJS, PostgreSQL, Prisma](/examples/nextjs-postgres-prisma) - [Apollo Federation](/examples/apollo-federation) - [Subscriptions & Live Queries](./examples/nextjs-postgres-prisma) - [Cross API joins across data-sources](/examples/cross-api-joins) - [Inject a Bearer Token with Auth0](./examples/inject-bearer) - [Migrate from Apollo GraphQL](./examples/migrate-from-apollo) - [Publish & Install APIs](./examples/publish-install-api) - [Dockerize WunderGraph](https://github.com/wundergraph/docker) - [Type-safe Golang Client](/examples/golang-client) - [Type-safe Node.js Client](/examples/nodejs-ts-client) - [OpenAPI and mocking](/examples/openapi-mocking) ## The WunderGraph Stack WunderGraph is made up of the three core components: - [**wunderctl**](packages/wunderctl): A command line tool to create, deploy and manage your WunderGraph application. - [**SDK**](packages/sdk): Auto-generated and type-safe client to configure and interact with your WunderGraph. - [**WunderHub**](https://hub.wundergraph.com/) The Package Manager for APIs that allows you to share and integrate your API's in a few clicks. The auto-generated type-safe client can be used in _any_ Node.js or TypeScript backend application (including serverless applications and microservices). ## Core features - **Unified Graph**: Combine all your data sources into a unified GraphQL Schema. - **JSON-RPC**: Expose GraphQL operations through JSON-RPC. Learn [more](https://wundergraph-landing-git-feat-update-landing-jensneuse.vercel.app/blog/graphql_is_not_meant_to_be_exposed_over_the_internet) about this design choice. - **Type-Safe Clients**: Auto generate custom type-safe API Clients with Authentication / Authorization and file upload support. - **Customizable**: Customizable gateway logic with TypeScript. - **Standards**: Build upon standards like GraphQL, OpenAPI, OAuth2, S3... - **Open Source**: 100% Open Source, No vendor lock-in. - **Community**: First-class support for frameworks like Next.js, React, Svelte... > **Note**: [WunderHub](https://hub.wundergraph.com/) is our vision of the Package Manager for APIs. Like npm, but for APIs. Sign up for free! ## Architecture & Key Differentiators <div align="center"> <img src="./assets/architecture.jpg" height="auto"/> </div> You can learn more about the architecture of WunderGraph and why we’ve built it this way in [the architecture section](docs/architecture.md). ## Learn more about WunderGraph If you'd like to get a quick overview, have a look at these [annotated example snippets](docs/at-a-glance.md). ## How does WunderGraph work This section provides a high-level overview of how WunderGraph works and its most consumer centric components. For a more thorough introduction, visit the [architecture](./docs/architecture) documentation. After initializing your first WunderGraph application with `npx create-wundergraph-app <project-name> -E simple`, you have a NPM package and a `.wundergraph` folder. This folder contains the following files: - `wundergraph.config.ts` - The primary config file for your WunderGraph application. Add data-sources and more. - `wundergraph.operations.ts` - Configure authentication, caching and more for a specific or all operations. - `wundergraph.server.ts` - The hooks server to hook into different lifecycle events of your gateway. After configuring your data-sources, you can start writing operations. An operation is just a `*.graphql` file. The name of the file will be the operation name. You can write queries, mutations and subscriptions that spans multiple data-sources. Each operation will be exposed securely via HTTP JSON-API through the WunderGraph gateway. After writing your operations, you can start deploying your WunderGraph application. ## Contributing Read the [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute to WunderGraph. ## Security We are thankful for any and all security reports. Please read the [SECURITY.md](SECURITY.md) to learn how to report any security concerns to WunderGraph. ## Community & Support - [GitHub Issues](https://github.com/wundergraph/wundergraph/issues). Best for: bugs and errors you encounter using WunderGraph. - [Email Support](mailto:[email protected]). Best for: specific questions around WunderGraph as an early enterprise adopter. - [Slack Support](mailto:[email protected]). Best for: problems with WunderGraph as an enterprise customer. - [Discord](https://discord.gg/Jjmc8TC). Best for: sharing your applications and hanging out with the community. - [Feedback and Feature Requests](https://wundergraph.canny.io/). Best for: discussing and voting on feature requests and giving feedback to our developers. ## Enterprise We're a small but growing team of API Enthusiasts, thrilled to help you get the best Developer Experience of working with APIs. Our Support Plans are tailored to help your teams get the most out of WunderGraph. We love building close relationships with our customers, allowing us to continuously improve the product and iterate fast. Our sales team is available to talk with you about your project needs, pricing information, support plans, and custom-built features. Use this [Link](https://form.typeform.com/to/fuRWxErj?typeform-embed-id=9220606329610526&typeform-embed=popup-blank&typeform-source=wundergraph.com&typeform-medium=embed-sdk&typeform-medium-version=next) to contact our sales team for a demo.

Easy to use open source fast database for search | Good alternative to Elasticsearch now | Drop-in replacement for E in the ELK soon

<p align="center"> <a href="https://manticoresearch.com" target="_blank" rel="noopener"> <img src="https://manticoresearch.com/logo.png" width="50%" alt="Manticore Search Logo"> </a> </p> <h3 align="center"> <a href="https://manticoresearch.com">Website</a> • <a href="https://manticoresearch.com/install/">Downloads</a> • <a href="https://manual.manticoresearch.com">Docs</a> • <a href="https://manticoresearch.com/blog/">Blog</a> • <a href="https://play.manticoresearch.com">Courses</a> • <a href="https://forum.manticoresearch.com">Forum</a> • <a href="https://slack.manticoresearch.com">Slack</a> • <a href="https://t.me/manticoresearch_en">Telegram (En)</a> • <a href="https://t.me/manticore_chat">Telegram (Ru)</a> • <a href="https://twitter.com/manticoresearch">Twitter</a> </h3> <p>&nbsp;</p> # Introduction [](COPYING) [](https://twitter.com/manticoresearch) [](http://slack.manticoresearch.com/) [](https://github.com/manticoresoftware/docker) [](https://eepurl.com/dkUTHv) [](https://github.com/manticoresoftware/manticoresearch/graphs/commit-activity) [](https://github.com/manticoresoftware/manticoresearch/issues?q=is%3Aissue+is%3Aclosed) **❗Read recent [blog post about Manticore vs Elasticsearch](https://manticoresearch.com/blog/manticore-alternative-to-elasticsearch/)❗** Manticore Search is an easy to use open source fast database for search. Good alternative for Elasticsearch. What distinguishes it from other solutions is: * It's very fast and therefore more cost-efficient than alternatives, for example Manticore is: - **182x faster** than MySQL for [small data](https://db-benchmarks.com/test-hn-small/#mysql-vs-manticore-search) ([reproducible](https://github.com/db-benchmarks/db-benchmarks#get-started)❗) - **29x faster** than Elasticsearch for [log analytics](https://db-benchmarks.com/test-logs10m/#elasticsearch-with-no-tuning-vs-manticore-search-default-row-wise-storage) ([reproducible](https://github.com/db-benchmarks/db-benchmarks#get-started)❗) - **15x faster** than Elasticsearch for [small dataset](https://db-benchmarks.com/test-hn-small/#manticore-search-vs-elasticsearch) ([reproducible](https://github.com/db-benchmarks/db-benchmarks#get-started)❗) - **5x faster** than Elasticsearch for [medium-size data](https://db-benchmarks.com/test-hn/#manticore-search-columnar-storage-vs-elasticsearch) ([reproducible](https://github.com/db-benchmarks/db-benchmarks#get-started)❗) - **4x faster** than Elasticsearch for [big data](https://db-benchmarks.com/test-taxi/#manticore-search-vs-elasticsearch) ([reproducible](https://github.com/db-benchmarks/db-benchmarks#get-started)❗) - **up to 2x faster** max throughput than Elasticsearch's for data ingestion on a single server ([reproducible](https://manticoresearch.com/blog/manticore-alternative-to-elasticsearch/#data-ingestion-performance#get-started)❗) * With its modern multithreading architecture and efficient query parallelization capabilities, Manticore is able to fully utilize all your CPU cores to achieve the quickest response times possible. * The powerful and speedy full-text search works seamlessly with both small and large datasets. * Row-wise storage for small, medium and big size datasets. * For even larger datasets, Manticore offers columnar storage support through the [Manticore Columnar Library](https://github.com/manticoresoftware/columnar/), capable of handling datasets too big to fit in RAM. * Performance secondary indexes are automatically created, saving you time and effort. * The cost-based query optimizer optimizes search queries for optimal performance. * Manticore is SQL-first, utilizing SQL as its native syntax, and offers compatibility with the MySQL protocol, allowing you to use your preferred MySQL client. * With clients available in [PHP](https://github.com/manticoresoftware/manticoresearch-php), [Python](https://github.com/manticoresoftware/manticoresearch-python), [JavaScript](https://github.com/manticoresoftware/manticoresearch-javascript), [Java](https://github.com/manticoresoftware/manticoresearch-java), [Elixir](https://github.com/manticoresoftware/manticoresearch-elixir), and [Go](https://github.com/manticoresoftware/go-sdk), integration with Manticore Search becomes easy. * Manticore also provides a programmatic HTTP JSON protocol for more versatile data and schema management. * Built in C++, Manticore Search starts quickly and uses minimal RAM, with low-level optimizations contributing to its impressive performance. * With real-time inserts, newly added documents are immediately accessible. * Interactive courses are available through [Interactive courses](https://play.manticoresearch.com/) to make learning a breeze. * Manticore also boasts built-in replication and load balancing for added reliability. * Data can be synced from sources such as MySQL, PostgreSQL, ODBC, xml, and csv with ease. * While not fully ACID-compliant, Manticore still supports transactions and binlog to ensure safe writes. * Effortless data backup and recovery with built-in tools and SQL commands [Craigslist](https://www.craigslist.org/), [Socialgist](https://socialgist.com/), [PubChem](https://pubchem.ncbi.nlm.nih.gov/), [Rozetka](https://rozetka.com.ua/) and many others use Manticore for efficient searching and stream filtering. Manticore Search was forked from [Sphinx 2.3.2](https://github.com/sphinxsearch/sphinx) in 2017. # More features * Full-text search and relevance: - Over 20 [full-text operators](https://play.manticoresearch.com/fulltextintro/) and over 20 ranking factors - Custom ranking * Other search capabilities: - [Rich filtering functionality](https://manual.manticoresearch.com/Searching/Full_text_matching/Operators) - [Faceted search](https://play.manticoresearch.com/faceting/) - [Geo-spatial search](https://play.manticoresearch.com/geosearch/) - [Spelling correction](https://play.manticoresearch.com/didyoumean/) - [Autocomplete](https://play.manticoresearch.com/simpleautocomplete/) - A wide range of functions for filtering and data manipulation * Natural language processing (NLP): - [Stemming](https://manual.manticoresearch.com/Creating_an_index/NLP_and_tokenization/Morphology) - [Lemmatization](https://manual.manticoresearch.com/Creating_an_index/NLP_and_tokenization/Morphology) - [Stopwords](https://manual.manticoresearch.com/Creating_an_index/NLP_and_tokenization/Ignoring_stop-words#stopwords) - [Synonyms](https://manual.manticoresearch.com/Creating_an_index/NLP_and_tokenization/Exceptions) - [Wordforms](https://manual.manticoresearch.com/Creating_an_index/NLP_and_tokenization/Wordforms#wordforms) - [Advanced tokenization at character and word level](https://manual.manticoresearch.com/Creating_an_index/NLP_and_tokenization/Low-level_tokenization#charset_table) - [Proper Chinese segmentation](https://play.manticoresearch.com/icu-chinese/) - [Text highlighting](https://play.manticoresearch.com/highlighting/) * Stream filtering [using a "percolate" index](https://play.manticoresearch.com/pq/) * High-availability: - Data can be distributed across servers and data-centers - [Synchronous replication](https://play.manticoresearch.com/replication/) - Built-in load balancing * Security: - [https support](https://play.manticoresearch.com/https/) - [read-only mode](https://manual.manticoresearch.com/Security/Read_only) * Data safety: - [manticore-backup tool and SQL command BACKUP](https://manual.manticoresearch.com/Securing_and_compacting_a_table/Backup_and_restore) to back up and restore your data * Data storages: - row-wise - requires more RAM, provides faster performance - columnar - requires less RAM, still provides decent performance, but lower than the row-wise storage for some kinds of queries - docstore - doesn't require RAM at all, but allows only fetching original value, not sorting/grouping/filtering * Performance optimizations: - [Secondary indexes](https://manual.manticoresearch.com/Server_settings/Searchd#secondary_indexes) - Cost-based optimizer determines the most efficient execution plan of a search query * Data types: - full-text field - inverted index - int, bigint and float numeric fields in row-wise and columnar fashion - multi-value attributes (array) - string and JSON - on-disk "[stored](https://play.manticoresearch.com/docstore/)" for key-value purpose * Integrations: - [Sync from MySQL and PostgreSQL](https://manual.manticoresearch.com/Creating_an_index/Local_indexes/Plain_index) - [Sync from XML](https://manual.manticoresearch.com/Adding_data_from_external_storages/Fetching_from_XML_streams#XML-file-format) - [Sync from CSV](https://manual.manticoresearch.com/Adding_data_from_external_storages/Fetching_from_CSV,TSV#Fetching-from-TSV,CSV) - [With MySQL as a storage engine](https://manual.manticoresearch.com/Extensions/SphinxSE#Using-SphinxSE) - [With MySQL via FEDERATED engine](https://manual.manticoresearch.com/Extensions/FEDERATED) - [ProxySQL](https://manticoresearch.com/2018/06/18/using-proxysql-to-route-inserts-in-a-distributed-realtime-index/) - [Manticore Columnar Library](https://github.com/manticoresoftware/columnar) # Installation ### Docker Docker image is available on [Docker Hub](https://dockr.ly/33biV0U). To experiment with Manticore Search in Docker just run: ``` docker run -e EXTRA=1 --name manticore --rm -d manticoresearch/manticore && until docker logs manticore 2>&1 | grep -q "accepting connections"; do sleep 1; done && docker exec -it manticore mysql && docker stop manticore ``` You can then: create an index, add data and run searches. For example: ``` create table movies(title text, year int) morphology='stem_en' html_strip='1' stopwords='en'; insert into movies(title, year) values ('The Seven Samurai', 1954), ('Bonnie and Clyde', 1954), ('Reservoir Dogs', 1992), ('Airplane!', 1980), ('Raging Bull', 1980), ('Groundhog Day', 1993), ('<a href="http://google.com/">Jurassic Park</a>', 1993), ('Ferris Bueller\'s Day Off', 1986); select highlight(), year from movies where match('the dog'); select highlight(), year from movies where match('days') facet year; select * from movies where match('google'); ``` Note that upon exiting the MySQL client, the Manticore container will be stopped and removed, resulting in no saved data, so **use this way only for testing / sandboxing purposes**. Read [the full instruction for the docker image](https://github.com/manticoresoftware/docker) for more details including our recommendations on running it in production. ### Packages ## [Ubuntu, Debian, Centos, Windows and MacOS packages are here](https://manticoresearch.com/install/). ### YUM repo for RHEL/Centos/Amazon Linux ``` sudo yum install https://repo.manticoresearch.com/manticore-repo.noarch.rpm sudo yum install manticore manticore-columnar-lib ``` ### APT repo for Ubuntu/Debian/Mint ``` wget https://repo.manticoresearch.com/manticore-repo.noarch.deb sudo dpkg -i manticore-repo.noarch.deb sudo apt update sudo apt install manticore manticore-columnar-lib ``` ### Homebrew on MacOS ``` brew install manticoresearch ``` ### Windows See [instruction here](https://manual.manticoresearch.com/Installation/Windows). ### MacOS tarball See [instruction here](https://manual.manticoresearch.com/Installation/MacOS#From-tarball-with-binaries). # Documentation and community sites * [Documentation](https://manual.manticoresearch.com) * [Interactive courses](https://play.manticoresearch.com) * [Manticore Community Forum](https://forum.manticoresearch.com/) * [Public Slack chat](http://slack.manticoresearch.com/) * [Public Telegram chat (En)](https://t.me/manticoresearch_en) * [Public Telegram chat (Ru)](https://t.me/manticore_chat) * [Bug tracker](https://github.com/manticoresoftware/manticore/issues) # Third-party integrations * https://dev.tiki.org/Manticore-Search - TikiWiki CMS Groupware integration * https://github.com/EvilFreelancer/laravel-manticoresearch - Laravel ManticoreSearch plugin * https://www.mediawiki.org/wiki/Extension:SphinxSearch - extension for MediaWiki * https://github.com/gordonbanderson/silverstripe-manticore-search - integration for SilverStripe * https://drwho.virtadpt.net/archive/2022-05-13/combining-manticore-and-searx/ - integration for SearX * https://github.com/dimv36/sphinxlink - Extension for PostgreSQL for running search queries and returning data as PostgreSQL tables # How we can support you Should your company require any help - we provide full-cycle services in the areas of Sphinx and Manticore Search: * Audit * Support * Consulting * Development * Training [More details here](https://manticoresearch.com/services/) # ❤️ How you can support Manticore Search Manticore Search is a GPLv2-licensed Open Source project with development made possible by support from our core team, contributors, and sponsors. Building premium Open Source software is not easy. If you would like to make sure Manticore Search stays free, here is how you can help the project: * [Donation through PayPal](https://www.paypal.me/manticoresearch) * [Become our client and let us help you](https://manticoresearch.com/services)

interactive notebooks from Planet Engineering

## Planet Interactive Guides [](https://gitter.im/planetlabs/notebooks?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) In this repository, you'll find a collection of [Jupyter notebooks](http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/what_is_jupyter.html) from the software developers, data scientists, and developer advocates at [Planet](https://www.planet.com/). These interactive, open-source ([APLv2](LICENSE)) guides are designed to help you explore Planet data, work with our APIs and tools, and learn how to extract information from our massive archive of high-cadence satellite imagery. We hope these guides will inspire you to ask interesting questions of Planet data. Need help? Find a bug? Please [file an issue](https://github.com/planetlabs/notebooks/issues/new) and we'll get back to you. ## Install and use these notebooks ### System Prerequisites * [Docker](https://store.docker.com/search?type=edition&offering=community) * [Planet Account](https://www.planet.com/explorer/?signup=1) * [Planet API Key](https://www.planet.com/account/) NOTE: After installing Docker, Windows users should install WSL2 Backend when prompted. ### Clone or update repo: If you've never cloned the Planet notebooks repo, run the following: ```bash git clone https://github.com/planetlabs/notebooks.git cd notebooks ``` If you have previously cloned the Planet notebooks repo in the past, make sure to update to pull any changes locally that might have happened since you last interacted with the Planet notebooks: ```bash cd notebooks git pull ``` ## Authentication ## Access your Planet API Key in Python Authentication with Planet's API Key can be achieved by using a valid Planet API Key. You can export your API Key as an environment variable on your system: ```bash export PL_API_KEY="YOUR-API-KEY" ``` If you wish to have your API Key be persistent (forever stored as ```PL_API_KEY```), then you may enter this ```export``` command in your ```~/.bashrc``` or ```~/.zshrc``` file. If you are using our Docker environment, as is defined below, it will already be set. In Python, we set up an API Key variable, ```PLANET_API_KEY```, from an environment variable to use with our API requests: ```python # Import the os module in order to access environment variables import os # Set up the API Key from the `PL_API_KEY` environment variable PLANET_API_KEY = os.getenv('PL_API_KEY') ``` Now, your Planet API Key is stored in the variable ```PLANET_API_KEY``` and is ready to use in your Python code. ## Run Planet Notebooks in Docker Planet Notebooks rely on a complex stack of technologies that are not always easy to install and properly configure. To ease this complexity we provide a docker container for running the notebook on docker compatible systems. To install docker on your system please see docker's [documentation](https://docs.docker.com/engine/installation/) for your operating system. ### Download prebuilt Docker image (recommended) The Docker image for these notebooks is hosted in the [planetlabs/notebooks](https://hub.docker.com/r/planetlabs/notebooks) repo on DockerHub. To download and prepare the image for use, run: ```bash cd notebooks docker pull planetlabs/notebooks docker tag planetlabs/notebooks planet-notebooks # If you get errors running the above, you might have to add sudo to the beginning: #sudo docker pull planetlabs/notebooks #sudo docker tag planetlabs/notebooks planet-notebooks ``` If you want to re-build the Docker image yourself, this is documented below in the "Appendix: Build the Docker image" section. ### Run the container To run the container (after building or downloading it), add your Planet API key below and issue the following command from the git repository root directory: ```bash docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks # If you get a permissions error running the above, you should add sudo to the front: # sudo docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks # Windows users run: winpty docker run -it --rm -p 8888:8888 -v "/$PWD":/home/joyvan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks ``` This does several things: 1. Maps the docker container's ```8888``` port to your system's ```8888``` port. This makes the container available to your host systems web browser. 1. Maps a host system path ```$PWD``` to the docker container's working directory. This ensures that the notebooks you create, edit, and save are available on your host system under the `jupyter-notebooks` sub-directory and are not *destroyed* when you exit the container. This also allows for running tests in the `tests` sub-directory. 1. Ensures that the directory in the Docker container named `/home/jovyan/work` that has the notebooks in them is accessible to the Jupyter notebook server. 1. Starts an interactive terminal that is accessible through http://localhost:8888. 1. Sets an environment variable with your unique Planet API key for authenticating against the API. 1. Includes the ```--rm``` option to clean up the notebook after you exit the process. ### Open Jupyter notebooks Once the Docker container is running, the CLI output will display a URL that you will use to access Jupyter notebooks with your browser. ``` http://localhost:8888/?token=<UNIQUE-TOKEN> ``` NOTE: This security token will change every time you start your Docker container. ### Available notebooks #### NOTE: PSScene3Band and PSScene4Band item type and assets will be deprecated by January 2023. These item types will not be available for new customers provisioned after March 1, 2022. We recommend all customers who are interested in medium resolution imagery use the [PSScene item type](https://developers.planet.com/docs/data/psscene/) as soon as possible. #### Search, activate, download with the Data API * [Explore the Planet Data API with Python](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/data-api-tutorials/planet_data_api_introduction.ipynb) * [Search, activate, and download imagery with the Planet Python Client](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/data-api-tutorials/planet_cli_introduction.ipynb) * [Search & Download Quickstart Guide](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/data-api-tutorials/search_and_download_quickstart.ipynb) * [Planet Data API reference](https://developers.planet.com/docs/apis/data/) #### Ordering, delivery, and tools with the Orders API * [Ordering and Delivery](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/orders/ordering_and_delivery.ipynb) * [Tools and Toolchains](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/orders/tools_and_toolchains.ipynb) * [Planet Orders API reference](https://developers.planet.com/docs/orders/) ### Process Planet data * [Create a mosaic from multiple PlanetScope scenes](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/mosaicing/basic_compositing_demo.ipynb) * [Calculate a vegetation index from 4-band satellite imagery](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/ndvi/ndvi_planetscope.ipynb) * [Convert PlanetScope metadata from radiance to reflectance](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/toar/toar_planetscope.ipynb) * [Visualize and convert a UDM to a binary mask](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/udm/udm.ipynb) * [Work with the Usable Data Mask (UDM2)](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/udm2) ### Analyze and visualize Planet data * Analytics quickstart: 1. [Summarizing Feeds and Subscriptions](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/quickstart/01_checking_available_feeds_and_subscriptions.ipynb) 2. [Getting Analytic Feed Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/quickstart/02_fetching_feed_results.ipynb) 3. [Visualizing Raster Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/quickstart/03_visualizing_raster_results.ipynb) * Analytics user guide: 1. [Getting Started with Planet Analytics API](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/01_getting_started_with_the_planet_analytics_api.ipynb) 2. [Planet Analytic Feeds Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/02_analytic_feeds_results.ipynb) 3. [Change Detection](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/03_change_detection.ipynb) 4. [Summary Statistics - Buildings](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/04_summary_statistics_buildings.ipynb) 5. [Summary Statistics - Ships and Clouds](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/05_summary_statistics_ships_and_clouds.ipynb) * Other analytics notebooks: * [Detect, count, and visualize ships in Planet imagery](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/ship-detector/01_ship_detector.ipynb) * [Pixel-by-pixel comparison of PlanetScope and Landsat Scenes](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/landsat-ps-comparison/landsat-ps-comparison.ipynb) * [Calculate Coverage for a Search Query](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/coverage/calculate_coverage.ipynb) * [Segment and Classify Crops](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/crop-classification) * [Identify Forest Degradation](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/forest-monitoring) * [Identify the Temporal Signature of Crops](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/temporal-analysis) * [Converting Raster Results to Vector Features](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics-snippets/README.md) * [Creating a Heatmap of Vector Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/change_detection_heatmap.ipynb) * [Introduction to Cloud Native Geospatial Tools](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/cloud-native-geospatial) Soon we hope to add notebooks from the researchers, technologists, geographers, and entrepreneurs who are already using Planet data to ask interesting and innovative questions about our changing Earth. If you're working with our imagery and have a notebook (or just an idea for a notebook) that you'd like to share, please [file an issue](https://github.com/planetlabs/notebooks/issues) and let us know. ### Appendix: Build the Docker image This documents how to build the docker image yourself, rather than using the recommended step of downloading pre-built Docker images. This is useful if you are a developer adding dependencies or a new Jupyter notebook to this repo, for example. First you must build the docker image. Note, this only has to be done the first time you use it. After checking out the repository, you run: ```bash cd planet-notebook-docker docker build --rm -t planet-notebooks . cd .. ``` This will build and install the Docker image on your system, making it available to run. This may take some time (from 10 minutes to an hour) depending on your network connection and how long Anaconda takes to configure its environment.

💻😍Tools, processes and resources you need to create an awesome API with Django REST Framework

<h1 align="center"> <img width="400" src="https://cdn.rawgit.com/sindresorhus/awesome/master/media/logo.svg" alt="Awesome"> </h1> # Awesome Django REST Framework [](https://github.com/sindresorhus/awesome)  > Curated list of tools, processes and resources you need to create an awesome API with Django REST Framework! **Let's make it the biggest resource repository for our community.** *Please read the [contribution guidelines](contributing.md) before contributing.* **Check out my [medium blog](https://medium.com/@nioperas06/) or say *hi* on [Twitter](https://twitter.com/jgantindev).** ## Table of Contents - [Packages](#packages) - [Authentication](#authentication) - [Authorization](#authorization) - [Documentation](#documentation) - [Routing](#routing) - [Serialization](#serialization) - [Visualization](#visualization) - [Logging](#logging) - [Filtering](#filtering) - [Pagination](#pagination) - [Renderers and Parsers](#renderers-and-parsers) - [Other](#other) - [Tutorials](#tutorials) - [Books](#books) - [Talks](#talks) - [Best practices](#bestpractices) - [Common issues](#common-issues) ## Packages ### Authentication * [django-rest-passwordreset](https://github.com/anx-ckreuzberger/django-rest-passwordreset): Password reset endpoints that hook into Django Authentication system * [djoser](https://github.com/sunscrapers/djoser): REST implementation of Django authentication system * [dj-rest-auth](https://github.com/jazzband/dj-rest-auth): A set of REST API endpoints to handle User Registration and Authentication tasks * [django-rest-registration](https://github.com/apragacz/django-rest-registration): User registration and authentication REST API, based on Django REST Framework. * [django-rest-framework-simplejwt](https://github.com/davesque/django-rest-framework-simplejwt): A JSON Web Token authentication plugin for the Django REST Framework * [django-rest-framework-social-oauth2](https://github.com/PhilipGarnero/django-rest-framework-social-oauth2): python-social-auth and oauth2 support for django-rest-framework * [django-oauth-toolkit](https://github.com/jazzband/django-oauth-toolkit): Django OAuth Toolkit can help you providing out of the box all the endpoints, data and logic needed to add OAuth2 capabilities to your Django projects. Django OAuth Toolkit makes extensive use of the excellent OAuthLib, so that everything is rfc-compliant. * [django-rest-durin](https://django-rest-durin.readthedocs.io/en/latest/index.html) provides token auth for multiple Web/CLI/Mobile API clients via one interface but allows different token configuration for each client (For example, permissions and token expiration time can be different per API client). * [djangorest-routes](https://github.com/israelabraham/djangorest-routes): Djangorest Routes is an authentication library strongly built in Python that serves the purpose of quick bootstrapping a project's authentication infrastructure. ### Authorization * [dry-rest-permissions](https://github.com/dbkaplan/dry-rest-permissions): Rules based permissions. * [drf-access-policy](https://github.com/rsinger86/drf-access-policy): Declarative access policies/permissions modeled after AWS' IAM policies. * [djangorestframework-api-key](https://github.com/florimondmanca/djangorestframework-api-key): API key permissions. * [djangorestframework-composed-permissions](https://github.com/niwinz/djangorestframework-composed-permissions): A simple way to define complex permissions. * [rest_condition](https://github.com/caxap/rest_condition): Complex permissions flow. * [django-rest-framework-roles](https://github.com/computer-lab/django-rest-framework-roles): Parameterizes Django REST Framework methods over user-defined roles. * [django-rest-framework-role-filters](https://github.com/allisson/django-rest-framework-role-filters): Simple role filtering. * [drf-psq](https://github.com/drf-psq/drf-psq): The simplest and most general way to manage action-based permissions, serializers, and querysets dependent on permission-based rules. ### Documentation * [drf-yasg](https://github.com/axnsan12/drf-yasg): Alternative OpenAPI Generator for Django REST Framework with response schema support * [drf-spectacular](https://github.com/tfranzel/drf-spectacular): Sane and flexible OpenAPI 3.0 schema generation for Django REST framework * [drf-openapi-tester](https://github.com/snok/drf-openapi-tester): Test drf test responses against OpenAPI/Swagger documentation. ### Routing * [drf-nested-routers](https://github.com/alanjds/drf-nested-routers): Nested Routers for Django Rest Framework ### Serialization * [django-rest-framework-recursive](https://github.com/heywbj/django-rest-framework-recursive/): Recursive Serialization for Django REST framework * [drf-extra-fields](https://github.com/Hipo/drf-extra-fields/): Extra fields for Django REST framework. * [drf-flex-fields](https://github.com/rsinger86/drf-flex-fields): Dynamically set fields and expand nested resources in Django REST Framework serializers. * [drf-writable-nested](https://github.com/beda-software/drf-writable-nested): Writable nested model serializer for Django REST Framework ### Visualization * [django-rest-pandas](https://github.com/wq/django-rest-pandas): Serves up Pandas dataframes via the Django REST Framework for use in client-side (i.e. d3.js) visualizations and offline analysis (e.g. Excel) * [django-rest-framework-gis](https://github.com/djangonauts/django-rest-framework-gis): Geographic add-ons for Django REST Framework * [drf-renderer-xlsx](https://github.com/wharton/drf-renderer-xlsx): Allows you to create XLSX for Django REST Framework ### Logging * [drf-api-tracking](https://github.com/lingster/drf-api-tracking): Provides a Django model and DRF view mixin that work together to log Django Rest Framework requests to the database. * [django-requestlogs](https://github.com/Raekkeri/django-requestlogs): Package providing middleware and other helpers for audit logging. ### Filtering * [django-rest-framework-filters](https://github.com/philipn/django-rest-framework-filters): Better filtering. * [django-rest-framework-word-search-filter](https://github.com/trollknurr/django-rest-framework-word-search-filter): Full word search filter backend for Django REST Framework. DB backend independent. * [django-url-filter](https://github.com/miki725/django-url-filter): Django URL Filter provides a safe way to filter data via human-friendly URLs. * [drf-url-filters](https://github.com/manjitkumar/drf-url-filters): A django app to apply filters on drf querysets using query params with validations using voluptuous. ### Pagination * [drf-proxy-pagination](https://github.com/tuffnatty/drf-proxy-pagination): Pagination class for Django REST Framework to choose pagination class by query parameter * [django-rest-framework-link-header-pagination](https://github.com/tbeadle/django-rest-framework-link-header-pagination): Provide pagination for django-rest-framework using a "Link" HTTP header ### Renderers and Parsers * [django-rest-framework-yaml](https://github.com/jpadilla/django-rest-framework-yaml): YAML support for Django REST Framework. * [django-rest-framework-xml](https://github.com/jpadilla/django-rest-framework-xml): XML support for Django REST Framework. * [django-rest-framework-jsonp](https://github.com/jpadilla/django-rest-framework-jsonp): JSONP support for Django REST Framework. * [drf-excel](https://github.com/wharton/drf-excel): An XLSX spreadsheet renderer for Django REST Framework. * [django-rest-framework-csv](https://github.com/mjumbewu/django-rest-framework-csv): CSV Tools for Django REST Framework. * [drf-ujson-renderer](https://github.com/gizmag/drf-ujson-renderer): Django Rest Framework renderer using ujson. * [djangorestframework-camel-case](https://github.com/vbabiy/djangorestframework-camel-case): Camel case JSON support for Django REST framework. * [django-rest-pandas](https://github.com/wq/django-rest-pandas): Serves up Pandas dataframes via the Django REST Framework for use in client-side (i.e. d3.js) visualizations and offline analysis (e.g. Excel). * [rest-framework-latex](https://github.com/mypebble/rest-framework-latex): A LaTeX renderer for Django REST Framework. ### Other * [django-rest-localflavor](https://github.com/gilsondev/django-rest-localflavor/): Country-specific Django helpers, to use in Django Rest Framework * [django-rest-framework-json-api](https://github.com/django-json-api/django-rest-framework-json-api): Implements most of the JSON API 1.0 spec. * [drf-extensions](https://github.com/chibisov/drf-extensions): DRF-extensions is a collection of custom extensions for Django REST Framework * [drf-generators](https://github.com/Brobin/drf-generators): Generate Views, Serializers, and Urls for your Django Rest Framework application. * [django-restql](https://github.com/yezyilomo/django-restql): Turn your API made with Django REST Framework(DRF) into a GraphQL like API. * [django-rest-tsg](https://github.com/jinkanhq/django-rest-tsg): A TypeScript code generator for DRF serializers, enums and dataclasses. * [django-rest-cli](https://github.com/py-universe/django-rest-cli): A CRUD endpoints generator and flexible cookiecutter for rapid REST APIs dev. ## Tutorials * [The Complete Guide to Django REST Framework and Vue JS](https://www.udemy.com/course/the-complete-guide-to-django-rest-framework-and-vue-js/?referralCode=A2FA0F6C1C4BE66A3B3E) * [Beginner's Guide to the Django REST Framework](https://code.tutsplus.com/tutorials/beginners-guide-to-the-django-rest-framework--cms-19786) * [Django Rest Framework - an Introduction](https://realpython.com/blog/python/django-rest-framework-quick-start/) * [Django REST Framework Tutorial](https://tests4geeks.com/django-rest-framework-tutorial/) * [Django REST Framework Course](https://teamtreehouse.com/library/django-rest-framework) * [Modern Django - Blog Series covering Django api and React frontend](http://v1k45.com/blog/modern-django-part-1-setting-up-django-and-react/) * [Building a RESTful API with Django REST Framework](http://agiliq.com/blog/2014/12/building-a-restful-api-with-django-rest-framework/) * [Getting Started with Django REST Framework and AngularJS](http://blog.kevinastone.com/getting-started-with-django-rest-framework-and-angularjs.html) * [End to End Web App with Django REST Framework & AngularJS](http://mourafiq.com/2013/07/01/end-to-end-web-app-with-django-angular-1.html) * [Start Your API - Django REST Framework Part 1](https://godjango.com/41-start-your-api-django-rest-framework-part-1/) * [Permissions & Authentication - Django REST Framework Part 2](https://godjango.com/43-permissions-authentication-django-rest-framework-part-2/) * [ViewSets and Routers - Django REST Framework Part 3](https://godjango.com/45-viewsets-and-routers-django-rest-framework-part-3/) * [Django REST Framework User Endpoint](http://richardtier.com/2014/02/25/django-rest-framework-user-endpoint/) * [Check Credentials Using Django REST Framework](http://richardtier.com/2014/03/06/110/) * [Creating a Production Ready API with Python and Django REST Framework – Part 1](https://www.andreagrandi.it/2016/09/28/creating-production-ready-api-python-django-rest-framework-part-1/) * [Creating a Production Ready API with Python and Django REST Framework – Part 2](https://www.andreagrandi.it/2016/10/01/creating-a-production-ready-api-with-python-and-django-rest-framework-part-2/) * [Classy Django REST Framework](http://www.cdrf.co/) * [Permissions in Django REST Framework](https://testdriven.io/blog/drf-permissions/) * [Built-in Permission Classes in Django REST Framework](https://testdriven.io/blog/built-in-permission-classes-drf/) * [Effectively Using Django REST Framework Serializers](https://testdriven.io/blog/drf-serializers/) ## Books * [Django for APIs: Build web APIs with Python and Django](https://djangoforapis.com/) ## Courses * [Test-Driven Development with Django, Django REST Framework, and Docker](https://testdriven.io/courses/tdd-django/) ## Talks * [Fergal Walsh - Rethinking how we build HTTP APIs](https://www.youtube.com/watch?v=qTHkNkgFJeg) * [Samuel Fuentes - Fast product development using Django Rest Framework. #lessonslearned](https://www.youtube.com/watch?v=0hrf83ZIKw0&t=39s) * [Marco Montanari - Django, Django Rest Framework and Angular2: RAD on SaaS platforms](https://www.youtube.com/watch?v=DrQmYoZLGw8&t=129s) * [Alejandro Castillo - Django Rest Framework, one year after: tips, tools, tricks and pitfalls.](https://www.youtube.com/watch?v=0URILwS7-WI&t=18s) * [Rafał Nowicki - Python REST frameworks review](https://www.youtube.com/watch?v=HhKSgRvfF20&t=827s) ## Common issues * [Web API performance: profiling Django REST framework](https://www.dabapps.com/blog/api-performance-profiling-django-rest-framework/) * [My Experience in Serializer-Land (Django Rest Framework)](http://blog.traintracks.io/my-experience-in-serializer-land-django-rest-framework/) * [Optimizing slow Django REST Framework performance](http://ses4j.github.io/2015/11/23/optimizing-slow-django-rest-framework-performance/) * [Improve Serialization Performance in Django Rest Framework | How we reduced serialization time by 99%!](https://hakibenita.com/django-rest-framework-slow)

A ROS/ROS2 Multi-robot Simulator for Autonomous Vehicles

<h1 align="center">SVL Simulator: An Autonomous Vehicle Simulator</h1> <div align="center"> <a href="https://github.com/lgsvl/simulator/releases/latest"> <img src="https://img.shields.io/github/release-pre/lgsvl/simulator.svg" alt="Github release" /></a> <a href=""> <img src="https://img.shields.io/github/downloads/lgsvl/simulator/total.svg" alt="Release downloads" /></a> </div> <div align="center"> <h4> <a href="https://svlsimulator.com" style="text-decoration: none"> Website</a> <span> | </span> <a href="https://svlsimulator.com/docs" style="text-decoration: none"> Documentation</a> <span> | </span> <a href="https://github.com/lgsvl/simulator/releases/latest" style="text-decoration: none"> Download</a> </h4> </div> ## Sunsetting SVL Simulator ### LG has made the difficult decision to suspend active development of SVL Simulator, as of January 1, 2022. There are no plans for any new or bugfix releases of SVL Simulator in 2022. There will be no new source code changes pushed to GitHub, and there will be no reviews or merging of Pull Requests submitted on GitHub for SVL Simulator or any of its related plug-ins. There will be no new simulator assets built and shared nor updates made to existing assets by the SVL Simulator team. We will make a reasonable effort to keep the [wise.svlsimulator.com](https://wise.svlsimulator.com) website up and running through at least Thursday, June 30, 2022, and will also maintain the [SVLSimulator.com](https://SVLSimulator.com) web site including the [simulator documentation](https://www.svlsimulator.com/docs/) pages through at least Thursday, June 30, 2022. At this time we do not plan to remove the [SVL Simulator source code](https://github.com/lgsvl/simulator) (and related plug-in) projects from GitHub. The open source project and source code will remain available for anyone who wants to build (or modify) SVL Simulator. We apologize for any inconvenience this may cause and appreciate your understanding. Sincerely, The SVL Simulator team <br/> ### Questions ##### **Q: Will SVL Simulator run locally without the [wise.svlsimulator.com](https://wise.svlsimulator.com) web site?** A: The latest released version of SVL (2021.3) requires the use of the WISE (web user interface) cloud service to download assets, configure simulation clusters, and create and launch simulations. It may be possible to remove this dependency (e.g. in a fork; see below) and then build and launch a local simulator instance. ##### **Q: Will LG release the source code for the WISE (web user interface) cloud service?** A: There are no plans at this time to release the source code for WISE. ##### **Q: Would LG be interested in transferring the SVL Simulator project to someone interested in taking over the project?** A: There are no plans at this time to transfer the SVL Simulator project (or the WISE cloud service). ##### **Q: Will the Simulator Software License Agreement be changed?** A: There are no plans at this time to change the [Simulator Software License Agreement](https://github.com/lgsvl/simulator/blob/master/LICENSE). ##### **Q: Can users share source code changes and forks of SVL Simulator?** A: As a GitHub project, anyone is able to create their own fork; in fact, there are already over 500 such forks of the [SVL Simulator project](https://github.com/lgsvl/simulator). Users can then make changes and even submit pull requests back to the original (parent) project. While we have no plans to review or merge such changes into the main project, users are free to review open PRs and create their own local build from their own or any other public fork. ##### **Q: Can users share new builds of SVL Simulator?** A: The [Simulator Software License Agreement](https://github.com/lgsvl/simulator/blob/master/LICENSE) allows you to “modify or create derivative works of the Licensed Materials” and only restricts their commercial use. Therefore, it is ok for users to share new builds of SVL Simulator as long as such builds are not sold or otherwise used for commercial purposes. ##### **Q: What about the SVL Simulator Premium product and/or cloud simulation service?** A: There are no plans at this time to offer a SVL Simulator Premium product or cloud service. ##### **Q: Can users still post technical questions on GitHub?** A: Technical questions may be posted to the [SVL Simulator Issues](https://github.com/lgsvl/simulator/issues) page on GitHub but may not be answered by the SVL Simulator team. We encourage users to help each other with questions or issues that are posted. ##### **Q: What if there are other questions not addressed in this document?** A: Other questions may be posted to the [SVL Simulator Issues](https://github.com/lgsvl/simulator/issues) page on GitHub. <br/> ------ # Project README ## Stay Informed Check out our latest [news](https://www.svlsimulator.com/news/) and subscribe to our [mailing list](http://eepurl.com/htlRjH) to get the latest updates. ## Introduction LG Electronics America R&D Lab has developed an HDRP Unity-based multi-robot simulator for autonomous vehicle developers. We provide an out-of-the-box solution which can meet the needs of developers wishing to focus on testing their autonomous vehicle algorithms. It currently has integration with The Autoware Foundation's [Autoware.auto](https://gitlab.com/autowarefoundation/autoware.auto/AutowareAuto) and Baidu's [Apollo](https://github.com/ApolloAuto/apollo) platforms, can generate HD maps, and can be immediately used for testing and validation of a whole system with little need for custom integrations. We hope to build a collaborative community among robotics and autonomous vehicle developers by open sourcing our efforts. *To use the simulator with Apollo 6.0 or master, first download the simulator binary, then follow our [Running with latest Apollo](https://www.svlsimulator.com/docs/system-under-test/apollo-master-instructions/) docs.* *To use the simulator with Autoware.auto, first download the simulator binary, then follow the guide on our [Autoware.auto](https://autowarefoundation.gitlab.io/autoware.auto/AutowareAuto/lgsvl.html).* For users in China, you can view our latest videos [here](https://space.bilibili.com/412295691) and download our simulator releases [here](https://pan.baidu.com/s/1M33ysJYZfi4vya41gmB0rw) (code: 6k91). 对于中国的用户，您也可在[哔哩哔哩](https://space.bilibili.com/412295691)上观看我们最新发布的视频，从[百度网盘](https://pan.baidu.com/s/1M33ysJYZfi4vya41gmB0rw)(提取码: 6k91)上下载使用我们的仿真器。 ## Paper If you are using SVL Simulator for your research paper, please cite our ITSC 2020 paper: [LGSVL Simulator: A High Fidelity Simulator for Autonomous Driving](https://arxiv.org/pdf/2005.03778) ``` @article{rong2020lgsvl, title={LGSVL Simulator: A High Fidelity Simulator for Autonomous Driving}, author={Rong, Guodong and Shin, Byung Hyun and Tabatabaee, Hadi and Lu, Qiang and Lemke, Steve and Mo{\v{z}}eiko, M{\=a}rti{\c{n}}{\v{s}} and Boise, Eric and Uhm, Geehoon and Gerow, Mark and Mehta, Shalin and others}, journal={arXiv preprint arXiv:2005.03778}, year={2020} } ``` ## Getting Started You can find complete and the most up-to-date guides on our [documentation website](https://www.svlsimulator.com/docs). Running the simulator with reasonable performance and frame rate (for perception related tasks) requires a high performance desktop. Below is the recommended system for running the simulator at high quality. We are currently working on performance improvements for a better experience. **Recommended system:** - 4 GHz Quad Core CPU - Nvidia GTX 1080, 8GB GPU memory - Windows 10 64 Bit The easiest way to get started with running the simulator is to download our [latest release](https://github.com/lgsvl/simulator/releases/latest) and run as a standalone executable. Currently, running the simulator in Windows yields better performance than running on Linux. ### Downloading and starting simulator 1. Download the latest release of the SVL Simulator for your supported operating system (Windows or Linux) here: [https://github.com/lgsvl/simulator/releases/latest](https://github.com/lgsvl/simulator/releases/latest) 2. Unzip the downloaded folder and run the executable. See the full installation guide [here](https://svlsimulator.com/docs/installation-guide/installing-simulator). ### Building and running from source If you would like to customize the simulator, build simulation content, or access specific features available in [Developer Mode](https://www.svlsimulator.com/docs/running-simulations/developer-mode), you can clone the project with Unity Editor, and build the project from source. Check out our instructions for getting started with building from source [here](https://www.svlsimulator.com/docs/installation-guide/build-instructions). **Note:** Please checkout the "release-*" branches or release tags for stable (ready features) and "master" branch for unstable (preview of work in progress). ## Simulator Instructions (from 2021.1 release onwards) 1. After starting the simulator, you should see a button to "Link to Cloud". 2. Use this button to link your local simulator instance to a [cluster](https://www.svlsimulator.com/docs/user-interface/web/clusters-tab) on our [web user interface](https://wise.svlsimulator.com). 3. Now create a [random traffic](https://www.svlsimulator.com/docs/creating-scenarios/random-traffic-scenarios/) simulation. For a standard setup, select "BorregasAve" for map and "Jaguar2015XE with Apollo 5.0 sensor configuration" for vehicle. Click "Run" to begin. 4. The vehicle should spawn inside the map environment that was selected. 5. Read [here](https://www.svlsimulator.com/docs/user-interface/keyboard-shortcuts/) for an explanation of all current keyboard shortcuts and controls. 6. Follow the guides on our respective [Autoware](https://github.com/lgsvl/Autoware) and [Apollo 5.0](https://github.com/lgsvl/apollo-5.0) repositories for instructions on running the platforms with the simulator. **NOTE**: If using a release older than "2021.1", please follow the instructions on our documentation [archives](https://www.svlsimulator.com/docs/archive/). ### Guide to simulator functionality Look [here](https://www.svlsimulator.com/docs) for a guide to currently available functionality and features. ## Contact Please feel free to provide feedback or ask questions by creating a Github issue. For inquiries about collaboration, please email us at [[email protected]](mailto:[email protected]). ## Copyright and License Copyright (c) 2019-2021 LG Electronics, Inc. This software contains code licensed as described in LICENSE.

An API gateway and framework for turning functions into web services

# FunctionScript    ## An API gateway and framework for turning functions into web services FunctionScript is a language and specification for turning JavaScript functions into typed HTTP APIs. It allows JavaScript (Node.js) functions to be seamlessly exported as HTTP APIs by **defining what the HTTP interface will look like and how it behaves in the preceding comment block** - including type-safety mechanisms. FunctionScript arose out of a need to introduce developers with little programming experience, but familiarity with JavaScript, to full-stack API development and best practices around defining and connecting HTTP application interfaces. For this reason, the goals of the language are significantly different than [TypeScript](https://github.com/microsoft/TypeScript). **FunctionScript is intended to provide an easy introduction to API development for those of any skill level, while maintaining professional power and flexibility.** FunctionScript is the primary specification underpinning the [Autocode](https://autocode.com) platform and its standard library of APIs. ### Quick Example of a FunctionScript API The following is a real-world excerpt of an API that can be used to query a Spreadsheet like a Database. The underlying implementation has been hidden, but the parameters for the API can be seen. ```javascript /** * Select Rows from a Spreadsheet by querying it like a Database * @param {string} spreadsheetId The id of the Spreadsheet. * @param {string} range The A1 notation of the values to use as a table. * @param {enum} bounds Specify the ending bounds of the table. * ["FIRST_EMPTY_ROW", "FIRST_EMPTY_ROW"] * ["FULL_RANGE", "FULL_RANGE"] * @param {object} where A list of column values to filter by. * @param {object} limit A limit representing the number of results to return * @ {number} offset The offset of records to begin at * @ {number} count The number of records to return, 0 will return all * @returns {object} selectQueryResult * @ {string} spreadsheetId * @ {string} range * @ {array} rows An array of objects corresponding to row values */ module.exports = async ( spreadsheetId = null, range, bounds = 'FIRST_EMPTY_ROW', where = {}, limit = {offset: 0, count: 0}, context ) => { /* implementation-specific JavaScript */ return {/* some data */}; }; ``` It generates an API which accepts (and type checks against, following schemas): - **`spreadsheetId`** A `string` - **`range`** A `string` - **`bounds`** An `enum`, can be either `"FIRST_EMPTY_ROW"` or `"FULL_RANGE"` - **`where`** An `object` - **`limit`** An `object` that must contain: - `limit.offset`, a `number` - `limit.count`, a `number` It will return an `object`: - **`selectQueryResult`** - `selectQueryResult.spreadsheetId` must be a `string` - `selectQueryResult.range` must be a `string` - `selectQueryResult.rows` must be an `array` ## Background The impetus for creating FunctionScript is simple: it stems from the initial vision of [Autocode](https://autocode.com). We believe the modern web is missing a base primitive - the API. Daily, computer systems and developers around the planet make trillions of requests to perform specific tasks: process credit card payments with [Stripe](https://stripe.com), send team messages via [Slack](https://slack.com), create SMS messages with [Twilio](https://twilio.com). These requests are made primarily over HTTP: Hypertext Transfer Protocol. However, little to no "hypertext" is actually sent or received, these use cases have emerged in an *ad hoc* fashion as a testament to the power of the world wide web. Oftentimes, API standardization attempts have been presented as band-aids instead of solutions: requiring developers to jury rig a language, framework, markup language and hosting provider together just to get a simple "hello world" out the door. By creating API development standards as part of a **language specification** instead of a framework, FunctionScript truly treats the web API as a base primitive of software development instead of an afterthought. This allows teams to be able to deliver high-quality APIs with the same fidelity as organizations like Stripe in a fraction of the time without requiring any additional tooling. # Table of Contents 1. [Introduction](#introduction) 1. [Why FunctionScript?](#why-functionscript) 1. [FunctionScript Examples](#functionscript-examples) 1. [All Available Types](#all-available-types) 1. [Specification](#specification) 1. [FunctionScript Resource Definition](#functionscript-resource-definition) 1. [Context Definition](#context-definition) 1. [Parameters](#parameters) 1. [Constraints](#constraints) 1. [Types](#types) 1. [Type Conversion](#type-conversion) 1. [Nullability](#nullability) 1. [FunctionScript Resource Requests](#functionscript-resource-requests) 1. [Context](#context) 1. [Errors](#errors) 1. [ClientError](#clienterror) 1. [ParameterError](#parametererror) 1. [Details: Required](#details-required) 1. [Details: Invalid](#details-invalid) 1. [FatalError](#fatalerror) 1. [RuntimeError](#runtimeerror) 1. [ValueError](#valueerror) 1. [FunctionScript Server and Gateway: Implementation](#functionscript-server-and-gateway-implementation) 1. [Acknowledgements](#acknowledgements) # Introduction To put it simply, FunctionScript defines semantics and rules for turning exported JavaScript (Node.js) functions into strongly-typed, HTTP-accessible web APIs. In order to use FunctionScript, you'd set up your own [FunctionScript Gateway](#functionscript-server-and-gateway-implementation) or you would use an existing FunctionScript-compliant service like [Autocode](https://autocode.com/). FunctionScript allows you to turn something like this... ```javascript // hello_world.js /** * My hello world function! */ module.exports = (name = 'world') => { return `hello ${name}`; }; ``` Into a web API that can be called over HTTP like this (GET): ``` https://$user.api.stdlib.com/service@dev/hello_world?name=joe ``` Or like this (POST): ```json { "name": "joe" } ``` And gives a result like this: ```json "hello joe" ``` Or, when a type mismatch occurs (like `{"name":10}`): ```json { "error": { "type":"ParameterError" ... } } ``` ## Why FunctionScript? FunctionScript is intended primarily to provide a scaffold to build and deliver APIs easily. It works best as a part of the [Autocode](https://autocode.com/) platform which consumes the FunctionScript API definitions, hosts the code, generates documentation from the definitions, and automatically handles versioning and environment management. The reason we've open sourced the language specification is so that developers have an easier time developing against the highly modular API ecosystem we've created and can contribute their thoughts and requests. You can break down the reason for the development of FunctionScript into a few key points: - Modern developers and people being introduced to software development for the first time are often trying to build web-native scripts. It is *exceedingly* difficult to go from "zero to API" in less than a few hours, writing code is just the first step of many. We'd like it to be the first and only step. - No true standards around APIs have ever been built or enforced in a rigorous manner across the industry. Primarily, opinions around SOAP, REST and GraphQL requests have been built into **frameworks and tools** instead of a **language specification**, which has artificially inflated the cognitive overhead required to ship functional web-based software. - Companies like Stripe and Twilio which have built and enforced their own API development paradigms internally have unlocked massive developer audiences in short timeframes, indicating the power of treating web APIs as a first-class citizen of development. - [Serverless computing](https://en.wikipedia.org/wiki/Serverless_computing), specifically the Function-as-a-Service model of web-based computation, has made API development significantly more accessible but has not brought us over the "last-mile" hump. - JavaScript, specifically Node.js, is an ideal target for API development standardization due to its accessibility (front-end and back-end), growth trajectory, and flexibility. Most new developers are introduced to JavaScript out of necessity. - As opposed to something like [TypeScript](https://github.com/microsoft/TypeScript), FunctionScript helps newer entrants to software development by extending JavaScript with very little overhead. It adds types around *only the HTTP interface*, leaving the majority of the language footprint untouched but strengthening the "weakest" and least predictable link in the development chain: user input. With FunctionScript, it's our goal to develop a language specification for building APIs that automatically provides a number of necessary features without additional tooling: - Standardized API Calling Conventions (HTTP) - Type-Safety Mechanisms at the HTTP -> Code Interface - Automatically Generated API Documentation # FunctionScript Examples We'll be updating this section with examples for you to play with and modify on your own. ## All Available Types Here's an example of a hypothetical `createUser.js` function that can be used to create a user resource. It includes all available type definitions. ```javascript /** * @param {integer} id ID of the User * @param {string} username Name of the user * @param {number} age Age of the user * @param {float} communityScore Community score (between 0.00 and 100.00) * @param {object} metadata Key-value pairs corresponding to additional user data * @ {string} createdAt Created at ISO-8601 String. Required as part of metadata. * @ {?string} notes Additional notes. Nullable (not required) as part of object * @param {array} friendIds List of friend ids * @ {integer} friendId ID of a user (forces array to have all integer entries) * @param {buffer} profilePhoto Base64-encoded filedata, read into Node as a Buffer * @param {enum} userGroup The user group. Can be "USER" (read as 0) or "ADMIN" (read as 9) * ["USER", 0] * ["ADMIN", 9] * @param {boolean} overwrite Overwrite current user data, if username matching * @returns {object.http} successPage API Returns an HTTP object (webpage) */ module.exports = async (id = null, username, age, communityScore, metadata, friendsIds = [], profilePhoto, userGroup, overwrite = false) => { // NOTE: id, friendIds and overwrite will be OPTIONAL as they have each been // provided a defaultValue // Implementation-specific code here // API Output // NOTE: Note that because "object.http" was specified, this MUST follow the // object.http schema: headers, statusCode, body return { headers: {'Content-Type': 'text/html'}, statusCode: 200, body: Buffer.from('Here is a success message!') }; }; ``` # Specification ## FunctionScript Resource Definition A FunctionScript definition is a JSON output, traditionally saved as a `definition.json` file, generated from a JavaScript file, that respects the following format. Given a function like this (filename `my_function.js`): ```javascript // my_function.js /** * This is my function, it likes the greek alphabet * @param {String} alpha Some letters, I guess * @param {Number} beta And a number * @param {Boolean} gamma True or false? * @returns {Object} some value */ module.exports = async (alpha, beta = 2, gamma, context) => { /* your code */ }; ``` The FunctionScript parser will generate a `definition.json` file that looks like the following: ```json { "name": "my_function", "format": { "language": "nodejs", "async": true }, "description": "This is my function, it likes the greek alphabet", "bg": { "mode": "info", "value": "" }, "context": null, "params": [ { "name": "alpha", "type": "string", "description": "Some letters, I guess" }, { "name": "beta", "type": "number", "defaultValue": 2, "description": "And a number" }, { "name": "gamma", "type": "boolean", "description": "True or false?" } ], "returns": { "type": "object", "description": "some value" } } ``` A definition must implement the following fields; | Field | Definition | | ----- | ---------- | | name | A user-readable function name (used to execute the function), must match `/[A-Z][A-Z0-9_]*/i` | | format | An object requiring a `language` field, along with any implementation details | | description | A brief description of what the function does, can be empty (`""`) | | bg | An object containing "mode" and "value" parameters specifying the behavior of function responses when executed in the background | | params | An array of `NamedParameter`s, representing function arguments | returns | A `Parameter` without a `defaultValue` representing function return value | ## Context Definition If the function does not access execution context details, this should always be null. If it is an object, it indicates that the function *does* access context details (i.e. `remoteAddress`, http headers, etc. - see [Context](#context)). This object **does not have to be empty**, it can contain vendor-specific details; for example `"context": {"user": ["id", "email"]}` may indicate that the execution context specifically accesses authenticated user id and email addresses. ## Parameters Parameters have the following format; | Field | Required | Definition | | ----- | -------- | ---------- | | name | NamedParameter Only | The name of the Parameter, must match `/[A-Z][A-Z0-9_]*/i` | | type | yes | A string representing a valid FunctionScript type | | description | yes | A short description of the parameter, can be empty string (`""`) | | defaultValue | no | Must match the specified type. **If type is not provided, this parameter is required** | ### Types As FunctionScript interfaces with "userland" (user input), a strongly typed signature is enforced for all inbound parameters. The following is a list of supported FunctionScript types. | Type | Definition | Example Input Values (JSON) | | ---- | ---------- | -------------- | | boolean | True or False | `true` or `false` | | string | Basic text or character strings | `"hello"`, `"GOODBYE!"` | | number | Any double-precision [Floating Point](https://en.wikipedia.org/wiki/IEEE_floating_point) value | `2e+100`, `1.02`, `-5` | | float | Alias for `number` | `2e+100`, `1.02`, `-5` | | integer | Subset of `number`, integers between `-2^53 + 1` and `+2^53 - 1` (inclusive) | `0`, `-5`, `2000` | | object | Any JSON-serializable Object | `{}`, `{"a":true}`, `{"hello":["world"]}` | | object.http | An object representing an HTTP Response. Accepts `headers`, `body` and `statusCode` keys | `{"body": "Hello World"}`, `{"statusCode": 404, "body": "not found"}`, `{"headers": {"Content-Type": "image/png"}, "body": Buffer.from(...)}` | | array | Any JSON-serializable Array | `[]`, `[1, 2, 3]`, `[{"a":true}, null, 5]` | | buffer | Raw binary octet (byte) data representing a file | `{"_bytes": [8, 255]}` or `{"_base64": "d2h5IGRpZCB5b3UgcGFyc2UgdGhpcz8/"}` | | any | Any value mentioned above | `5`, `"hello"`, `[]` | | enum | An enumeration that maps input strings to values of your choosing | `"STRING_OF_YOUR_CHOICE"` | ### Type Conversion The `buffer` type will automatically be converted from any `object` with a **single key-value pair matching the footprints** `{"_bytes": []}` or `{"_base64": ""}`. Otherwise, parameters provided to a function are expected to match their defined types. Requests made over HTTP via query parameters or POST data with type `application/x-www-form-urlencoded` will be automatically converted from strings to their respective expected types, when possible (see [FunctionScript Resource Requests](#functionscript-resource-requests) below): | Type | Conversion Rule | | ---- | --------------- | | boolean | `"t"` and `"true"` become `true`, `"f"` and `"false"` become `false`, otherwise **do not convert** | | string | No conversion | | number | Determine float value, if NaN **do not convert**, otherwise convert | | float | Determine float value, if NaN **do not convert**, otherwise convert | | integer | Determine float value, if NaN **do not convert**, may fail integer type check if not in range | | object | Parse as JSON, if invalid **do not convert**, object may fail type check (array, buffer) | | object.http | Parse as JSON, if invalid **do not convert**, object may fail type check (array, buffer) | | array | Parse as JSON, if invalid **do not convert**, object may fail type check (object, buffer) | | buffer | Parse as JSON, if invalid **do not convert**, object may fail type check (object, array) | | any | No conversion | | enum | Read input as string | ### Nullability All types are potentially nullable, an nullability can be defined in two ways: **(1)** by setting `"defaultValue": null` in the `NamedParameter` definition. ``` /** * @param {string} nullableString */ module.exports = (nullableString = null) => { return `Test ${nullableString}`; } ``` **(2)** By prepending a `?` before the type name in the comment definition, i.e.: ``` /** * @param {?string} nullableString */ module.exports = (nullableString) => { return `Test ${nullableString}`; } ``` **NOTE:** That the difference between this two behaviors is that the latter will mean `nullableString` is both `required` AND `nullable`, whereas the former means `nullableString` has a `defaultValue` (is optional). ### Setting HTTP headers The `object.http` type should be used to generate HTTP responses that are intended to return more complex data than simple JSON responses. You can provide `headers`, `statusCode` and `body` in an `object.http` response. For example, to return an image that's of type `image/png`... ```javascript /** * Retrieves an image * @param {string} imageName The name of the image * @returns {object.http} image The result */ module.exports = (imageName) => { // fetch image, returns a buffer let png = imageName === 'cat' ? fs.readFileSync(`/images/kitty.png`) : fs.readFileSync(`/images/no-image.png`); // Forces image/png over HTTP requests, default // for buffer would otherwise be application/octet-stream return { headers: {'Content-Type': 'image/png'}, statusCode: 200, body: png }; }; ``` ## FunctionScript Resource Requests FunctionScript requests *must* complete the following steps; 1. Ensure the **Resource Definition** is valid and compliant, either on storage or accession. 1. Performs a handshake (i.e. HTTP) with initial request details 1. Accept an `Array`, `Object` or a string of URLencoded variables 1. If over HTTP and query parameters present, query parameters used as URL encoded variables 1. If over HTTP POST and query parameters present, reject requests that try to specify a POST body as well with a `ClientError` 1. If over HTTP POST, requests **must** include a `Content-Type` header or a `ClientError` is immediately returned 1. If over HTTP POST, `Content-Type` **must** be `application/json` for `Array` or `Object` data, or `application/x-www-form-urlencoded` for string data or a `ClientError` is immediately returned 1. If `application/x-www-form-urlencoded` values are provided (either via POST body or query parameters), convert types based on [Type Conversion](#type-conversion) and knowledge of the function definition and create an `Object` 1. If `Array`: Parameters will be checked for type consistency in the order of the definition `params` 1. If `Object`: Parameters will be checked for type consistency based on names of the definition `params` 1. If any inconsistencies are found, cease execution and immediately return a `ParameterError` 1. If a parameter has no defaultValue specified and is not provided, immediately return a `ParameterError` 1. Try to execute the function, if the function fails to parse or is not valid, immediately return a `FatalError` 1. If a function hits a specified timeout (execution time limit), immediately return a `FatalError` 1. If a function returns an error (via callback) or one is thrown and not caught, immediately return a `RuntimeError` 1. If function returns inconsistent response (does not match `returns` type), immediately return a `ValueError` 1. If no errors are encountered, return the value to the client 1. If over HTTP and `content-type` is not being overloaded (i.e. developer specified through a vendor-specific mechanism), return `buffer` type data as `application/octet-stream` and any other values as `application/json`. ### Context Every function intended to be consumed via FunctionScript has the option to specify an *optional* magic `context` parameter that receives vendor-specific information about the function execution context - for example, if consumed over HTTP, header details. FunctionScript definitions must specify whether or not they consume a `context` object. Context objects are extensible but **MUST** contain the following fields; | Field | Definition | | ----- | ---------- | | params | An `object` mapping called parameter names to their values | | http | `null` if not accessed via http, otherwise an `object` | | http.headers | If accessed via HTTP, an `object` containing header values | ### Errors Errors returned by FunctionScript-compliant services must follow the following JSON format: ```json { "error": { "type": "ClientError", "message": "You know nothing, Jon Snow", "details": {} } } ``` `details` is an optional object that can provide additional Parameter details. Valid Error types are: - `ClientError` - `ParameterError` - `FatalError` - `RuntimeError` - `ValueError` #### ClientError `ClientError`s are returned as a result of bad or malformed client data, including lack of authorization or a missing function (not found). If over HTTP, they **must** returns status codes in the range of `4xx`. #### ParameterError `ParameterError`s are a result of Parameters not passing type-safety checks, and **must** return status code `400` if over HTTP. Parameter Errors **must** have the following format; ```json { "error": { "type": "ParameterError", "message": "ParameterError", "details": {...} } } ``` `"details"` should be an object mapping parameter names to their respective validation (type-checking) errors. Currently, this specification defines two classifications of a ParameterError for a parameter; *required* and *invalid*. The format of `"details": {}` should follow this format; ##### Details: Required ```json { "param_name": { "message": "((descriptive message stating parameter is required))", "required": true } } ``` ##### Details: Invalid ```json { "param_name": { "message": "((descriptive message stating parameter is invalid))", "invalid": true, "expected": { "type": "number" }, "actual": { "type": "string", "value": "hello world" } } } ``` #### FatalError `FatalError`s are a result of function mismanagement - either your function could not be loaded, executed, or it timed out. These **must** return status code `500` if over HTTP. #### RuntimeError `RuntimeError`s are a result of uncaught exceptions in your code as it runs, including errors you explicitly choose to throw (or send to clients via a callback, for example). These **must** return status code `403` if over HTTP. #### ValueError `ValueError`s are a result of your function returning an unexpected value based on FunctionScript type-safety mechanisms. These **must** return status code `502` if over HTTP. `ValueError` looks like an *invalid* ParameterError, where the `details` Object only ever contains a single key called `"returns"`. These are encountered due to implementation issues on the part of the function developer. ```json { "error": { "type": "ValueError", "message": "ValueError", "details": { "returns": { "message": "((descriptive message stating return value is invalid))", "invalid": true, "expected": { "type": "boolean" }, "actual": { "type": "number", "value": 2017 } } } } } ``` # FunctionScript Server and Gateway: Implementation A fully-compliant FunctionScript gateway (that just uses local function resources) is available with this package, simply clone it and run `npm test` or look at the `/tests` folder for more information. The FunctionScript specification is used as the platform specification for [Autocode](https://autocode.com), and is available for local use with the [Autocode CLI](https://github.com/acode/cli) which relies on this repository as a dependency. # Acknowledgements FunctionScript is the result of years of concerted effort working to make API development easier. It would not be possible without the personal and financial commitments of some very amazing people and companies. We'd like to thank our customers, investors, supporters, friends and family. ### Core Contributors - [**Keith Horwood**](https://twitter.com/keithwhor) - [**Jacob Lee**](https://twitter.com/hacubu) - [**Steve Meyer**](https://twitter.com/notoriaga) - [**Yusuf Musleh**](https://twitter.com/yusuf-musleh) # Notes The software contained within this repository has been developed and is copyrighted by the [Autocode](https://autocode.com) team (Polybit Inc.) and is MIT licensed.

Curated collection of blockchain & cryptocurrency resources.

# CryptoList Curated collection of blockchain &amp; cryptocurrency links. # Sponsor [<img src="https://github.com/coinpride/CryptoList/blob/master/join_cryptomemes.png?raw=true" width="467">](https://t.me/join_cryptomemes) # Contents - [Media](#media) - [Magazines and Blogs](#magazines-and-blogs) - [Medium](#medium) - [Telegram Channels](#telegram-channels) - [News Aggregators](#news-aggregators) - [Price Trackers](#price-trackers) - [ICO Trackers](#ico-trackers) - [Exchanges](#exchanges) - [Communities](#communities) - [Chats](#chats) - [Forums](#forums) - [Other](#other) - [Twitter Users and Lists](#twitter-users-and-lists) - [Jobs](#jobs) - [Wallets](#wallets) - [Altfolio](#altfolio) - [Useful Tools](#useful-tools) - [Video](#video) - [YouTube Channels](#youtube-channels) - [Movies](#movies) - [Learning](#learning) - [Books](#books) - [Courses](#courses) - [Other](#other) - [Trading Tools](#trading-tools) - [For Developers](#for-developers) - [API](#api) - [Other](#other) - [Podcasts](#podcasts) - [Mining](#mining) - [Games](#games) - [Sponsors](#sponsors) - [Contribute](#contribute) - [License](#license) # Media ## Magazines and Blogs * [CryptoHackers](https://cryptohackers.party/) - Cryptoworld superheroes interviews. Fascinating facts, teams insides and success stories. * [CoinTelegraph](https://cointelegraph.com/) - The leading publication offering latest news, analysis, expert opinions, community commentaries. Founded in 2013. * [CoinDesk](https://www.coindesk.com/) - CoinDesk is the world leader in news and information on digital currencies. 17M mothly users. * [CryptoCoins News](https://www.cryptocoinsnews.com/) - Fresh news and analysis. This huge blog posts very frequently. Approx. 7M readers monthly. * [Bitcoin Magazine](https://bitcoinmagazine.com/) - Bitcoin Magazine is the oldest and most established source of news, information and expert commentaries. Sometimes posts deep and very interesting articles. * [99 Bitcoins](https://99bitcoins.com/) - 99 Bitcoins is the largest information source for non technical newbies. * [Coin Speaker](https://www.coinspeaker.com/) - Founded in 2014, CoinSpeaker is one of the most influentional news source. * [The Memory Pool](https://nakamotoinstitute.org/mempool/) - Satoshi Nakamoto Institute blog. * [Tim Swanson Blog](https://www.ofnumbers.com/category/bitcoin/) - Blog of director of market research at R3. * [Oleg Andreev Blog](https://oleganza.com/) - Blog of hardcore developer, product architect at Chain.com. * [CoinGape](https://coingape.com) - Global blockchain, cryptocurrency, ICO news, updates, guides and analysis. * [Freedom to Tinker](https://freedom-to-tinker.com/tag/bitcoin/) - Princeton hosted tech blog: researches and experts commentaries. * [Money and State](http://moneyandstate.com/) - Blog of Erik Voorhees, CEO of leading digital asset exchange ShapeShift.io * [Gavin Andersesn Blog](http://gavinandresen.ninja/) - Blog of Bitcoin developer. * [Peter Todd Blog](https://petertodd.org/) - Blog of Todd, the applied cryptography consultant. * [Richard Brown Blog](https://gendal.me/tag/bitcoin/) - Blog of Head of Technology at R3CEV. * [Laanwj Blog](https://laanwj.github.io/) - Blog of Bitcoin core developer and reverse engineer. * [Crypto Analyst](https://www.cryptoanalyst.co/) - World’s premier cryptocurrency news analysis. * [Bitrazzi](https://bitrazzi.com/) - Bitcoin, Cryptocurrency And Blockchain News. * [Bitfalls](https://bitfalls.com) - Technical news, solidity tutorials, and skeptical research. EN and HR languages. * [What Bitcoin Did](https://www.whatbitcoindid.com/) - Blog of accidental Bitcoin and Cryptocurrency investor, miner, blogger and podcaster. * [CryptoGround](https://www.cryptoground.com) - Get latest news related to Bitcoin, Ethereum and other cryptocurrencies. ## Medium * [Vitalik Buterin](https://medium.com/@VitalikButerin) - Ethereum creator, cryptocurrency evangelist. * [Bitcoin Tech Talk](https://bitcointechtalk.com) - All About Bitcoin Development. * [Tuur Demeester](https://medium.com/@tuurdemeester) - Economist & investor, editor in chief at Adamant Research. * [Vinny Lingham](https://vinnylingham.com) - CEO of Civic.com. * [Nicolas Dorier](https://medium.com/@nicolasdorier) - Main developer of NBitcoin. CTO at Metaco SA. * [Nick Tomaino](https://thecontrol.co/@ntmoney) - Tech investor @RunaCapital. * [Eric Lombrozo](https://medium.com/@elombrozo) - Co-CEO & CTO Ciphrex Corp., Bitcoin Core contributor. * [Jimmy Song](https://medium.com/@jimmysong) - Bitcoin Developer and Entrepreneur. * [Linda Xie](https://medium.com/@linda.xie) - Product Manager @Coinbase. Advisor @0xProject. * [Fred Ehrsam](https://medium.com/@FEhrsam) - Previously co-founder @Coinbase, trader @GoldmanSachs, computer science @DukeU. * [Token Economy](https://tokeneconomy.co) - Making sense of the latest in crypto-land: cryptocurrencies, blockchains, ICOs, dapps & the growing token economy. ## Telegram Channels * [Crypto Memes](https://t.me/join_cryptomemes) - Cryptoworld funny pictures. * [Crypto](https://t.me/Crypto) - The god of all crypto channels. * [UpcomingICOs](https://t.me/UpcomingICOs) - This channel is dedicated to informing people of up and coming ICO's. * [CryptoNews](https://t.me/bitcoinnews) - Cryptocurrency news megafeed that is posted in real time, even before they hit social media. * [Ethereum dapps](https://t.me/ethereumdapps) - Ethereum & DAPPS news and updates. * [Telegram Crypto Groups](http://telegramcryptogroups.com) - Directory of all of Telegram crypto related groups. # News Aggregators * [CryptoControl](https://cryptocontrol.io/en/social) - CryptoControl aggregates news from many sources (Twitter, Reddit, Google Trends etc) and displays it in the Trello style. * [CryptoPanic](https://cryptopanic.com/) - CryptoPanic is news aggregator platform indicating impact on price and market for traders and cryptocurrency enthusiasts. * [ETHNews](https://www.ethnews.com) - ETHNews is emerging provider of Ethereum and Blockchain ecosystem news. * [Coin Spectator](https://coinspectator.com/) - Get the latest cryptocurrency, bitcoin & blockchain news from many news sources. * [CoinsCalendar](http://www.coinscalendar.com/) - CoinsCalendar displays all upcoming coins events and updates. * [CoinDar](https://coindar.org/) - Be first to know about coming cryptocurrency news, updates, hard forks, meetups, coins listing on exchanges and other important events. * [BTCnews](https://itunes.apple.com/app/btcnews-bitcoin-cryptocurrency/id946903421) - Mature cryptocurrency news and charts app for iOS. * [CryptoAudio](http://cryptoaud.io) - A tool that creates news summaries from various sources and reads them using a text-to-speech technology. * [CryptoFlash.io](https://cryptoflash.io) - Top 200+ cryptocurrencies news & rumors in real time! * [AmuletPlatform](https://amuletplatform.com/data/) - Real-time sentiment analysis of 24M+ posts about crypto from Reddit and Bitcointalk * [InTokenWeTrust](https://intwt.com/) - News aggregator platform with all media and blogs about cryptocurrency. # Price Trackers * [CoinMarketcap](https://coinmarketcap.com/) - Old and cool. All coins prices, graphs, market caps. API, widgets, tools. Used by 90M monthly users. * [Coincap](http://coincap.io/) - CoinCap tracks market data for hundreds of cryptocurrencies in real-time. They also have very useful mobile app. * [Cryptowatch](https://cryptowat.ch) - Live price charts and market data for Bitcoin, Ethereum, and more. Many exchanges, flexible settings and cool API. * [Bitcoinwisdom](https://bitcoinwisdom.com) - Live Bitcoin/Litecoin charts with EMA, MACD and other indicators. Support many exchanges (Bitfinex, Bitstamp, Coinbase, Bittrex, Poloniex etc). * [Flippening Watch](https://www.flippening.watch/) - When will Ethereum overtake Bitcoin and become the most important cryptocurrency? * [Coindex](https://itunes.apple.com/us/app/coindex/id1251487103) - Beautiful cryptocurrency price tracker for iOS. * [WorldCoinIndex](https://www.worldcoinindex.com/) - Realtime cryptocurrency price monitoring tool. Lots of altcoins and many fiat currencies. * [CryptTrader](https://cryptrader.com/) - Cryptocurrency trading platform. Charts, news and trollbox. Add widgets to customize the look. * [Coin Daily Update](https://coindailyupdate.com) - Daily email update with price changes of customizable coins. * [Coindera](https://coindera.com/) - Real time cryptocurrency price alerts for 2,000+ coins on 25+ exchanges. * [Cryptocurrency CLI](https://github.com/christ0ph3r/cryptocurrency-cli) - Cryptocurrency portfolio on the command line. * [ckandr](https://github.com/screwgoth/ckandr) - A command-line cryptocurrency price ticker specifically for popular Indian cryptocurrency exchanges. * [CoinAlyze](https://coinalyze.net) - Cryptocurrency real-time charts, price levels, statistics and candlestick patterns detection. * [Cryptomon](https://cryptomon.io) - Modern trading indicators and price predictions based on machine intelligence. * [MoonHash](https://chrome.google.com/webstore/detail/%E2%97%90-moonhash-crypto-portfol/clbooohlcomlhgkfencdenfiadhkefff?hl=en-US) - Cryptocurrency portfolio, price monitoring and telegram monitoring Google Chrome Extension * [Coincall](https://coincall.io) - Simplest web-based crypto price and portfolio tracker. * [Owl Crypto](https://owlcrypto.com) - Cryptocurrency percentage change monitor. * [Coin Market Manager](https://www.coinmarketman.com) - Smart, accurate, Portfolio tracking. Realtime Breakeven and Profit Loss features. # ICO Trackers * [ICOtracker](https://icotracker.net) - Very informative and trusted tracker. * [The ICO digest](https://theicodigest.com) - Weekly ICO digest. * [TokenData](https://www.tokendata.io/) - See ICO stats: ROI, total investments, status and other information. * [CoinSchedule](https://www.coinschedule.com) - Live Token Sales & ICOs. * [ICO Bazaar](https://icobazaar.com) - Informative website + ICOs alerts. * [Picoloresearch](https://picoloresearch.com/) - Independent research on blockchain startups and ICOs. * [Smith + Crown ICO list](https://www.smithandcrown.com/icos/) - Curated list of ongoing and upcoming token sales. Have some research tiers. * [ICORating](https://icorating.com/) - ICOrating specializes in evaluating companies with planned ICO. * [ICO Alert](https://www.icoalert.com/) - Source for analysis of active and upcoming Initial Coin Offerings. * [TokenMarket](https://tokenmarket.net) - TokenMarket is marketplace for tokens, digital assets and blockchain based investing. * [ICOdrops](https://icodrops.com/) - Constantly updating kanban style ICO board. * [ICO Whitelists](https://icowhitelists.com) - Articles on ICOs. Also tracks growth of 200+ Telegram groups for ICOs. * [ICOAlarm](http://www.icoalarmapp.com/) - ICO discovery, analysis, and alerts crossplatform mobile application. * [ICO Toplist](https://icotoplist.com) - List, review and rate all ICOs: Past, Active and Upcoming ones. # Exchanges * [Local Bitcoins](https://localbitcoins.com/) - Buy and sell bitcoins near you. Trusted by 10M monthly users. * [Poloniex](https://www.poloniex.com/) - USA. Trust: 3.5/5. Tons of altcoins. Poor support. * [CoinBase](https://www.coinbase.com) - USA. Trust: 5/5. Pay with fiat. * [Kraken](https://www.kraken.com/) - USA. Trust: 5/5. Founded in 2011. * [Bittrex](https://www.bittrex.com) - USA. Trust: 3.8/5. Many altcoins. * [CEX.IO](https://cex.io/) - UK. Trust: 5/5. Fiat. Newbie friendly. * [BestBitcoinExchange](https://www.bestbitcoinexchange.io/) - Curated list of 35 popular exchanges. Looks SEOish but does the job well. * [Shapeshift](https://shapeshift.io) - No login, fast, awesome API. * [Changelly](https://changelly.com/) - Fiat, nice affiliate program. * [Cryptoradar](https://cryptoradar.co) - Compares prices and features from > 25 exchanges and brokers. * [Binance](https://www.binance.com) - Modern exchange with the lowest fees and it's own token. * [Kucoin](https://www.kucoin.com) - Modern. Evolving really fast. Has it's own token. * [Guarda Exchange](https://guarda.co/exchange) - Anonymous crypto exchange and wallet. * [DDEX](https://www.ddex.io/) - Decentralized, non-custodial token to token trading powered by 0xproject and Hydro. * [ForkDelta](https://forkdelta.app/) - One of the earliest and still most popular decentralized exchanges. * [ChangeNOW](https://changenow.io/) - Limitless and fast coin swaps free of custody. * [n.exchange](https://n.exchange/) - Open source non-custodial exchange with fiat, a great API and a non-custodial cross chain order book. # Communities ## Chats * [Crypto Aquarium](https://cryptoaquarium.com) - Great community (Telegram, Slack). Curated by Joshua Petty, the Coindex creator. 800+ members. * [Bitpam](https://discordapp.com/invite/VpPrGmF?ref=cryptominded) - Friendly Discord community. 300+ members. * [Bitcoin Core Community](https://t.me/BitcoinCore) - Telegram discussion about Bitcoin and Bitcoin Core. 2000+ members. * [Blockstack](https://docs.google.com/forms/d/e/1FAIpQLSed5Mnu0G5ZMJdWs6cTO_8sTJfUVfe1sYL6WFDcD51_XuQkZw/viewform) - Official Blockstack Slack community. 3000+ members. * [CryptoMinded](https://community.cryptominded.com/) - All things crypto: events, jobs, trades, news. 1000+ Slack members. * [IRC #bitcoin channel](https://webchat.freenode.net/?channels=bitcoin&uio=d4/) - Old good IRC. The channel of 200 silent people. ## Forums * [CryptoHeresy ⚡️](https://cryptoheresy.com) - Fresh Bitcoin forum with focus on cryptocurrency tools and resources. * [Bitcoin Talk](https://bitcoinTalk.org/) - Homepage of the Bitcoin community from the start. Made by Satoshi Nakamoto in 2009. * [Bitcoin.com Forum](https://forum.bitcoin.com/) - Strong community of 30,000+ users. * [BitcoinGarden](https://bitcoingarden.org) - This young forum has appeared in Jan 2017. * [CryptoCurrencyTalk](https://cryptocurrencytalk.com/) - Born in 2013, very active forum. Modern engine. * [Token Daily](https://www.tokendaily.co) - Crypto news, launches, white papers and Q&A with experts 📈 * [Stadivm](https://stadivm.com/) - Newborn cryptocurrency forum with a potential. ## Other * [Cryptocompare](https://www.cryptocompare.com) - CryptoCompare is interactive platform where you can discuss the latest crypto trends and monitor all markets streaming in real time. Also includes perfect altfoilio app. * [Trading View](https://www.tradingview.com/u/DLavrov/) - Follow pro traders and learn from their analyzes. (Mr. Lavrov is great specialist). * [Bitcoin on StackExchange](https://bitcoin.stackexchange.com/) - Question and answer site for Bitcoin crypto-currency enthusiasts. * [/r/Bitcoin/](https://www.reddit.com/r/Bitcoin/) - Discuss Bitcoin news on Reddit. 300,000+ readers. * [Steemit](https://steemit.com) - Fancy Reddit running on a blockchain. Post to earn $. Spend $ to promote yourself. * [Coinvision](https://www.coinvision.co/) - Get alerts about the most credible crypto coins and ICOs and also access private great community. ## Twitter Users and Lists * [Quality Crypto](https://twitter.com/followingell/lists/quality-crypto) - List of >50 prominent, high signal-to-noise-ratio accounts. # Jobs * [Coinality](https://coinality.com/) - Coinality is free service connecting crypto employers and job seekers. * [Cryptogrind](https://www.cryptogrind.com/) - Bitcoin freelance platform. * [Blockchain Dev Jobs](https://blockchaindevjobs.com/) - Curated list of jobs from around the web for blockchain engineers. * [Ethlance](https://ethlance.com) - Hire or work for ETH. * [/r/Jobs4Bitcoins/](https://www.reddit.com/r/Jobs4Bitcoins/) - Place on Reddit to offer your talents and skills in exchange for the fastest growing currency in the world. * [Crypto.jobs](https://crypto.jobs) - Well categorized jobs list. Owner does a lot to promote it. * [Beincrypto](https://beincrypto.com) - Aggregates all the crypto jobs from major job boards. * [Jobs by BlockRepublic](https://blockrepublic.io/blockchain-jobs/) - Useful filters, locations & categories. * [Crypto Jobs List](https://cryptojobslist.com/) - Curated jobs from top verified blockchain companies. # Wallets * [Bitcoin Core](https://bitcoin.org/en/download) - Bitcoin Core is MIT licensed open source Bitcoin wallet. It runs own full node so 145GG of free disk space is required. OSX/Linux/Windows/Ubuntu. * [Blockchain.info](https://blockchain.info/wallet/#/) - World’s most popular digital wallet. Mobile apps included. * [Electrum](https://electrum.org/#home) - Thin Bitcoin client. Opensource, MIT, has 100+ contributors. * [Exodus](https://www.exodus.io) - Exodus is the first desktop multi-asset wallet with ShapeShift built in. * [MyEtherWallet](https://www.myetherwallet.com) - Opensource webapp to access Ethereum. Old and reliable. ERC20 support. Loved by phishers! * [Coinomi](https://coinomi.com/) - Supports many altcoins, fast and has perfect UI ([closed source now](https://github.com/bitcoin-dot-org/bitcoin.org/issues/1622)). * [Jaxx](https://jaxx.io) - Reliable, Jaxx supports many of the leading cryptocurrency platforms. Crossplatform. * [Ledger Hardware](https://www.ledger.com/) - Reliable hardware wallet. Supports BTC/ETH/ETC/DASH/DOGE and many more coins and ERC20 tokens. * [Trezor Hardware](https://trezor.io) - The first & most secure hardware wallet. Supports BTC/ETH/ETC/DASH/ and many more coins and ERC20 tokens. * [CoinBase](https://www.coinbase.com/) - Buy Bitcoin for $, NFC payments, requested payments. * [MyCelium](https://wallet.mycelium.com) - Geeky wallet, easy to set miners fee, rich transaction details. * [Samourai](https://samouraiwallet.com/) - Secure Bitcoin wallet for Android. * [WalletList](https://walletlist.me) - Showcase your public cryptocurrency addresses. * [WalletGenerator.net](https://walletgenerator.net) - Universal JavaScript client-side wallet generator for 100+ coins. # Altfolio * [Blockfolio](https://blockfolio.com/) - Cryptocurrency management, with easy to use tools to keep track of all your cryptocurrency investments. Nice widgets. Simple. Android/iOS. * [ACrypto](https://acrypto.io/) - Track bitcoin and altcoins prices, custom alarms, detailed charts. Flexible, many settings, informative. Available for iOS & Android. * [Altpocket](https://varrock.altpocket.io/) - The only tool you need for showcasing, tracking and sharing your cryptocurrency investments. * [Coinfyi](https://coin.fyi) - Track your performance, news & market signals related to your cryptocurrency investments. Anonymous. Simple. Free. * [f0lio](https://f0l.io) - Beatutiful cryptocurrency portfolio management for mobile devices. * [BitWorth](https://www.bitworth.app/) - Cryptocurrency Net Worth Tracker for iOS. * [CoinDex](https://itunes.apple.com/us/app/coindex/id1251487103) - iOS app that lets you stay up to date with the cryptocurrency markets you want to watch. * [Delta](https://delta.app/) - Ultimate cryptocurrency portfolio tracker tool for iOS & Android. * [Crypto Central](https://cryptocentral.ai) - Bitcoin & cryptocurrency portfolio tracker for iOS/Android. * [Cryptagon](https://cryptagon.io) - Powerful app to track portfolio. Automatic imports from exchanges. * [Cryptonomy](https://www.cryptonomynow.com/) - Portfolio tracking, social, forum, chat, ico listings, news aggregator, crypto academy. Android/iOS. * [wallmine](https://wallmine.com/stocks-and-cryptocurrency-portfolio-tracker) - Track both cryptocurrencies and stocks; screeners, heatmaps, news, push notifications. * [CoinTracker](https://www.cointracker.io) - Cryptocurrency asset tracker that automatically pulls all balances and transactions from exchanges and cryptocurrency wallets. * [Coin Beat](http://www.coinbeatapp.com/) - Crypto tracker for managing over 1300 crypto currencies. Get instant push notification on price activity. iOS and Android. # Useful Tools * [QR Code Generator](https://bitcoinqrcodegenerator.win/) - With this free tool you can instantly generate QR code for your Bitcoin/Litecoin/Ethereum/Dogecoin address. * [Block Explorer](https://tradeblock.com/bitcoin/) - Discover the Bitcoin blockchain blocks online. Includes fees and miners information. * [EtherScan](https://etherscan.io) - Block Explorer and Analytics Platform for Ethereum. * [ETH Gas Station](https://ethgasstation.info) - Consumer oriented metrics for the Ethereum Gas Market. * [Metamask](https://metamask.io/) - Run Ethereum dApps right in your browser without running full node. * [ATM Map](https://bitcoinatmmap.com/) - Find Bitcoin ATM’s in your country. * [Statoshi](https://statoshi.info) - Realtime Bitcoin node stats. Made by Jameson Lopp. * [RSIhunter](https://rsihunter.com/) - Find "oversold" and "overbought" cryptocurrencies. * [CryptoFinance](https://cryptofinance.ai/) - Google Sheets add-on to get cryptocurrencies rate in spreadsheets. * [Vanitygen Plus](https://github.com/exploitagency/vanitygen-plus) - Generate custom key addresses for 90+ coins. * [CoinPop.me](https://coinpop.me/) - Create shareable page for all your cryptocurrency donation addresses. * [If You Had Bought Crypto](https://ifyouhadboughtcrypto.com) - How rich would you be if you had invested in your favourite Cryptocurrency? * [Vaulty.io](https://vaulty.io) - Accept any cryptocurrency for your website, blog, or for general personal use with just one link. * [Bitcoin Flip Trading simulator](https://bitcoinflip.app/) - 101% realistic and fun crypto trading Simulator for Beginners! * [QWallet](https://qwallet.io/) - Search & view the value of any Ethereum wallet, create your own token portfolio. * [Ethplorer](https://ethplorer.io) - Block explorer and analytics platform for Ethereum. * [EtherChain](https://etherchain.org) - Ethereum Blockchain Explorer. * [Trivial.co](https://trivial.co) - Network explorer and analytics platform for Ethereum and ERC-20 tokens. * [HappyDApps](https://happydapps.net) - Web 3.0 browser compatibility check. # Video ## YouTube Channels * [The Cryptoverse](https://www.youtube.com/channel/UCLnQ34ZBSjy2JQjeRudFEDw) - Your cryptocurrency news dose. * [World Crypto Network](https://www.youtube.com/user/WorldCryptoNetwork) - Informative news digests. * [Crypt0](https://www.youtube.com/user/obham001) - Omar is one of the most popular crypto bloggers. He creates fascinating interviews. * [Ameer Rosic](https://www.youtube.com/user/AmeerRosic) - News, interviews, podcasts and reviews. * [aantonop](https://www.youtube.com/user/aantonop/) - Presentations, discussions, QA by Andreas, the author of "Mastering Bitcoin". * [CoinSummit](https://www.youtube.com/channel/UCr4QRCZDXrCecaV2w4nuLeQ/) - CoinSummit records: startups showcases, discussions and presentations. * [BitcoinFilm](https://www.youtube.com/channel/UC42Y8ajCzQ_rjS_wVTamglQ) - Short films about people using Bitcoin. * [Bitcoin and Cryptocurrency Course](https://www.youtube.com/channel/UCNcSSleedtfyDuhBvOQzFzQ/videos) - Bitcoin and Cryptocurrency Technologies course. 12 videos, each 45-90 mins. * [CryptoPortfolio](https://www.youtube.com/channel/UCI9POyyP-f93JHfkhr2ma2g/) - YouTube channel reviewing ICOs and various cryptocurrencies. * [CryptoBud](https://www.youtube.com/channel/UCAEktd4wejD_N4aPyDPD3zw) - Technical and fundamental analysis on how to invest in cryptocurrencies. * [Cryptotips](https://www.youtube.com/cryptotips) - Heidi provides you with insights into projects, ICOs and ecosystem, as well as creating videos for beginners. * [EtherCasts](https://www.youtube.com/user/EtherCasts) - Ancient Ethereum news, reviews and interviews channel. * [Bitcoin Playlist](https://www.youtube.com/playlist?list=PL05dEp7goGNiKWYdiE4nurEPFMmF9XpzF) - Great list of 55 Bitcoin talks. * [Decentralized TV](https://www.youtube.com/channel/UCueLJ4vLHTwMpYILmdBjRlg) - Blockchain, Bitcoin, and Cryptocurrency News, Culture, and Entertainment. * [Crypto Daily](https://www.youtube.com/channel/UC67AEEecqFEc92nVvcqKdhA/) - Crypto news on (mostly) daily basis. ## Movies * [Ulterior States](http://www.iamsatoshi.com/) - Real-life conversations with some thought leaders within the Bitcoin ecosystem. The film took 3 years to complete. * [The Bitcoin Doco](https://vimeo.com/112223859) - Fascinating story focusing on the emergence of new world wide currency. * [Life Inside Secret Chinese Bitcoin Mine](https://www.youtube.com/watch?v=K8kua5B5K3I) - Interesting story about the miners of the new millenium. # Learning ## Books * [Mastering Bitcoin](https://bitcoinbook.info/) - Mostly for developers. The second edition was published in June 2017. * [The Internet of Money](https://www.amazon.com/Internet-Money-Andreas-M-Antonopoulos/dp/1537000454) - Significance of bitcoin through series of essays spanning the exhilarating maturation of this technology. * [Ethereum](https://www.amazon.com/Ethereum-Blockchains-Decentralized-Autonomous-Organizations/dp/1523930470) - Non-technical guide to understand blockchains. Mostly focused on Ethereum. * [The Age of Cryptocurrency](https://www.amazon.com/Age-Cryptocurrency-Blockchain-Challenging-Economic/dp/1250081556) - Insight into the modern financial system and the Bitcoin industry. * [Programming Cryptocurrencies and Blockchains](http://yukimotopress.github.io/blockchains) - Learn to build your own blockchains and peer-to-peer central bank nodes from scratch. ## Courses * [Coursera Course](https://www.coursera.org/learn/cryptocurrency) - Telling what is special about Bitcoin and how it works at technical level. Created by Princeton University. * [Udemy Course](https://www.udemy.com/bitcoin-or-how-i-learned-to-stop-worrying-and-love-crypto) - The definitive guide to understand what the bitcoin is and why we should care about them. * [Khan's Academy Course](https://www.khanacademy.org/economics-finance-domain/core-finance/money-and-banking/bitcoin/v/bitcoin-what-is-it) - The very basics of how blockchain, Bitcoin and encryption works. * [Pluralsight Course](https://www.pluralsight.com/courses/bitcoin-decentralized-technology) - Introduction to Bitcoin and decentralized technology for beginners. * [University of Nicosia MOOC](https://digitalcurrency.unic.ac.cy/free-introductory-mooc/) - University of Nicosia´s free MOOC (Massive Open Online Course) DFIN-511: Introduction to Digital Currencies. ## Other * [CoinPride Newsletter](https://coinpride.com/) - The most important crypto news and events. One handcrafted email per week. * [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page) - Technical specifications of the protocol as well as more basic information about how to buy, sell or use bitcoins. * [Blockchain Demo](https://blockchaindemo.io/) - This interactive demo will guide you through each component of blockchain step-by-step. * [MyCryptoGuide](https://mycrypto.guide/) - The guide is meant to serve as both easy-to-understand introduction to the world of cryptocurrencies. * [Bad Bitcoin](https://www.badbitcoin.org) - List of known scams, HYIPs and Ponzi schemes. * [EthList](https://github.com/Scanate/EthList) - The Crowdsourced Ethereum Reading List. * [Satoshi Nakamoto WhitePaper](https://bitcoin.org/bitcoin.pdf) - Bitcoin fundamentals described by the creator. * [Bitcoin Developer Docs](https://bitcoin.org/en/developer-guide) - Detailed information about the Bitcoin protocol and related specifications. * [Bitcoin Forks](https://mapofcoins.com/bitcoin) - All bitcoin forks visualisation. * [Coin Demo](https://coindemo.io) - Visual demonstration of how bitcoin transactions work. * [Rhymes With Fiat](https://www.rhymeswithfiat.com) - Bitcoin webcomic (with educational notes). * [Whitepaper.io](https://whitepaper.io) - All whitepapers in one place. # Trading Tools * [Quadency](https://quadency.com) - Crypto trading and real-time portfolio analytics. # For Developers ## API * [Shapeshift](https://docs.shapeshift.io/) - Embed exchange in your app. Trusted by hundreds of apps. * [Bittrex](https://bittrex.github.io) - Almighty API. You can do anything with it. * [Poloniex](https://docs.poloniex.com) - The biggest exchange API. PHP and Python wrapper. * [CryptoWatch](https://cryptowat.ch/docs/api) - Public REST API, providing basic information about all markets on Cryptowatch. * [Microsoft BaaS](https://azure.microsoft.com/en-in/solutions/blockchain/) - Blockchain as Service (BaaS) from Microsoft Azure. * [CoinMarketCap](https://coinmarketcap.com/api/) - Powerful JSON API covering 1000+ coins. Limit: 1 request per 6 sec. * [CoinCap](https://docs.coincap.io/) - Simple and informative. Lots of altcoins. History data. No limits. * [ChangeNOW](https://changenow.io/api/docs) - Easy integration of the cryptocurrency exchange. Limitless and fast coin swaps free of custody. ## Other * [Bitpay](https://bitpay.com/) - Use BitPay's retail, ecommerce, billing, and donation tools to accept payments. * [Gekko](https://github.com/askmike/gekko) - Free and open source trading bot. GUI, CLI, NodeJS, nice docs. 18 exchanges (including Bitfinex, Bitstamp and Poloniex). * [Zenbot](https://github.com/DeviaVir/zenbot) - Free and open source trading bot. CLI, NodeJS. GDAX, Poloniex, Kraken, Bittrex, Quadriga and Gemini. * [Web3.js](https://github.com/ethereum/web3.js) - Ethereum JS API. Requires nodejs, npm and running node. * [OpenZeppelin](https://openzeppelin.org) - OpenZeppelin is open framework of reusable and secure smart contracts in the Solidity language. 1500+ Slack community members. * [GETH](https://www.ethereum.org/cli) - CLI tools for Ethereum. Python, C++, Go implementations. * [Embark](https://github.com/iurimatias/embark-framework) - Framework for serverless Decentralized Applications using Ethereum, IPFS and other platforms. JS. * [Truffle](http://truffleframework.com/) - The most popular framework for Ethereum. JS. * [Ropsten Ethereum Faucet](http://faucet.bitfwd.xyz/) - Instantly get ether to experiment on the Ropsten testnet. * [Kovan Ethereum Faucet](https://gitter.im/kovan-testnet) - Instantly get ether to experiment on the Kovan testnet. * [CCXT](https://github.com/ccxt/ccxt) - JS/Python/PHP library for cryptocurrency trading and e-commerce with support for many exchanges and merchant APIs. * [QuikNode](https://quiknode.io/) - Cloud-hosted Ethereum nodes for developers and investors. * [Consensys Academy](https://consensys.net/academy/resources/) - Getting started resources by Consensys. * [Portis](https://portis.io/) - JavaScript SDK that lets people run your Ethereum DApp in the browser, using the same account on all their devices. # Podcasts (Updated October, 2019) * [Epicenter](https://epicenter.tv/) - The Podcast at the Forefront of the Decentralized Technology Revolution. * [Bitcoin Knowledge](http://www.bitcoin.kn/) - Learn about blockchain and fintech. * [BlockChannel](https://soundcloud.com/blockchannelshow) - Dedicated to educating the world on the power of blockchain based technologies like Bitcoin, Ethereum, and ZCash. * [Off The Chain] (https://blockworksgroup.io/off-the-chain-podcast) - Host Anthony “Pomp” Pompliano talks to some of the most respected names in crypto and Wall Street to find out how intelligent investors from the new and old financial system are thinking about digital assets. * [Unchained: Your No-Hype Resource for All Things Crypto] (https://unchainedpodcast.com) - This weekly, hour-long podcast with host Laura Shin dives deep into the people building the decentralized internet, the details of this technology that could underpin our future, and some of the thorniest topics in crypto, such as regulation, security and privacy. * [What Grinds My Gears] (https://blockworksgroup.io/what-grinds-my-gears-podcast) - From Meltem Demirors and Jill Carlson, What Grinds My Gears is a podcast about the bizarre and buzzworthy happenings in the world of cryptocurrency. Each week, they delve into one key theme in crypto, and examine this theme through a broader financial, political, and cultural lens * [What Bitcoin Did] (https://www.whatbitcoindid.com/podcast) - In this podcast you will hear host Peter McCormack speak with crypto traders, miners, venture capitalist, investors, technical developers, CEOs, journalist and other people driving forward the growth of Bitcoin and other cryptocurrencies. * [Untold Stories with Charlie Shrem] (https://blockworksgroup.io/untold-stories-podcast) - Host Charlie Shrem dives deep into the lives and personal histories of some of crypto’s most influential leaders. * [Tales From The Crypt] (https://anchor.fm/tales-from-the-crypt) - Tales from the Crypt is a podcast hosted by Marty Bent about Bitcoin. Join Marty, Editor in Chief of "the best newsletter in crypto", as he sits down to discuss Bitcoin with interesting people. * [The Token Daily with Soona Amhaz] (https://blockworksgroup.io/the-token-daily-podcast) - Host soona amhaz sits down with the movers and shakers of the crypto industry to discuss the big ideas they spend their days thinking about. Soona and her guests examine everything from industry trends, to what books they’re reading, to human psychology and investing. * [The Flippening] (https://blog.nomics.com/category/flippening/) - Flippening is for cryptocurrency investors. Each week host Clay Collins discusses the cryptocurrency economy, new investment strategies for maximizing returns, and stories from the front lines of financial disruption. * [The Chain Reaction Podcast] (https://fiftyonepercent.podbean.com) - Host Tom Shaughnessy of Delphi Digital converses with the top names in crypto and blockchain. * [Unconfirmed: Insights and Analysis From the Top Minds in Crypto] (https://unchainedpodcast.com/category/unconfirmed/) - This weekly crypto podcast reveals how the marquee names in crypto are reacting to the week’s top headlines. With host Laura Shin, the guests also discuss what they’re thinking about these days and reveal what they believe is on the horizon in crypto * [The Unhashed Podcast] (https://www.spreaker.com/show/the-unhashed-podcast-bitcoin-blockchain-) - Unhashed breaks down the latest in Bitcoin news and developments and puts them into terms everyone can understand. Expect to be both entertained and educated about cryptocurrencies and blockchain. * [The Scoop] (https://www.theblockcrypto.com/the-scoop-podcast) - The Block’s team, led by Frank Chaparro, draw out the freshest and deepest insights about digital assets from traditional Wall Street, crypto native, Fortune 500 and many other crypto ecosystem leaders. * [Base Layer] (https://acrabaselayer.podbean.com) - Base Layer with host David Nage will be providing insights from founders and investors in the base layer of cryptoassets. * [Blockchain Innovation: Interviewing The Brightest Minds In Blockchain] (https://blockchain.global/blockchain-innovation/) - Blockchain Innovation is where host Frederick Munawa interviews the brightest minds in Blockchain and cryptocurrency — entrepreneurs, executives, and top academics — to discuss present and future applications of Blockchain Technology. * [Blockchain Insider] (https://bi.11fs.com/) - Blockchain Insider, hosted by Simon Taylor and Colin Platt is a dedicated podcast specializing in Bitcoin, Blockchain and distributed ledger technology (DLT). Simon and Colin break down the week’s news with expertise and enthusiasm for the blockchain and digital currency sector. * [Let’s Talk Crypto] (https://schoolofcrypto.com) - Let’s Talk Crypto with Barry Moore and Tom Galeski breaks it all down in easy to understand terms and helps you “learn and earn” in the age of cryptocurrencies. * [Blockchain 2025] (https://podcast.bitcoin.com/s9-Blockchain-2025) - Blockchain is a technology that will disrupt nearly every industry. Host Matt Aaron and Blake Moore explore one industry in every episode. * [IBM Blockchain Pulse] (https://www.ibm.com/blogs/blockchain/category/podcast) - Host and blockchain-evangelist Matt Hooper engages with the planet’s most dynamic blockchain thought-leaders, explorers and innovators to discover the countless new ways blockchain is leaping from theory to reality: From entertainment to identity, from payments to secure supply-chain transparency. * [Messari’s Unqualified Opinions] (https://blockworksgroup.io/unqualified-opinions) - Unqualified Opinions is a podcast hosted by Messari’s CEO Ryan Selkis featuring candid, fast-paced interviews with crypto’s top builders and investors. * [The Bitcoin Podcast Network] (https://thebitcoinpodcast.com/category/podcast) - One of the ‘originals’ and hands-down one of the best sources of information on the crypto market available online today. * [Crypto Street Podcast] (https://cryptostreetpod.podbean.com) - The Crypto Street Podcast is a cryptocurrency podcast hosted by the three Twitter influencers @K1llerWh4le, @13Prince31 and @CryptoDale. With a lot of humor, they address current market trends mixed with opinion-based discussions on the crypto-ecosystem. * [Ledger Cast] (https://ledgerstatus.com/topic/ledgercast/) - Ledger Cast covers the cryptocurrency industry, including technical and trading analysis, fundamental analysis, and anything else crypto and blockchain related. The podcast is initiated by Ledger Status (@ledgerstatus) who is known for his in-depth technical analysis of cryptoassets. # Mining * [CoinWarz](https://www.coinwarz.com) - Mining profitability calculators. Help choosing perfect coin to mine. * [WhatToMine?](https://whattomine.com) - Find the most profitable cryptocurrencies to mine. * [Bitcoin Difficulty](https://bitcoinwisdom.com/bitcoin/difficulty) - Realtime Mining Statistics. * [Mining pools](https://blockchain.info/pools) - Mining pool hashrate distribution. * [WhatIsMyHashRate?](http://www.whatismyhashrate.com/) - Measure your browser's hashrate. * [CoinHive](https://coinhive.com/) - Install JS miner on your website. * [bfgminer](https://github.com/luke-jr/bfgminer) - Multi-threaded miner for ASICs built in C. # Games * [CryptoKitties](https://www.cryptokitties.co/) - Collect, breed and trade rare kitties in one of the world's first blockchain games. # Sponsors [<img src="https://raw.githubusercontent.com/coinpride/CryptoList/master/sponsors/findbitcoinatm_sponsor_logo.png">](https://www.findbitcoinatm.com.au/) [<img height="70" src="https://raw.githubusercontent.com/coinpride/CryptoList/master/sponsors/crypto_weekly_list.png">](https://cryptoweekly.co/list/?ref=coinpride) [<img width="240" src="https://raw.githubusercontent.com/coinpride/CryptoList/master/sponsors/quadency.jpg">](https://quadency.com/?utm_source=GitHubCL&utm_medium=Sponsorship&utm_campaign=CryptoList) # Contribute Found a nice link? Noticed a bug? Feel free to contribute! You are so much welcome! But read the [CONTRIBUTING.md](https://github.com/coinpride/CryptoList/blob/master/CONTRIBUTING.md) first. # License <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.

:books: A collection of useful resources for building RESTful HTTP+JSON APIs.

# HTTP API Development Tools ## Introduction This is a collection of useful resources for building RESTful HTTP+JSON APIs. There are a lot of good tools and entire ecosystems out there! It can be overwhelming not knowing what options are available, so you can use this as a reference starting point. Contributions are most welcome. Categories are also open to suggestions! ## Table of Contents * [API Specification Languages](#api-specification-languages) * [API Specification Tools](#api-specification-tools) * [API Specifications](#api-specifications) * [API Frameworks](#api-frameworks) * [API Client Development Tools](#api-client-development-tools) * [API Documentation](#api-documentation) * [API Clients](#api-clients) * [API Debugging and Mocking](#api-debugging-and-mocking) * [API Design Guides](#api-design-guides) * [API Publishing](#api-publishing) * [API Gateways](#api-gateways) * [API Security](#api-security) * [API Monitoring](#api-monitoring) * [API Testing](#api-testing) * [API Developer Portal](#api-developer-portal) * [JSON Format Standards](#json-format-standards) * [Learning Resources](#learning-resources) * [Blogs](#blogs) * [References](#references) ## API Specification Languages - [OpenAPI (formerly known as Swagger)](https://github.com/OAI/OpenAPI-Specification) - [API Blueprint](https://github.com/apiaryio/api-blueprint) - [JSON Schema](http://json-schema.org/) - [RAML](https://raml.org/) ## API Specification Tools - [Swagger Inspector](https://swagger.io/tools/swagger-inspector/): Test and auto-generate OpenAPI documentation for any API. - [Swagger Editor](http://editor.swagger.io/): An editor for designing Swagger specifications. - [Swagger Tools and Integrations](https://swagger.io/open-source-integrations/): A list of libraries and frameworks serving the Swagger ecosystem. - [OpenAPI extension for VS Code](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi): Visual Studio Code (VS Code) extension that provides support for the OpenAPI Specification. - [OpenAPI plugin for JetBrains IDEs](https://plugins.jetbrains.com/plugin/14837-openapi-swagger-editor): Jetbrains plugin that provides support for the OpenAPI Specification. - [Dredd](https://github.com/apiaryio/dredd): Validate API documentation written in API Blueprint against its backend implementation. - [API Spec Converter](https://lucybot-inc.github.io/api-spec-converter/): Convert between different API spec formats. - [Apimatic](https://www.apimatic.io/): Supports API description formats including Swagger, OAI format, RAML, API Blueprint, IO Docs, WADL, Postman Collections and HAR 1.4 and more - [OpenAPI Definition Designer](https://openapidesigner.com): Free visual OpenAPI3 definition creation and editing tool. - [Stoplight Studio](https://stoplight.io/studio/): Create, prototype, and share OpenAPI descriptions and JSON Schemas using a visual editor. - [Spectral](https://github.com/stoplightio/spectral): Define rulesets to lint YAML or JSON, including OpenAPI 2.x, 3.x and AsyncAPI ## API Specifications - [API Commons](http://apicommons.org/): A repository of language-agnostic API specifications / Data Models. - [APIS.guru](https://apis.guru/openapi-directory/): Directory of API specs in OpenAPI(aka Swagger) 2.0 format. - [AnyAPI](https://any-api.com/): Documentation and Test Consoles for Public APIs. ## API Frameworks ### Ruby - [rails-api](https://github.com/rails-api/rails-api): Rails for API only applications. - [pliny](https://github.com/interagent/pliny): Opinionated template Sinatra app for writing APIs in Ruby. - [grape](https://github.com/ruby-grape/grape): An opinionated micro-framework for creating REST-like APIs in Ruby. - [ActiveModel::Serializer](https://github.com/rails-api/active_model_serializers): Brings convention over configuration to your JSON generation. - [rabl](https://github.com/nesquena/rabl): Generate JSON and XML from any ruby object. - [jbuilder](https://github.com/rails/jbuilder): Create JSON structures via a Builder-style DSL. - [roar](https://github.com/trailblazer/roar): Parse and render REST API documents using representers. ### Python - [Django REST framework](http://www.django-rest-framework.org/): Toolkit that makes it easy to build Web APIs. - [Tastypie](https://github.com/django-tastypie/django-tastypie): Webservice API framework for Django. - [restless](https://github.com/toastdriven/restless): A lightweight REST miniframework for Python. - [flask-restful](https://github.com/flask-restful/flask-restful): Simple framework for creating REST APIs. - [Falcon](https://github.com/falconry/falcon): Falcon is a low-level, high-performance Python framework for building HTTP APIs, app backends, and higher-level frameworks. - [Connexion](https://github.com/zalando/connexion): Swagger/OpenAPI First framework for Python on top of Flask with automatic endpoint validation and OAuth2 support - [apistar](https://github.com/encode/apistar): A smart Web API framework, designed for Python3. - [sanic](https://github.com/channelcat/sanic): Sanic is a Flask-like Python 3.5+ web server that's written to go fast. - [hug](https://github.com/timothycrosley/hug): hug aims to make developing Python driven APIs as simple as possible, but no simpler. - [FastAPI](https://github.com/tiangolo/fastapi): FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints. ### Javascript - [hapi.js](https://hapijs.com/): Web and services application framework for Node.js. - [Restify](https://github.com/restify/node-restify): Node.js REST framework specifically meant for web service APIs. - [Express](https://expressjs.com/): Fast, unopinionated, minimalist web framework for Node.js. - [sailsjs](http://sailsjs.org/): Realtime MVC Framework for Node.js. - [Actionhero](https://www.actionherojs.com/): Multi-transport Node.js API server with integrated cluster capabilities and delayed tasks. - [Baucis](https://github.com/wprl/baucis): To build - [Koa](http://koajs.com/): Next generation web framework for Node.js - [Loopback](http://loopback.io/): Node.js framework for creating APIs and easily connecting to backend data sources. - [Seneca](http://senecajs.org/): A microservices toolkit for Node.js. - [Feathers](https://feathersjs.com/): Build RESTful and real-time APIs through Socket.io or Primus. - [Deployd](https://github.com/deployd/deployd): Deployd is the simplest way to build realtime APIs for web and mobile apps - [Nest](https://github.com/kamilmysliwiec/nest): A modern node.js framework for efficient and scalable web applications built on top of TypeScript ### Go - [Go-Json-Rest](https://github.com/ant0ine/go-json-rest): Thin layer on top of `net/http` that helps building RESTful APIs easily - [gocrud](https://github.com/manishrjain/gocrud): Go library to simplify creating, updating and deleting arbitrary depth structured data — to make building REST services fast and easy. - [sleepy](https://github.com/dougblack/sleepy): RESTful micro-framework written in Go. - [restit](https://github.com/go-restit/restit): Go micro framework to help writing RESTful API integration test. - [go-relax](https://github.com/codehack/go-relax): Framework of pluggable components to build RESTful API's. - [go-rest](https://github.com/ungerik/go-rest): Small and evil REST framework for Go. - [go-restful](https://github.com/emicklei/go-restful): A declarative highly readable framework for building restful API's. - [Goat](https://github.com/bahlo/goat): Minimalistic REST API server in Go. - [Resoursea](https://github.com/resoursea/api): REST framework for quickly writing resource based services. - [Zerver](https://github.com/cosiner/zerver): Zerver is a expressive, modular, feature completed RESTful framework. - [Fiber](https://github.com/gofiber/fiber): :zap:Fiber is an Express inspired web framework written in Go with :coffee: . ### Scala - [Colossus](https://github.com/tumblr/colossus): I/O and microservice library for Scala. - [Finatra](https://twitter.github.io/finatra/): Fast, testable, Scala HTTP services built on Twitter-Server and Finagle. - [Play](https://www.playframework.com/): The high velocity web framework for Java and Scala. - [Scalatra](http://www.scalatra.org/): Simple, accessible and free web micro-framework. - [Skinny Micro](https://github.com/skinny-framework/skinny-micro): Micro-web framework to build servlet applications in Scala. - [Spray](http://spray.io/): Open-source toolkit for building REST/HTTP-based integration layers on top of Scala and Akka. - [Akka HTTP](https://github.com/akka/akka-http): The Akka HTTP modules implement a full server- and client-side HTTP stack on top of akka-actor and akka-stream. - [Swagger Akka HTTP](https://github.com/swagger-akka-http/swagger-akka-http): Swagger-Akka-Http brings Swagger support for Akka-Http Apis. ### Java - [Rest.li](http://rest.li/): REST framework using type-safe bindings and asynchronous, non-blocking IO. - [Dropwizard](https://www.dropwizard.io/en/latest/): Framework for developing ops-friendly, high-performance, RESTful web services. - [Jersey](https://jersey.java.net/): RESTful web services in Java. - [Spring Boot](https://projects.spring.io/spring-boot/): RESTful Web Service using Spring, high-performance and little configuration needed. - [Metamug Mason](https://github.com/metamug/mason): Create REST APIs with JSP tags and SQL. Edit and hot deploy REST resources on the server. ### Haskell - [Scotty](https://github.com/scotty-web/scotty): Micro web framework inspired by Ruby's Sinatra, using WAI and Warp. - [Spock](https://github.com/agrafix/Spock): Another Haskell web framework for rapid development. - [Servant](https://github.com/haskell-servant/servant): A Type-Level Web DSL. - [Yesod](https://github.com/yesodweb/yesod): The Haskell RESTful web framework. ### Elixir - [Phoenix](http://phoenixframework.org/): Framework for building HTML5 apps, API backends and distributed systems. - [Plug](https://github.com/elixir-plug/plug): A specification and conveniences for composable modules between web applications. ### Erlang - [Cowboy](https://github.com/ninenines/cowboy): Small, fast, modular HTTP server written in Erlang. - [Gen Microservice](https://github.com/videlalvaro/gen_microservice): This library solves the problem of implementing microservices with Erlang. - [Mochiweb](https://github.com/mochi/mochiweb): Erlang library for building lightweight HTTP servers. ### Postgres - [PostgREST](https://github.com/begriffs/postgrest): Serve a RESTful API from any existing PostgreSQL database. - [pREST](https://github.com/prest/prest): pREST is a way to serve a RESTful API from any databases written in Go. ### MySQL - [xmysql](https://github.com/o1lab/xmysql): Generate REST APIs for any MySQL Database. ### PHP - [API Platform](https://github.com/api-platform/api-platform): API framework on top of Symfony with JSON-LD, Schema.org and Hydra support - [Dingo API](https://github.com/dingo/api): A RESTful API package for the Laravel and Lumen frameworks - [Fractal](https://github.com/thephpleague/fractal): Fractal provides a presentation and transformation layer for complex data output, the like found in RESTful APIs, and works really well with JSON - [Yii2 Framework](https://github.com/yiisoft/yii2): Provides a whole set of tools to simplify the task of implementing RESTful Web Service APIs ### R - [Plumber](https://www.rplumber.io/): API Framework to build APIs for simple R Functions ### C# - [ASP.NET Web APIs](https://dotnet.microsoft.com/en-us/apps/aspnet/apis): Build secure REST APIs on any platform with C# ### Miscellaneous - [Dream Factory](https://github.com/dreamfactorysoftware/dreamfactory): Turn any database into an API platform. ## API Client Development Tools ### General - [Swagger CodeGen](https://github.com/swagger-api/swagger-codegen): Generate client libraries automatically from a Swagger-compliant server. - [AutoRest](https://github.com/Azure/autorest): Generate client libraries for RESTful web services - [OpenAPI Generator](https://github.com/openapitools/openapi-generator): A community fork of Swagger Codegen to automatically generate API clients, server stubs and documentation for REST APIs given an OpenAPI/Swagger spec. ### Ruby - [Net::HTTP](https://apidock.com/ruby/Net/HTTP): An HTTP client API for Ruby. - [faraday](https://github.com/lostisland/faraday): Simple, but flexible HTTP client library, with support for multiple backends. - [rest-client](https://github.com/rest-client/rest-client): Simple HTTP and REST client for Ruby - [heroics](https://github.com/interagent/heroics): Ruby HTTP client for APIs represented with JSON schema. - [blanket](https://github.com/inf0rmer/blanket): A Ruby API wrapper. - [nestful](https://github.com/maccman/nestful): Ruby HTTP/REST client. ### Java - [Retrofit](https://square.github.io/retrofit/): A type-safe HTTP client for Android and Java. ### Javascript - [Restangular](https://github.com/mgonto/restangular): Restangular is an AngularJS service that simplifies common GET, POST, DELETE, and UPDATE requests with a minimum of client code ### .NET - [Refit](https://github.com/paulcbetts/refit): The automatic type-safe REST library for .NET Core, Xamarin and .NET - [WebAnchor](https://github.com/mattiasnordqvist/Web-Anchor): Web Anchor provides type-safe, testable and flexible access to web resources. ### .Dart - [Frog](https://dartfrog.vgv.dev/docs/overview): Dart Frog is built on top of shelf and mason and is inspired by many tools including remix.run, next.js, and express.js. - [Serverpod](https://github.com/serverpod/serverpod): Serverpod is a next-generation app and web server, built for the Flutter community. It allows you to write your server-side code in Dart, automatically generate your APIs, and hook up your database with minimal effort. Serverpod is open-source, and you can host your server anywhere. ## API Documentation - [ReDoc](https://github.com/Rebilly/ReDoc): OpenAPI/Swagger-generated API Reference Documentation. - [Swagger UI](https://github.com/swagger-api/swagger-ui): Dynamically generate documentation from a Swagger-compliant API. - [Slate](https://github.com/lord/slate): Static site generated documentation for your API. - [DeveloperHub](https://developerhub.io/): Documentation tool to write, publish, review, analyse and collect feedback on personalised customer-facing API docs. - [prmd](https://github.com/interagent/prmd): JSON Schema tooling: scaffold, verify, and generate documentation from JSON Schema documents. - [Aglio](https://github.com/danielgtaylor/aglio): An API Blueprint renderer with theme support that outputs static HTML. - [Apiary](https://apiary.io/): Collaborative design, instant API mock, generated documentation, integrated code samples, debugging and automated testing. - [Readme](https://readme.io/): API Documentation Hosting. - [API Docs](https://api-docs.io/): Hosted public API documentation for OAS (Swagger) and RAML specs. - [Docbox](https://github.com/tmcw/docbox): REST API documentation generator, using Markdown. - [widdershins](https://github.com/Mermade/widdershins): REST API documentation generator from OpenAPI 3.0 / Swagger 2.0 / AsyncAPI 1.x / Semoasa 0.1.0 definition - [Elements](https://github.com/stoplightio/elements): Web Components-based API documentation for OpenAPI 3.x/2.x ## API Clients ### Open Source - [Hoppscotch](https://github.com/hoppscotch/hoppscotch): API client for REST, GraphQL, Websocket, SSE, Socket.IO and MQTT ### Hosted - [JSON Generator](http://www.json-generator.com/): Generate and host mock JSON data. ### Desktop - [Postman](https://www.getpostman.com): Desktop API testing tool. - [Firecamp](https://firecamp.app): API Studio for WebSocket, Rest API and GraphQL. - [HTTPie](https://httpie.org/): Command line HTTP client. - [Paw](https://paw.cloud/): REST client for Mac. - [Insomnia](https://insomnia.rest/): REST API client for Mac, Windows, and Linux. - [httpy](https://github.com/knid/httpy): Programmable Command line HTTP client. ## API Debugging and Mocking ### Hosted - [Beeceptor](https://beeceptor.com): An HTTP-proxy for rest APIs - inspect and build mock APIs. - [MockBin](https://mockbin.com/): Generate mock HTTP endpoints. - [httpbin](http://httpbin.org): Templated responses for testing various scenarios for HTTP requests. - [Prism](https://github.com/stoplightio/prism): a set of packages for API mocking and contract testing with OpenAPI v2 (formerly known as Swagger) and OpenAPI v3.x, including mock servers and a validation proxy. - [MockingCloud](https://mockingcloud.com): Generate full mock REST APIs with just OpenAPI yaml/json spec files. - [Svix Play](https://www.svix.com/play/): Easily inspect, test, and debug incoming webhooks. ### Desktop - [Postman](https://www.getpostman.com/docs/postman/mock_servers/setting_up_mock): Desktop API client and mocking tool. - [Json-Server](https://github.com/typicode/json-server) Full fake REST API with zero coding. - [Mockoon](https://mockoon.com): Desktop API mocking tool. ## API Design Guides - [Google API Design Guide](https://cloud.google.com/apis/design/) - [PayPal API Style Guide](https://github.com/paypal/api-standards/blob/master/api-style-guide.md) - [Heroku Platform HTTP API Design Guide](https://github.com/interagent/http-api-design) - [Haufe API Style Guide](http://work.haufegroup.io/api-style-guide/) - [Microsoft REST API Guidelines](https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md) - [18F API Standards](https://github.com/18f/api-standards) - [The RESTed NARWHL](https://www.narwhl.com/) - [White House Web API Standards](https://github.com/whitehouse/api-standards) - [Zalando REST API Guidelines](https://zalando.github.io/restful-api-guidelines/) - [API Stylebook Design Guidelines](http://apistylebook.com/design/guidelines/) - [API Stylebook Design Topics](http://apistylebook.com/design/topics/) - [Adidas-group API Design Guide](https://github.com/adidas-group/api-guidelines) - [Azure API Design](https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design) ## API Publishing - [Mashape](https://www.mashape.com/): API Marketplace. ## API Gateways - [AWS API Gateway](https://aws.amazon.com/api-gateway/): Traffic management, authorization and access control, monitoring, and API version management. - [Ambassador API Gateway](https://www.getambassador.io/): Ambassador is a specialized control plane that translates Kubernetes annotations to Envoy configuration. All traffic is directly handled by the high-performance Envoy Proxy. - [APIGrove](https://apigrove.github.io/apigrove/): API manager built in Java on top of Fuse ESB. - [Apigee127](https://github.com/apigee-127/a127-documentation/wiki/What-is-Apigee-127): nodejs based API Gateway - [Pushpin](http://pushpin.org): Proxy for both request/response or streaming (long poll) of responses - [Strongloop](https://github.com/strongloop/microgateway): nodejs based API Gateway - [Fusio](http://www.fusio-project.org/): PHP based open source API management platform - [Camel](https://camel.apache.org/): Empowers you to define routing and mediation rules in a variety of domain-specific languages, including a Java-based fluent API, Spring or Blueprint XML configuration files, and a Scala DSL. - [HAProxy](http://www.haproxy.org/): Reliable, high Performance TCP/HTTP load balancer. - [OpenResty](https://openresty.org/): Fast web application server built on top of Nginx. - [Tengine](http://tengine.taobao.org/): A distribution of Nginx with some advanced features. - [Tyk](https://tyk.io/): Open-source, fast and scalable API gateway, portal and API management platform. - [Vulcand](https://github.com/vulcand/vulcand): Programmatic load balancer backed by Etcd. - [Zuul](https://github.com/Netflix/zuul): An edge service that provides dynamic routing, monitoring, resiliency, security, and more. - [Kong](https://getkong.org/): An open-source management layer for APIs, delivering high performance and reliability. - [Janus](https://github.com/hellofresh/janus): A lightweight API Gateway written in Go by [Hello Fresh](https://engineering.hellofresh.com). - [fabio](https://github.com/fabiolb/fabio): A fast, modern, zero-conf load balancing HTTP(S) router for deploying microservices managed by [consul](https://www.consul.io) by eBay. - [Traefik](https://github.com/containous/traefik): Træfik (pronounced like traffic) is a modern HTTP reverse proxy and load balancer written in Go. - [Oathkeeper](https://github.com/ory/oathkeeper): OIdentity & Access Proxy (IAP) that authorizes HTTP requests based on sets of rules. Integrates with ORY Hydra. ## API Security - [Online OpenAPI/Swagger File Security Audit](https://apisecurity.io/tools/audit/): Free online static analysis of API contract files. Upload the file and get the report. - [API Security checklist](https://github.com/shieldfy/API-Security-Checklist): Checklist of the most important security countermeasures when designing, testing, and releasing your API. - [Ory Hydra](https://github.com/ory/hydra): OAuth2 server with OpenID Connect written in Go. ## API Web Scanners - [Cherrybomb](https://github.com/blst-security/cherrybomb): Stop half-done API specifications! Cherrybomb is a CLI tool that helps you avoid undefined user behaviour by validating your API specifications. ## API Monitoring - [Runscope](https://www.runscope.com/): API Performance Monitoring. - [Ping-API](https://ping-api.com/): Automated API Testing. ## API Testing - [Assertible](https://assertible.com): Continuously test and monitor your APIs after deployments and across environments. - [Pyresttest](https://github.com/svanoort/pyresttest): YAML based REST testing and API microbenchmarking tool - [OWASP Zaproxy](https://github.com/zaproxy/zaproxy): A tool to test your API for known security vulnerabilities, with a great CI integration. - [RestQA](https://github.com/restqa/restqa): Microservice API Testing tool focused on providing a great developer experience. ## API Developer Portal - [Tyk](https://tyk.io/features): API Developer Portal on top of API gateway, make your API gateway easier to be used by developers. - [APIMATIC](https://apimatic.io/developer-experience-portal): Instantly build an API Portal with SDKs, Live Code Samples, Test Cases, API Transformation and language specific Docs & Reference - tailored for your API. ## JSON Format Standards - [HAL](http://stateless.co/hal_specification.html) - [JSONAPI](http://jsonapi.org/faq/) - [JSON Schema](http://json-schema.org/) - [Hydra](http://www.hydra-cg.com/) - [Ion](https://github.com/ionwg/ion-doc) - [JSON-LD](https://json-ld.org/) ## Learning Resources - [REST in Practice](http://shop.oreilly.com/product/9780596805838.do) - [Roy Fielding's dissertation on REST](https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm) - [Best Practices for Designing a Pragmatic RESTful API](http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api) - [How to Design a REST API](https://blog.octo.com/en/design-a-rest-api/) - [Automated API Development](https://yos.io/2016/04/27/automated-api-development/) - [Nordic APIs](http://nordicapis.com/) - [Undisturbed REST](https://www.mulesoft.com/sites/default/files/resource-assets/ebook-UndisturbedREST_v1.pdf) - [Build APIs You Won't Hate](https://leanpub.com/build-apis-you-wont-hate) - [Irresistible APIs](https://www.manning.com/books/irresistible-apis) - [How to build an API](https://apiary.io/how-to-build-api) - [API University](https://www.programmableweb.com/api-university) - [RESTful Web Services](http://shop.oreilly.com/product/9780596529260.do) - [RESTful Web APIs](http://shop.oreilly.com/product/0636920028468.do) - [The Ten Essentials for Good API Documentation](https://alistapart.com/article/the-ten-essentials-for-good-api-documentation) - [APIsecurity.io weekly newsletter](https://apisecurity.io) - [Testing Web APIs](https://www.manning.com/books/testing-web-apis) ## Blogs - [API Evangelist](http://apievangelist.com/blog/) ## References - [HTTP Status Codes Reference](https://httpstatuses.com/) ## Contributing [Pull Requests](https://github.com/yosriady/api-development-tools/pulls) are most welcome! Please write a brief one-sentence summary when adding a new resource. ## Thanks **api-development-tools** © 2016+, Yos Riady. Released under the [MIT] License.<br> Authored and maintained by Yos Riady with help from contributors ([list][contributors]). > [yos.io](https://yos.io) &nbsp;&middot;&nbsp; > GitHub [@yosriady](https://github.com/yosriady) [MIT]: https://mit-license.org/ [contributors]: https://github.com/yosriady/api-development-tools/contributors

An API focused facade that sits on top of an object model.

[](http://badge.fury.io/rb/grape-entity)  [](https://coveralls.io/github/ruby-grape/grape-entity?branch=master) [](https://codeclimate.com/github/ruby-grape/grape-entity) # Table of Contents - [Grape::Entity](#grapeentity) - [Introduction](#introduction) - [Example](#example) - [Reusable Responses with Entities](#reusable-responses-with-entities) - [Defining Entities](#defining-entities) - [Basic Exposure](#basic-exposure) - [Exposing with a Presenter](#exposing-with-a-presenter) - [Conditional Exposure](#conditional-exposure) - [Safe Exposure](#safe-exposure) - [Nested Exposure](#nested-exposure) - [Collection Exposure](#collection-exposure) - [Merge Fields](#merge-fields) - [Runtime Exposure](#runtime-exposure) - [Unexpose](#unexpose) - [Overriding exposures](#overriding-exposures) - [Returning only the fields you want](#returning-only-the-fields-you-want) - [Aliases](#aliases) - [Format Before Exposing](#format-before-exposing) - [Expose Nil](#expose-nil) - [Default Value](#default-value) - [Documentation](#documentation) - [Options Hash](#options-hash) - [Passing Additional Option To Nested Exposure](#passing-additional-option-to-nested-exposure) - [Attribute Path Tracking](#attribute-path-tracking) - [Using the Exposure DSL](#using-the-exposure-dsl) - [Using Entities](#using-entities) - [Entity Organization](#entity-organization) - [Caveats](#caveats) - [Installation](#installation) - [Testing with Entities](#testing-with-entities) - [Project Resources](#project-resources) - [Contributing](#contributing) - [License](#license) - [Copyright](#copyright) # Grape::Entity ## Introduction This gem adds Entity support to API frameworks, such as [Grape](https://github.com/ruby-grape/grape). Grape's Entity is an API focused facade that sits on top of an object model. ### Example ```ruby module API module Entities class Status < Grape::Entity format_with(:iso_timestamp) { |dt| dt.iso8601 } expose :user_name expose :text, documentation: { type: "String", desc: "Status update text." } expose :ip, if: { type: :full } expose :user_type, :user_id, if: lambda { |status, options| status.user.public? } expose :location, merge: true expose :contact_info do expose :phone expose :address, merge: true, using: API::Entities::Address end expose :digest do |status, options| Digest::MD5.hexdigest status.txt end expose :replies, using: API::Entities::Status, as: :responses expose :last_reply, using: API::Entities::Status do |status, options| status.replies.last end with_options(format_with: :iso_timestamp) do expose :created_at expose :updated_at end end end end module API module Entities class StatusDetailed < API::Entities::Status expose :internal_id end end end ``` ## Reusable Responses with Entities Entities are a reusable means for converting Ruby objects to API responses. Entities can be used to conditionally include fields, nest other entities, and build ever larger responses, using inheritance. ### Defining Entities Entities inherit from Grape::Entity, and define a simple DSL. Exposures can use runtime options to determine which fields should be visible, these options are available to `:if`, `:unless`, and `:proc`. #### Basic Exposure Define a list of fields that will always be exposed. ```ruby expose :user_name, :ip ``` The field lookup takes several steps * first try `entity-instance.exposure` * next try `object.exposure` * next try `object.fetch(exposure)` * last raise an Exception `exposure` is a Symbol by default. If `object` is a Hash with stringified keys, you can set the hash accessor at the entity-class level to properly expose its members: ```ruby class Status < GrapeEntity self.hash_access = :to_s expose :code expose :message end Status.represent({ 'code' => 418, 'message' => "I'm a teapot" }).as_json #=> { code: 418, message: "I'm a teapot" } ``` #### Exposing with a Presenter Don't derive your model classes from `Grape::Entity`, expose them using a presenter. ```ruby expose :replies, using: API::Entities::Status, as: :responses ``` Presenter classes can also be specified in string format, which helps with circular dependencies. ```ruby expose :replies, using: "API::Entities::Status", as: :responses ``` #### Conditional Exposure Use `:if` or `:unless` to expose fields conditionally. ```ruby expose :ip, if: { type: :full } expose :ip, if: lambda { |instance, options| options[:type] == :full } # exposed if the function evaluates to true expose :ip, if: :type # exposed if :type is available in the options hash expose :ip, if: { type: :full } # exposed if options :type has a value of :full expose :ip, unless: ... # the opposite of :if ``` #### Safe Exposure Don't raise an exception and expose as nil, even if the :x cannot be evaluated. ```ruby expose :ip, safe: true ``` #### Nested Exposure Supply a block to define a hash using nested exposures. ```ruby expose :contact_info do expose :phone expose :address, using: API::Entities::Address end ``` You can also conditionally expose attributes in nested exposures: ```ruby expose :contact_info do expose :phone expose :address, using: API::Entities::Address expose :email, if: lambda { |instance, options| options[:type] == :full } end ``` #### Collection Exposure Use `root(plural, singular = nil)` to expose an object or a collection of objects with a root key. ```ruby root 'users', 'user' expose :id, :name, ... ``` By default every object of a collection is wrapped into an instance of your `Entity` class. You can override this behavior and wrap the whole collection into one instance of your `Entity` class. As example: ```ruby present_collection true, :collection_name # `collection_name` is optional and defaults to `items` expose :collection_name, using: API::Entities::Items ``` #### Merge Fields Use `:merge` option to merge fields into the hash or into the root: ```ruby expose :contact_info do expose :phone expose :address, merge: true, using: API::Entities::Address end expose :status, merge: true ``` This will return something like: ```ruby { contact_info: { phone: "88002000700", city: 'City 17', address_line: 'Block C' }, text: 'HL3', likes: 19 } ``` It also works with collections: ```ruby expose :profiles do expose :users, merge: true, using: API::Entities::User expose :admins, merge: true, using: API::Entities::Admin end ``` Provide lambda to solve collisions: ```ruby expose :status, merge: ->(key, old_val, new_val) { old_val + new_val if old_val && new_val } ``` #### Runtime Exposure Use a block or a `Proc` to evaluate exposure at runtime. The supplied block or `Proc` will be called with two parameters: the represented object and runtime options. **NOTE:** A block supplied with no parameters will be evaluated as a nested exposure (see above). ```ruby expose :digest do |status, options| Digest::MD5.hexdigest status.txt end ``` ```ruby expose :digest, proc: ... # equivalent to a block ``` You can also define a method on the entity and it will try that before trying on the object the entity wraps. ```ruby class ExampleEntity < Grape::Entity expose :attr_not_on_wrapped_object # ... private def attr_not_on_wrapped_object 42 end end ``` You always have access to the presented instance (`object`) and the top-level entity options (`options`). ```ruby class ExampleEntity < Grape::Entity expose :formatted_value # ... private def formatted_value "+ X #{object.value} #{options[:y]}" end end ``` #### Unexpose To undefine an exposed field, use the ```.unexpose``` method. Useful for modifying inherited entities. ```ruby class UserData < Grape::Entity expose :name expose :address1 expose :address2 expose :address_state expose :address_city expose :email expose :phone end class MailingAddress < UserData unexpose :email unexpose :phone end ``` #### Overriding exposures If you want to add one more exposure for the field but don't want the first one to be fired (for instance, when using inheritance), you can use the `override` flag. For instance: ```ruby class User < Grape::Entity expose :name end class Employee < User expose :name, as: :employee_name, override: true end ``` `User` will return something like this `{ "name" : "John" }` while `Employee` will present the same data as `{ "employee_name" : "John" }` instead of `{ "name" : "John", "employee_name" : "John" }`. #### Returning only the fields you want After exposing the desired attributes, you can choose which one you need when representing some object or collection by using the only: and except: options. See the example: ```ruby class UserEntity expose :id expose :name expose :email end class Entity expose :id expose :title expose :user, using: UserEntity end data = Entity.represent(model, only: [:title, { user: [:name, :email] }]) data.as_json ``` This will return something like this: ```ruby { title: 'grape-entity is awesome!', user: { name: 'John Applet', email: '[email protected]' } } ``` Instead of returning all the exposed attributes. The same result can be achieved with the following exposure: ```ruby data = Entity.represent(model, except: [:id, { user: [:id] }]) data.as_json ``` #### Aliases Expose under a different name with `:as`. ```ruby expose :replies, using: API::Entities::Status, as: :responses ``` #### Format Before Exposing Apply a formatter before exposing a value. ```ruby module Entities class MyModel < Grape::Entity format_with(:iso_timestamp) do |date| date.iso8601 end with_options(format_with: :iso_timestamp) do expose :created_at expose :updated_at end end end ``` Defining a reusable formatter between multiples entities: ```ruby module ApiHelpers extend Grape::API::Helpers Grape::Entity.format_with :utc do |date| date.utc if date end end ``` ```ruby module Entities class MyModel < Grape::Entity expose :updated_at, format_with: :utc end class AnotherModel < Grape::Entity expose :created_at, format_with: :utc end end ``` #### Expose Nil By default, exposures that contain `nil` values will be represented in the resulting JSON as `null`. As an example, a hash with the following values: ```ruby { name: nil, age: 100 } ``` will result in a JSON object that looks like: ```javascript { "name": null, "age": 100 } ``` There are also times when, rather than displaying an attribute with a `null` value, it is more desirable to not display the attribute at all. Using the hash from above the desired JSON would look like: ```javascript { "age": 100 } ``` In order to turn on this behavior for an as-exposure basis, the option `expose_nil` can be used. By default, `expose_nil` is considered to be `true`, meaning that `nil` values will be represented in JSON as `null`. If `false` is provided, then attributes with `nil` values will be omitted from the resulting JSON completely. ```ruby module Entities class MyModel < Grape::Entity expose :name, expose_nil: false expose :age, expose_nil: false end end ``` `expose_nil` is per exposure, so you can suppress exposures from resulting in `null` or express `null` values on a per exposure basis as you need: ```ruby module Entities class MyModel < Grape::Entity expose :name, expose_nil: false expose :age # since expose_nil is omitted nil values will be rendered as null end end ``` It is also possible to use `expose_nil` with `with_options` if you want to add the configuration to multiple exposures at once. ```ruby module Entities class MyModel < Grape::Entity # None of the exposures in the with_options block will render nil values as null with_options(expose_nil: false) do expose :name expose :age end end end ``` When using `with_options`, it is possible to again override which exposures will render `nil` as `null` by adding the option on a specific exposure. ```ruby module Entities class MyModel < Grape::Entity # None of the exposures in the with_options block will render nil values as null with_options(expose_nil: false) do expose :name expose :age, expose_nil: true # nil values would be rendered as null in the JSON end end end ``` #### Default Value This option can be used to provide a default value in case the return value is nil or empty. ```ruby module Entities class MyModel < Grape::Entity expose :name, default: '' expose :age, default: 60 end end ``` #### Documentation Expose documentation with the field. Gets bubbled up when used with Grape and various API documentation systems. ```ruby expose :text, documentation: { type: "String", desc: "Status update text." } ``` ### Options Hash The option keys `:version` and `:collection` are always defined. The `:version` key is defined as `api.version`. The `:collection` key is boolean, and defined as `true` if the object presented is an array. The options also contain the runtime environment in `:env`, which includes request parameters in `options[:env]['grape.request.params']`. Any additional options defined on the entity exposure are included as is. In the following example `user` is set to the value of `current_user`. ```ruby class Status < Grape::Entity expose :user, if: lambda { |instance, options| options[:user] } do |instance, options| # examine available environment keys with `p options[:env].keys` options[:user] end end ``` ``` present s, with: Status, user: current_user ``` #### Passing Additional Option To Nested Exposure Sometimes you want to pass additional options or parameters to nested a exposure. For example, let's say that you need to expose an address for a contact info and it has two different formats: **full** and **simple**. You can pass an additional `full_format` option to specify which format to render. ```ruby # api/contact.rb expose :contact_info do expose :phone expose :address do |instance, options| # use `#merge` to extend options and then pass the new version of options to the nested entity API::Entities::Address.represent instance.address, options.merge(full_format: instance.need_full_format?) end expose :email, if: lambda { |instance, options| options[:type] == :full } end # api/address.rb expose :state, if: lambda {|instance, options| !!options[:full_format]} # the new option could be retrieved in options hash for conditional exposure expose :city, if: lambda {|instance, options| !!options[:full_format]} expose :street do |instance, options| # the new option could be retrieved in options hash for runtime exposure !!options[:full_format] ? instance.full_street_name : instance.simple_street_name end ``` **Notice**: In the above code, you should pay attention to [**Safe Exposure**](#safe-exposure) yourself. For example, `instance.address` might be `nil` and it is better to expose it as nil directly. #### Attribute Path Tracking Sometimes, especially when there are nested attributes, you might want to know which attribute is being exposed. For example, some APIs allow users to provide a parameter to control which fields will be included in (or excluded from) the response. GrapeEntity can track the path of each attribute, which you can access during conditions checking or runtime exposure via `options[:attr_path]`. The attribute path is an array. The last item of this array is the name (alias) of current attribute. If the attribute is nested, the former items are names (aliases) of its ancestor attributes. Example: ```ruby class Status < Grape::Entity expose :user # path is [:user] expose :foo, as: :bar # path is [:bar] expose :a do expose :b, as: :xx do expose :c # path is [:a, :xx, :c] end end end ``` ### Using the Exposure DSL Grape ships with a DSL to easily define entities within the context of an existing class: ```ruby class Status include Grape::Entity::DSL entity :text, :user_id do expose :detailed, if: :conditional end end ``` The above will automatically create a `Status::Entity` class and define properties on it according to the same rules as above. If you only want to define simple exposures you don't have to supply a block and can instead simply supply a list of comma-separated symbols. ### Using Entities With Grape, once an entity is defined, it can be used within endpoints, by calling `present`. The `present` method accepts two arguments, the `object` to be presented and the `options` associated with it. The options hash must always include `:with`, which defines the entity to expose (unless namespaced entity classes are used, see [next section](#entity-organization)). If the entity includes documentation it can be included in an endpoint's description. ```ruby module API class Statuses < Grape::API version 'v1' desc 'Statuses.', { params: API::Entities::Status.documentation } get '/statuses' do statuses = Status.all type = current_user.admin? ? :full : :default present statuses, with: API::Entities::Status, type: type end end end ``` ### Entity Organization In addition to separately organizing entities, it may be useful to put them as namespaced classes underneath the model they represent. ```ruby class Status def entity Entity.new(self) end class Entity < Grape::Entity expose :text, :user_id end end ``` If you organize your entities this way, Grape will automatically detect the `Entity` class and use it to present your models. In this example, if you added `present Status.new` to your endpoint, Grape would automatically detect that there is a `Status::Entity` class and use that as the representative entity. This can still be overridden by using the `:with` option or an explicit `represents` call. ### Caveats Entities with duplicate exposure names and conditions will silently overwrite one another. In the following example, when `object.check` equals "foo", only `field_a` will be exposed. However, when `object.check` equals "bar" both `field_b` and `foo` will be exposed. ```ruby module API module Entities class Status < Grape::Entity expose :field_a, :foo, if: lambda { |object, options| object.check == "foo" } expose :field_b, :foo, if: lambda { |object, options| object.check == "bar" } end end end ``` This can be problematic, when you have mixed collections. Using `respond_to?` is safer. ```ruby module API module Entities class Status < Grape::Entity expose :field_a, if: lambda { |object, options| object.check == "foo" } expose :field_b, if: lambda { |object, options| object.check == "bar" } expose :foo, if: lambda { |object, options| object.respond_to?(:foo) } end end end ``` Also note that an `ArgumentError` is raised when unknown options are passed to either `expose` or `with_options`. ## Installation Add this line to your application's Gemfile: gem 'grape-entity' And then execute: $ bundle Or install it yourself as: $ gem install grape-entity ## Testing with Entities Test API request/response as usual. Also see [Grape Entity Matchers](https://github.com/agileanimal/grape-entity-matchers). ## Project Resources * Need help? [Grape Google Group](http://groups.google.com/group/ruby-grape) ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md). ## License MIT License. See [LICENSE](LICENSE) for details. ## Copyright Copyright (c) 2010-2016 Michael Bleigh, Intridea, Inc., ruby-grape and Contributors.

Simple clean Go REST API architecture with dependency injection and mocking example, following SOLID principles.

service-pattern-go ------- Hey! Welcome, this is an example of simple REST API implementation with clean architecture written in Go with complete Dependency Injection along with Mocking example, following SOLID principles. Inspired by [Manuel Kiessling go-cleanarchitecture](http://manuel.kiessling.net/2012/09/28/applying-the-clean-architecture-to-go-applications/) and [Joshua Partogi TDD training session](https://github.com/jpartogi/tennis-kata-laravel/) It has simple dependencies: - [Chi (Router)](https://github.com/go-chi/chi) - [Testify (Test & Mock framework)](https://github.com/stretchr/testify) - [Mockery (Mock generator)](https://github.com/vektra/mockery) - [Hystrix-Go (Circuit Breaker)](https://github.com/afex/hystrix-go) Get Started: - [Install](https://irahardianto.github.io/service-pattern-go/#install) - [Introduction](https://irahardianto.github.io/service-pattern-go/#introduction) - [Folder Structure](https://irahardianto.github.io/service-pattern-go/#folder-structure) - [Depency Injection](https://irahardianto.github.io/service-pattern-go/#dependency-injection) - [Mocking](https://irahardianto.github.io/service-pattern-go/#mocking) - [Testing](https://irahardianto.github.io/service-pattern-go/#testing) - [Circuit Breaker](https://irahardianto.github.io/service-pattern-go/#circuit-breaker) ---------- [Install](https://irahardianto.github.io/service-pattern-go/#install) ------- Clone the source git clone https://github.com/irahardianto/service-pattern-go Setup dependencies go get -u github.com/go-chi/chi go get -u github.com/jinzhu/gorm go get github.com/stretchr/testify go get github.com/vektra/mockery/.../ go get github.com/afex/hystrix-go/hystrix go get -u github.com/mattn/go-sqlite3 Setup sqlite data structure sqlite3 /var/tmp/tennis.db < setup.sql Test first for your liking go test ./... -v Run the app go build && ./service-pattern-go And visit http://localhost:8080/getScore/Rafael/vs/Serena ---------- [Introduction](https://irahardianto.github.io/service-pattern-go/#introduction) ------- This is an example of Go clean architecture implementing Dependency Injection and Mocking for unit testing purposes to achieve safe, reliable and secure source code. The idea of the pattern itself is to create decoupled systems that the implementation of lower level domain is not a concern of the implementor, and can be replaced without having concern of breaking implementor function. The aim of the architecture is to produce a system that are: - Independent of frameworks. The system should be able to become an independent system, not bound into any framework implementation that cause the system to be bloated, instead those framework should be used as a tools to support the system implementation rather than limiting the system capabilities. - Highly testable. All codes are guilty and tests is the only way we can prove it otherwise, this means that our test coverage has to be able to cover as much layers as we can so we can be sure of our code reliability. - Independent of database. Business logic should not be bound to the database, the system should be able to swap MySQL, Maria DB, PosgreSQL, Mongo DB, Dynamo DB without breaking the logic. - Independent of 3rd party library. No 3rd party library should be implemented directly to the system logic, we should abstract in away that our system can replace the library anytime we want. Every implementation should only be by using interface, there should be no direct access from the implementor to implementation, that way we can inject its dependency and replace it with mock object during unit tests. For example: PlayerService -> implement IPlayerRepository, instead of direct PlayerRepository type PlayerService struct { interfaces.IPlayerRepository } func (service *PlayerService) GetScores(player1Name string, player2Name string) (string, error) { baseScore := [4]string{"Love", "Fifteen", "Thirty", "Forty"} var result string player1, err := service.GetPlayerByName(player1Name) if err != nil { //Handle error } player2, err := service.GetPlayerByName(player2Name) if err != nil { //Handle error } if player1.Score < 4 && player2.Score < 4 && !(player1.Score+player2.Score == 6) { s := baseScore[player1.Score] if player1.Score == player2.Score { result = s + "-All" } else { result = s + "-" + baseScore[player2.Score] } } if player1.Score == player2.Score { result = "Deuce" } return result, nil } If you look into the implementation of these lines player1, err := service.GetPlayerByName(player1Name) player2, err := service.GetPlayerByName(player2Name) Both are actually abstract implementation of the interface, not the real implementation itself. So later on the Dependency Injection section, we will learn those interface will be injected with the implementation during the compile time. This way, we can switch the implementation of IPlayerService & IPlayerRepository during the injection with whatever implementation without changing the implementation logic. Throughout this repo you will find implementation of design patterns such as **Strategy Pattern** when we inject our dependencies with the real implementations. We create **Singleton** and use it to wired up our router and services. We use **Composite** for all our abstract interface implementations so that the implementor can abstractly implement the methods it has, just as the example above where **PlayerService** implements **interfaces.IPlayerRepository** and allows it to directly invoke **GetPlayerByName** which is **IPlayerRepository's** method. We also use **Decorator Pattern** to hook up our circuit breaker without needing to change / modify the original implementation. ---------- [Folder Structure](https://irahardianto.github.io/service-pattern-go/#folder-structure) ------- / |- controllers |- infrastructures |- interfaces |- models |- repositories |- services |- viewmodels main.go router.go servicecontainer.go The folder structure is created to accomodate seperation of concern principle, where every struct should have single responsibility to achieve decoupled system. Every folder is a namespace of their own, and every file / struct under the same folder should only use the same namepace as their root folder. ### controllers controllers folder hosts all the structs under controllers namespace, controllers are the handler of all requests coming in, to the router, its doing just that, business logic and data access layer should be done separately. controller struct implement services through their interface, no direct services implementation should be done in controller, this is done to maintain decoupled systems. The implementation will be injected during the compiled time. ### infrasctructures infrasctructures folder host all structs under infrasctructures namespace, infrasctructures consists of setup for the system to connect to external data source, it is used to host things like database connection configurations, MySQL, MariaDB, MongoDB, DynamoDB. ### interfaces interfaces folder hosts all the structs under interfaces namespace, interfaces as the name suggest are the bridge between different domain so they can interact with each other, in our case, this should be the only way for them to interact. interface in Go is a bit different then you might already find in other language like Java or C#, while the later implements interface explicitly, Go implements interface implicitly. You just need to implement all method the interface has, and you're good to "Go". In our system, our PlayerController implements IPlayerService to be able to interact with the implementation that will be injected. In our case, IPlayerService will be injected with PlayerService. The same thing applies on PlayerService which implements IPlayerRepository to be able interact with the injected implementation. In our case, IPlayerRepository will be injected with PlayerRepository during the compile time. PlayerRepository on the other hand, will be injected with infrasctructure configuration that has been setup earlier, this ensure that you can change the implementation of PlayerRepository, without changing the implementor which in this case PlayerService let alone break it. The same thing goes to PlayerService and PlayerController relationship, we can refactor PlayerService, we can change it however we want, without touching the implementor which is PlayerController. ### models models folder hosts all structs under models namespace, model is a struct reflecting our data object from / to database. models should only define data structs, no other functionalities should be included here. ### repositories repositories folder hosts all structs under repositories namespace, repositories is where the implementation of data access layer. All queries and data operation from / to database should happen here, and the implementor should be agnostic of what is the database engine is used, how the queries is done, all they care is they can pull the data according to the interface they are implementing. ### services services folder hosts all structs under services namespace, services is where the business logic lies on, it handles controller request and fetch data from data layer it needs and run their logic to satisfy what controller expect the service to return. controller might implement many services interface to satisfy the request needs, and controller should be agnostic of how services implements their logic, all they care is that they should be able to pull the result they need according to the interface they implements. ### viewmodels viewmodels folder hosts all the structs under viewmodels namespace, viewmodels are model to be use as a response return of REST API call ### main.go main.go is the entry point of our system, here lies the router bindings it triggers ChiRouter singleton and call InitRouter to bind the router. ### router.go router.go is where we binds controllers to appropriate route to handle desired http request. By default we are using Chi router as it is a light weight router and not bloated with unnecessary unwanted features. ### servicecontainer.go servicecontainer.go is where the magic begins, this is the place where we injected all implementations of interfaces. Lets cover throughly in the dependency injection section. ---------- [Dependecy Injection](https://irahardianto.github.io/service-pattern-go/#dependency-injection) ------- Dependecy injection is the heart of TDD, without it we wont be able to do proper TDD because there will be no mocking and we cannot decoupled our code properly. This is one of the misconception when people thinks that they are doing unit testing instead actually they are doing integration test which connects the logic to database. Unit test should be done independently and database should not come in to play when we are doing unit test. One thing to not though, in Go dependency has to be injected during compile time instead of runtime which cause it a bit different than Java / C# implementation, but anyway, its just plain old dependency injection. In essence unit test is created to test our logic not our data integrity, and by taking database during unit testing it will add huge complexity to the tests itself, and this creates barrier for programmers new to unit testing as they are struggling to create proper testing for their functions. Now why dependency injection is a crucial part in doing proper TDD? the answer lies in the usage of interface. Back when I have never encountered mocking, I always wondering, what is the use of interface, why we should create abstraction for our functions instead of just write it all already, why the hell should we create a duplicate, abstraction that we will be implementing shortly anyway, some says that, because in doing so, your code will be much cleaner and we have proper pattern, I called that bullshit because in essence we dont have to do it if it only for that reason, and I'm still wondering until I learned about mocking. Some other people says that interface is used so your program is decoupled, and when needed you can replace the implementations without needing to adjust the implementor. That make sense right? much better than the bullshit. Yea that make sense, we can replace whatever implement whatever interface with whatever. Yea, but how many times would you replace you database connection calls? chances are rare if not never especially if you working on software house that deliver projects after projects after projects, you will never see you component got replaced. The when I learned about mocking, all that I have been asking coming to conclusions as if I was like having epiphany, we will discuss more about mocking in the mocking section, but for now lets discuss it in regards of dependency injection usage. So as you see in our project structure, instead of having all component directly talks to each other, we are using interface, take PlayerController for example type PlayerController struct { interfaces.IPlayerService } func (controller *PlayerController) GetPlayerScore(res http.ResponseWriter, req *http.Request) { player1Name := chi.URLParam(req, "player1") player2Name := chi.URLParam(req, "player2") scores, err := controller.GetScores(player1Name, player2Name) if err != nil { //Handle error } json.NewEncoder(res).Encode(viewmodels.ScoresVM{scores}) } You see that PlayerController uses IPlayerService interface, and since IPlayerService has GetScores method, PlayerController can invoke it and get the result right away. Wait a minute, isn't that the interface is just merely abstraction? so how do it get executed, where is the implementation? type IPlayerService interface { GetScores(player1Name string, player2Name string) (string, error) } You see, instead of calling directly to PlayerService, PlayerController uses the interface of PlayerService which is IPlayerService, there could be many implementation of IPlayerService not just limited to PlayerService it could be BrotherService etc, but how do we determined that PlayerService will be used instead? func (k *kernel) InjectPlayerController() controllers.PlayerController { sqlConn, _ := sql.Open("sqlite3", "/var/tmp/tennis.db") sqliteHandler := &infrastructures.SQLiteHandler{} sqliteHandler.Conn = sqlConn playerRepository := &repositories.PlayerRepository{sqliteHandler} playerService := &services.PlayerService{&repositories.PlayerRepositoryWithCircuitBreaker{playerRepository}} playerController := controllers.PlayerController{playerService} return playerController } This is where dependency injection come in to play, as you see here in servicecontainer.go we are creating **playerController** and inject it with **playerService** as simple as that, this is what dependency injection all about no more. So **playerController's IPlayerService** will be injected by **playerService** along with all implementation that it implements, so for example **GetPlayerByName** now returns whatever **GetPlayerByName** implemented by **playerService** as you can see it in **PlayerService.go** Now, how does this relates to TDD & mocking? playerService := new(mocks.IPlayerService) You see, in PlayerController_test.go we are using mock object to inject the implementation of our service, lets discuss more detail about mocking and testing in each section. ---------- [Mocking](https://irahardianto.github.io/service-pattern-go/#mocking) ------- Mocking is a concept many times people struggle to understand, let alone implement it, at least I was the one among the one who struggles to understand this concept. But understanding this concept is essential to do TDD. The key point is, we mock dependencies that we need to run our tests, this is why dependency injection is essential to proceed. We are using testfy as our mock library Basically what mock object do is replacing injection instead of real implementation with mock as point out at the end of dependency injection session playerService := new(mocks.IPlayerService) We then create mock GetScores functionalities along with its request and response. playerService.On("GetScores", "Rafael", "Serena").Return("Forty-Fifteen", nil) As you see, then the mock object is injected to **playerService** of PlayerController, this is why dependency injection is essential to this proses as it is the only way we can inject interface with mock object instead of real implementation. playerController := PlayerController{playerService} We generate mock our by using vektra mockery for IPlayerService, go to the interfaces folder and then just type. mockery -name=IPlayerService The output will be inside ```mocks/IPlayerService.go``` and we can use it right away for our testing. ---------- [Testing](https://irahardianto.github.io/service-pattern-go/#testing) ------- We have cover pretty much everything there is I hope that you already get the idea of proper unit testing and why we should implement interfaces, dependency injection and mocking. The last piece is the unit test itself. func TestPlayerScore(t *testing.T) { // create an instance of our test object playerService := new(mocks.IPlayerService) // setup expectations playerService.On("GetScores", "Rafael", "Serena").Return("Forty-Fifteen", nil) playerController := PlayerController{playerService} // call the code we are testing req := httptest.NewRequest("GET", "http://localhost:8080/getScore/Rafael/vs/Serena", nil) w := httptest.NewRecorder() r := chi.NewRouter() r.HandleFunc("/getScore/{player1}/vs/{player2}", playerController.GetPlayerScore) r.ServeHTTP(w, req) expectedResult := viewmodels.ScoresVM{} expectedResult.Score = "Forty-Fifteen" actualResult := viewmodels.ScoresVM{} json.NewDecoder(w.Body).Decode(&actualResult) // assert that the expectations were met assert.Equal(t, expectedResult, actualResult) } As you see here after injecting playerService of playerController with mock object, we are calling the playerController.GetPlayer and simulate request all the way from the router. req := httptest.NewRequest("GET", "http://localhost:8080/getScore/Rafael/vs/Serena", nil) w := httptest.NewRecorder() r := chi.NewRouter() r.HandleFunc("/getScore/{player1}/vs/{player2}", playerController.GetPlayerScore) r.ServeHTTP(w, req) And assert the result by using testify assertion library assert.Equal(t, expectedResult, actualResult) ---------- [Circuit Breaker](https://irahardianto.github.io/service-pattern-go/#circuit-breaker) ------- Building a distributed system we should really think that everything is not reliable, networks could breaks, servers could suddenly crash, even your 100% unit-tested app could be the root cause of the problems. With that in said, when designing distributed system we should keep that in mind, so when some of our system is down, it won't take the whole system. Circuit breaker is a pattern with which we could design our system to be fault-tolerant and can withstand one or more service failure. It should be wrapping all call outside application ex: db call, redis call, api call. Essentially circuit breaker works just like electrical circuit breakers, nothing fancy here, the only different is when the breaker is tripped it can be automatically closed when the downstream service is responding properly as described in the picture below.  In our case, we will be using hystrix-go, it is a go port from Netflix's hystrix library, how it works is essentially the same, even hystrix-go supports turbine along with its hystrix dashboard, but in my case, I rather use the datadog plugins, since we are using datadog to monitor our system. For the sake of SOLID principles implementation in our codebase, we will add hystrix-go to our PlayerRepository leveraging decorator pattern, this will maintain our base repository implementation, the one that calls database, clean from modification and we will create its extension which is named PlayerRepositoryWithCircuitBreaker. This is the O part of SOLID which stands for Open for extension, Close for modification. If you recall we inject our PlayerService with PlayerRepositoryWithCircuitBreaker and the original PlayerRepository wrapped inside. playerService.PlayerRepository = &repositories.PlayerRepositoryWithCircuitBreaker{playerRepository} Base PlayerRepository implementation : type PlayerRepository struct { interfaces.IDbHandler } func (repository *PlayerRepository) GetPlayerByName(name string) (models.PlayerModel, error) { row, err :=repository.Query(fmt.Sprintf("SELECT * FROM player_models WHERE name = '%s'", name)) if err != nil { return models.PlayerModel{}, err } var player models.PlayerModel row.Next() row.Scan(&player.Id, &player.Name, &player.Score) return player, nil } PlayerRepository extension implementation : type PlayerRepositoryWithCircuitBreaker struct { PlayerRepository interfaces.IPlayerRepository } func (repository *PlayerRepositoryWithCircuitBreaker) GetPlayerByName(name string) (models.PlayerModel, error) { output := make(chan models.PlayerModel, 1) hystrix.ConfigureCommand("get_player_by_name", hystrix.CommandConfig{Timeout: 1000}) errors := hystrix.Go("get_player_by_name", func() error { player, _ := repository.PlayerRepository.GetPlayerByName(name) output <- player return nil }, nil) select { case out := <-output: return out, nil case err := <-errors: println(err) return models.PlayerModel{}, err } } Basically PlayerRepositoryWithCircuitBreaker implement the same interface as PlayerRepository, IPlayerRepository type IPlayerRepository interface { GetPlayerByName(name string) (models.PlayerModel, error) } As you see here, it is very easy to implement hystrix-go circuit breaker, you just need to wrap your db call inside hystrix if the timeout reached, the circuit breaker will be tripped and all calls to database will be halt, error will be returned instead for future call until db service is up and healthy. Cheers, M. Ichsan Rahardianto.

Autocode CLI and standard library tooling

# <img src="https://content.public.files.stdlib.com/shared/static/branding/autocode-logo-wordmark.svg" width="300"> **Autocode Setup** | [Node](https://github.com/acode/lib-node) | [Web](https://github.com/acode/lib-js) | [Python (alpha)](https://github.com/acode/lib-python) | [Ruby (alpha)](https://github.com/acode/lib-ruby) # Introduction [Autocode](https://autocode.com) is a fastest and easy way to build web services and APIs that respond to external SaaS events. The Autocode ecosystem treats external SaaS APIs as single-line function calls with the use of the [lib](https://github.com/acode/lib-node) package in NPM. The Autocode CLI allows you to interact seamlessly with the following components of Autocode: 1. Executing APIs on the Autocode standard library 2. Uploading new APIs / web services to Autocode's hosting platform Autocode is based on Function as a Service ("serverless") architecture, initially popularized by AWS Lambda. You can use Autocode to build modular, scalable APIs for yourself and other developers in *minutes* without having to manage servers, gateways, domains, write documentation, or build SDKs. Your development workflow has never been easier - focus on writing code you love, let Autocode handle everything else. Autocode uses an **open specification** called [FunctionScript](https://github.com/acode/FunctionScript) for function definitions and execution. If you run into concerns or questions as you're building from this guide, please reference the FunctionScript repository. :) You can view services published by our large and growing developer community [on the Autocode standard library page](https://autocode.com/lib).  # Table of contents 1. [Getting started](#getting-started) 1. [Creating your first service](#creating-your-first-service) 1. [Connecting service endpoints](#connecting-service-endpoints) 1. [Accessing your APIs from other applications](#accessing-your-apis-from-other-applications) 1. [Accessing your APIs over HTTP](#accessing-your-apis-over-http) 1. [Version control and package management](#version-control-and-package-management) 1. [Logging](#logging) 1. [Additional functionality](#additional-functionality) 1. [Acknowledgements](#acknowledgements) 1. [Contact](#contact) # Getting started To get started with Autocode, first make sure you have Node 8.x or later installed, [available from the official Node.js website](https://nodejs.org). Next install the Autocode CLI tools with: ``` $ npm install lib.cli -g ``` And you're now ready to start building! # Creating your first service The first thing you'll want to do is create a workspace. Create a new directory you intend to build your services in and initialize the workspace. ``` $ mkdir autocode-workspace $ cd autocode-workspace $ lib init ``` You'll be asked for an e-mail address to log in to the Autocode registry. If you don't yet have an account, you can create one by going to https://autocode.com/. Note that you can skip account creation with `lib init --no-login`. You'll be unable to use the registry, but it's useful for creating workspaces when you don't have internet access. Next, create your service: ``` $ lib create <service> ``` You'll be asked for a default function name, which is the entry point into your service (useful if you only want a single entry point). This will automatically generate a service project scaffold in `autocode-workspace/<username>/<service>`. Once created, enter the service directory: ``` $ cd your_username/your_service ``` In this directory, you'll see something like: ``` - functions/ - __main__.js - package.json - env.json - WELCOME.md - README.md ``` At this point, there's a "hello world" function that's been automatically created (`__main__.js`). Autocode comes paired with a simple `lib` command for testing your functions locally and running them in the cloud. To test your function: ```shell $ lib . "hello world" ``` If we examine the `functions/__main__.js` file, we see the following: ```javascript /** * A basic Hello World function * @param {string} name Who you're saying hello to * @returns {string} */ module.exports = async (name = 'world', context) => { return `hello ${name}`; }; ``` We can pass parameters to it using the CLI by specifying named parameters: ```shell $ lib . --name "dolores abernathy" "hello dolores abernathy" ``` Note that `context` is a magic parameter (automatically populated with execution details, when provided) as is `callback` (terminates execution), so these **don't need to be documented** and **can not be specified as parameters when executing the function**. ## Pushing to the cloud To push your function to a development environment in the cloud... ```shell $ lib up dev $ lib your_username.your_service[@dev] "hello world" ``` And to release it (when you're ready!) ```shell $ lib release $ lib your_username.your_service "hello world" ``` You can check out your service on the web, and use it in applications using our functions gateway, `api.stdlib.com`. ``` https://your_username.api.stdlib.com/your_service/ ``` That's it! You haven't written a line of code yet, and you have mastery over building a service, testing it in a development (staging) environment online, and releasing it for private (or public) consumption. **Note:** By default, APIs that you publish with `lib release` will have a documentation page in the Autocode public registry. You can keep your page private, as well as restrict execution access or add collaborators to your API, by modifying your API's permissions. For more information, see this [docs page](https://docs.stdlib.com/main/#/access-control/api-permissions). **Another Note:** Staging environments (like the one created with `lib up dev`) are *mutable* and can be replaced indefinitely. Releases (`lib release`) are *immutable* and can never be overwritten. However, any service can be torn down with `lib down <environment>` or `lib down -r <version>` (but releases can't be replaced once removed, to prevent mistakes and / or bad actors). # Connecting service endpoints You'll notice that you can create more than one function per service. While you can structure your project however you'd like internally, it should also be noted that these functions have zero-latency access to each other. You can access them internally with the `lib` [package on NPM](https://github.com/stdlib/lib-node), which behaves similarly to the `lib` command for testing. Use: ``` $ npm install lib --save ``` In your main service directory to add it, and use it like so: #### functions/add.js ```javascript module.exports = async (a = 0, b = 0) => { return a + b; }; ``` #### functions/add_double.js ```javascript const lib = require('lib'); module.exports = async (a = 0, b = 0, context) => { let result = await lib[`${context.service.identifier}.add`]({a: a, b: b}); return result * 2; }; ``` In this case, calling `lib .add --a 1 --b 2` will return `3` and `lib .add_double --a 1 --b 2` will return `6`. The `context` magic parameter is used for its `context.service.identifier` property, which will return the string `"your_username.your_service[@local]"` in the case of local execution, `"your_username.your_service[@ENV]"` when deployed to an environment or release (where `ENV` is your environment name or semver). # Accessing your APIs from other applications As mentioned in the previous section, you can use the NPM `lib` package that's [available on GitHub and NPM](https://github.com/stdlib/lib-node) to access your APIs from legacy Node.js applications and even the web browser. We'll have more SDKs coming out in the following months. An existing app would call a function (username.bestTrekChar with version 0.2.1): ```javascript const lib = require('lib'); let result; try { result = await lib.username.bestTrekChar['@0.2.1']({name: 'spock'}); } catch (err) { // handle error } // do something with result ``` Which would speak to your API... ```javascript module.exports = async (name = 'kirk') => { if (name === 'kirk') { return 'why, thank, you, too, kind'; } else if (name === 'spock') { return 'i think this feeling is called "pleased"'; } else { throw new Error('Only kirk and spock supported.'); } }; ``` # Accessing your APIs over HTTP We definitely recommend using the [lib library on NPM](https://github.com/stdlib/lib-node) to make API calls as specified above, but you can also make HTTPS requests directly to the Autocode gateway. HTTP query parameters are mapped automatically to parameters by name. ``` https://username.api.stdlib.com/[email protected]/?name=BATMAN ``` Maps directly to: ```javascript /** * Hello World * @param {string} name * @returns {string} */ module.exports = async (name = 'world') => { // returns "HELLO BATMAN" from above HTTP query return `Hello ${name}`; }; ``` # Version control and package management A quick note on version control - Autocode is *not* a replacement for normal git-based workflows, it is a supplement focused around service creation and execution. You have unlimited access to any release (that hasn't been torn down) with `lib download <serviceIdentifier>` to download and unpack the tarball to a working directory. Tarballs (and package contents) are *closed-source*. Nobody but you (and potentially your teammates) has access to these. It's up to you whether or not you share the guts of your service with others on GitHub or NPM. As mentioned above: releases are *immutable* and can not be overwritten (but can be removed, just not replaced afterwards) and development / staging environments are *mutable*, you can overwrite them as much as you'd like. # Logging Logging for services is enabled by default. When running a service locally with `lib .` or `lib .functionname`, all logs will be output in your console. The very last output (normally a JSON-compatible string) is the return value of the function. To view remote logs (in dev or release environments), use the following syntax: ```shell :: Lists all logs for the service $ lib logs username.servicename :: Lists main service endpoint logs for "dev" environment $ lib logs username.servicename[@dev] :: Lists service endpoint named "test" logs for "dev" environment $ lib logs username.servicename[@dev].test :: Lists all logs for "dev" environment $ lib logs username.servicename[@dev]* $ lib logs username.servicename[@dev].* ``` The default log type is `stdout`, though you can specify `stderr` with `lib logs username.servicename -t stderr`. Limit the number of lines to show with the `-l` argument (or `--lines`). # Additional functionality Autocode comes packed with a bunch of other goodies - as we roll out updates to the platform the serverless builds we're using may change. You can update your service to our latest build using `lib rebuild`. If for any reason your service goes down and is unrecoverable, you can fix it with this command. To see a full list of commands available for the CLI tools, type: ``` $ lib help ``` We've conveniently copy-and-pasted the output here for you to peruse; ``` * -b Execute as a Background Function -d Specify debug mode (prints Gateway logs locally, response logs remotely) -i Specify information mode (prints tar packing and execution request progress) -t Specify an Identity Token to use manually -x Unauthenticated - Execute without a token (overrides active token and -t flag) --* all verbose flags converted to named keyword parameters Runs an Autocode function, i.e. "lib user.service[@env]" (remote) or "lib ." (local) create [service] -n No login - don't require an internet connection -w Write over - overwrite the current directory contents --no-login No login - don't require an internet connection --write-over Write over - overwrite the current directory contents Creates a new (local) service down [environment] -r Remove a release version (provide number) --release Remove a release version (provide number) Removes Autocode package from registry and cloud environment download [username/name OR username/name@env OR username/name@version] -w Write over - overwrite the target directory contents --write-over Write over - overwrite the target directory contents Retrieves and extracts Autocode package endpoints:create [name] [description] [param_1] [param_2] [...] [param_n] -n New directory: Create as a __main__.js file, with the name representing the directory --new New directory: Create as a __main__.js file, with the name representing the directory Creates a new endpoint for a service hostnames:add [source] [target] Adds a new hostname route from a source custom hostname to a target service you own. Accepts wildcards wrapped in curly braces ("{}") or "*" at the front of the hostname. hostnames:list Displays created hostname routes from source custom hostnames to target services you own hostnames:remove Removes a hostname route from a source custom hostname to a target service you own http -p Port (default 8170) --port Port (default 8170) Creates HTTP Server for Current Service init [environment] -f Force command to overwrite existing workspace -n No login - don't require an internet connection --force Force command to overwrite existing workspace --no-login No login - don't require an internet connection Initializes Autocode workspace login --email E-mail --password Password Logs in to Autocode logout -f Force - clears information even if current Access Token invalid --force Force - clears information even if current Access Token invalid Logs out of Autocode in this workspace logs [service] -l The number of log lines you want to retrieve -t The log type you want to retrieve. Allowed values are "stdout" and "stderr". --lines The number of log lines you want to retrieve --type The log type you want to retrieve. Allowed values are "stdout" and "stderr". Retrieves logs for a given service rebuild [environment] -r Rebuild a release package --release Rebuild a release package Rebuilds a service (useful for registry performance updates), alias of `lib restart -b` release Pushes release of Autocode package to registry and cloud (Alias of `lib up -r`) tokens Selects an active Identity Token for API Authentication tokens:add-to-env Sets STDLIB_SECRET_TOKEN in env.json "local" field to the value of an existing token tokens:list -a All - show invalidated tokens as well -s Silent mode - do not display information --all All - show invalidated tokens as well --silent Silent mode - do not display information Lists your remotely generated Identity Tokens (Authentication) up [environment] -f Force deploy -r Upload a release package --force Force deploy --release Upload a release package Pushes Autocode package to registry and cloud environment user -s <key> <value> Sets a specified key-value pair --new-password Sets a new password via a prompt --reset-password <email> Sends a password reset request for the specified e-mail address --set <key> <value> Sets a specified key-value pair Retrieves (and sets) current user information version Returns currently installed version of Autocode command line tools ``` # Upgrading from previous versions If you're running a previous version and are having issues with the CLI, try cleaning up the old CLI binary links first; ``` $ rm /usr/local/bin/f $ rm /usr/local/bin/lib $ rm /usr/local/bin/stdlib ``` # That's it! Yep, it's really that easy. To keep up-to-date on developments, please star us here on GitHub, and sign up a user account for the registry. You can read more about service hosting and keep track of official updates on [the official Autocode website, autocode.com](https://autocode.com). # Acknowledgements Autocode is a product of and &copy; 2021 Polybit Inc. We'd love for you to pay attention to [@AutocodeHQ](https://twitter.com/AutocodeHQ) and what we're building next! If you'd consider joining the team, [shoot us an e-mail](mailto:[email protected]). You can also follow our team on Twitter: - [@keithwhor (Keith Horwood)](https://twitter.com/keithwhor) - [@hacubu (Jacob Lee)](https://twitter.com/hacubu) - [@YusufMusleh (Yusuf Musleh)](https://twitter.com/YusufMusleh) - [@threesided (Scott Gamble)](https://twitter.com/threesided) Issues encouraged, PRs welcome, and we're happy to have you on board! Enjoy and happy building :) # Thanks Special thanks to the people and companies that have believed in and supported our vision and development over the years. - Slack [@SlackHQ](https://twitter.com/SlackHQ) - Stripe [@Stripe](https://twitter.com/Stripe) - Romain Huet [@romainhuet](https://twitter.com/romainhuet) - Chad Fowler [@chadfowler](https://twitter.com/chadfowler) - Brian LeRoux [@brianleroux](https://twitter.com/brianleroux) - Ahmad Nassri [@AhmadNassri](https://twitter.com/AhmadNassri) ... and many more!

List of API's for gathering information about phone numbers, addresses, domains etc

<div align="center"> <img align="center" src="./logo.png" width="180px" > <h2 align="center">APIs For OSINT</h2> <img alt="GitHub stars" src="https://img.shields.io/github/stars/cipher387/API-s-for-OSINT"> <img alt="GitHub forks" src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"> <img alt="GitHub forks" src="https://img.shields.io/github/forks/cipher387/API-s-for-OSINT"> This is a Collection of APIs that will be useful for automating various tasks in OSINT. </p> </div> [](https://github.com/dwyl/esta/issues) <p align="center"> [](https://hits.seeyoufarm.com) Instruction for total beginners: [OSINT automation: using сustom functions for working with API requests in Google Sheets](https://medium.com/@cyb_detective/osint-automation-using-%D1%81ustom-functions-for-working-with-api-requests-in-google-sheets-3f7130cf5f82) Thank you for following me! [@cyb_detective](https://linktr.ee/cyb_detective) ## Table of contents - [APIs](#phone-number-lookup-and-verification) - [Phone Number Lookup and Verification](#phone-number-lookup-and-verification) - [Address/ZIP codes lookup](#addresszip-codes-lookup) - [People and documents verification](#people-and-documents-verification) - [Business/Entity search](#businessentity-search) - [Domain/DNS/IP lookup](#domaindnsip-lookup) - [Mobile Apps Endpoints](#mobile-apps-endpoints) - [Scraping](#scraping) - [Whois](#whois) - [GEO IP](#geo-ip) - [Wi-fi lookup](#wi-fi-lookup) - [Network](#network) - [Finance](#finance) - [Email](#email) - [Names/Surnames](#names) - [Pastebin/Leaks](#pastebinleaks) - [Archives](#archives) - [Hashes decrypt/encrypt](#hashes-decryptencrypt) - [Crypto](#crypto) - [IOT](#iot) - [Malware](#malware) - [Face Search and detection](#face-search) - [Social Media and Messengers](#social-media-and-messengers) - [UNOFFICIAL APIs](#unofficial-apis) - [Search Engines](#search-engines) - [News analyze](#news-analyze) - [Darknet](#darknet) - [Torrents/file sharing](#torrentsfile-sharing) - [Flights](#flights) - [Webcams](#webcams) - [Regular expressions](#regex) - [API testing tools](#api-testing-tools) - [Curl converters](#curl-converters-tools-that-help-to-write-code-using-api-queries) - [Create your own API](#create-your-own-api) - [Distribute your own API](#distribute-your-own-api) - [API Keys Info](#api-keys-info) - [Contributing](#contributing) - [Contact](#contact) - [License](#license) ## Phone Number Lookup and Verification | Name | Link | Description | Price | | ---------- | --------------------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------- | | Numverify | https://numverify.com | Global Phone Number Validation & Lookup JSON API. Supports 232 countries. | 250 requests FREE | | Twillo | https://www.twilio.com/docs/lookup/api | Provides a way to retrieve additional information about a phone number | Free or $0.01 per request (for caller lookup) | | Plivo | https://www.plivo.com/lookup/ | Determine carrier, number type, format, and country for any phone number worldwide | from $0.04 per request | | GetContact | https://github.com/kovinevmv/getcontact | Find info about user by phone number | from $6,89 in months/100 requests | | Veriphone | https://veriphone.io/ | Phone number validation & carrier lookup | 1000 requests/month FREE | ## Address/ZIP codes lookup | Name | Link | Description | Price | | ---------------------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------- | | Global Address | https://rapidapi.com/adminMelissa/api/global-address/ | Easily verify, check or lookup address | FREE | | US Street Address | https://smartystreets.com/docs/cloud/us-street-api | Validate and append data for any US postal address | FREE | | Google Maps Geocoding API | https://developers.google.com/maps/documentation/geocoding/overview | convert addresses (like "1600 Amphitheatre Parkway, Mountain View, CA") into geographic coordinates | 0.005 USD per request | | Postcoder | https://postcoder.com/address-lookup | Find adress by postcode | £130/5000 requests | | Zipcodebase | https://zipcodebase.com | Lookup postal codes, calculate distances and much more | 5000 requests FREE | | Openweathermap geocoding API | https://openweathermap.org/api/geocoding-api | get geographical coordinates (lat, lon) by using name of the location (city name or area name) | 60 calls/minute 1,000,000 calls/month | | DistanceMatrix | https://distancematrix.ai/product | Calculate, evaluate and plan your routes | $1.25-$2 per 1000 elements | ## People and documents verification | Name | Link | Description | Price | | ------------ | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | | Approuve.com | https://appruve.co | Allows you to verify the identities of individuals, businesses, and connect to financial account data across Africa | Paid | | Onfido.com | https://onfido.com | Onfido Document Verification lets your users scan a photo ID from any device, before checking it's genuine. Combined with Biometric Verification, it's a seamless way to anchor an account to the real identity of a customer. India | Paid | | Superpass.io | https://surepass.io/passport-id-verification-api/ | Passport, Photo ID and Driver License Verification in India | Paid | ## Business/Entity search | Name | Link | Description | Price | | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------- | | Open corporates | https://api.opencorporates.com | Companies information | Paid, price upon request | | Linkedin company search API | https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/company-search?context=linkedin%2Fcompliance%2Fcontext&tabs=http | Find companies using keywords, industry, location, and other criteria | FREE | | Mattermark | https://rapidapi.com/raygorodskij/api/Mattermark/ | Get companies and investor information | free 14-day trial, from $49 per month | ## Domain/DNS/IP lookup | Name | Link | Description | Price | | ---------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | API OSINT DS | https://github.com/davidonzo/apiosintDS | Collect info about IPv4/FQDN/URLs and file hashes in md5, sha1 or sha256 | FREE | | InfoDB API | https://www.ipinfodb.com/api | The API returns the location of an IP address (country, region, city, zipcode, latitude, longitude) and the associated timezone in XML, JSON or plain text format | FREE | | Domainsdb.info | https://domainsdb.info | Registered Domain Names Search | FREE | | BGPView | https://bgpview.docs.apiary.io/# | allowing consumers to view all sort of analytics data about the current state and structure of the internet | FREE | | DNSCheck | https://www.dnscheck.co/api | monitor the status of both individual DNS records and groups of related DNS records | up to 10 DNS records/FREE | | Cloudflare Trace | https://github.com/fawazahmed0/cloudflare-trace-api | Get IP Address, Timestamp, User Agent, Country Code, IATA, HTTP Version, TLS/SSL Version & More | FREE | | Host.io | https://host.io/ | Get info about domain | FREE | ## Mobile Apps Endpoints | Name | Link | Description | Price | | ----------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | BeVigil OSINT API | https://bevigil.com/osint-api | provides access to millions of asset footprint data points including domain intel, cloud services, API information, and third party assets extracted from millions of mobile apps being continuously uploaded and scanned by users on bevigil.com | 50 credits free/1000 credits/$50 | ## Scraping | Name | Link | Description | Price | | -------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | ----- | | WebScraping.AI | https://webscraping.ai/ | Web Scraping API with built-in proxies and JS rendering | FREE | | ZenRows | https://www.zenrows.com/ | Web Scraping API that bypasses anti-bot solutions while offering JS rendering, and rotating proxies apiKey Yes Unknown | FREE | ## Whois | Name | Link | Description | Price | | ------------ | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------- | | Whois freaks | https://whoisfreaks.com/ | well-parsed and structured domain WHOIS data for all domain names, registrars, countries and TLDs since the birth of internet | $19/5000 requests | | WhoisXMLApi | https://whois.whoisxmlapi.com | gathers a variety of domain ownership and registration data points from a comprehensive WHOIS database | 500 requests in month/FREE | | IPtoWhois | https://www.ip2whois.com/developers-api | Get detailed info about a domain | 500 requests/month FREE | ## GEO IP | Name | Link | Description | Price | | ---------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | Ipstack | https://ipstack.com | Detect country, region, city and zip code | FREE | | Ipgeolocation.io | https://ipgeolocation.io | provides country, city, state, province, local currency, latitude and longitude, company detail, ISP lookup, language, zip code, country calling code, time zone, current time, sunset and sunrise time, moonset and moonrise | 30 000 requests per month/FREE | | IPInfoDB | https://ipinfodb.com/api | Free Geolocation tools and APIs for country, region, city and time zone lookup by IP address | FREE | | IP API | https://ip-api.com/ | Free domain/IP geolocation info | FREE | ## Wi-fi lookup | Name | Link | Description | Price | | ------------ | ------------------------ | -------------------------------------------------------- | ----- | | Mylnikov API | https://www.mylnikov.org | public API implementation of Wi-Fi Geo-Location database | FREE | | Wigle | https://api.wigle.net/ | get location and other information by SSID | FREE | ## Network | Name | Link | Description | Price | | ----------- | ---------------------------------- | ---------------------------------------------------------------------- | ----- | | PeetingDB | https://www.peeringdb.com/apidocs/ | Database of networks, and the go-to location for interconnection data | FREE | | PacketTotal | https://packettotal.com/api.html | .pcap files analyze | FREE | ## Finance | Name | Link | Description | Price | | ------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | -------------------------------- | | Binlist.net | https://binlist.net/ | get information about bank by BIN | FREE | | FDIC Bank Data API | https://banks.data.fdic.gov/docs/ | institutions, locations and history events | FREE | | Amdoren | https://www.amdoren.com/currency-api/ | Free currency API with over 150 currencies | FREE | | VATComply.com | https://www.vatcomply.com/documentation | Exchange rates, geolocation and VAT number validation | FREE | | Alpaca | https://alpaca.markets/docs/api-documentation/api-v2/market-data/alpaca-data-api-v2/ | Realtime and historical market data on all US equities and ETFs | FREE | | Swiftcodesapi | https://swiftcodesapi.com | Verifying the validity of a bank SWIFT code or IBAN account number | $39 per month/4000 swift lookups | | IBANAPI | https://ibanapi.com | Validate IBAN number and get bank account information from it | Freemium/10$ Starter plan | ## Email | Name | Link | Description | Price | | ------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | EVA | https://eva.pingutil.com/ | Measuring email deliverability & quality | FREE | | Mailboxlayer | https://mailboxlayer.com/ | Simple REST API measuring email deliverability & quality | 100 requests FREE, 5000 requests in month — $14.49 | | EmailCrawlr | https://emailcrawlr.com/ | Get key information about company websites. Find all email addresses associated with a domain. Get social accounts associated with an email. Verify email address deliverability. | 200 requests FREE, 5000 requets — $40 | | Voila Norbert | https://www.voilanorbert.com/api/ | Find anyone's email address and ensure your emails reach real people | from $49 in month | | Kickbox | https://open.kickbox.com/ | Email verification API | FREE | | FachaAPI | https://api.facha.dev/ | Allows checking if an email domain is a temporary email domain | FREE | ## Name/Surname | Name | Link | Description | Price | | ------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | Genderize.io | https://genderize.io | Instantly answers the question of how likely a certain name is to be male or female and shows the popularity of the name. | 1000 names/day free | | Agify.io | https://agify.io | Predicts the age of a person given their name | 1000 names/day free | | Nataonalize.io | https://nationalize.io | Predicts the nationality of a person given their name | 1000 names/day free | ## Pastebin/Leaks | Name | Link | Description | Price | | ------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | | HaveIBeenPwned | https://haveibeenpwned.com/API/v3 | allows the list of pwned accounts (email addresses and usernames) | $3.50 per month | | Psdmp.ws | https://psbdmp.ws/api | search in Pastebin | $9.95 per 10000 requests | | LeakPeek | https://psbdmp.ws/api | searc in leaks databases | $9.99 per 4 weeks unlimited access | | BreachDirectory.com | https://breachdirectory.com/api?lang=en | search domain in data breaches databases | FREE | | LeekLookup | https://leak-lookup.com/api | search domain, email_address, fullname, ip address, phone, password, username in leaks databases | 10 requests FREE | | BreachDirectory.org | https://rapidapi.com/rohan-patra/api/breachdirectory/pricing | search domain, email_address, fullname, ip address, phone, password, username in leaks databases (possible to view password hashes) | 50 requests in month/FREE | ## Archives | Name | Link | Description | Price | | ------------------- | ---------------------------------------- | ---------------------------------------------------------------- | ----- | | Wayback Machine API (Memento API, CDX Server API, Wayback Availability JSON API) | https://archive.org/help/wayback_api.php | Retrieve information about Wayback capture data | FREE | | TROVE (Australian Web Archive) API | https://trove.nla.gov.au/about/create-something/using-api | Retrieve information about TROVE capture data | FREE | | Archive-it API | https://support.archive-it.org/hc/en-us/articles/115001790023-Access-Archive-It-s-Wayback-index-with-the-CDX-C-API | Retrieve information about archive-it capture data | FREE | | UK Web Archive API | https://ukwa-manage.readthedocs.io/en/latest/#api-reference | Retrieve information about UK Web Archive capture data | FREE | | Arquivo.pt API | https://github.com/arquivo/pwa-technologies/wiki/Arquivo.pt-API | Allows full-text search and access preserved web content and related metadata. It is also possible to search by URL, accessing all versions of preserved web content. API returns a JSON object. | FREE | | Library Of Congress archive API | https://www.loc.gov/apis/ | Provides structured data about Library of Congress collections | FREE | | BotsArchive | https://botsarchive.com/docs.html | JSON formatted details about Telegram Bots available in database | FREE | ## Hashes decrypt/encrypt | Name | Link | Description | Price | | ----------- | ------------------------------ | ------------------------------------------- | ------------- | | MD5 Decrypt | https://md5decrypt.net/en/Api/ | Search for decrypted hashes in the database | 1.99 EURO/day | ## Crypto | Name | Link | Description | Price | | ------------------ | ----------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------- | | BTC.com | https://btc.com/btc/adapter?type=api-doc | get information about addresses and transanctions | FREE | | Blockchair | https://blockchair.com | Explore data stored on 17 blockchains (BTC, ETH, Cardano, Ripple etc) | $0.33 - $1 per 1000 calls | | Bitcointabyse | https://www.bitcoinabuse.com/api-docs | Lookup bitcoin addresses that have been linked to criminal activity | FREE | | Bitcoinwhoswho | https://www.bitcoinwhoswho.com/api | Scam reports on the Bitcoin Address | FREE | | Etherscan | https://etherscan.io/apis | Ethereum explorer API | FREE | | apilayer coinlayer | https://coinlayer.com | Real-time Crypto Currency Exchange Rates | FREE | | BlockFacts | https://blockfacts.io/ | Real-time crypto data from multiple exchanges via a single unified API, and much more | FREE | | Brave NewCoin | https://bravenewcoin.com/developers | Real-time and historic crypto data from more than 200+ exchanges | FREE | | WorldCoinIndex | https://www.worldcoinindex.com/apiservice | Cryptocurrencies Prices | FREE | ## IOT | Name | Link | Description | Price | | --------- | ------------------------------------- | -------------------------------------------------------- | -------------- | | Shodan | https://developer.shodan.io | IP and DNS information about all devices in the internet | from $59/month | | Fofa.so | https://fofa.so/static_pages/api_help | IP and DNS information about all devices in the internet | ??? | | Censys.io | https://censys.io/api | Search engine for Internet connected host and devices | FREE | ## Malware | Name | Link | Description | Price | | ------------------------------------- | ----------------------------------------------------------------- | ------------------------ | ------------------ | | VirusTotal | https://developers.virustotal.com/reference | files and urls analyze | Public API is FREE | | AbuseLPDB | https://docs.abuseipdb.com/#introduction | IP/domain/URL reputation | FREE | | AlienVault Open Threat Exchange (OTX) | https://otx.alienvault.com/api | IP/domain/URL reputation | FREE | | Phisherman | https://phisherman.gg | IP/domain/URL reputation | FREE | | URLScan.io | https://urlscan.io/about-api/ | Scan and Analyse URLs | FREE | | Web of Thrust | https://support.mywot.com/hc/en-us/sections/360004477734-API- | IP/domain/URL reputation | FREE | | Threat Jammer | https://threatjammer.com/docs/introduction-threat-jammer-user-api | IP/domain/URL reputation | ??? | ## Face Search | Name | Link | Description | Price | | ------------ | --------------------------------- | ---------------------------------------------------- | --------------------- | | Search4faces | https://search4faces.com/api.html | Detect and locate human faces within an image, and returns high-precision face bounding boxes. Face⁺⁺ also allows you to store metadata of each detected face for future use. | $21 per 1000 requests | ## Face Detection | Name | Link | Description | Price | | ------------ | --------------------------------- | ---------------------------------------------------- | --------------------- | | Face++ | https://www.faceplusplus.com/face-detection/ | Search for people in social networks by facial image | from 0.03 per call | | BetaFace | https://www.betafaceapi.com/wpa/ | Can scan uploaded image files or image URLs, find faces and analyze them. API also provides verification (faces comparison) and identification (faces search) services, as well able to maintain multiple user-defined recognition databases (namespaces) | 50 image per day FREE/from 0.15 EUR per request| ## Social Media and Messengers | Name | Link | Description | Price | | ------------------------------ | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------- | ----- | | Twitch | https://dev.twitch.tv/docs/v5/reference | | | | YouTube Data API | https://developers.google.com/youtube/v3 | | | | Reddit | https://www.reddit.com/dev/api/ | | | | Vkontakte | https://vk.com/dev/methods | | | | Twitter API | https://developer.twitter.com/en | | | | Linkedin API | https://docs.microsoft.com/en-us/linkedin/ | | | | All Facebook and Instagram API | https://developers.facebook.com/docs/ | | | | Whatsapp Business API | https://www.whatsapp.com/business/api | | | | Telegram and Telegram Bot API | https://core.telegram.org | | | | Weibo API | https://open.weibo.com/wiki/API文档/en | | | | XING | https://dev.xing.com/partners/job_integration/api_docs | | | | Viber | https://developers.viber.com/docs/api/rest-bot-api/ | | | | Dicord | https://discord.com/developers/docs | | | | Odnoklassniki | https://ok.ru/apiok | | | | Blogger | https://developers.google.com/blogger/ | The Blogger APIs allows client applications to view and update Blogger content | FREE | | Disqus | https://disqus.com/api/docs/auth/ | Communicate with Disqus data | FREE | | Foursquare | https://developer.foursquare.com/ | Interact with Foursquare users and places (geolocation-based checkins, photos, tips, events, etc) | FREE | | HackerNews | https://github.com/HackerNews/API | Social news for CS and entrepreneurship | FREE | | Kakao | https://developers.kakao.com/ | Kakao Login, Share on KakaoTalk, Social Plugins and more | FREE | | Line | https://developers.line.biz/ | Line Login, Share on Line, Social Plugins and more | FREE | | TikTok | https://developers.tiktok.com/doc/login-kit-web | Fetches user info and user's video posts on TikTok platform | FREE | | Tumblr | https://www.tumblr.com/docs/en/api/v2 | Read and write Tumblr Data | FREE | ## UNOFFICIAL APIs > !WARNING Use with caution! Accounts may be blocked permanently for using unofficial APIs. | Name | Link | Description | Price | | ------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------- | ----- | | TikTok | https://github.com/davidteather/TikTok-Api | The Unofficial TikTok API Wrapper In Python | FREE | | Google Trends | https://github.com/suryasev/unofficial-google-trends-api | Unofficial Google Trends API | FREE | | YouTube Music | https://github.com/sigma67/ytmusicapi | Unofficial APi for YouTube Music | FREE | | Duolingo | https://github.com/KartikTalwar/Duolingo | Duolingo unofficial API (can gather info about users) | FREE | | Steam. | https://github.com/smiley/steamapi | An unofficial object-oriented Python library for accessing the Steam Web API. | FREE | | Instagram | https://github.com/ping/instagram_private_api | Instagram Private API | FREE | | Discord | https://github.com/discordjs/discord.js | JavaScript library for interacting with the Discord API | FREE | | Zhihu | https://github.com/syaning/zhihu-api | FREE Unofficial API for Zhihu | FREE | | Quora | https://github.com/csu/quora-api | Unofficial API for Quora | FREE | | DnsDumbster | https://github.com/PaulSec/API-dnsdumpster.com | (Unofficial) Python API for DnsDumbster | FREE | | PornHub | https://github.com/sskender/pornhub-api | Unofficial API for PornHub in Python | FREE | | Skype | https://github.com/ShyykoSerhiy/skyweb | Unofficial Skype API for nodejs via 'Skype (HTTP)' protocol. | FREE | | Google Search | https://github.com/aviaryan/python-gsearch | Google Search unofficial API for Python with no external dependencies | FREE | | Airbnb | https://github.com/nderkach/airbnb-python | Python wrapper around the Airbnb API (unofficial) | FREE | | Medium | https://github.com/enginebai/PyMedium | Unofficial Medium Python Flask API and SDK | FREE | | Facebook | https://github.com/davidyen1124/Facebot | Powerful unofficial Facebook API | FREE | | Linkedin | https://github.com/tomquirk/linkedin-api | Unofficial Linkedin API for Python | FREE | ## Search Engines | Name | Link | Description | Price | | ------------------------------ | ------------------------------------------------------------- | ----------------------------------------------------------------------------- | -------------------------------- | | Google Custom Search JSON API | https://developers.google.com/custom-search/v1/overview | Search in Google | 100 requests FREE | | Serpstack | https://serpstack.com/ | Google search results to JSON | FREE | | Serpapi | https://serpapi.com | Google, Baidu, Yandex, Yahoo, DuckDuckGo, Bint and many others search results | $50/5000 searches/month | | Bing Web Search API | https://www.microsoft.com/en-us/bing/apis/bing-web-search-api | Search in Bing (+instant answers and location) | 1000 transactions per month FREE | | WolframAlpha API | https://products.wolframalpha.com/api/pricing/ | Short answers, conversations, calculators and many more | from $25 per 1000 queries | | DuckDuckgo Instant Answers API | https://duckduckgo.com/api | An API for some of our Instant Answers, not for full search results. | FREE | | Memex Marginalia | https://memex.marginalia.nu/projects/edge/api.gmi | An API for new privacy search engine | FREE | ## News analyze | Name | Link | Description | Price | | ---------- | ----------------------- | ------------------------------------ | ----------------------- | | MediaStack | https://mediastack.com/ | News articles search results in JSON | 500 requests/month FREE | ## Darknet | Name | Link | Description | Price | | ------------- | ---------------------------- | --------------------------------- | ----- | | Darksearch.io | https://darksearch.io/apidoc | search by websites in .onion zone | FREE | ## Torrents/file sharing | Name | Link | Description | Price | | ------------- | ---------------------------- | --------------------------------- | ----- | | Jackett | https://github.com/Jackett/Jackett | API for automate searching in different torrent trackers | FREE | | Torrents API PY | [https://github.com/Jackett/Jackett](https://github.com/Ryuk-me/Torrent-Api-py) | Unofficial API for 1337x, Piratebay, Nyaasi, Torlock, Torrent Galaxy, Zooqle, Kickass, Bitsearch, MagnetDL,Libgen, YTS, Limetorrent, TorrentFunk, Glodls, Torre | FREE | | Torrent Search API | [https://github.com/Jackett/Jackett](https://rapidapi.com/theoneappkh/api/torrent-search/) | API for Torrent Search Engine with Extratorrents, Piratebay, and ISOhunt | 500 queries/day FREE | | Torrent search api | https://github.com/JimmyLaurent/torrent-search-api | Yet another node torrent scraper (supports iptorrents, torrentleech, torrent9, torrentz2, 1337x, thepiratebay, Yggtorrent, TorrentProject, Eztv, Yts, LimeTorrents) | FREE | | Torrentinim | https://github.com/sergiotapia/torrentinim | Very low memory-footprint, self hosted API-only torrent search engine. Sonarr + Radarr Compatible, native support for Linux, Mac and Windows. | FREE | ## Flights | Name | Link | Description | Price | | --------------- | --------------------------------------------- | ---------------------------------------------------------------------------------- | ----- | | Aviation Stack | https://aviationstack.com | get information about flights, aircrafts and airlines | FREE | | OpenSky Network | https://opensky-network.org/apidoc/index.html | Free real-time ADS-B aviation data | FREE | | AviationAPI | https://docs.aviationapi.com/ | FAA Aeronautical Charts and Publications, Airport Information, and Airport Weather | FREE | | FachaAPI | https://api.facha.dev | Aircraft details and live positioning API | FREE | ## Webcams | Name | Link | Description | Price | | ----------------- | ---------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------- | | Windy Webcams API | https://api.windy.com/webcams/docs | Get a list of available webcams for a country, city or geographical coordinates | FREE with limits or 9990 euro without limits | ## Regex | Name | Link | Description | Price | | ----------------- | ---------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------- | | Autoregex | https://autoregex.notion.site/AutoRegex-API-Documentation-97256bad2c114a6db0c5822860214d3a | Convert English phrase to regular expression | from $3.49/month | ## API testing tools | Name | Link | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | | API Guessr (detect API by auth key or by token) | https://api-guesser.netlify.app/ | | REQBIN Online REST & SOAP API Testing Tool | https://reqbin.com | | ExtendClass Online REST Client | https://extendsclass.com/rest-client-online.html | | Codebeatify.org Online API Test | https://codebeautify.org/api-test | | SyncWith Google Sheet add-on. Link more than 1000 APIs with Spreadsheet | https://workspace.google.com/u/0/marketplace/app/syncwith_crypto_binance_coingecko_airbox/449644239211?hl=ru&pann=sheets_addon_widget | | Talend API Tester Google Chrome Extension | https://workspace.google.com/u/0/marketplace/app/syncwith_crypto_binance_coingecko_airbox/449644239211?hl=ru&pann=sheets_addon_widget | | ## Curl converters (tools that help to write code using API queries) | Name | Link | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | | Convert curl commands to Python, JavaScript, PHP, R, Go, C#, Ruby, Rust, Elixir, Java, MATLAB, Dart, CFML, Ansible URI or JSON | https://curlconverter.com | | Curl-to-PHP. Instantly convert curl commands to PHP code |https://incarnate.github.io/curl-to-php/ | | Curl to PHP online (Codebeatify) | https://codebeautify.org/curl-to-php-online | | Curl to JavaScript fetch | https://kigiri.github.io/fetch/ | | Curl to JavaScript fetch (Scrapingbee) | https://www.scrapingbee.com/curl-converter/javascript-fetch/ | | Curl to C# converter | https://curl.olsh.me | ## Create your own API | Name | Link | | -------------------------------------------------------------------- | --------------------------------- | | Sheety. Create API frome GOOGLE SHEET | https://sheety.co/ | | Postman. Platform for creating your own API | https://www.postman.com | | Reetoo. Rest API Generator | https://retool.com/api-generator/ | | Beeceptor. Rest API mocking and intercepting in seconds (no coding). | https://beeceptor.com | ## Distribute your own API | Name | Link | | ---------------------------------------------------- | ------------------------------------------- | | RapidAPI. Market your API for millions of developers | https://rapidapi.com/solution/api-provider/ | | Apilayer. API Marketplace | https://apilayer.com | ## API Keys Info | Name | Link | Description | | ---------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | Keyhacks | https://github.com/streaak/keyhacks | Keyhacks is a repository which shows quick ways in which API keys leaked by a bug bounty program can be checked to see if they're valid. | | All about APIKey | https://github.com/daffainfo/all-about-apikey | Detailed information about API key / OAuth token for different services (Description, Request, Response, Regex, Example) | | API Guessr | https://api-guesser.netlify.app/ | Enter API Key and and find out which service they belong to | ## Contributing Contributions are always welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first. ## Contact - Revue : [@cyb_detective](https://www.getrevue.co/profile/cyb_detective) - Github : [@cipher387](https://github.com/cipher387) - Twitter : [@cyb_detective](https://twitter.com/cyb_detective) - Telegram : [@cybdetective](https://t.me/cybdetective) ## License  This work is licensed under a [CC0 1.0 Universal](LICENSE.md) license.

A Laravel Fractal package for building API responses, giving you the power of Fractal with Laravel's elegancy.

<p align="center"><img src="http://designiack.no/package-logo.png" width="396" height="111"></p> <p align="center"> <a href="https://github.com/flugger/laravel-responder"><img src="https://poser.pugx.org/flugger/laravel-responder/v/stable?format=flat-square" alt="Latest Stable Version"></a> <a href="https://packagist.org/packages/flugger/laravel-responder"><img src="https://img.shields.io/packagist/dt/flugger/laravel-responder.svg?style=flat-square" alt="Packagist Downloads"></a> <a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square" alt="Software License"></a> <a href="https://travis-ci.org/flugger/laravel-responder"><img src="https://img.shields.io/travis/flugger/laravel-responder/master.svg?style=flat-square" alt="Build Status"></a> <a href="https://scrutinizer-ci.com/g/flugger/laravel-responder/?branch=master"><img src="https://img.shields.io/scrutinizer/g/flugger/laravel-responder.svg?style=flat-square" alt="Code Quality"></a> <a href="https://scrutinizer-ci.com/g/flugger/laravel-responder/code-structure/master"><img src="https://img.shields.io/scrutinizer/coverage/g/flugger/laravel-responder.svg?style=flat-square" alt="Test Coverage"></a> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=PRMC9WLJY8E46&lc=NO&item_name=Laravel%20Responder&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted"><img src="https://img.shields.io/badge/donate-PayPal-yellow.svg?style=flat-square" alt="Donate"></a> </p> Laravel Responder is a package for building API responses, integrating [Fractal](https://github.com/thephpleague/fractal) into Laravel and Lumen. It can transform your data using transformers, create and serialize success- and error responses, handle exceptions and assist you with testing your responses. # Table of Contents - [Introduction](#introduction) - [Requirements](#requirements) - [Installation](#installation) - [Usage](#usage) - [Creating Responses](#creating-responses) - [Creating Success Responses](#creating-success-responses) - [Creating Transformers](#creating-transformers) - [Transforming Data](#transforming-data) - [Creating Error Responses](#creating-error-responses) - [Handling Exceptions](#handling-exceptions) - [Contributing](#contributing) - [Donating](#contributing) - [License](#license) # Introduction Laravel lets you return models directly from a controller method to convert it to JSON. This is a quick way to build APIs but leaves your database columns exposed. [Fractal](https://fractal.thephpleague.com), a popular PHP package from [The PHP League](https://thephpleague.com/), solves this by introducing transformers. However, it can be a bit cumbersome to integrate into the framework as seen below: ```php public function index() { $resource = new Collection(User::all(), new UserTransformer()); return response()->json((new Manager)->createData($resource)->toArray()); } ``` Not _that_ bad, but we all get a little spoiled by Laravel's magic. Wouldn't it be better if we could refactor it to: ```php public function index() { return responder()->success(User::all())->respond(); } ``` The package will allow you to do this and much more. The goal has been to create a high-quality package that feels like native Laravel. A package that lets you embrace the power of Fractal, while hiding it behind beautiful abstractions. There has also been put a lot of focus and thought to the documentation. Happy exploration! # Requirements This package requires: - PHP __7.0__+ - Laravel __5.1__+ or Lumen __5.1__+ # Installation To get started, install the package through Composer: ```shell composer require flugger/laravel-responder ``` ## Laravel #### Register Service Provider Append the following line to the `providers` key in `config/app.php` to register the package: ```php Flugg\Responder\ResponderServiceProvider::class, ``` *** _The package supports auto-discovery, so if you use Laravel 5.5 or later you may skip registering the service provider and facades as they will be registered automatically._ *** #### Register Facades _(optional)_ If you like facades, you may also append the `Responder` and `Transformation` facades to the `aliases` key: ```php 'Responder' => Flugg\Responder\Facades\Responder::class, 'Transformation' => Flugg\Responder\Facades\Transformation::class, ``` #### Publish Package Assets _(optional)_ You may additionally publish the package configuration and language file using the `vendor:publish` Artisan command: ```shell php artisan vendor:publish --provider="Flugg\Responder\ResponderServiceProvider" ``` This will publish a `responder.php` configuration file in your `config` folder. It will also publish an `errors.php` file inside your `lang/en` folder which can be used for storing error messages. ## Lumen #### Register Service Provider Add the following line to `app/bootstrap.php` to register the package: ```php $app->register(Flugg\Responder\ResponderServiceProvider::class); ``` #### Register Facades _(optional)_ You may also add the following lines to `app/bootstrap.php` to register the facades: ```php class_alias(Flugg\Responder\Facades\Responder::class, 'Responder'); class_alias(Flugg\Responder\Facades\Transformation::class, 'Transformation'); ``` #### Publish Package Assets _(optional)_ Seeing there is no `vendor:publish` command in Lumen, you will have to create your own `config/responder.php` file if you want to configure the package. # Usage This documentation assumes some knowledge of how [Fractal](https://github.com/thephpleague/fractal) works. ## Creating Responses The package has a `Responder` service class, which has a `success` and `error` method to build success- and error responses respectively. To use the service and begin creating responses, pick one of the options below: #### Option 1: Inject `Responder` Service You may inject the `Flugg\Responder\Responder` service class directly into your controller methods: ```php public function index(Responder $responder) { return $responder->success(); } ``` You can also use the `error` method to create error responses: ```php return $responder->error(); ``` #### Option 2: Use `responder` Helper If you're a fan of Laravel's `response` helper function, you may like the `responder` helper function: ```php return responder()->success(); ``` ```php return responder()->error(); ``` #### Option 3: Use `Responder` Facade Optionally, you may use the `Responder` facade to create responses: ```php return Responder::success(); ``` ```php return Responder::error(); ``` #### Option 4: Use `MakesResponses` Trait Lastly, the package provides a `Flugg\Responder\Http\MakesResponses` trait you can use in your controllers: ```php return $this->success(); ``` ```php return $this->error(); ``` *** _Which option you pick is up to you, they are all equivalent, the important thing is to stay consistent. The helper function (option 2) will be used for the remaining of the documentation._ *** ### Building Responses The `success` and `error` methods return a `SuccessResponseBuilder` and `ErrorResponseBuilder` respectively, which both extend an abstract `ResponseBuilder`, giving them common behaviors. They will be converted to JSON when returned from a controller, but you can explicitly create an instance of `Illuminate\Http\JsonResponse` with the `respond` method: ```php return responder()->success()->respond(); ``` ```php return responder()->error()->respond(); ``` The status code is set to `200` by default, but can be changed by setting the first parameter. You can also pass a list of headers as the second argument: ```php return responder()->success()->respond(201, ['x-foo' => true]); ``` ```php return responder()->error()->respond(404, ['x-foo' => false]); ``` *** _Consider always using the `respond` method for consistency's sake._ *** ### Casting Response Data Instead of converting the response to a `JsonResponse` using the `respond` method, you can cast the response data to a few other types, like an array: ```php return responder()->success()->toArray(); ``` ```php return responder()->error()->toArray(); ``` You also have a `toCollection` and `toJson` method at your disposal. ### Decorating Response A response decorator allows for last minute changes to the response before it's returned. The package comes with two response decorators out of the box adding a `status` and `success` field to the response output. The `decorators` key in the configuration file defines a list of all enabled response decorators: ```php 'decorators' => [ \Flugg\Responder\Http\Responses\Decorators\StatusCodeDecorator::class, \Flugg\Responder\Http\Responses\Decorators\SuccessFlagDecorator::class, ], ``` You may disable a decorator by removing it from the list, or add your own decorator extending the abstract class `Flugg\Responder\Http\Responses\Decorators\ResponseDecorator`. You can also add additional decorators per response: ```php return responder()->success()->decorator(ExampleDecorator::class)->respond(); ``` ```php return responder()->error()->decorator(ExampleDecorator::class)->respond(); ``` *** The package also ships with some situational decorators disabled by default, but which can be added to the decorator list: - `PrettyPrintDecorator` decorator will beautify the JSON output; ```php \Flugg\Responder\Http\Responses\Decorators\PrettyPrintDecorator::class, ``` - `EscapeHtmlDecorator` decorator, based on the "sanitize input, escape output" concept, will escape HTML entities in all strings returned by your API. You can securely store input data "as is" (even malicious HTML tags) being sure that it will be outputted as un-harmful strings. Note that, using this decorator, printing data as text will result in the wrong representation and you must print it as HTML to retrieve the original value. ```php \Flugg\Responder\Http\Responses\Decorators\EscapeHtmlDecorator::class, ``` *** ## Creating Success Responses As briefly demonstrated above, success responses are created using the `success` method: ```php return responder()->success()->respond(); ``` Assuming no changes have been made to the configuration, the above code would output the following JSON: ```json { "status": 200, "success": true, "data": null } ``` ### Setting Response Data The `success` method takes the response data as the first argument: ```php return responder()->success(Product::all())->respond(); ``` It accepts the same data types as you would normally return from your controllers, however, it also supports query builder and relationship instances: ```php return responder()->success(Product::where('id', 1))->respond(); ``` ```php return responder()->success(Product::first()->shipments())->respond(); ``` *** _The package will run the queries and convert them to collections behind the scenes._ *** ### Transforming Response Data The response data will be transformed with Fractal if you've attached a transformer to the response. There are two ways to attach a transformer; either _explicitly_ by setting it on the response, or _implicitly_ by binding it to a model. Let's look at both ways in greater detail. #### Setting Transformer On Response You can attach a transformer to the response by sending a second argument to the `success` method. For instance, below we're attaching a simple closure transformer, transforming a list of products to only output their names: ```php return responder()->success(Product::all(), function ($product) { return ['name' => $product->name]; })->respond(); ``` You may also transform using a dedicated transformer class: ```php return responder()->success(Product::all(), ProductTransformer::class)->respond(); ``` ```php return responder()->success(Product::all(), new ProductTransformer)->respond(); ``` *** _You can read more about creating dedicated transformer classes in the [Creating Transformers](#creating-transformers) chapter._ *** #### Binding Transformer To Model If no transformer is set, the package will search the response data for an element implementing the `Flugg\Responder\Contracts\Transformable` interface to resolve a transformer from. You can take use of this by implementing the `Transformable` interface in your models: ```php class Product extends Model implements Transformable {} ``` You can satisfy the contract by adding a `transformer` method that returns the corresponding transformer: ```php /** * Get a transformer for the class. * * @return \Flugg\Responder\Transformers\Transformer|string|callable */ public function transformer() { return ProductTransformer::class; } ``` *** _You're not limited to returning a class name string, you can return a transformer instance or closure transformer, just like the second parameter of the `success` method._ *** Instead of implementing the `Transformable` contract for all models, an alternative approach is to bind the transformers using the `bind` method on the `TransformerResolver` class. You can place the code below within `AppServiceProvider` or an entirely new `TransformerServiceProvider`: ```php use Flugg\Responder\Contracts\Transformers\TransformerResolver; public function boot() { $this->app->make(TransformerResolver::class)->bind([ \App\Product::class => \App\Transformers\ProductTransformer::class, \App\Shipment::class => \App\Transformers\ShipmentTransformer::class, ]); } ``` After you've bound a transformer to a model you can skip the second parameter and still transform the data: ```php return responder()->success(Product::all())->respond(); ``` *** _As you might have noticed, unlike Fractal, you don't need to worry about creating resource objects like `Item` and `Collection`. The package will make one for you based on the data type, however, you may wrap your data in a resource object to override this._ *** ### Setting Resource Key If the data you send into the response is a model or contains a list of models, a resource key will implicitly be resolved from the model's table name. You can overwrite this by adding a `getResourceKey` method to your model: ```php public function getResourceKey(): string { return 'products'; } ``` You can also explicitly set a resource key on a response by sending a third argument to the ´success` method: ```php return responder()->success(Product::all(), ProductTransformer::class, 'products')->respond(); ``` ### Paginating Response Data Sending a paginator to the `success` method will set pagination meta data and transform the data automatically, as well as append any query string parameters to the paginator links. ```php return responder()->success(Product::paginate())->respond(); ``` Assuming there are no products and the default configuration is used, the JSON output would look like: ```json { "success": true, "status": 200, "data": [], "pagination": { "total": 0, "count": 0, "perPage": 15, "currentPage": 1, "totalPages": 1, "links": [] } } ``` #### Setting Paginator On Response Instead of sending a paginator as data, you may set the data and paginator seperately, like you traditionally would with Fractal. You can manually set a paginator using the `paginator` method, which expects an instance of `League\Fractal\Pagination\IlluminatePaginatorAdapter`: ```php $paginator = Product::paginate(); $adapter = new IlluminatePaginatorAdapter($paginator); return responder()->success($paginator->getCollection())->paginator($adapter)->respond(); ``` #### Setting Cursor On Response You can also set cursors using the `cursor` method, expecting an instance of `League\Fractal\Pagination\Cursor`: ```php if ($request->has('cursor')) { $products = Product::where('id', '>', request()->cursor)->take(request()->limit)->get(); } else { $products = Product::take(request()->limit)->get(); } $cursor = new Cursor(request()->cursor, request()->previous, $products->last()->id ?? null, Product::count()); return responder()->success($products)->cursor($cursor)->respond(); ``` ### Including Relationships If a transformer class is attached to the response, you can include relationships using the `with` method: ```php return responder()->success(Product::all())->with('shipments')->respond(); ``` You can send multiple arguments and specify nested relations using dot notation: ```php return responder()->success(Product::all())->with('shipments', 'orders.customer')->respond(); ``` All relationships will be automatically eager loaded, and just like you would when using `with` or `load` to eager load with Eloquent, you may use a callback to specify additional query constraints. Like in the example below, where we're only including related shipments that hasn't yet been shipped: ```php return responder()->success(Product::all())->with(['shipments' => function ($query) { $query->whereNull('shipped_at'); }])->respond(); ``` #### Including From Query String Relationships are loaded from a query string parameter if the `load_relations_parameter` configuration key is set to a string. By default, it's set to `with`, allowing you to automatically include relations from the query string: ``` GET /products?with=shipments,orders.customer ``` #### Excluding Default Relations In your transformer classes, you may specify relations to automatically load. You may disable any of these relations using the `without` method: ```php return responder()->success(Product::all())->without('comments')->respond(); ``` ### Filtering Transformed Data The technique of filtering the transformed data to only return what we need is called sparse fieldsets and can be specified using the `only` method: ```php return responder()->success(Product::all())->only('id', 'name')->respond(); ``` When including relationships, you may also want to filter fields on related resources as well. This can be done by instead specifying an array where each key represents the resource keys for the resources being filtered ```php return responder()->success(Product::all())->with('shipments')->only([ 'products' => ['id', 'name'], 'shipments' => ['id'] ])->respond(); ``` #### Filtering From Query String Fields will automatically be filtered if the `filter_fields_parameter` configuration key is set to a string. It defaults to `only`, allowing you to filter fields from the query string: ``` GET /products?only=id,name ``` You may automatically filter related resources by setting the parameter to a key-based array: ``` GET /products?with=shipments&only[products]=id,name&only[shipments]=id ``` ### Adding Meta Data You may want to attach additional meta data to your response. You can do this using the `meta` method: ```php return responder()->success(Product::all())->meta(['count' => Product::count()])->respond(); ``` When using the default serializer, the meta data will simply be appended to the response array: ```json { "success": true, "status": 200, "data": [], "count": 0 } ``` ### Serializing Response Data After the data has been transformed, it will be serialized using the specified success serializer in the configuration file, which defaults to the package's own `Flugg\Responder\Serializers\SuccessSerializer`. You can overwrite this on your responses using the `serializer` method: ```php return responder()->success()->serializer(JsonApiSerializer::class)->respond(); ``` ```php return responder()->success()->serializer(new JsonApiSerializer())->respond(); ``` Above we're using Fractal's `JsonApiSerializer` class. Fractal also ships with an `ArraySerializer` and `DataArraySerializer` class. If none of these suit your taste, feel free to create your own serializer by extending `League\Fractal\Serializer\SerializerAbstract`. You can read more about it in [Fractal's documentation](http://fractal.thephpleague.com/serializers/). ## Creating Transformers A dedicated transformer class gives you a convenient location to transform data and allows you to reuse the transformer at multiple places. It also allows you to include and transform relationships. You can create a transformer using the `make:transformer` Artisan command: ```shell php artisan make:transformer ProductTransformer ``` The command will generate a new `ProductTransformer.php` file in the `app/Transformers` folder: ```php <?php namespace App\Transformers; use App\User; use Flugg\Responder\Transformers\Transformer; class ProductTransformer extends Transformer { /** * List of available relations. * * @var string[] */ protected $relations = []; /** * A list of autoloaded default relations. * * @var array */ protected $load = []; /** * Transform the model. * * @param \App\Product $product * @return array */ public function transform(Product $product): array { return [ 'id' => (int) $product->id, ]; } } ``` It will automatically resolve a model name from the name provided. For instance, the package will extract `Product` from `ProductTransformer` and assume the models live directly in the `app` folder (as per Laravel's convention). If you store them somewhere else, you can use the `--model` (or `-m`) option to override it: ```shell php artisan make:transformer ProductTransformer --model="App\Models\Product" ``` #### Creating Plain Transformers The transformer file generated above is a model transformer expecting an `App\Product` model for the `transform` method. However, we can create a plain transformer by applying the `--plain` (or `-p`) modifier: ```shell php artisan make:transformer ProductTransformer --plain ``` This will remove the typehint from the `transform` method and add less boilerplate code. ### Setting Relationships The `$relations` and `$load` properties in the transformer are the equivalent to Fractal's own `$availableIncludes` and `$defaultIncludes`. In addition to the slight name change, the package uses the `$relations` and `$load` properties to map out all available relationships for eager loading, so in contrast to Fractal, you should map the relationship to their corresponding transformer: ```php protected $relations = [ 'shipments' => ShipmentTransformer::class, ]; ``` *** _You can choose to skip the mapping and just pass the strings like with Fractal, but that means the package wont be able to eager load relationships automatically._ *** #### Setting Whitelisted Relationships The `$relations` property specifies a list of relations available to be included. You can set a list of relations mapped to their corresponding transformers: ```php protected $relations = [ 'shipments' => ShipmentTransformer::class, 'orders' => OrderTransformer::class, ]; ``` #### Setting Autoloaded Relationships The `$load` property specifies a list of relations to be autoloaded every time you transform data with the transformer: ```php protected $load = [ 'shipments' => ShipmentTransformer::class, 'orders' => OrderTransformer::class, ]; ``` *** _You don't have to add relations to both `$relations` and `$load`, all relations in `$load` will be available by nature._ *** ### Including Relationships While Fractal requires you to to create a method in your transformer for every included relation, this package lets you skip this when transforming models, as it will automatically fetch relationships from the model. You may of course override this functionality by creating an "include" method: ```php /** * Include related shipments. * * @param \App\Product $product * @return mixed */ public function includeShipments(Product $product) { return $product->shipments; } ``` Unlike Fractal you can just return the data directly without wrapping it in an `item` or `collection` method. *** _You should be careful with executing database calls inside the include methods as you might end up with an unexpected amount of hits to the database._ *** #### Using Include Parameters Fractal can parse query string parameters which can be used when including relations. For more information about how to format the parameters see Fractal's [documentation on parameters](https://fractal.thephpleague.com/transformers/#include-parameters). You may access the parameters by adding a second parameter to the "include" method: ```php public function includeShipments(Product $product, Collection $parameters) { return $product->shipments->take($parameters->get('limit')); } ``` *** _To be as decoupled from Fractal as possible the parameters (which are normally accessed using `League\Fractal\ParamBag`) are accessed as Laravel collections instead._ *** #### Adding Query Constraints Just as you can specify a query constraint when including a relationship with the `with` method, you can also add query constraints as a "load" method on the transformer. This will automatically be applied when extracting relationships for eager loading. ```php /** * Load shipments with constraints. * * @param \Illuminate\Database\Eloquent\Builder $query * @return \Illuminate\Database\Eloquent\Builder */ public function loadShipments($query) { return $query->whereNull('shipped_at'); } ``` *** _Note: You cannot mix "include" and "load" methods because the package doesn't eager load relationships included with an "include" method._ *** ### Filtering Relationships After a relation has been included, you can make any last second changes to it using a filter method. For instance, below we're filtering the list of related shipments to only include shipments that has not been shipped: ```php /** * Filter included shipments. * * @param \Illuminate\Database\Eloquent\Collection $shipments * @return \Illuminate\Support\Collection */ public function filterShipments($shipments) { return $shipments->filter(function ($shipment) { return is_null($shipment->shipped_at); }); } ``` ## Transforming Data We've looked at how to transform response data of success responses, however, there may be other places than your controllers where you want to transform data. An example is broadcasted events where you're exposing data using websockets instead of HTTP. You just want to return the transformed data, not an entire response. It's possible to simply transform data by newing up the transformer and calling `transform`: ```php return (new ProductTransformer)->transform(Product::first()); ``` However, this approach might become a bit messy when building transformations with relationships: ```php return array_merge((new ProductTransformer)->transform($product = Product::first()), [ 'shipments' => $product->shipments->map(function ($shipment) { return (new ShipmentTransformer)->transform($shipment); }) ]); ``` Yuck! Imagine that with multiple nested relationships. Let's explore a simpler way to handle this. ### Building Transformations The `SuccessResponseBuilder` actually delegates all of the transformation work to a dedicated `Flugg\Responder\TransformBuilder` class. We can use this class ourself to transform data. For instance, if the product and shipment transformers were bound to the models, we could replicate the code above in the following way: ```php public function index(TransformBuilder $transformation) { return $transformation->resource(Product::all())->with('shipments')->transform(); } ``` Instead of using the `success` method on the `Responder` service, we use the `resource` method on the `TransformBuilder` with the same method signature. We also use `transform` to execute the transformation instead of `respond` as we did when creating responses. In addition to the `with` method, you also have access to the other transformation methods like `without`, `only`, `meta` and `serializer`. *** _Using `toArray` on the `Responder` service is almost the same as the code above, however, it will also include response decorators which might not be desired._ *** ### Transforming Without Serializing When using the `TransformBuilder` to transform data it will still serialize the data using the configured serializer. Fractal requires the use of a serializer to transform data, but sometimes we're just interested in the raw transformed data. The package ships with a `Flugg\Responder\Serializers\NoopSerializer` to solve this, a no-op serializer which leaves the transformed data untouched: ```php return $transformation->resource(Product::all())->serializer(NoopSerializer::class)->transform(); ``` If you think this is looking messy, don't worry, there's a quicker way. In fact, you will probably never even need to utilize the `NoopSerializer` or `TransformBuilder` manually, but it helps to know how it works. The `Flugg\Responder\Transformation` is a class which can be used for quickly transforming data without serializing. #### Option 1: The `Transformation` Service The `Transformation` class utilizes the `TransformBuilder` class to build a transformation using the `NoopSerializer`. You can inject the `Transformation` class and call `make` to obtain an instance of `TransformBuilder` which gives you access to all of the chainable methods including `with`, like below: ```php public function __construct(Transformation $transformation) { $transformation->make(Product::all())->with('shipments')->transform(); } ``` #### Option 2: The `transformation` Helper You can use the `transformation` helper function to transform data without serializing: ```php transformation(Product::all())->with('shipments')->transform(); ``` #### Option 3: The `Transformation` Facade You can also use the `Transformation` facade to achieve the same thing: ```php Transformation::make(Product::all())->with('shipments')->transform(); ``` ### Transforming To Camel Case Model attributes are traditionally specified in snake case, however, you might prefer to use camel case for the response fields. A transformer makes for a perfect location to convert the fields, as seen from the `soldOut` field in the example below: ```php return responder()->success(Product::all(), function ($product) { return ['soldOut' => (bool) $product->sold_out]; })->respond(); ``` #### Transforming Request Parameters After responding with camel case, you probably want to let people send in request data using camel cased parameters as well. The package provides a `Flugg\Responder\Http\Middleware\ConvertToSnakeCase` middleware you can append to the `$middleware` array in `app/Http/Kernel.php` to convert all parameters to snake case automatically: ```php protected $middleware = [ // ... \Flugg\Responder\Http\Middleware\ConvertToSnakeCase::class, ]; ``` *** _The middleware will run before request validation, so you should specify your validation rules in snake case as well._ *** ## Creating Error Responses Whenever a consumer of your API does something unexpected, you can return an error response describing the problem. As briefly shown in a previous chapter, an error response can be created using the `error` method: ```php return responder()->error()->respond(); ``` The error response has knowledge about an error code, a corresponding error message and optionally some error data. With the default configuration, the above code would output the following JSON: ```json { "success": false, "status": 500, "error": { "code": null, "message": null } } ``` ### Setting Error Code & Message You can fill the first parameter of the `error` method to set an error code: ```php return responder()->error('sold_out_error')->respond(); ``` *** _You may optionally use integers for error codes._ *** In addition, you may set the second parameter to an error message describing the error: ```php return responder()->error('sold_out_error', 'The requested product is sold out.')->respond(); ``` #### Set Messages In Language Files You can set the error messages in a language file, which allows for returning messages in different languages. The configuration file has an `error_message_files` key defining a list of language files with error messages. By default, it is set to `['errors']`, meaning it will look for an `errors.php` file inside `resources/lang/en`. You can use these files to map error codes to corresponding error messages: ```php return [ 'sold_out_error' => 'The requested product is sold out.', ]; ``` #### Register Messages Using `ErrorMessageResolver` Instead of using language files, you may alternatively set error messages directly on the `ErrorMessageResolver` class. You can place the code below within `AppServiceProvider` or an entirely new `TransformerServiceProvider`: ```php use Flugg\Responder\ErrorMessageResolver; public function boot() { $this->app->make(ErrorMessageResolver::class)->register([ 'sold_out_error' => 'The requested product is sold out.', ]); } ``` ### Adding Error Data You may want to set additional data on the error response. Like in the example below, we're returning a list of shipments with the `sold_out` error response, giving the consumer information about when a new shipment for the product might arrive. ```php return responder()->error('sold_out')->data(['shipments' => Shipment::all()])->respond(); ``` The error data will be appended to the response data. Assuming we're using the default serializer and there are no shipments in the database, the code above would look like: ```json { "success": false, "status": 500, "error": { "code": "sold_out", "message": "The requested product is sold out.", "shipments": [] } } ``` ### Serializing Response Data Similarly to success responses, error responses will be serialized using the specified error serializer in the configuration file. This defaults to the package's own `Flugg\Responder\Serializers\ErrorSerializer`, but can of course be changed by using the `serializer` method: ```php return responder()->error()->serializer(ExampleErrorSerializer::class)->respond(); ``` ```php return responder()->success()->serializer(new ExampleErrorSerializer())->respond(); ``` You can create your own error serializer by implementing the `Flugg\Responder\Contracts\ErrorSerializer` contract. ## Handling Exceptions No matter how much we try to avoid them, exceptions do happen. Responding to the exceptions in an elegant manner will improve the user experience of your API. The package can enhance your exception handler to automatically turn exceptions in to error responses. If you want to take use of this, you can either use the package's exception handler or include a trait as described in further details below. #### Option 1: Replace `Handler` Class To use the package's exception handler you need to replace the default import in `app/Exceptions/Handler.php`: ```php use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; ``` With the package's handler class: ```php use Flugg\Responder\Exceptions\Handler as ExceptionHandler; ``` *** This will not work with Lumen as its exception handler is incompatible with Laravel's. Look instead at the second option below. *** #### Option 2: Use `ConvertsExceptions` Trait The package's exception handler uses the `Flugg\Responder\Exceptions\ConvertsExceptions` trait to load of most of its work. Instead of replacing the exception handler, you can use the trait in your own handler class. To replicate the behavior of the exception handler, you would also have to add the following code to the `render` method: ```php public function render($request, Exception $exception) { $this->convertDefaultException($exception); if ($exception instanceof HttpException) { return $this->renderResponse($exception); } return parent::render($request, $exception); } ``` If you only want to return JSON error responses on requests actually asking for JSON, you may wrap the code above in a `wantsJson` check as seen below: ```php if ($request->wantsJson()) { $this->convertDefaultException($exception); if ($exception instanceof HttpException) { return $this->renderResponse($exception); } } ``` ### Converting Exceptions Once you've implemented one of the above options, the package will convert some of Laravel's exceptions to an exception extending `Flugg\Responder\Exceptions\Http\HttpException`. It will then convert these to an error response. The table below shows which Laravel exceptions are converted and what they are converted to. All the exceptions on the right is under the `Flugg\Responder\Exceptions\Http` namespace and extends `Flugg\Responder\Exceptions\Http\HttpException`. All exceptions extending the `HttpException` class will be automatically converted to an error response. | Caught Exceptions | Converted To | | --------------------------------------------------------------- | ---------------------------- | | `Illuminate\Auth\AuthenticationException` | `UnauthenticatedException` | | `Illuminate\Auth\Access\AuthorizationException` | `UnauthorizedException` | | `Symfony\Component\HttpKernel\Exception\NotFoundHttpException` | `PageNotFoundException` | | `Illuminate\Database\Eloquent\ModelNotFoundException` | `PageNotFoundException` | | `Illuminate\Database\Eloquent\RelationNotFoundException` | `RelationNotFoundException` | | `Illuminate\Validation\ValidationException` | `ValidationFailedException` | You can disable the conversions of some of the exceptions above using the `$dontConvert` property: ```php /** * A list of default exception types that should not be converted. * * @var array */ protected $dontConvert = [ ModelNotFoundException::class, ]; ``` *** If you're using the trait option, you can disable all the default conversions by removing the call to `convertDefaultException` in the `render` method. *** #### Convert Custom Exceptions In addition to letting the package convert Laravel exceptions, you can also convert your own exceptions using the `convert` method in the `render` method: ```php $this->convert($exception, [ InvalidValueException => PageNotFoundException, ]); ``` You can optionally give it a closure that throws the new exception, if you want to give it constructor parameters: ```php $this->convert($exception, [ MaintenanceModeException => function ($exception) { throw new ServerDownException($exception->retryAfter); }, ]); ``` ### Creating HTTP Exceptions An exception class is a convenient place to store information about an error. The package provides an abstract exception class `Flugg\Responder\Exceptions\Http\HttpException`, which has knowledge about status code, an error code and an error message. Continuing on our product example from above, we could create our own `HttpException` class: ```php <?php namespace App\Exceptions; use Flugg\Responder\Exceptions\Http\HttpException; class SoldOutException extends HttpException { /** * The HTTP status code. * * @var int */ protected $status = 400; /** * The error code. * * @var string|null */ protected $errorCode = 'sold_out_error'; /** * The error message. * * @var string|null */ protected $message = 'The requested product is sold out.'; } ``` You can also add a `data` method returning additional error data: ```php /** * Retrieve additional error data. * * @return array|null */ public function data() { return [ 'shipments' => Shipment::all() ]; } ``` If you're letting the package handle exceptions, you can now throw the exception anywhere in your application and it will automatically be rendered to an error response. ```php throw new SoldOutException(); ``` # Contributing Contributions are more than welcome and you're free to create a pull request on Github. You can run tests with the following command: ```shell vendor/bin/phpunit ``` If you find bugs or have suggestions for improvements, feel free to submit an issue on Github. However, if it's a security related issue, please send an email to [email protected] instead. # Donating The package is completely free to use, however, a lot of time has been put into making it. If you want to show your appreciation by leaving a small donation, you can do so by clicking [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=PRMC9WLJY8E46&lc=NO&item_name=Laravel%20Responder&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted). Thanks! # License Laravel Responder is free software distributed under the terms of the MIT license. See [license.md](license.md) for more details.

🤖 GPU accelerated Neural networks in JavaScript for Browsers and Node.js

<p align="center"> <img src="https://cdn.rawgit.com/harthur-org/brain.js/ff595242/logo.svg" alt="Logo" width=200px/> </p> # brain.js GPU accelerated Neural networks in JavaScript for Browsers and Node.js <p style="text-align: center" align="center"> <a href="https://brain.js.org"><img src="https://img.shields.io/website?up_message=brain.js.org&url=https%3A%2F%2Fbrain.js.org" alt="GitHub"></a> [](https://npmjs.com/package/brain.js) [](http://standardjs.com) [](#backers) [](#sponsors) [](https://gitter.im/brain-js/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://slack.bri.im)  [](https://codecov.io/gh/BrainJS/brain.js) <a href="https://twitter.com/brainjsfnd"><img src="https://img.shields.io/twitter/follow/brainjsfnd?label=Twitter&style=social" alt="Twitter"></a> [](https://nodei.co/npm/brain.js/) </p> ## About `brain.js` is a GPU accelerated library for [Neural Networks](http://en.wikipedia.org/wiki/Artificial_neural_network) written in JavaScript. :bulb: This is a continuation of the [**harthur/brain**](https://github.com/harthur/brain), which is not maintained anymore. [More info](https://github.com/harthur/brain/issues/72) ## Table of Contents - [Installation and Usage](#Installation-and-Usage) - [NPM](#NPM) - [CDN](#CDN) - [Download](#Download) - [Installation note](#Installation-note) - [Building from source](#Building-from-source) - [Examples](#examples) - [More Examples](#more-examples) - [Training](#training) - [Data format](#data-format) - [For training with NeuralNetwork](#for-training-with-neuralnetwork) - [For training with `RNNTimeStep`, `LSTMTimeStep` and `GRUTimeStep`](#for-training-with-rnntimestep-lstmtimestep-and-grutimestep) - [For training with `RNN`, `LSTM` and `GRU`](#for-training-with-rnn-lstm-and-gru) - [Training Options](#training-options) - [Async Training](#async-training) - [Cross Validation](#cross-validation) - [Train Stream](#streams) - [Methods](#methods) - [train](#traintrainingdata---trainingstatus) - [run](#runinput---prediction) - [forecast](#forecastinput-count---predictions) - [Failing](#failing) - [JSON](#json) - [Standalone Function](#standalone-function) - [Options](#options) - [activation](#activation) - [hiddenLayers](#hiddenlayers) - [Streams](#streams) - [Utilities](#utilities) - [`likely`](#likely) - [`toSVG`](#toSVG) - [Neural Network Types](#neural-network-types) - [Why different Neural Network Types?](#why-different-neural-network-types) ## Installation and Usage ### NPM If you can install `brain.js` with [npm](http://npmjs.org): ```bash npm install brain.js ``` ### CDN ```html <script src="//unpkg.com/brain.js"></script> ``` ### Download [Download the latest brain.js for browser](https://unpkg.com/brain.js) ### Installation note `Brain.js` depends on a native module `headless-gl` for gpu support. In most cases installing `brain.js` from npm should just work. However, if you run into problems, this mean prebuilt binaries are not able to download from github repositories and you might need to build it yourself. #### Building from source Please make sure the following dependencies are installed and up to date and then run: ```bash npm rebuild ``` ##### System dependencies ###### Mac OS X - [Python 2.7](https://www.python.org/) - [XCode](https://developer.apple.com/xcode/) ###### Ubuntu/Debian - [Python 2.7](https://www.python.org/) - A GNU C++ environment (available via the `build-essential` package on `apt`) - [libxi-dev](http://www.x.org/wiki/) - Working and up to date OpenGL drivers - [GLEW](http://glew.sourceforge.net/) - [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) ```bash sudo apt-get install -y build-essential libxi-dev libglu1-mesa-dev libglew-dev pkg-config ``` ###### Windows - [Python 2.7](https://www.python.org/) - [Microsoft Visual Studio Build Tools 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48159) - run in cmd: `npm config set msvs_version 2015` - run in cmd: `npm config set python python2.7` \* If you are using `Build Tools 2017` then run `npm config set msvs_version 2017` ## Examples Here's an example showcasing how to approximate the XOR function using `brain.js`: more info on config [here](https://github.com/BrainJS/brain.js/blob/develop/src/neural-network.js#L31). :bulb: [A fun and practical introduction to Brain.js](https://scrimba.com/g/gneuralnetworks) ```javascript // provide optional config object (or undefined). Defaults shown. const config = { binaryThresh: 0.5, hiddenLayers: [3], // array of ints for the sizes of the hidden layers in the network activation: 'sigmoid', // supported activation types: ['sigmoid', 'relu', 'leaky-relu', 'tanh'], leakyReluAlpha: 0.01, // supported for activation type 'leaky-relu' }; // create a simple feed forward neural network with backpropagation const net = new brain.NeuralNetwork(config); net.train([ { input: [0, 0], output: [0] }, { input: [0, 1], output: [1] }, { input: [1, 0], output: [1] }, { input: [1, 1], output: [0] }, ]); const output = net.run([1, 0]); // [0.987] ``` or more info on config [here](https://github.com/BrainJS/brain.js/blob/develop/src/recurrent/rnn.js#L726). ```javascript // provide optional config object, defaults shown. const config = { inputSize: 20, inputRange: 20, hiddenLayers: [20, 20], outputSize: 20, learningRate: 0.01, decayRate: 0.999, }; // create a simple recurrent neural network const net = new brain.recurrent.RNN(config); net.train([ { input: [0, 0], output: [0] }, { input: [0, 1], output: [1] }, { input: [1, 0], output: [1] }, { input: [1, 1], output: [0] }, ]); let output = net.run([0, 0]); // [0] output = net.run([0, 1]); // [1] output = net.run([1, 0]); // [1] output = net.run([1, 1]); // [0] ``` However, there is no reason to use a neural network to figure out XOR. (-: So, here is a more involved, realistic example: [Demo: training a neural network to recognize color contrast](https://brain.js.org/). ## More Examples You can check out this fantastic screencast, which explains how to train a simple neural network using a real world dataset: [How to create a neural network in the browser using Brain.js](https://scrimba.com/c/c36zkcb). - [writing a children's book using a recurrent neural network](./examples/javascript/childrens-book.js) and [typescript version](./examples/typescript/childrens-book.ts) - [using cross validation with a feed forward net](./examples/javascript/cross-validate.js) and [typescript version](./examples/typescript/cross-validate.ts) - experimental (NeuralNetwork only, but more to come!) [using the gpu in a browser](./examples/javascript/gpu.html) or [using node gpu fallback to cpu](./examples/gpu-fallback.js) and [typescript version](./examples/typescript/gpu-fallback.ts) - [learning math using a recurrent neural network](./examples/javascript/learn-math.js) and [typescript version](./examples/typescript/learn-math.ts) - [predict next number, and forecast numbers](./examples/javascript/predict-numbers.js) and [typescript version](./examples/typescript/predict-numbers.ts) - [simple letter detection](./examples/javascript/which-letter-simple.js) and [typescript version](./examples/typescript/which-letter-simple.ts) - [Cryotherapy Success Rate Prediction](https://cryotherapy.surge.sh) - [Rock Paper Scissors](https://github.com/arifikhsan/batu-gunting-kertas-nuxt) - [Detect the Color of an Image](https://github.com/ChocolateLoverRaj/detect-image-color) ## Training Use `train()` to train the network with an array of training data. The network has to be trained with all the data in bulk in one call to `train()`. More training patterns will probably take longer to train, but will usually result in a network better at classifying new patterns. ### Note Training is computationally expensive, so you should try to train the network offline (or on a Worker) and use the `toFunction()` or `toJSON()` options to plug the pre-trained network into your website. ### Data format #### For training with `NeuralNetwork` Each training pattern should have an `input` and an `output`, both of which can be either an array of numbers from `0` to `1` or a hash of numbers from `0` to `1`. For the [color contrast demo](https://brain.js.org/) it looks something like this: ```javascript const net = new brain.NeuralNetwork(); net.train([ { input: { r: 0.03, g: 0.7, b: 0.5 }, output: { black: 1 } }, { input: { r: 0.16, g: 0.09, b: 0.2 }, output: { white: 1 } }, { input: { r: 0.5, g: 0.5, b: 1.0 }, output: { white: 1 } }, ]); const output = net.run({ r: 1, g: 0.4, b: 0 }); // { white: 0.99, black: 0.002 } ``` Here's another variation of the above example. (_Note_ that input objects do not need to be similar.) ```javascript net.train([ { input: { r: 0.03, g: 0.7 }, output: { black: 1 } }, { input: { r: 0.16, b: 0.2 }, output: { white: 1 } }, { input: { r: 0.5, g: 0.5, b: 1.0 }, output: { white: 1 } }, ]); const output = net.run({ r: 1, g: 0.4, b: 0 }); // { white: 0.81, black: 0.18 } ``` #### For training with `RNNTimeStep`, `LSTMTimeStep` and `GRUTimeStep` Each training pattern can either: - Be an array of numbers - Be an array of arrays of numbers Example using an array of numbers: ```javascript const net = new brain.recurrent.LSTMTimeStep(); net.train([[1, 2, 3]]); const output = net.run([1, 2]); // 3 ``` Example using an array of arrays of numbers: ```javascript const net = new brain.recurrent.LSTMTimeStep({ inputSize: 2, hiddenLayers: [10], outputSize: 2, }); net.train([ [1, 3], [2, 2], [3, 1], ]); const output = net.run([ [1, 3], [2, 2], ]); // [3, 1] ``` #### For training with `RNN`, `LSTM` and `GRU` Each training pattern can either: - Be an array of values - Be a string - Have an `input` and an `output` - Either of which can have an array of values or a string CAUTION: When using an array of values, you can use ANY value, however, the values are represented in the neural network by a single input. So the more _distinct values_ has _the larger your input layer_. If you have a hundreds, thousands, or millions of floating point values _THIS IS NOT THE RIGHT CLASS FOR THE JOB_. Also, when deviating from strings, this gets into beta Example using direct strings: Hello World Using Brainjs ```javascript const net = new brain.recurrent.LSTM(); net.train(['I am brainjs, Hello World!']); const output = net.run('I am brainjs'); alert(output); ``` ```javascript const net = new brain.recurrent.LSTM(); net.train([ 'doe, a deer, a female deer', 'ray, a drop of golden sun', 'me, a name I call myself', ]); const output = net.run('doe'); // ', a deer, a female deer' ``` Example using strings with inputs and outputs: ```javascript const net = new brain.recurrent.LSTM(); net.train([ { input: 'I feel great about the world!', output: 'happy' }, { input: 'The world is a terrible place!', output: 'sad' }, ]); const output = net.run('I feel great about the world!'); // 'happy' ``` ### Training Options `train()` takes a hash of options as its second argument: ```javascript net.train(data, { // Defaults values --> expected validation iterations: 20000, // the maximum times to iterate the training data --> number greater than 0 errorThresh: 0.005, // the acceptable error percentage from training data --> number between 0 and 1 log: false, // true to use console.log, when a function is supplied it is used --> Either true or a function logPeriod: 10, // iterations between logging out --> number greater than 0 learningRate: 0.3, // scales with delta to effect training rate --> number between 0 and 1 momentum: 0.1, // scales with next layer's change value --> number between 0 and 1 callback: null, // a periodic call back that can be triggered while training --> null or function callbackPeriod: 10, // the number of iterations through the training data between callback calls --> number greater than 0 timeout: number, // the max number of milliseconds to train for --> number greater than 0. Default --> Infinity }); ``` The network will stop training whenever one of the two criteria is met: the training error has gone below the threshold (default `0.005`), or the max number of iterations (default `20000`) has been reached. By default training will not let you know how it's doing until the end, but set `log` to `true` to get periodic updates on the current training error of the network. The training error should decrease every time. The updates will be printed to console. If you set `log` to a function, this function will be called with the updates instead of printing to the console. However, if you want to use the values of the updates in your own output, the `callback` can be set to a function to do so instead. The learning rate is a parameter that influences how quickly the network trains. It's a number from `0` to `1`. If the learning rate is close to `0`, it will take longer to train. If the learning rate is closer to `1`, it will train faster, but training results may be constrained to a local minimum and perform badly on new data.(_Overfitting_) The default learning rate is `0.3`. The momentum is similar to learning rate, expecting a value from `0` to `1` as well, but it is multiplied against the next level's change value. The default value is `0.1` Any of these training options can be passed into the constructor or passed into the `updateTrainingOptions(opts)` method and they will be saved on the network and used during the training time. If you save your network to json, these training options are saved and restored as well (except for callback and log, callback will be forgotten and log will be restored using console.log). A boolean property called `invalidTrainOptsShouldThrow` is set to `true` by default. While the option is `true`, if you enter a training option that is outside the normal range, an error will be thrown with a message about the abnormal option. When the option is set to `false`, no error will be sent, but a message will still be sent to `console.warn` with the related information. ### Async Training `trainAsync()` takes the same arguments as train (data and options). Instead of returning the results object from training, it returns a promise that when resolved will return the training results object. Does NOT work with: * `brain.recurrent.RNN` * `brain.recurrent.GRU` * `brain.recurrent.LSTM` * `brain.recurrent.RNNTimeStep` * `brain.recurrent.GRUTimeStep` * `brain.recurrent.LSTMTimeStep` ```javascript const net = new brain.NeuralNetwork(); net .trainAsync(data, options) .then((res) => { // do something with my trained network }) .catch(handleError); ``` With multiple networks you can train in parallel like this: ```javascript const net = new brain.NeuralNetwork(); const net2 = new brain.NeuralNetwork(); const p1 = net.trainAsync(data, options); const p2 = net2.trainAsync(data, options); Promise.all([p1, p2]) .then((values) => { const res = values[0]; const res2 = values[1]; console.log( `net trained in ${res.iterations} and net2 trained in ${res2.iterations}` ); // do something super cool with my 2 trained networks }) .catch(handleError); ``` ### Cross Validation [Cross Validation](<https://en.wikipedia.org/wiki/Cross-validation_(statistics)>) can provide a less fragile way of training on larger data sets. The brain.js api provides Cross Validation in this example: ```js const crossValidate = new brain.CrossValidate(() => new brain.NeuralNetwork(networkOptions)); crossValidate.train(data, trainingOptions, k); //note k (or KFolds) is optional const json = crossValidate.toJSON(); // all stats in json as well as neural networks const net = crossValidate.toNeuralNetwork(); // get top performing net out of `crossValidate` // optionally later const json = crossValidate.toJSON(); const net = crossValidate.fromJSON(json); ``` Use `CrossValidate` with these classes: - `brain.NeuralNetwork` - `brain.RNNTimeStep` - `brain.LSTMTimeStep` - `brain.GRUTimeStep` An example of using cross validate can be found in [examples/javascript/cross-validate.js](examples/javascript/cross-validate.js) ## Methods ### `train(trainingData)` -> trainingStatus The output of `train()` is a hash of information about how the training went: ```javascript { error: 0.0039139985510105032, // training error iterations: 406 // training iterations } ``` ### `run(input)` -> prediction Supported on classes: - `brain.NeuralNetwork` - `brain.NeuralNetworkGPU` -> All the functionality of `brain.NeuralNetwork` but, ran on GPU (via gpu.js in WebGL2, WebGL1, or fallback to CPU) - `brain.recurrent.RNN` - `brain.recurrent.LSTM` - `brain.recurrent.GRU` - `brain.recurrent.RNNTimeStep` - `brain.recurrent.LSTMTimeStep` - `brain.recurrent.GRUTimeStep` Example: ```js // feed forward const net = new brain.NeuralNetwork(); net.fromJSON(json); net.run(input); // time step const net = new brain.LSTMTimeStep(); net.fromJSON(json); net.run(input); // recurrent const net = new brain.LSTM(); net.fromJSON(json); net.run(input); ``` ### `forecast(input, count)` -> predictions Available with the following classes. Outputs a array of predictions. Predictions being a continuation of the inputs. - `brain.recurrent.RNNTimeStep` - `brain.recurrent.LSTMTimeStep` - `brain.recurrent.GRUTimeStep` Example: ```js const net = new brain.LSTMTimeStep(); net.fromJSON(json); net.forecast(input, 3); ``` ### `toJSON() -> json` Serialize neural network to json ### `fromJSON(json)` Deserialize neural network from json ## Failing If the network failed to train, the error will be above the error threshold. This could happen if the training data is too noisy (most likely), the network does not have enough hidden layers or nodes to handle the complexity of the data, or it has not been trained for enough iterations. If the training error is still something huge like `0.4` after 20000 iterations, it's a good sign that the network can't make sense of the given data. ### RNN, LSTM, or GRU Output too short or too long The instance of the net's property `maxPredictionLength` (default 100) can be set to adjust the output of the net; Example: ```js const net = new brain.recurrent.LSTM(); // later in code, after training on a few novels, write me a new one! net.maxPredictionLength = 1000000000; // Be careful! net.run('Once upon a time'); ``` ## JSON Serialize or load in the state of a trained network with JSON: ```javascript const json = net.toJSON(); net.fromJSON(json); ``` ## Standalone Function You can also get a custom standalone function from a trained network that acts just like `run()`: ```javascript const run = net.toFunction(); const output = run({ r: 1, g: 0.4, b: 0 }); console.log(run.toString()); // copy and paste! no need to import brain.js ``` ## Options `NeuralNetwork()` takes a hash of options: ```javascript const net = new brain.NeuralNetwork({ activation: 'sigmoid', // activation function hiddenLayers: [4], learningRate: 0.6, // global learning rate, useful when training using streams }); ``` ### activation This parameter lets you specify which activation function your neural network should use. There are currently four supported activation functions, **sigmoid** being the default: - [sigmoid](https://www.wikiwand.com/en/Sigmoid_function) - [relu](<https://www.wikiwand.com/en/Rectifier_(neural_networks)>) - [leaky-relu](<https://www.wikiwand.com/en/Rectifier_(neural_networks)>) - related option - 'leakyReluAlpha' optional number, defaults to 0.01 - [tanh](https://theclevermachine.wordpress.com/tag/tanh-function/) Here's a table (thanks, Wikipedia!) summarizing a plethora of activation functions — [Activation Function](https://www.wikiwand.com/en/Activation_function) ### hiddenLayers You can use this to specify the number of hidden layers in the network and the size of each layer. For example, if you want two hidden layers - the first with 3 nodes and the second with 4 nodes, you'd give: ```js hiddenLayers: [3, 4]; ``` By default `brain.js` uses one hidden layer with size proportionate to the size of the input array. ## Streams Use https://www.npmjs.com/package/train-stream to stream data to a NeuralNetwork ## Utilities ### `likely` ```js const likely = require('brain/likely'); const key = likely(input, net); ``` Likely example see: [simple letter detection](./examples/javascript/which-letter-simple.js) ### `toSVG` ```js <script src="../../src/utilities/svg.js"></script> ``` Renders the network topology of a feedforward network ```js document.getElementById('result').innerHTML = brain.utilities.toSVG( network, options ); ``` toSVG example see: [network rendering](./examples/javascript/rendering-svg.html) The user interface used:  ## Neural Network Types - [`brain.NeuralNetwork`](src/neural-network.ts) - [Feedforward Neural Network](https://en.wikipedia.org/wiki/Feedforward_neural_network) with backpropagation - [`brain.NeuralNetworkGPU`](src/neural-network-gpu.ts) - [Feedforward Neural Network](https://en.wikipedia.org/wiki/Feedforward_neural_network) with backpropagation, GPU version - [`brain.recurrent.RNNTimeStep`](src/recurrent/rnn-time-step.ts) - [Time Step Recurrent Neural Network or "RNN"](https://en.wikipedia.org/wiki/Recurrent_neural_network) - [`brain.recurrent.LSTMTimeStep`](src/recurrent/lstm-time-step.ts) - [Time Step Long Short Term Memory Neural Network or "LSTM"](https://en.wikipedia.org/wiki/Long_short-term_memory) - [`brain.recurrent.GRUTimeStep`](src/recurrent/gru-time-step.ts) - [Time Step Gated Recurrent Unit or "GRU"](https://en.wikipedia.org/wiki/Gated_recurrent_unit) - [`brain.recurrent.RNN`](src/recurrent/rnn.ts) - [Recurrent Neural Network or "RNN"](https://en.wikipedia.org/wiki/Recurrent_neural_network) - [`brain.recurrent.LSTM`](src/recurrent/lstm.ts) - [Long Short Term Memory Neural Network or "LSTM"](https://en.wikipedia.org/wiki/Long_short-term_memory) - [`brain.recurrent.GRU`](src/recurrent/gru.ts) - [Gated Recurrent Unit or "GRU"](https://en.wikipedia.org/wiki/Gated_recurrent_unit) - [`brain.FeedForward`](src/feed-forward.ts) - [Highly Customizable Feedforward Neural Network](https://en.wikipedia.org/wiki/Feedforward_neural_network) with backpropagation - [`brain.Recurrent`](src/recurrent.ts) - [Highly Customizable Recurrent Neural Network](https://en.wikipedia.org/wiki/Recurrent_neural_network) with backpropagation ### Why different Neural Network Types Different neural nets do different things well. For example: - A Feedforward Neural Network can classify simple things very well, but it has no memory of previous actions and has infinite variation of results. - A Time Step Recurrent Neural Network _remembers_, and can predict future values. - A Recurrent Neural Network _remembers_, and has a finite set of results. ## Get Involved ### W3C machine learning standardization process If you are a developer or if you just care about how ML API should look like - please take a part and join W3C community and share your opinions or simply support opinions you like or agree with. Brain.js is a widely adopted open source machine learning library in the javascript world. There are several reasons for it, but most notable is **simplicity of usage while not sacrificing performance**. We would like to keep it also simple to learn, simple to use and performant when it comes to W3C standard. We think that current brain.js API is quite close to what we could expect to become a standard. And since supporting doesn't require much effort and still can make a huge difference feel free to join W3C community group and support us with brain.js like API. Get involved into W3C machine learning ongoing standardization process [here](https://www.w3.org/community/webmachinelearning/). You can also join our open discussion about standardization [here](https://github.com/BrainJS/brain.js/issues/337). ## Issues If you have an issue, either a bug or a feature you think would benefit your project let us know and we will do our best. Create issues [here](https://github.com/BrainJS/brain.js/issues) and follow the template. ### brain.js.org Source for `brain.js.org` is available at [Brain.js.org Repository](https://github.com/BrainJS/brain.js.org). Built using awesome `vue.js` & `bulma`. Contributions are always welcome. ## Contributors This project exists thanks to all the people who contribute. [[Contribute](/.github/CONTRIBUTING.md)]. <a href="https://github.com/BrainJS/brain.js/graphs/contributors"><img src="https://opencollective.com/brainjs/contributors.svg?width=890&button=false" /></a> ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/brainjs#backer)] <a href="https://opencollective.com/brainjs#backers" target="_blank"><img src="https://opencollective.com/brainjs/backers.svg?width=890"></a> ## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/brainjs#sponsor)] <a href="https://opencollective.com/brainjs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/0/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/1/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/1/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/2/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/2/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/3/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/3/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/4/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/4/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/5/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/5/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/6/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/6/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/7/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/7/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/8/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/8/avatar.svg"></a> <a href="https://opencollective.com/brainjs/sponsor/9/website" target="_blank"><img src="https://opencollective.com/brainjs/sponsor/9/avatar.svg"></a>

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

[maven-central]: https://img.shields.io/maven-central/v/net.dv8tion/JDA?color=blue [jitpack]: https://img.shields.io/badge/Snapshots-JitPack-blue [download]: #download [discord-invite]: https://discord.gg/0hMr4ce0tIl3SLv5 [migration]: https://jda.wiki/introduction/migration-v3-v4/ [jenkins]: https://ci.dv8tion.net/job/JDA5 [license]: https://github.com/DV8FromTheWorld/JDA/tree/master/LICENSE [faq]: https://jda.wiki/introduction/faq/ [troubleshooting]: https://jda.wiki/using-jda/troubleshooting/ [discord-shield]: https://discord.com/api/guilds/125227483518861312/widget.png [faq-shield]: https://img.shields.io/badge/Wiki-FAQ-blue.svg [troubleshooting-shield]: https://img.shields.io/badge/Wiki-Troubleshooting-darkgreen.svg [jenkins-shield]: https://img.shields.io/badge/Download-Jenkins-purple.svg [license-shield]: https://img.shields.io/badge/License-Apache%202.0-white.svg [migration-shield]: https://img.shields.io/badge/Wiki-Migrating%20from%20V3-darkgreen.svg <img align="right" src="https://github.com/DV8FromTheWorld/JDA/blob/assets/assets/readme/logo.png?raw=true" height="200" width="200"> [ ![maven-central][] ][download] [ ![jitpack][] ](https://jitpack.io/#DV8FromtheWorld/JDA) [ ![jenkins-shield][] ][jenkins] [ ![license-shield][] ][license] [ ![discord-shield][] ][discord-invite] [ ![faq-shield] ][faq] [ ![troubleshooting-shield] ][troubleshooting] [ ![migration-shield][] ][migration] # JDA (Java Discord API) JDA strives to provide a clean and full wrapping of the Discord REST api and its Websocket-Events for Java. This library is a helpful tool that provides the functionality to create a discord bot in java. ## Summary Due to official statements made by the Discord developers we will no longer support unofficial features. These features are undocumented API endpoints or protocols that are not available to bot-accounts. _Please see the [Discord docs](https://discord.com/developers/docs/reference) for more information about bot accounts._ 1. [Introduction](#creating-the-jda-object) 2. [Sharding](#sharding-a-bot) 3. [Entity Lifetimes](#entity-lifetimes) 4. [Download](#download) 5. [Documentation](#documentation) 6. [Support](#getting-help) 7. [Extensions And Plugins](#third-party-recommendations) 8. [Contributing](#contributing-to-jda) 9. [Dependencies](#dependencies) 10. [Other Libraries](#related-projects) ## UserBots and SelfBots Discord is currently prohibiting creation and usage of automated client accounts (AccountType.CLIENT). We have officially dropped support for client login as of version **4.2.0**! Note that JDA is not a good tool to build a custom discord client as it loads all servers/guilds on startup unlike a client which does this via lazy loading instead. If you need a bot, use a bot account from the [Application Dashboard](https://discord.com/developers/applications). [Read More](https://support.discord.com/hc/en-us/articles/115002192352-Automated-user-accounts-self-bots-) ## Creating the JDA Object Creating the JDA Object is done via the JDABuilder class. After setting the token and other options via setters, the JDA Object is then created by calling the `build()` method. When `build()` returns, JDA might not have finished starting up. However, you can use `awaitReady()` on the JDA object to ensure that the entire cache is loaded before proceeding. Note that this method is blocking and will cause the thread to sleep until startup has completed. **Example**: ```java JDA jda = JDABuilder.createDefault("token").build(); ``` ### Configuration Both the `JDABuilder` and the `DefaultShardManagerBuilder` allow a set of configurations to improve the experience. **Example**: ```java public static void main(String[] args) { JDABuilder builder = JDABuilder.createDefault(args[0]); // Disable parts of the cache builder.disableCache(CacheFlag.MEMBER_OVERRIDES, CacheFlag.VOICE_STATE); // Enable the bulk delete event builder.setBulkDeleteSplittingEnabled(false); // Set activity (like "playing Something") builder.setActivity(Activity.watching("TV")); builder.build(); } ``` > See [JDABuilder](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/JDABuilder.html) and [DefaultShardManagerBuilder](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/sharding/DefaultShardManagerBuilder.html) You can configure the memory usage by changing enabled `CacheFlags` on the `JDABuilder`. Additionally, you can change the handling of member/user cache by setting either a `ChunkingFilter`, disabling **intents**, or changing the **member cache policy**. ```java public void configureMemoryUsage(JDABuilder builder) { // Disable cache for member activities (streaming/games/spotify) builder.disableCache(CacheFlag.ACTIVITY); // Only cache members who are either in a voice channel or owner of the guild builder.setMemberCachePolicy(MemberCachePolicy.VOICE.or(MemberCachePolicy.OWNER)); // Disable member chunking on startup builder.setChunkingFilter(ChunkingFilter.NONE); // Disable presence updates and typing events builder.disableIntents(GatewayIntent.GUILD_PRESENCE, GatewayIntent.GUILD_MESSAGE_TYPING); // Consider guilds with more than 50 members as "large". // Large guilds will only provide online members in their setup and thus reduce bandwidth if chunking is disabled. builder.setLargeThreshold(50); } ``` ### Listening to Events The event system in JDA is configured through a hierarchy of classes/interfaces. We offer two implementations for the `IEventManager`: - **InterfacedEventManager** which uses an `EventListener` interface and the `ListenerAdapter` abstract class - **AnnotatedEventManager** which uses the `@SubscribeEvent` annotation that can be applied to methods By default the **InterfacedEventManager** is used. Since you can create your own implementation of `IEventManager` this is a very versatile and configurable system. If the aforementioned implementations don't suit your use-case you can simply create a custom implementation and configure it on the `JDABuilder` with `setEventManager(...)`. #### Examples: **Using EventListener**: ```java public class ReadyListener implements EventListener { public static void main(String[] args) throws InterruptedException { // Note: It is important to register your ReadyListener before building JDA jda = JDABuilder.createDefault("token") .addEventListeners(new ReadyListener()) .build(); // optionally block until JDA is ready jda.awaitReady(); } @Override public void onEvent(GenericEvent event) { if (event instanceof ReadyEvent) System.out.println("API is ready!"); } } ``` **Using ListenerAdapter**: ```java public class MessageListener extends ListenerAdapter { public static void main(String[] args) { JDA jda = JDABuilder.createDefault("token") .enableIntents(GatewayIntent.MESSAGE_CONTENT) // enables explicit access to message.getContentDisplay() .build(); //You can also add event listeners to the already built JDA instance // Note that some events may not be received if the listener is added after calling build() // This includes events such as the ReadyEvent jda.addEventListener(new MessageListener()); } @Override public void onMessageReceived(MessageReceivedEvent event) { if (event.isFromType(ChannelType.PRIVATE)) { System.out.printf("[PM] %s: %s\n", event.getAuthor().getName(), event.getMessage().getContentDisplay()); } else { System.out.printf("[%s][%s] %s: %s\n", event.getGuild().getName(), event.getTextChannel().getName(), event.getMember().getEffectiveName(), event.getMessage().getContentDisplay()); } } } ``` **Slash-Commands**: ```java public class Bot extends ListenerAdapter { public static void main(String[] args) { if (args.length < 1) { System.out.println("You have to provide a token as first argument!"); System.exit(1); } // args[0] would be the token (using an environment variable or config file is preferred for security) // We don't need any intents for this bot. Slash commands work without any intents! JDA jda = JDABuilder.createLight(args[0], Collections.emptyList()) .addEventListeners(new Bot()) .setActivity(Activity.playing("Type /ping")) .build(); // Sets the global command list to the provided commands (removing all others) jda.updateCommands().addCommands( Commands.slash("ping", "Calculate ping of the bot"), Commands.slash("ban", "Ban a user from the server") .setDefaultPermissions(DefaultMemberPermissions.enabledFor(Permission.BAN_MEMBERS)) // only usable with ban permissions .setGuildOnly(true) // Ban command only works inside a guild .addOption(OptionType.USER, "user", "The user to ban", true) // required option of type user (target to ban) .addOption(OptionType.STRING, "reason", "The ban reason") // optional reason ).queue(); } @Override public void onSlashCommandInteraction(SlashCommandInteractionEvent event) { // make sure we handle the right command switch (event.getName()) { case "ping": long time = System.currentTimeMillis(); event.reply("Pong!").setEphemeral(true) // reply or acknowledge .flatMap(v -> event.getHook().editOriginalFormat("Pong: %d ms", System.currentTimeMillis() - time) // then edit original ).queue(); // Queue both reply and edit break; case "ban": // double check permissions, don't trust discord on this! if (!event.getMember().hasPermission(Permission.BAN_MEMBERS)) { event.reply("You cannot ban members! Nice try ;)").setEphemeral(true).queue(); break; } User target = event.getOption("user", OptionMapping::getUser); // optionally check for member information Member member = event.getOption("user", OptionMapping::getMember); if (!event.getMember().canInteract(member)) { event.reply("You cannot ban this user.").setEphemeral(true).queue(); break; } // Before starting our ban request, tell the user we received the command // This sends a "Bot is thinking..." message which is later edited once we finished event.deferReply().queue(); String reason = event.getOption("reason", OptionMapping::getAsString); AuditableRestAction<Void> action = event.getGuild().ban(target, 0); // Start building our ban request if (reason != null) // reason is optional action = action.reason(reason); // set the reason for the ban in the audit logs and ban log action.queue(v -> { // Edit the thinking message with our response on success event.getHook().editOriginal("**" + target.getAsTag() + "** was banned by **" + event.getUser().getAsTag() + "**!").queue(); }, error -> { // Tell the user we encountered some error event.getHook().editOriginal("Some error occurred, try again!").queue(); error.printStackTrace(); }); } } } ``` ### RestAction Through [RestAction](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html) we provide request handling with - [callbacks](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#queue%28java.util.function.Consumer%29) - [promises](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#submit%28%29) - and [sync](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#complete%28%29) and it is up to the user to decide which pattern to utilize. It can be combined with reactive libraries such as [reactor-core](https://github.com/reactor/reactor-core) due to being lazy. The RestAction interface also supports a number of operators to avoid callback hell: - [`map`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#map%28java.util.function.Function%29) Convert the result of the `RestAction` to a different value - [`flatMap`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#flatMap%28java.util.function.Function%29) Chain another `RestAction` on the result - [`delay`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/requests/RestAction.html#delay%28java.time.Duration%29) Delay the element of the previous step **Example**: ```java public RestAction<Void> selfDestruct(MessageChannel channel, String content) { return channel.sendMessage("The following message will destroy itself in 1 minute!") .delay(10, SECONDS, scheduler) // edit 10 seconds later .flatMap((it) -> it.editMessage(content)) .delay(1, MINUTES, scheduler) // delete 1 minute later .flatMap(Message::delete); } ``` ### More Examples We provide a small set of Examples in the [Example Directory](https://github.com/DV8FromTheWorld/JDA/tree/master/src/examples/java). <!-- TODO: Find good examples - [JDA Butler](https://github.com/Almighty-Alpaca/JDA-Butler) [And many more!](https://github.com/search?q=JDA+discord+bot&type=Repositories&utf8=%E2%9C%93) --> ## Sharding a Bot Discord allows Bot-accounts to share load across sessions by limiting them to a fraction of the total connected Guilds/Servers of the bot. <br>This can be done using **sharding** which will limit JDA to only a certain amount of Guilds/Servers including events and entities. Sharding will limit the amount of Guilds/Channels/Users visible to the JDA session so it is recommended to have some kind of elevated management to access information of other shards. To use sharding in JDA you will need to use `JDABuilder.useSharding(int shardId, int shardTotal)`. The **shardId** is 0-based which means the first shard has the ID 0. The **shardTotal** is the total amount of shards (not 0-based) which can be seen similar to the length of an array, the last shard has the ID of `shardTotal - 1`. The [`SessionController`](https://ci.dv8tion.net/job/JDA5/javadoc/net/dv8tion/jda/api/utils/SessionController.html) is a tool of the JDABuilder that allows to control state and behaviour between shards (sessions). When using multiple builders to build shards you have to create one instance of this controller and add the same instance to each builder: `builder.setSessionController(controller)` Since version **3.4.0** JDA provides a `ShardManager` which automates this building process. ### Example Sharding - Using JDABuilder ```java public static void main(String[] args) throws Exception { JDABuilder shardBuilder = JDABuilder.createDefault(args[0]); //register your listeners here using shardBuilder.addEventListeners(...) shardBuilder.addEventListeners(new MessageListener()); for (int i = 0; i < 10; i++) { shardBuilder.useSharding(i, 10) .build(); } } ``` > When the `useSharding` method is invoked for the first time, the builder automatically sets a SessionController internally (if none is present) ### Example Sharding - Using DefaultShardManager ```java public static void main(String[] args) throws Exception { DefaultShardManagerBuilder builder = DefaultShardManagerBuilder.createDefault(args[0]); builder.addEventListeners(new MessageListener()); builder.build(); } ``` ## Entity Lifetimes An **Entity** is the term used to describe types such as **GuildChannel**/**Message**/**User** and other entities that Discord provides. Instances of these entities are created and deleted by JDA when Discord instructs it. This means the lifetime depends on signals provided by the Discord API which are used to create/update/delete entities. This is done through Gateway Events known as "dispatches" that are handled by the JDA WebSocket handlers. When Discord instructs JDA to delete entities, they are simply removed from the JDA cache and lose their references. Once that happens, nothing in JDA interacts or updates the instances of those entities, and they become useless. Discord may instruct to delete these entities randomly for cache synchronization with the API. **It is not recommended to store _any_ of these entities for a longer period of time!** Instead of keeping (e.g.) a `User` instance in some field, an ID should be used. With the ID of a user, you can use `getUserById(id)` to get and keep the user reference in a local variable (see below). ### Entity Updates When an entity is updated through its manager, they will send a request to the Discord API which will update the state of the entity. The success of this request **does not** imply the entity has been updated yet. All entities are updated by the aforementioned **Gateway Events** which means you cannot rely on the cache being updated yet once the execution of a RestAction has completed. Some requests rely on the cache being updated to correctly update the entity. An example of this is updating roles of a member which overrides all roles of the member by sending a list of the new set of roles. This is done by first checking the current cache, the roles the member has right now, and appending or removing the requested roles. If the cache has not yet been updated by an event, this will result in unexpected behavior. ### Entity Deletion Discord may request that a client (the JDA session) invalidates its entire cache. When this happens, JDA will remove all of its current entities and reconnect the session. This is signaled through the `ReconnectEvent`. When entities are removed from the JDA cache, they lose access to the encapsulating entities. For instance, a channel loses access to its guild. Once that happens, they are unable to make any API requests through RestAction and instead throw an `IllegalStateException`. It is **highly recommended** to only keep references to entities by storing their **id** and using the respective `get...ById(id)` method when needed. #### Example ```java public class UserLogger extends ListenerAdapter { private final long userId; public UserLogger(User user) { this.userId = user.getIdLong(); } @Override public void onMessageReceived(MessageReceivedEvent event) { User author = event.getAuthor(); Message message = event.getMessage(); if (author.getIdLong() == userId) { // Print the message of the user System.out.println(author.getAsTag() + ": " + message.getContentDisplay()); } } @Override public void onGuildJoin(GuildJoinEvent event) { JDA api = event.getJDA(); User user = api.getUserById(userId); // Acquire a reference to the User instance through the id user.openPrivateChannel().queue((channel) -> { // Send a private message to the user channel.sendMessageFormat("I have joined a new guild: **%s**", event.getGuild().getName()).queue(); }); } } ``` ## Download [ ![maven-central][] ](https://mvnrepository.com/artifact/net.dv8tion/JDA/latest) [ ![jitpack][] ](https://jitpack.io/#DV8FromtheWorld/JDA) Latest Release: [GitHub Release](https://github.com/DV8FromTheWorld/JDA/releases/latest) <br> Be sure to replace the **VERSION** key below with the one of the versions shown above! For snapshots, please use the instructions provided by [JitPack](https://jitpack.io/#DV8FromTheWorld/JDA). **Maven** ```xml <dependency> <groupId>net.dv8tion</groupId> <artifactId>JDA</artifactId> <version>VERSION</version> </dependency> ``` **Maven without Audio** ```xml <dependency> <groupId>net.dv8tion</groupId> <artifactId>JDA</artifactId> <version>VERSION</version> <exclusions> <exclusion> <groupId>club.minnced</groupId> <artifactId>opus-java</artifactId> </exclusion> </exclusions> </dependency> ``` **Gradle** ```gradle repositories { mavenCentral() } dependencies { //Change 'implementation' to 'compile' in old Gradle versions implementation("net.dv8tion:JDA:VERSION") } ``` **Gradle without Audio** ```gradle dependencies { //Change 'implementation' to 'compile' in old Gradle versions implementation("net.dv8tion:JDA:VERSION") { exclude module: 'opus-java' } } ``` The snapshot builds are only available via JitPack and require adding the JitPack resolver, you need to specify specific commits to access those builds. Stable releases are published to [maven-central](https://mvnrepository.com/artifact/net.dv8tion/JDA). If you do not need any opus de-/encoding done by JDA (voice receive/send with PCM) you can exclude `opus-java` entirely. This can be done if you only send audio with an `AudioSendHandler` which only sends opus (`isOpus() = true`). (See [lavaplayer](https://github.com/sedmelluq/lavaplayer)) If you want to use a custom opus library you can provide the absolute path to `OpusLibrary.loadFrom(String)` before using the audio api of JDA. This works without `opus-java-natives` as it only requires `opus-java-api`. <br>_For this setup you should only exclude `opus-java-natives` as `opus-java-api` is a requirement for en-/decoding._ See [opus-java](https://github.com/discord-java/opus-java) ### Logging Framework - SLF4J JDA is using [SLF4J](https://www.slf4j.org/) to log its messages. That means you should add some SLF4J implementation to your build path in addition to JDA. If no implementation is found, following message will be printed to the console on startup: ``` SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder". SLF4J: Defaulting to no-operation (NOP) logger implementation SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details. ``` JDA currently provides a fallback Logger in case that no SLF4J implementation is present. We strongly recommend to use one though, as that can improve speed and allows you to customize the Logger as well as log to files There is a guide for logback-classic available in our wiki: [Logging Setup](https://jda.wiki/setup/logging/) ## Documentation Docs can be found on the [Jenkins][jenkins] or directly [here](https://ci.dv8tion.net/job/JDA5/javadoc/) <br>A simple Wiki can also be found at [jda.wiki](https://jda.wiki/) ### Annotations We use a number of annotations to indicate future plans for implemented functionality such as new features of the Discord API. - [Incubating](https://github.com/DV8FromTheWorld/JDA/blob/master/src/main/java/net/dv8tion/jda/annotations/Incubating.java) <br>This annotation is used to indicate that functionality may change in the future. Often used when a new feature is added. - [ReplaceWith](https://github.com/DV8FromTheWorld/JDA/blob/master/src/main/java/net/dv8tion/jda/annotations/ReplaceWith.java) <br>Paired with `@Deprecated` this is used to inform you how the new code-fragment is supposed to look once the hereby annotated functionality is removed. - [ForRemoval](https://github.com/DV8FromTheWorld/JDA/blob/master/src/main/java/net/dv8tion/jda/annotations/ForRemoval.java) <br>Paired with `@Deprecated` this indicates that we plan to entirely remove the hereby annotated functionality in the future. - [DeprecatedSince](https://github.com/DV8FromTheWorld/JDA/blob/master/src/main/java/net/dv8tion/jda/annotations/DeprecatedSince.java) <br>Paired with `@Deprecated` this specifies when a feature was marked as deprecated. [Sources](https://github.com/DV8FromTheWorld/JDA/tree/master/src/main/java/net/dv8tion/jda/annotations) ## Getting Help For general troubleshooting you can visit our wiki [Troubleshooting][troubleshooting] and [FAQ][faq]. <br>If you need help, or just want to talk with the JDA or other Devs, you can join the [Official JDA Discord Guild][discord-invite]. Alternatively you can also join the [Unofficial Discord API Guild](https://discord.gg/discord-api). Once you joined, you can find JDA-specific help in the `#java_jda` channel. For guides and setup help you can also take a look at the [wiki](https://jda.wiki/) <br>Especially interesting are the [Getting Started](https://jda.wiki/introduction/jda/) and [Setup](https://jda.wiki/setup/intellij/) Pages. ## Third Party Recommendations ### [LavaPlayer](https://github.com/sedmelluq/lavaplayer) Created and maintained by [sedmelluq](https://github.com/sedmelluq) <br>LavaPlayer is the most popular library used by Music Bots created in Java. It is highly compatible with JDA and Discord4J and allows to play audio from Youtube, Soundcloud, Twitch, Bandcamp and [more providers](https://github.com/sedmelluq/lavaplayer#supported-formats). <br>The library can easily be expanded to more services by implementing your own AudioSourceManager and registering it. It is recommended to read the [Usage](https://github.com/sedmelluq/lavaplayer#usage) section of LavaPlayer to understand a proper implementation. <br>Sedmelluq provided a demo in his repository which presents an example implementation for JDA: https://github.com/sedmelluq/lavaplayer/tree/master/demo-jda ### [Lavalink](https://github.com/freyacodes/Lavalink) Maintained by [Freya Arbjerg](https://github.com/freyacodes). Lavalink is a popular standalone audio sending node based on Lavaplayer. Lavalink was built with scalability in mind, and allows streaming music via many servers. It supports most of Lavaplayer's features. Lavalink is used by many large bots, as well as bot developers who can not use a Java library like Lavaplayer. If you plan on serving music on a smaller scale with JDA it is often preferable to just use Lavaplayer directly as it is easier. [Lavalink-Client](https://github.com/FredBoat/Lavalink-Client) is the official Lavalink client for JDA. ### [jda-nas](https://github.com/sedmelluq/jda-nas) Created and maintained by [sedmelluq](https://github.com/sedmelluq) <br>Provides a native implementation for the JDA Audio Send-System to avoid GC pauses. Note that this send system creates an extra UDP-Client which causes audio receive to no longer function properly since discord identifies the sending UDP-Client as the receiver. ```java JDABuilder builder = JDABuilder.createDefault(BOT_TOKEN) .setAudioSendFactory(new NativeAudioSendFactory()); ``` ### [jda-ktx](https://github.com/MinnDevelopment/jda-ktx) Created and maintained by [MinnDevelopment](https://github.com/MinnDevelopment). <br>Provides [Kotlin](https://kotlinlang.org/) extensions for **RestAction** and events that provide a more idiomatic Kotlin experience. ```kotlin fun main() { val jda = light(BOT_TOKEN) jda.onCommand("ping") { event -> val time = measureTime { event.reply("Pong!").await() // suspending }.inWholeMilliseconds event.hook.editOriginal("Pong: $time ms").queue() } } ``` There is a number of examples available in the [README](https://github.com/MinnDevelopment/jda-ktx/#jda-ktx). ------ More can be found in our github organization: [JDA-Applications](https://github.com/JDA-Applications) ## Contributing to JDA If you want to contribute to JDA, make sure to base your branch off of our **development** branch (or a feature-branch) and create your PR into that **same** branch. **We will be rejecting any PRs between branches or into release branches!** It is very possible that your change might already be in development or you missed something. More information can be found at the wiki page [Contributing](https://github.com/DV8FromTheWorld/JDA/wiki/5\)-Contributing) ### Deprecation Policy When a feature is introduced to replace or enhance existing functionality we might deprecate old functionality. A deprecated method/class usually has a replacement mentioned in its documentation which should be switched to. Deprecated functionality might or might not exist in the next minor release. (Hint: The minor version is the `MM` of `XX.MM.RR` in our version format) It is possible that some features are deprecated without replacement, in this case the functionality is no longer supported by either the JDA structure due to fundamental changes (for example automation of a feature) or due to Discord API changes that cause it to be removed. We highly recommend discontinuing usage of deprecated functionality and update by going through each minor release instead of jumping. For instance, when updating from version 3.3.0 to version 3.5.1 you should do the following: - Update to `3.4.RR` and check for deprecation, replace - Update to `3.5.1` and check for deprecation, replace The `RR` in version `3.4.RR` should be replaced by the latest version that was published for `3.4`, you can find out which the latest version was by looking at the [release page](https://github.com/DV8FromTheWorld/JDA/releases) ## Dependencies: This project requires **Java 8+**.<br> All dependencies are managed automatically by Gradle. * NV Websocket Client * Version: **2.14** * [Github](https://github.com/TakahikoKawasaki/nv-websocket-client) * OkHttp * Version: **4.10.0** * [Github](https://github.com/square/okhttp) * Apache Commons Collections4 * Version: **4.4** * [Website](https://commons.apache.org/proper/commons-collections) * jackson * Version: **2.14.1** * [Github](https://github.com/FasterXML/jackson) * Trove4j * Version: **3.0.3** * [BitBucket](https://bitbucket.org/trove4j/trove) * slf4j-api * Version: **1.7.36** * [Website](https://www.slf4j.org/) * opus-java (optional) * Version: **1.1.1** * [GitHub](https://github.com/discord-java/opus-java) ## Related Projects - [Discord4J](https://github.com/Discord4J/Discord4J) - [Discord.NET](https://github.com/discord-net/Discord.Net) - [discord.py](https://github.com/Rapptz/discord.py) - [serenity](https://github.com/serenity-rs/serenity) **See also:** [Discord API Community Libraries](https://github.com/apacheli/discord-api-libs)

📹 Data-driven render automation for After Effects

<p align="center"> <img src="https://user-images.githubusercontent.com/2182108/60247318-22ba6480-98c9-11e9-8447-1cbb01db15fe.png" /> </p> <div align="center"> <a href="https://travis-ci.org/inlife/nexrender"><img src="https://travis-ci.org/inlife/nexrender.svg?branch=master" alt="Build status" /></a> <a href="https://github.com/inlife/nexrender/releases"><img src="https://img.shields.io/github/downloads/inlife/nexrender/total?label=release%20downloads"/></a> <a href="https://www.npmjs.com/package/@nexrender/core"><img src="https://img.shields.io/npm/dt/@nexrender/core?label=npm%20downloads"/></a> <a href="https://discord.gg/S2JtRcB"><img src="https://discordapp.com/api/guilds/354670964400848898/embed.png" alt="Discord server" /></a> </div> <br /> <div align="center"> Automate your Adobe After Effects rendering workflows. Create data-driven and template based videos. </div> <div align="center"> _{Built with love using nodejs &bull; Brought to you by <a href="https://github.com/inlife">@inlife</a> and other <a href="https://github.com/inlife/nexrender/graphs/contributors">contributors</a>} </div> # Table of contents <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> - [Introduction](#introduction) - [Features](#features) - [How it works](#how-it-works) - [Alternatives](#alternatives) - [Installation](#installation) - [Usage](#usage) - [Job](#job) - [Assets](#assets) - [Actions](#actions) - [Details](#details) - [Job States](#job-states) - [Programmatic](#programmatic) - [Information](#information) - [Template rendering](#template-rendering) - [Footage items](#footage-items) - [Fields](#fields) - [Example](#example) - [Original source](#original-source) - [Example](#example-1) - [Static assets](#static-assets) - [Example:](#example) - [Data Assets](#data-assets) - [Fields](#fields-1) - [Example](#example-2) - [Script Asset](#script-asset) - [Fields](#fields-2) - [Dynamic Parameters](#dynamic-parameters) - [Supported Parameter Types](#supported-parameter-types) - [Parameter Types examples](#parameter-types-examples) - [String](#string) - [Number](#number) - [Array](#array) - [Object](#object) - [Null](#null) - [Functions](#functions) - [Warnings](#warnings) - [Self-Invoking Functions Example](#self-invoking-functions-example) - [Named Functions](#named-functions) - [Anonymous Functions](#anonymous-functions) - [Complete functions example](#complete-functions-example) - [Examples](#examples) - [No dynamic parameters.](#no-dynamic-parameters) - [Dynamic variable - Array type parameter](#dynamic-variable---array-type-parameter) - [Default Dynamic Variable Keyword Parameter](#default-dynamic-variable-keyword-parameter) - [Example JSX Script with defaults:](#example-jsx-script-with-defaults) - [Example JSX Script without defaults:](#example-jsx-script-without-defaults) - [Network rendering](#network-rendering) - [Using binaries](#using-binaries) - [`nexrender-server`](#nexrender-server) - [Description:](#description) - [Supported platforms:](#supported-platforms) - [Requirements:](#requirements) - [Example](#example-3) - [`nexrender-worker`](#nexrender-worker) - [Description:](#description-1) - [Supported platforms:](#supported-platforms-1) - [Requirements:](#requirements-1) - [Example](#example-4) - [Using API](#using-api) - [Tested with](#tested-with) - [Additional Information](#additional-information) - [Protocols](#protocols) - [Examples](#examples-1) - [WSL (Windows Subsystem for Linux)](#wsl) - [Linux Mapping](#linux-mapping) - [Windows Pathing](#windows-pathing) - [Binary](#wsl-binary) - [Workpath](#wsl-worthpath) - [Memory](#wsl-memory) - [Problems](#problems) - [Development](#development) - [Project Values](#project-values) - [Awesome External Packages](#awesome-external-packages) - [Awesome Related Projects](#awesome-related-projects) - [Custom Actions](#custom-actions) - [Migrating from v0.x](#migrating-from-v0x) - [Naming](#naming) - [Structure](#structure) - [Assets](#assets-1) - [Rendering](#rendering) - [CLI](#cli) - [Customers](#customers) - [Plans](#plans) - [Contributors](#contributors) - [Code Contributors](#code-contributors) - [Financial Contributors](#financial-contributors) - [Individuals](#individuals) - [Organizations](#organizations) <!-- END doctoc generated TOC please keep comment here to allow auto update --> # Introduction `nexrender` is a simple, small, carefully designed application with the main goal of rendering automation for Adobe After Effects based rendering workflows. At this point in time, the project is mainly targeted at people at least somewhat comfortable with scripting or development, and that have basic knowledge of `javascript` language and `json` formats. ### Features * data-driven, dynamic, personalized video rendering * automated video management, processing, and delivery * network-oriented project structure, render farm * highly modular nature, extensive plugin support * works only in cli mode, never launches After Effects GUI application * does not require licenses for Adobe After Effects on any worker machine * free to use and open source ### How it works * rendering: It uses Adobe After Effects' aerender command-line interface application. * compositing: It creates a temporary folder, copies project and replaces assets with provided ones. * personalization: It uses AE's expressions, scripting, and compositing (noted above). * scheduling: It stores projects in a local database, managed from anywhere using http api. * network: It renders project per machine, and can be used to render several projects simultaneously. * farm: Can be used to render a single project on several machines via Multi-Machine Sequence. ### Alternatives Probably the closest (feature-wise) alternative that exists at the moment is the Dataclay's [Templater](http://dataclay.com/) bot edition. Compared to nexrender it has a rich GUI support and a number of enterprise-scale features, however, it is not free. # Installation You can download binaries directly from the [releases](https://github.com/inlife/nexrender/releases) section, or install them using npm, whichever option works better for you. However, please note: the npm version of the binaries doesn't include all optional `plugin` packages that are covered in the usage section. If you wish to install them as well, please do so by providing each one individually: ``` npm i -g @nexrender/cli @nexrender/action-copy @nexrender/action-encode ... ``` # Usage We will be using `nexrender-cli` binary for this example. It's recommended to download/install it if you haven't already. Also, check out these example/tutorial videos made by our community: * ["Creating automated music video with nexrender"](https://www.youtube.com/watch?v=E64dXZ_AReQ) by **[douglas prod.](https://www.youtube.com/channel/UCDFTT_oX6VwmANKMng0-NUA)** >⚠ If using WSL check out [wsl support](#wsl) ## Job A job is a single working unit in the nexrender ecosystem. It is a json document, that describes what should be done, and how it should be done. Minimal job description always should contain a pointer onto Adobe After Effects project, which is needed to be rendered, and a composition that will be used to render. The pointer is `src` (string) field containing a URI pointing towards specified file, followed by `composition` (string) field, containing the name of the composition that needs to be rendered. >Note: check out [supported protocols](#protocols) for `src` field. ```json // myjob.json { "template": { "src": "file:///users/myuser/documents/myproject.aep", "composition": "main" } } ``` or for remote file accessible via http ```json // myjob.json { "template": { "src": "http://example.com/myproject.aep", "composition": "main" } } ``` Submitting this data to the binary will result in start of the rendering process: ```sh $ nexrender-cli '{"template":{"src":"file:///home/documents/myproject.aep","composition":"main"}}' ``` > Note: on MacOS you might need to change the permissions for downloaded file, so it would be considered as an executable. > You can do it by running: `$ chmod 755 nexrender-cli-macos` or more conveniently using the `--file` option ```sh $ nexrender-cli --file myjob.json ``` > Note: its recommended to run `nexrender-cli -h` at least once, to read all useful information about available options. More info: [@nexrender/cli](packages/nexrender-cli) ### Assets We've successfully rendered a static project file using nexrender, however, there is not much point doing that unless we are going to add some dynamic data into the mix. A way to implement something like that is to add an `asset` to our job definition: ```json // myjob.json { "template": { "src": "file:///d:/documents/myproject.aep", "composition": "main" }, "assets": [ { "src": "file:///d:/images/myimage.png", "type": "image", "layerName": "background.png" } ] } ``` What we've done there is we told nexrender to use a particular asset as a replacement for something that we had defined in our `aep` project. More specifically, when rendering is gonna happen, nexrender will copy/download this asset file, and attempt to find and replace `footage` entry by specified layer name. Check out: [detailed information about footage items](#footage-items). ### Actions You might've noticed that unless you added `--skip-cleanup` flag to our command, all rendered results will be deleted, and a big warning message will be shown every time you attempt to run the `nexrender-cli` with our job. The reason is that we haven't defined any actions that we need to do after we finished actual rendering. Let's fix that and add a simple one, copy. ```json // myjob.json { "template": { "src": "http://example.com/assets/myproject.aep", "composition": "main" }, "assets": [ { "src": "http://example.com/assets/myimage.png", "type": "image", "layerName": "background.png" } ], "actions":{ "postrender": [ { "module": "@nexrender/action-encode", "preset": "mp4", "output": "encoded.mp4" }, { "module": "@nexrender/action-copy", "input": "encoded.mp4", "output": "d:/mydocuments/results/myresult.mp4" } ] } } ``` We've just added a `postrender` action, that will occur right after we finished rendering. A module that we described in this case, is responsible for copying result file from a temp folder to the `output` folder. There are multiple built-in modules within nexrender ecosystem: * [@nexrender/action-copy](packages/nexrender-action-copy) * [@nexrender/action-encode](packages/nexrender-action-encode) * [@nexrender/action-upload](packages/nexrender-action-upload) * [@nexrender/action-cache](packages/nexrender-action-cache) * (list will be expanded) Every module might have his own set of fields, however, `module` field is always there. Also, you might've noticed that `actions` is an object, however, we described only one (`postrender`) field in it. And there are more: - `predownload` - can be used to modify the job before the assets are downloaded - `postdownload` - can be used to modify the job after the assets are downloaded - `prerender` - can be used to process data/assets just before the actual render will start. Also, if you are planning on having more than one action, please note: **actions are order-sensitive**, that means if you put let's say some encoding action after upload, the latter one might not be able to find a file that needs to be generated by the former one, since the ordering was wrong. If you have at least some experience with `Node.js`, you might've noticed that the `module` definition looks exactly like a package name. And well, yes it is. When nexrender stumbles upon a `module` entry, it will try to require this package from internal storage, and then if no module has been found, it will attempt to look for globally installed Node.js modules with that name. That means if you are comfortable with writing `Node.js` code, you can easily create your own module, and use it by providing either absolute/relative path (on a local machine), or publishing the module and installing it globally on your target machine. ```sh npm i -g my-awesome-nexrender-action ``` And then using it: ```json { "actions":{ "postrender": [ { "module": "my-awesome-nexrender-action", "param1": "something big", "param2": 15 } ] } } ``` Also, you can [checkout packages](#awesome-external-packages) made by other contributors across the network: ### Details Job structure has more fields, that we haven't checked out yet. The detailed version of the structure looks like this: ```js { "tags": String, "priority": Number, "template": { "src": String, "composition": String, "frameStart": Number, "frameEnd": Number, "incrementFrame": Number, "continueOnMissing": Boolean, "settingsTemplate": String, "outputModule": String, "outputExt": String, }, "assets": [], "actions": { "predownload": [], "postdownload": [], "prerender": [], "postrender": [], }, "onChange": Function, "onRenderProgress": Function, "onRenderError": Function } ``` Majority of the fields are just proxied to the `aerender` binary, and their descriptions and default values can be checked [here](https://helpx.adobe.com/after-effects/using/automated-rendering-network-rendering.html). - `tags` (optional) (example `primary,plugins` : comma delimited ) is a piece of information that describes the job that it is assigned to. It can be used by the worker(s) / or api client(s) to pickup the job with specific tags (see `tagSelector` [here](packages/nexrender-worker) ). Tags name must be an alphanumeric. - `priority` (default 0) is a number of priority. Jobs are selected based on their priority field by the worker, in case of a collision it will choose the oldest one. - `onChange` is a [callback](https://github.com/inlife/nexrender/blob/master/packages/nexrender-core/src/helpers/state.js) which will be triggered every time the job state is changed (happens on every task change). - `onRenderProgress` is a [callback](https://github.com/inlife/nexrender/blob/master/packages/nexrender-core/src/tasks/render.js) which will be triggered every time the rendering progress has changed. - `onRenderError` is a [callback](https://github.com/inlife/nexrender/blob/master/packages/nexrender-core/src/tasks/render.js) which will be triggered when `arender` encounters an error during its runtime. So far known errors are (please contribute): - Errors from [nexrender.jsx](https://github.com/inlife/nexrender/blob/master/packages/nexrender-core/src/assets/nexrender.jsx) - most likely issue in the `assets` section within the job. - `No comp was found with the given name.` - Composition from `template.composition` not present in the AE file. - `After Effects error: file is damaged.` - AE file is broken and could not be opened (caused by incomplete transfer/download) Note: Callback functions are only available via programmatic use. For more information, please refer to the source code. ### Job States > **Note:** Job states are mainly used for network rendering. If you are using `nexrender-cli` you can skip this section. Job can have state field (`job.state`) be set to one of those values: * `created` (default) * `queued` (when pushed to the nexrender-server) * `picked` (when somebody picked up job on nexrender-server) * `started` (when worker started preparing and running the job) * `render:setup` (bunch of states that are specific to each render step) * `render:predownload` * `render:download` * `render:postdownload` * `render:prerender` * `render:script` * `render:dorender` * `render:postrender` * `render:cleanup` * `finished` (when worker successfully finished rendering the job) * `error` (when worker got an error at any step starting from `started` state) ## Programmatic In case you are building your own application and just need to use a rendering part, or you wanna manually trigger jobs from your code, there is a way to use nexrender programmatically: Install the [@nexrender/core](https://github.com/inlife/nexrender/tree/master/packages/nexrender-core) ```sh $ npm install @nexrender/core --save ``` And then load it, and run it ```js const { render } = require('@nexrender/core') const main = async () => { const result = await render(/*myJobJson*/) } main().catch(console.error); ``` Or you can go more advanced, and provide some settings as your 2nd argument to the `render` function: ```js const { render } = require('@nexrender/core') const main = async () => { const result = await render(/*myJobJson*/, { workpath: '/Users/myname/.nexrender/', binary: '/Users/mynames/Apllications/aerender', skipCleanup: true, addLicense: false, debug: true, }) } main().catch(console.error); ```` ### Information The module returns 2 methods, `init` and `render`. `render` calls `init` internally, if it sees that there were some options provided to `render` as 2nd argument. First one is responsible for setting up the env, checking if all needed patches for AE are in place, automatically adding render-only license file for a free usage of Adobe's product (unless disabled), and a few other minor things. Second one is responsible for mainly job-related operations of the full cycle: downloading, rendering, processing, and uploading. `init` accepts an object, containing additional options: * `workpath` - string, manually set path to working directory where project folder will be created, overrides default one in system temp folder * `binary` - string, manually set path pointing to the aerender(.exe) binary, overrides auto found one * `debug` - boolean, enables or disables debug mode, false by default * `skipCleanup` - boolean, providing true will prevent nexrender from removing the temp folder with project (false by default) * `skipRender` - boolean, providing true will prevent nexrender from running actual rendering, might be useful if you only want to call scripts * `multiFrames` - boolean, providing true will attmpt to use aerender's built-in feature of multi frame rendering (false by default) * `multiFramesCPU` - integer between 1-100, the percentage of CPU used by multi frame rendering, if enabled (90 by default) * `reuse` - boolean, false by default, (from Adobe site): Reuse the currently running instance of After Effects (if found) to perform the render. When an already running instance is used, aerender saves preferences to disk when rendering has completed, but does not quit After Effects. If this argument is not used, aerender starts a new instance of After Effects, even if one is already running. It quits that instance when rendering has completed, and does not save preferences. * `maxMemoryPercent` - integer, undefined by default, check [original documentation](https://helpx.adobe.com/after-effects/using/automated-rendering-network-rendering.html) for more info * `imageCachePercent` - integer, undefined by default, check [original documentation](https://helpx.adobe.com/after-effects/using/automated-rendering-network-rendering.html) for more info * `addLicense` - boolean, providing false will disable ae_render_only_node.txt license file auto-creation (true by default) * `forceCommandLinePatch` - boolean, providing true will force patch re-installation * `wslMap` - String, set WSL drive map, check [wsl](#wsl) for more info * `maxRenderTimeout` - Number, set max render timeout in seconds, will abort rendering if it takes longer than this value (default: 0 - disabled) * `cache` - boolean or string. Set the cache folder used by HTTP assets. If `true` will use the default path of `${workpath}/http-cache`, if set to a string it will be interpreted as a filesystem path to the cache folder. More info: [@nexrender/core](packages/nexrender-core) ## Using the ${workPath} mask in @nexrender/action-encode The output of `@nexrender/action-encode` is always prepended by the working path of the job, so you don't have to guess paths. However if you want to use the working path of the job for something else such as encoding in multiple bitrates it is necessary to use the `${workPath}` mask. This is especially useful for HLS encoding ```json //HLS encoding { "module": "@nexrender/action-encode", "output": "encoded_playlist_%v.m3u8", "params": { "-acodec": "aac", "-vcodec": "libx264", "-pix_fmt": "yuv420p", "-map": [ "0:0", "0:0", "0:0" ], "-b:v:0": "2000k", "-b:v:1": "1000k", "-b:v:2": "500k", "-f": "hls", "-hls_time": "10", "-hls_list_size": "0", "-var_stream_map": "v:0,name:high v:1,name:medium v:2,name:low", "-master_pl_name": "master.m3u8", "-hls_segment_filename": "${workPath}\\encoded%d_%v.ts" } } ``` The `-hls_segment_filename` flag requires the absolute paths or else it would save on the working path of the nexrender application hence the use of `${workPath}` # Template rendering One of the main benefits of using nexrender is an ability to render projects using data other than what has been used while the project has been created. Data means any sort of source/footage material, it can be images, audio tracks, video clips, text strings, values for colors/positions, even dynamic animations using expressions. All of those things can be replaced for every job without even opening a project file or starting After Effects. > Note: Also this process can be called in other ways: **templated**, **data-driven** or **dynamic** video generation. This approach allows you to create a .aep file once, and then reuse it for as many target results as you need to. However, what is needed to get started? ## Footage items Footage item replacement is what briefly has been covered in the `Job` section of this document. The idea is quite simple, you describe which asset will replace existing described footage item in a specific layer, by specifying `src`, and one of the `layerName` or `layerIndex` options. ### Fields * `src`: string, a URI pointer to the specific resource, check out [supported protocols](#protocols) * `type`: string, for footage items, is one of (`image`, `audio`, `video`) * `layerName`: string, target layer name in the After Effects project * `layerIndex`: integer, can be used instead of `layerName` to select a layer by providing an index, starting from 1 (default behavior of AE jsx scripting env) * `composition`: string, composition where the layer is. Useful for searching layer in specific compositions. If none is provided, it uses the wildcard composition "\*", that will result in a wildcard composition matching, and will apply this data to every matching layer in every matching composition. If you want to search in a nested composition you can provide a path to that composition using `"->"` delimiter. For example, `"FULL_HD->intro->logo comp"` matches a composition named `logo comp` that is used in composition `intro` which in turn is used in composition `FULL_HD`. Note, that `FULL_HD` doesn't have to be the root composition. Make sure to specify a **composition** name, not a layer name. * `name`: string, an optional filename that the asset will be saved as. If not provided the `layerName` or the basename of the file will be used * `extension`: string, an optional extension to be added to the filename before it is sent for rendering. This is because After Effects expects the file extension to match the content type of the file. If none is provided, the filename will be unchanged. * `useOriginal`: boolean, an optional feature specific to the `file://` protocol that prevents nexrender from copying an asset to a local temp folder, and use original instead The specified asset from `src` field will be downloaded/copied to the working directory, and just before rendering will happen, a footage item with specified `layerName` or `layerIndex` in the original project will be replaced with the freshly downloaded asset. This way you (if you are using network rendering) can not only deliver assets to the target platform but also dynamically replace them. >Note: if `layerName` is used for footage file asset, it should always contain the extension in the name as well. ### Example ```json { "assets": [ { "src": "https://example.com/assets/image.jpg", "type": "image", "layerName": "MyNicePicture.jpg" }, { "src": "https://example.com/assets/jpeg-without-extension", "type": "image", "layerName": "MyOtherNicePicture.jpg", "extension": "jpg" }, { "src": "file:///home/assets/audio.mp3", "type": "audio", "name": "music.mp3", "layerIndex": 15 } ] } ``` ### HTTP caching When using the `http` or `https` protocol, you can utilize local caching to minimize the amount of data that have to be transferred over a network and speed up project/assets download. To use HTTP caching, the server serving your assets must support the relevant [HTTP caching semantics](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching). The simplest way to enable caching is to use the setting wide cache option (setting`--cache` flag if using CLI or worker CLI, setting `cache: true` when using programmatically). This will enable HTTP based caching for all your assets and project files if they are requested over HTTP from a server that supports the relevant headers. You can also control caching on a more granular level if desired. For each asset's setting if a `params` property is set, it will be passed directly to [make-fetch-happen](https://github.com/npm/make-fetch-happen) which includes the `cachePath` property that you can set to a custom folder path (or null if you want to disable caching for a particular asset only). > Note: caches are not cleared automatically so you may need to monitor the cache folder size if you are using a lot of large assets over time. Assets, if they have been cached, will always resolve even if they are stale and the server is not available. ### Example ```json { "assets": [ { "src": "https://example.com/assets/image.jpg", "type": "image", "layerName": "MyNicePicture.jpg", "params": { "cachePath": "/tmp/my-nexrender-cache" } }, { "src": "https://example.com/assets/jpeg-without-extension", "type": "image", "layerName": "MyOtherNicePicture.jpg", "extension": "jpg", "params": { "cachePath": "/tmp/my-nexrender-cache" } } ] } ``` ### Original source For `file` protocol based assets (assets coming from the local filesystem/shared network), you can provide an additional option, `useOriginal`, that would force nexrender to use an original file rather than creating a local copy inside of the temp rendering folder. That could be useful for large asset files, that would otherwise take a long time to copy. #### Example ```json { "assets": [ { "src": "file:///D:/assets/MyBigAsset.wav", "type": "audio", "useOriginal": true, "layerIndex": 15 } ] } ``` ## Static assets There is also a plain asset type that allows you to simply provide a `src`, and that file will be downloaded in the folder with the project. No additional automated actions will happen with that asset, unless you manually use scripting to do something with those. Might be useful for some static data-based injections, or some other use cases. ### Example: ```json { "assets": [ { "src": "http://example.com/assets/something.json", "type": "static" }, { "src": "http://example.com/assets/something_else.csv", "name": "mydata.csv", "type": "static" } ] } ``` ## Data Assets The second important point for the dynamic data-driven video generation is the ability to replace/change/modify non-footage data in the project. To do that, a special asset of type `data` can be used. ### Fields * `type`: string, for data items, is always `data` * `layerName`: string, target layer name in the After Effects project * `layerIndex`: integer, can be used instead of `layerName` to select a layer by providing an index, starting from 1 (default behavior of AE jsx scripting env) * `property`: string, indicates which layer property you want to change * `value`: mixed, optional, indicates which value you want to be set to a specified property * `expression`: string, optional, allows you to specify an expression that can be executed every frame to calculate the value * `composition`: string, composition where the layer is, useful for searching layer in specific compositions. If none is provided, it uses the wildcard composition "\*", that will result in a wildcard composition matching, and will apply this data to every matching layer in every matching composition. If you want to search in a nested composition you can provide a path to that composition using `"->"` delimiter. For example, `"FULL_HD->intro->logo comp"` matches a composition named `logo comp` that is used in composition `intro` which in turn is used in composition `FULL_HD`. Note, that `FULL_HD` doesn't have to be the root composition. Make sure to specify a **composition** name, not a layer name. * `continueOnMissing`: boolean (default false), optional, allows you to bypass an error exception if couldn't find any layers. Probably should not be used by users, unless they know what are they doing. Since both `value` and `expression` are optional, you can provide them in any combination, depending on the effect you want to achieve. Providing `value` will set the exact value for the property right after execution, and providing an expression will make sure it will be evaluated every frame. >Note: If you are not sure what expressions are, and how to use them, please refer [to this page](https://helpx.adobe.com/after-effects/using/expression-basics.html) And if you are not sure what a `property` is or where to get it, you can refer to this image: <details> <summary><b>Property Example</b></summary> >As you can see there are a few `Property Groups` like Text, Masks, Transform that include actual properties. Those properties are what can be used as a target.  In case you need to change some **deep properties**, as shown on this image...  ... you can do that by providing the property name using a dot `.` separator (e.g. "Effects.Skin_Color.Color"). In case your property already has `.` in the name, and you are sure it will lead to a collision while parsing, you can instead use an arrow symbol `->`. You can also change the deeper attributes of properties, for example the font of a text layer, using "Source Text.font" or the font size by "Source Text.fontSize". </details> ### Example ```json { "assets": [ { "type": "data", "layerName": "MyNicePicture.jpg", "property": "Position", "value": [500, 100] }, { "type": "data", "layerName": "my text field", "property": "Source Text", "expression": "time > 100 ? 'Bye bye' : 'Hello world'" }, { "type": "data", "layerName": "my text field", "property": "Source Text.font", "value": "Arial-BoldItalicMT" }, { "type": "data", "layerName": "background", "property": "Effects.Skin_Color.Color", "value": [1, 0, 0] }, { "type": "data", "layerIndex": 15, "property": "Scale", "expression": "[time * 0.1, time * 0.1]" }, ] } ``` >Note: any error in expression will prevent the project from rendering. Make sure to read error messages reported by After Effects binary carefully. ## Script Asset 🚀 **NEW**: Now you can pass arguments to JSX dynamically! Read below for more information 🚀 The last and the most complex and yet the most powerful is an ability to execute custom `jsx` scripts just before the rendering will start. This approach allows you to do pretty much anything that is allowed for scripting, like creating/removing layers, adding new elements, restructuring the whole composition, and much more. With some basic knowledge of `ExtendScript Toolkit`, you can write custom scripts that nexrender will pass through to the underlying CLI (or render network) to execute before rendering. You'll just need to provide a `src` pointing towards the script resource and a `type` of `"script"`. ### Fields * `src`: **string**, a URI pointer to the specific resource, check out [supported protocols](#protocols) * `type`: **string**, for script items, is always `script` * `keyword`: (optional) **string**, name for the configuration object holding all the dynamically injected parameters. Defaults to **NX** * `parameters`: (optional) **object**, object where all the dynamically injected parameters are defined. Script variables that are not included in this list default to `null`. * `globalDefaultValue` (optional) **any**, An override for the default value of any unknown or undefined **NX** (or the `keyword` value, if set) config values. Use caution when overriding defaults like this. It is suggested to leave it as is and check for `null` values in your JSX code. ### Dynamic Parameters With dynamic parameters, you can set a parameter in your Job declaration to be used on a JSX Script! Each parameter object must have the following: * **key** (required) : The key of the variable. Example: Key = dog => NX.dog. * **value** (required) : The target value for the variable. Example: Key = dog, Value = "doggo" => NX.dog = "doggo". See [Supported Parameter Types](#supported-parameter-types). ### Supported Parameter Types We currently support all standard [JSON Parameters](https://restfulapi.net/json-data-types/) with the addition of javascript **[functions](#functions)**, which can be named, anonymous or self-invoking. * [`string`](#string) * [`number`](#number) * [`array`](#array) * [`object`](#object) * [`null`](#null) __(default)__ * [`functions`](#functions) ### Parameter Types examples #### String ```json "parameters" : [ { "key" : "fullName", "value": "John Doe" } ] ``` #### Number ```json "parameters" : [ { "key" : "orangeAmount", "value": 37 } ] ``` #### Array ```json "parameters" : [ { "key" : "officesList", "value": ["Santiago", "London", "Paris", "Kyoto", "Hong-Kong"] } ] ``` #### Object ```json "parameters" : [ { "key" : "carDetails", "value": { "model" : "Tesla Model S", "maxBatteryLife" : 500000, "color" : "vermilion" } } ] ``` #### Null This is the default value for parameters used on any given JSX script that are not initializated. ```json "parameters" : [ { "key" : "carDetails" } ] ``` `NX.get("carDetails")` will be equal to `null`. #### Functions Functions are useful if you need some dynamic calculation of specific values. You can use them in conjuction with other dynamic parameters as well. Currently we support [Self-invoking Functions](#self-invoking-functions-example), [Named Functions](#named-functions-example) and [Anonymous Functions](#anonymous-functions-example). After Effects ExtendedScript **does not support arrow functions** at the moment (cc 2020). ##### Warnings * You must **only use one function per parameter**; If there's more than one function defined in the parameter `value` the job will crash due to limitations in function detection and parsing. * Use well-formed functions and be aware of the computational weight of your functions. Malformed functions will cause the script to fail and subsequently the job to crash. ##### Self-Invoking Functions Example Self-invoking functions are useful when concatenating strings, or in places where you want the function output without redeclaring it. ```json "parameters" : [ { "key" : "onePlusOne", "value": "(function() { return 1+1; })()" } ] ``` The above function could be use in a string concatenation such as ```jsx alert("Miss, what's the mathematical operation required to compute the number" + NX.get("onePlusOne") + " ?"); // A typical second grade question. ``` ```json "parameters" : [ { "key" : "invitees", "value": ["Steve", "Natasha", "Tony", "Bruce", "Wanda", "Thor", "Peter", "Clint" ] }, { "key" : "eventInvitation", "value": "(function (venue) { alert( 'This years\' Avengers Gala is on the prestigious ' + venue.name + ' located at ' + venue.location + '. Our special guests ' + NX.get('invitees').value.map(function (a, i) { return (i == NX.get('invitees').value.length - 1) ? ' and ' + a + ' (whoever that is)' : a + ', '; }).join('') + ' going to be present for the ceremony!'); })({ name: NX.arg('venue'), location: NX.arg('location') })", "arguments": [ { "key" : "venue", "value" : "Smithsonian Museum of Natural History" }, { "key" : "location", "value": "10th St. & Constitution Ave." } ] } ] ``` This convoluted function would return a lovely invitation string to an event using a dynamic parameter set on the `json` Job, as well as having additional required parameters with their defaults and could be used as follows: ```jsx alert(NX.get("eventInvitation")); // Output: /* This years' Avengers Gala is on the prestigious Smithsonian Museum of Natural History located at 10th St. & Constitution Ave. Our special guests Steve, Natasha,Tony, Wanda, Thor, Peter and Clint (whoever that is) are going to be present for the ceremony! */ ``` #### Named Functions ```json "parameters" : [ { "key" : "sum", "value": "function namedSumFunction(a, b) { return a + b; }" } ] ``` ```jsx var result = NX.call("sum", [400, 20]); // 420 ``` Note that the usage of the named method is `sum` and not `namedSumFunction` due to JS' __hoisting__, so named functions are implemented and used the same way as anonymous functions. #### Anonymous Functions ```json "parameters" : [ { "key" : "sumValues", "value": "function (a, b) { return a + b; }" } ] ``` ```jsx var result = NX.call("sumValues", [400, 20]); // 420 ``` #### Complete functions example ```json { "template": { "src": "file:///template.aep", "composition": "BLANK_COMP" }, "assets": [ { "src": "file:///sampleParamInjection.jsx", "type": "script", "parameters": [ { "type": "array", "key" : "dogs", "value": [ "Captain Sparkles", "Summer", "Neptune"] }, { "type" : "number", "key" : "anAmount" }, { "type": "function", "key": "getDogsCount", "value" : "function() { return NX.get('dogs').length; }" }, { "type": "function", "key": "exampleFn", "value": "function ( parameter ) { return parameter; }" }, { "type" : "function", "key" : "dogCount", "value" : "(function(length) { return length })(NX.arg('dogCount'))", "arguments": [ { "key" : "dogCount", "value": ["NX.call('exampleFn', [NX.call('getDogsCount') + NX.get('anAmount')])"] } ] } ] } ] } ``` ### Examples #### No dynamic parameters. ```json { "assets": [ { "src": "http://example.com/scripts/myscript.jsx", "type": "script" } ] } ``` #### Dynamic variable - Array type parameter ```json "assets": [ { "src": "file:///C:/sample/sampleParamInjection.jsx", "type": "script", "parameters": [ { "key": "name", "value": "Dilip" } ] } ] ``` ##### Default Dynamic Variable Keyword Parameter The `value` could be a variable or a function, but beware that there is no sanitization nor validation so **if the input is malformed it could crash the job** By default the **keyword** is set to **`NX`**, so you would call your variables or methods like `NX.get("foo")` or `NX.call("bar", ["sampleStringParameter"])`. To change this keyword simply set `"keyword"` as shown below: ```json "assets": [ { "src": "file:///C:/sample/sampleParamInjection.jsx", "type": "script", "keyword": "_settings", "parameters": [ { "key": "name", "value": "Dilip" } ] } ] ``` This way instead of `NX.get("foo")` it would be `_settings.get("foo")` **_All dynamic parameters used in the script should have a JSX default_** ### Example JSX Script with defaults: ```jsx { return "Hello " + NX.get("name") || "John"; } ``` The code above will output either: 1. `"Hello John"` if no parameter defined on the JSON `parameters` array or this parameter is missing. 2. `"Hello NAME"` if parameter `name` has a `value` of `NAME` on the JSON `parameters` array. ### Example JSX Script without defaults: ```jsx { // The code below will crash if it's executed directly in After Effects. See documentation on how to enable cross environment fault tolerance. return "There are " + NX.get("beerBottlesAmount") + " beer bottles ready to drink!" } ``` The code above will output either: 1. `"There are null beer bottles ready to drink!" `if no parameter defined on the JSON `parameters` array. 2. `"There are 20 beer bottles ready to drink!"` if parameter `beerBottlesAmount` has a `value` of `20` on the JSON `parameters` array. But don't you worry about missing any of the examples above. If you use a variable in your JSX with the default keyword and no initialization whatsoever, the console will output a handy initialization code snippet for both JSON and JSX for you to copy and modify with your own values! That pretty much covers basics of templated rendering. # Network rendering We've covered basics on how to set up a minimal rendering flow using local cli machine rendering. Now, what if you want to start rendering on a remote machine, to reduce load while you are working on your local machine? Or maybe you need to render several videos at once, requiring a fleet of nodes running on some cloud cluster.  With nexrender, you can quickly and easily spin up your own rendering cluster. ## Using binaries You can download compiled versions of binaries directly from the [releases](https://github.com/inlife/nexrender/releases) section, or install them using npm, whichever option works better for you. ### `nexrender-server` #### Description: A CLI application which is responsible for job management, worker node cooperation, communications with the `nexrender-worker` instances, serves mainly as a producer in the nexrender network model. Technically speaking, its a very tiny HTTP server with minimal REST API support. Optional support for external databases can be added (like Redis, MongoDB, MySQL, etc.), with some of them already in place. Please check modules for more info. #### Supported platforms: Windows, macOS, Linux #### Requirements: None #### Example ```sh $ nexrender-server \ --port=3050 \ --secret=myapisecret ``` More info: [@nexrender/server](packages/nexrender-server) ### `nexrender-worker` #### Description: A CLI application which is responsible mainly for actual job processing and rendering, communication with the `nexrender-server`, and serves mainly as a consumer in the nexrender network model. #### Supported platforms: Windows, macOS #### Requirements: Installed licensed/trial version of Adobe After Effects #### Example ```sh $ nexrender-worker \ --host=https://my.server.com:3050 \ --secret=myapisecret ``` > Note: its recommended to run `nexrender-worker -h` at least once, to read all useful information about available options. More info: [@nexrender/worker](packages/nexrender-worker) ## Using API Now, after you've loaded up your worker and server nodes, they will need some jobs to be submitted to the server to start actual rendering. There are 2 main ways to do that. You can send a direct POST request: ```sh curl \ --request POST \ --header "nexrender-secret: myapisecret" \ --header "content-type: application/json" \ --data '{"template":{"src":"http://my.server.com/assets/project.aep","composition":"main"}}' \ http://my.server.com:3050/api/v1/jobs ``` Or you can use the javascript API client: ```sh npm install @nexrender/api --save ``` ```js const { createClient } = require('@nexrender/api') const client = createClient({ host: 'http://my.server.com:3050', secret: 'myapisecret', }) const main = async () => { const result = await client.addJob({ template: { src: 'http://my.server.com/assets/project.aep', composition: 'main', } }) result.on('created', job => console.log('project has been created')) result.on('started', job => console.log('project rendering started')) result.on('progress', (job, percents) => console.log('project is at: ' + percents + '%')) result.on('finished', job => console.log('project rendering finished')) result.on('error', err => console.log('project rendering error', err)) } main().catch(console.error); ``` More info: [@nexrender/api](packages/nexrender-api) # Tested with Current software was successfully tested on: * Adobe After Effects CS 5.5 [OS X 10.14.2] * Adobe After Effects CC (version 12.1.168) [OS X 10.11.2, Windows 10 64bit] * Adobe After Effects CC 2015 (version 13.6.0) [OS X 10.11.2] * Adobe After Effects CC 2018.3 [Windows 2012 Server R2 Datacenter] * Adobe After Effects CC 2019 [OS X 10.14.2, Windows Server 2019 (AWS)] # Additional Information ## Protocols `src` field is a URI string, that describes path pointing to the specific resource. It supports a few different protocols: * Built-in: * `file://` - file on a local file system, may include environment variables identified by a preceding $ sign (possibly a pipe? need testing) * `http://` - file on remote http server * `https://` - file on remote http server served via https * `data://` - URI encoded data, can be a [base64 or plain text](https://en.wikipedia.org/wiki/Data_URI_scheme) * External: * `gs://` - [@nexrender/provider-gs](packages/nexrender-provider-gs) - Google Cloud Storage provider * `s3://` - [@nexrender/provider-s3](packages/nexrender-provider-s3) - Amazon S3 provider * `ftp://` - [@nexrender/provider-ftp](packages/nexrender-provider-ftp) - Node.js FTP provider * (other protocols will be added there) ### Examples Here are some examples of src paths: ``` file:///home/assets/image.jpg file:///d:/projects/project.aep file://$ENVIRONMENT_VARIABLE/image.jpg http://somehost.com:8080/assets/image.jpg?key=foobar https://123.123.123.123/video.mp4 data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg== data:text/plain;charset=UTF-8,some%20data:1234,5678 ``` ## WSL If running WSL (`Windows Subsystem for Linux`) you will need to configure your project a bit differently in order for it to render correctly. ### Linux Mapping You will need to pass in which drive letter `Linux` is mapped to in `Windows`. This is the `Drive Letter` in which you can access your Linux file system from Windows. > ⚠ Note: Drive mapping is setup when configuring WSL You can do this through the CLI like so assuming Linux is mapped to `Z`. ```sh $ nexrender-cli -f mywsljob.json -m "Z" ``` or ```sh $ nexrender-cli -f mywsljob.json -wsl-map "Z" ``` And you can do this Programmatically like ```js const { render } = require('@nexrender/core') const main = async () => { const result = await render(/*myWSLJobJson*/, { skipCleanup: true, addLicense: false, debug: true, wslMap: "Z" }) } main().catch(console.error); ```` ### Windows Pathing When referencing windows file system you will need to use `/mnt/[DRIVE YOU WANT TO ACCESS]/[PATH TO YOUR FILE]`. like so ``` /mnt/d/Downloads/nexrender-boilerplate-master/assets/nm.png ``` CLI Example ```sh nexrender-cli -f mywsljob.json -m "Z" -w /mnt/d/Downloads/tmp/nexrender ``` Job Example ```json { "template": { "src": "file:///mnt/d/Downloads/nexrender-boilerplate-master/assets/nm05ae12.aepx", "composition": "main", }, "assets": [ { "src": "file:///mnt/d/Downloads/nexrender-boilerplate-master/assets/2016-aug-deep.jpg", "type": "image", "layerName": "background.jpg" } ], "actions": { "postrender": [ { "module": "@nexrender/action-encode", "output": "output.mp4", "preset": "mp4" } ] } } ``` > ⚠ Note: nexrender does not currently support custom root pathing ### WSL Binary If `After Effects` is installed into the default location `nexrender` should auto detected it. Otherwise you will need to provide its location following the [Windows Pathing Guide](#windows-pathing). Example for if you installed `After Effect` onto your `D drive`. ```sh nexrender-cli -f mywsljob.json -b "/mnt/d/Program Files/Adobe/Adobe After Effects 2020/Support Files/aerender.exe" ``` ### WSL Workpath By default nexrender will use your Linux /tmp folder to render out the jobs. We suggest changing this to a secondary drive as rendering can eat up disk space causing an issue where `WSL` does no release disk space back to `Windows`. Example under [Windows Pathing Guide](#windows-pathing). > Github Issue: [WSL 2 should automatically release disk space back to the host OS ](https://github.com/microsoft/WSL/issues/4699#issuecomment-656352632) ### WSL Memory It's also suggested that you create a `.wslconfig` file in your `Windows user folder` and limit the memory that can be used by `WSL`. Otherwise your rendering will crash on large projects. .wslconfig Example ``` [wsl2] memory=4GB swap=0 localhostForwarding=true ``` > Github Issue: [WSL 2 consumes massive amounts of RAM and doesn't return it](https://github.com/microsoft/WSL/issues/4166) ## Problems There might be a lot of problems creeping around, since this tool works as an intermediary and coordinator for a bunch of existing complex technologies, problems is something inescapable. However, we will try our best to expand and keep this section up to date with all possible caveats and solutions for those problems. 1. macOS access: there might be issues with nexrender accessing the aerender binary within the Adobe library folder, or accessing /tmp folders. For more details refer to https://github.com/inlife/nexrender/issues/534 ## Development If you wish to contribute by taking an active part in development, you might need this basic tutorial on how to get started: 1. clone the repo 2. run `npm install` 3. run `npm start` The last command will run [lerna](https://lerna.js.org/) bootstrap action to setup dependencies for all packages listed in the `packages/` folder, and link them together accordingly to their dependency relations. After that, you can start the usual development flow of writing code and testing it with `npm start` in a specific package. Why this multi-package structure has been chosen? It seemed like a much smarter and easier way to achieve a few things: 1. separation of concerns, every module is responsible for a limited set of things 2. modularity and plugin-friendly nature, which allows external packages to be used instead, or alongside built-in ones 3. minimal dependency, as you might've noticed, packages in nexrender try to have as little dependencies as possible making it much easier to maintain and develop The recommended approach is to add only needed things as dependencies, it's better to take some time to research module that is being added to the project, to see how many its own dependencies it will introduce, and possibly find a better and smaller one, or even extract some specific feature into a new micro module. And of course, the main thing about development is that it should be fun. :) ## Project Values This project has a few principle-based goals that guide its development: * **Do our thing really well.** Our thing is data-based automating of the rendering, and handling other interactive related components of that task set. It is not meant to be a replacement for specific corporate tools templater bot, rendergarden, etc. that have lots of features and customizability. (Some customizability is OK, but not to the extent that it becomes overly complicated or error-prone.) * **Limit dependencies.** Keep the packages lightweight. * **Pure nodejs.** This means no native module or other external/system dependencies. This package should be able to stand on its own and cross-compile easily to any platform -- and that includes its library dependencies. * **Idiomatic nodejs.** Keep modules small, minimal exported names, promise based async handling. * **Be elegant.** This package should be elegant to use and its code should be elegant when reading and testing. If it doesn't feel good, fix it up. * **Well-documented.** Use comments prudently; explain why non-obvious code is necessary (and use tests to enforce it). Keep the docs updated, and have examples where helpful. * **Keep it efficient.** This often means keep it simple. Fast code is valuable. * **Consensus.** Contributions should ideally be approved by multiple reviewers before being merged. Generally, avoid merging multi-chunk changes that do not go through at least one or two iterations/reviews. Except for trivial changes, PRs are seldom ready to merge right away. * **Have fun contributing.** Coding is awesome! ## Awesome External Packages Here you can find a list of packages published by other contributors: * [HarryLafranc/nexrender-action-handbrake](https://github.com/HarryLafranc/nexrender-action-handbrake) - Encode a video with Handbrake on nexrender-postrender * [dberget/nexrender-action-cloudinary](https://github.com/dberget/nexrender-action-cloudinary) - Upload a video to Cloudinary platform * [dberget/nexrender-action-normalize-color](https://github.com/dberget/nexrender-action-normalize-color) - Normalize colors for each asset defined in options * [dylangarcia/nexrender-action-unzip](https://github.com/dylangarcia/nexrender-action-unzip) - Unzip composition source before starting to render * [pilskalns/nexrender-action-template-unzip](https://github.com/Pilskalns/nexrender-action-template-unzip) - Unzip template and find (first) `.aep` file within it. Minimal config. * [oreporan/nexrender-action-upload-s3-presigned](https://github.com/oreporan/nexrender-action-upload-s3-presigned) - A postrender upload plugin which uploads using https (for s3 presigned_url) * [pulsedemon/nexrender-action-run-command](https://github.com/pulsedemon/nexrender-action-run-command) - Run shell commands as a nexrender action * [oksr/nexrender-action-slack-message](https://github.com/oksr/nexrender-action-slack-message) - Utility module for sending a Slack message when render start/finish or render error. * [vonstring/nexrender-action-mogrt-template](https://github.com/vonstring/nexrender-action-mogrt-template) - Added .mogrt support to Nexrender * [somename/package-name](#) - a nice description of a nice package doing nice things Since nexrender allows to use external packages installed globally from npm, its quite easy to add your own modules ## Awesome Related Projects * [Jeewes/nerc](https://github.com/Jeewes/nerc) - NERC: Tool for filling nexrender config templates with CSV data. * [newflight-co/createvid](https://github.com/newflight-co/createvid) - A fully functional, full-stack web app built in Vue. Actively looking for community support. ### Custom Actions To add a custom pre- or post-render action, all you need to do is to create at least a single file, that is going to return a function with promise. ```js // mymodule.js module.exports = (job, settings, action, type) => { console.log('hello from my module: ' + action.module); return Promise.resolve(); } ``` To use that action locally you can then require it by either using relative or global path. Additionally you can create a private npm module and link it, so it would become visible globally or even publish it to npm/your own private repo and use it. ```json // example 1 { "module": "d:/myprojects/mymodule/index.js", "somearg1": "hello world", "somearg2": 123456 } ``` ```json // example 2 { "module": "my-super-cool-module", "somearg1": "hello world", "somearg2": 123456 } ``` ```json // example 3 { "module": "@myorg/mymodule", "somearg1": "hello world", "somearg2": 123456 } ``` From there you can build pretty much any module that could process downloaded data before starting rendering, or doing tranformations on data after, or just simply sending an email when rendering is finished. >Note: both `job` and `settings` are mutable structures, any modifications made to them will reflect onto the flow of the next calls. Hence they can be used to store state between actions. ## Migrating from v0.x First version of nexrender was published in 2016, and it has been used by many people for quite some time since then. Even though version v1.x is based on the same concepts, it introduces major breaking changes that are incompatible with older version. However, majority of those changes were made to allow new, previously unimaginable things. <details> ### Naming 1. Nexrender Project -> Nexrender Job 2. Nexrender Rendernode -> Nexrender Worker 2. Nexrender API Server -> Nexrender Server Referring to project was confusing since it could be applied for both aep project and nexrender project. And rendernode name was quite too long, and unconvinient to use. ### Structure The structure of the job has changed, majority of the fields were moved from the root namespace, into "template" namespace, merging it with old "project.settings" namespace. Assets structure remained pretty much similar. A new object actions has been introduced. ### Assets Replaced http and file only assets to a URI based links, theoretically extendable without any limits. Many new other protocols and implementations can be added in a decentrilized manner. Strict division between asset types: * [image, audio, video] - footage items, behave like files * [data] - dynamic data assets, for direct value setting and expressions * [script] - files allowing full scripting limitless scripting support ### Rendering The biggest change that happened, is removal of old hacky way of replacing assets and patching aepx file to write custom expressions. Instead it has been replaced with brand new, recently discovered ExtendScript based injection. It allows to do a few quite important things: 1. Import and replace footage items via scripting, making it very reliable. (No more bugs related to same-system existing path override for aep project) 2. Set/Replace text, expressins and other types of data via scripting. (No more bugs related to changes in aepx structure, and no need to use aepx format at all) 3. Ability to run custom ExtendScript jsx scripts, which is limitless and revolutionary compared to previous version. ### CLI Project has been devided onto multiple subprojects, and mutiple cli applications as a result. Every cli application is auto-compiled to a platform specific executable on publish and auto-uploaded to the releases section. This allows anyone to use nexrender cli without installing a nodejs runtime onto target system. New CLI tool allows to run render directly from console for a local job, without need to start whole cluster. Worker, and CLI apps include minor QoL improvments, such as auto creation of the ae_render_only_node.txt file that allows free licensing, and After Effects folder auto detection. All tools include better help screen, and a lot of customization from command line arguments. </details> ## Customers Technically, since the tool is free, customers should be called users. In any case this section describes a list of users or companies that are proud users of nexrender. If you've used nexrender, and you like it, please feel free to add yourself into the list. * [Noxcaos Music](https://www.youtube.com/channel/UC2D9WSUKnyTX8wWqNVITTAw) * [Two Bit Circus](https://twobitcircus.com) * [Flügerl](https://www.youtube.com/fluegerl) * [NewFlight](https://newflight.co) * [den frie vilje](https://denfrievilje.dk) * [DR (Danish National Broadcaster)](https://dr.dk) * you name goes here ## Plans Features for next major release (`v2.0.0`): 1. Ability to switch renderers for a job (`none`, `aerender`, `media-encoder`) 2. Ability to push a job onto a server with ability to auto-split and render parts independently on the network 1. API for tracking/managing active workers in the network 2. Algo of splitting based on time & amount of workers 3. New job type (`partitioned`), which would be excluded from some general API responses 4. Mechanism of selecting a single node to be the "finisher", that would await and merge results of other jobs 5. Possible names: `@nexrender/action-merge-parent, @nexrender/action-merge-child` 3. Extend current scripting capabilities with an advanced real-time communication with the internal environment via TCP connection 4. Define a general abstract inteface for the actions, and a general package that would contain basic funcitonality like input/output arguments, etc. 5. Re-design networking layer, as well as server database layer, to count in cases where the jobs can be huge json objects. 6. Create automated footage detection and asset generator ## Contributors ### Code Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. <a href="https://github.com/inlife/nexrender/graphs/contributors"><img src="https://opencollective.com/nexrender/contributors.svg?width=890&button=false" /></a> ### Financial Contributors Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/nexrender/contribute)] #### Individuals <a href="https://opencollective.com/nexrender"><img src="https://opencollective.com/nexrender/individuals.svg?width=890"></a> #### Organizations Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/nexrender/contribute)] <a href="https://opencollective.com/nexrender/organization/0/website"><img src="https://opencollective.com/nexrender/organization/0/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/1/website"><img src="https://opencollective.com/nexrender/organization/1/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/2/website"><img src="https://opencollective.com/nexrender/organization/2/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/3/website"><img src="https://opencollective.com/nexrender/organization/3/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/4/website"><img src="https://opencollective.com/nexrender/organization/4/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/5/website"><img src="https://opencollective.com/nexrender/organization/5/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/6/website"><img src="https://opencollective.com/nexrender/organization/6/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/7/website"><img src="https://opencollective.com/nexrender/organization/7/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/8/website"><img src="https://opencollective.com/nexrender/organization/8/avatar.svg"></a> <a href="https://opencollective.com/nexrender/organization/9/website"><img src="https://opencollective.com/nexrender/organization/9/avatar.svg"></a>