Datasets:

doanhieung

/

gitsum

like 0

TinyDB is a lightweight document oriented database optimized for your happiness :)

30 days of Python programming challenge is a step-by-step guide to learn the Python programming language in 30 days. This challenge may take more than100 days, follow your own pace.

A curated list about Python in Education :snake: :mortar_board:

# awesome-python-in-education [](https://github.com/sindresorhus/awesome) *A curated list of resources about Python in Education* There are many ways to contribute to this project. Get started [here](CONTRIBUTING.md). Sparkline (GitHub stars velocity): [](https://stars.medv.io/quobit/awesome-python-in-education) ## Contents * [Roadmaps](#roadmaps) * [Courses and lessons](#courses-and-lessons) * [Interactive environments](#interactive-environments) * [MOOCs](#moocs) * [Introductions and Tutorials](#introductions-and-tutorials) * [Data Science](#data-science) * [Exercises and Games](#exercises-and-games) * [Reference and forums](#reference-and-forums) * [Python suitability for education](#python-suitability-for-education) * [Academic Papers](papers.md) * [Reference](#reference) * [Mailing lists](#mailing-lists) * [Forums](#forums) * [Tools and Libraries](#tools-and-libraries) * [Games, graphics and simulation](#games-graphics-and-simulation) * [Visualization](#visualization) * [Jupyter](#jupyter) * [IDEs](#ides) * [Debuggers](#debuggers) * [Conferences and videos](#conferences-and-videos) * [Books](#books) * [Coding Club books](#coding-club-books) * [Green Tea Press](#green-tea-press) * [Invent with Python series](#invent-with-python-series) * [Manning Publications](#manning-publications) * [No Starch Press](#no-starch-press) * [O'Reilly](#oreilly) * [Packt Pub](#packt-pub) * [Hardware](#hardware) - programming environment for tiny Python 3 projects, that can be embedded in web pages (using [Brython](https://brython.info/)) ### Interactive environments * [From Blocks to Code with Trinket!](https://hourofpython.com/from-blocks-to-code-with-trinket/) (more resources included in [Hour of Python](https://hourofpython.com/)) * [Python for Everybody](https://books.trinket.io/pfe/) - Trinket.io interactive book. * [How to Think Like a Computer Scientist](http://interactivepython.org/courselib/static/thinkcspy/index.html) (more resources included in [Runestone Interactive](http://runestoneinteractive.org/pages/library.html)) * [pythonroom](https://www.tynker.com/pythonroom) * [repl.it classrooms](https://repl.it/site/classrooms) * [CS Principles: Big Ideas in Programming](http://interactivepython.org/runestone/static/StudentCSP/index.html) * [CodeSkulptor](http://py3.codeskulptor.org/) * [BlockPy](http://think.cs.vt.edu/blockpy/) - web-based Python environment that lets you work with blocks, text, or both. * [Edublocks](http://edublocks.org/) - Making the transition from Scratch to Python easier. * [Python Lectures](https://github.com/rajathkumarmp/Python-Lectures) - IPython Notebooks to learn Python. * [Jupyter notebooks for teaching/learning Python 3](https://github.com/jerry-git/learn-python3/) * [Learn Python](http://www.learnpython.org/) * [Code Club Python modules](https://www.codeclubprojects.org/en-GB/python/) * [Computer Science Circles](http://cscircles.cemc.uwaterloo.ca/) * [Python from scratch](https://open.cs.uwaterloo.ca/python-from-scratch/) * [Interactive Python 3 tutorial with 100+ exercises](https://snakify.org/) * [Codesters](https://www.codesters.com/) * [Pyfiddle](https://pyfiddle.io/) * [Code the blocks](https://codetheblocks.com/) - interactive playground for learning how to code. * [Pythonpad.js](https://pythonpad.github.io/) - programming environment for tiny Python 3 projects, that can be embedded in web pages (using [Brython](https://brython.info/)) ### MOOCs * [Programming for Everybody](https://www.coursera.org/learn/python) * [An Introduction to Interactive Programming in Python (Part 1)](https://www.coursera.org/learn/interactive-python-1) * [An Introduction to Interactive Programming in Python (Part 2)](https://www.coursera.org/learn/interactive-python-2) * [Python Programming: A Concise Introduction](https://www.coursera.org/learn/python-programming-introduction) * [Introduction to Computer Science and Programming Using Python](https://www.edx.org/course/introduction-computer-science-mitx-6-00-1x-9) * [Learn to Program Using Python](https://www.edx.org/course/learn-program-using-python-utarlingtonx-cse1309x) * [CS For All: Introduction to Computer Science and Python Programming](https://www.edx.org/course/cs-all-introduction-computer-science-harveymuddx-cs005x-0) * [Programming Foundations with Python](https://www.udacity.com/course/programming-foundations-with-python--ud036) * [Python Codecademy](https://www.codecademy.com/learn/learn-python-3) * [CS 61A: The Structure and Interpretation of Computer Programs](http://cs61a.org/) * [Python School](https://pythonschool.net/) * [Python curriculum outline](https://github.com/freeCodeCamp/python-coding-challenges/issues/8) - Curriculum outline at FreeCodeCamp.com GitHub issue. ### Introductions and Tutorials * [The Hello World Program: Learn Python](https://thehelloworldprogram.com/python/) * [Practical Python Programming (course by @dabeaz)](https://github.com/dabeaz-course/practical-python) * [Introduction to Python](http://introtopython.org/) * [NewCoder](http://newcoder.io/) * [Python tutorial](https://pythonspot.com/) * [Programming with Python](http://swcarpentry.github.io/python-novice-inflammation/) - from [Software Carpentry](http://software-carpentry.org/) * [Introduction to Programming with Python](http://opentechschool.github.io/python-beginners/en/index.html) * [Python Land](https://python.land/) * [Python Course](http://www.python-course.eu/) * [The Programming Historian](http://programminghistorian.org/lessons/) * [Program Arcade Games With Python And Pygame](http://www.programarcadegames.com/) * [Python Tutorials for Kids 13+](https://python4kids.brendanscott.com/) * [KidsCanCode](http://kidscancode.org/lessons/) * [Python Asynchronous I/O Walkthrough](http://pgbovine.net/python-async-io-walkthrough.htm) * [Python Tutorials and Courses Directory](https://hackr.io/tutorials/learn-python) * [Python as a Second Language](https://swcarpentry.github.io/python-second-language/) * [A simple tutorial about effectively using pdb](https://github.com/spiside/pdb-tutorial) * [Beginning Python](http://archive.oreilly.com/oreillyschool/courses/Python1/index.html) - [Getting More out of Python](http://archive.oreilly.com/oreillyschool/courses/Python2/index.html) - [The Python Environment](http://archive.oreilly.com/oreillyschool/courses/Python3/index.html) - [Advanced Python](http://archive.oreilly.com/oreillyschool/courses/Python4/index.html) - 4 courses from the archived O'Reilly School of Technology * [Testing and Continuous Integration with Python](http://katyhuff.github.io/python-testing/) - a tutorial from the Software Carpentry. * [Playground and cheatsheet for learning Python](https://github.com/trekhleb/learn-python) * [Try Python](https://www.codeschool.com/courses/try-python) - a free course from Code School. * [Python Synopsis](https://github.com/ent1c3d/Python-Synopsis) - Python study guide. * [Python Fundamentals I & II](https://www.rithmschool.com/courses#python) - two 20h free courses from Rithm School. * [A Byte of Python](https://www.gitbook.com/book/swaroopch/byte-of-python/) * [A Brief, Animated Introduction to Programming with Python](https://ourcodestories.com/markm208/Playlist/16) * [Build applications in Python (the anti-textbook)](https://github.com/thewhitetulip/build-app-with-python-antitextbook) * [Asyncio in Python](https://tutorialedge.net/python/) - collection of tutorials about Asyncio in Python. * [A SQLite Tutorial with Python](http://stackabuse.com/a-sqlite-tutorial-with-python/) * [Learning Python for Social Scientists](https://nealcaren.github.io/python-tutorials/) * [Learn how to use Python for your Lab](https://www.pythonforthelab.com/) * [Python Basics](https://github.com/learnbyexample/Python_Basics) * [Dead Simple Python](https://dev.to/codemouse92/introducing-dead-simple-python-563o) - from beginners to python (not programming). * [Learn Python](https://learnpython.dev/) - Introduction and Intermediate Python, recorded for Frontend Masters by Nina Zakharenko. * [The Cracking Python Bootcamp](https://github.com/purcellconsult/Cracking-Python-Bootcamp) - Learn How to Code in Python in 12 Weeks By Building Fun Real World Projects. * [w3schools Python tutorial](https://www.w3schools.com/python/) * [Geeks for geeks Python tutorial](https://www.geeksforgeeks.org/python-programming-language/) * [Ultimate Python](https://github.com/huangsam/ultimate-python) - study guide for newcomers and professionals alike. * [LearnPython.org interactive tutorial](https://www.learnpython.org/) ### Data Science * [A Whirlwind Tour of Python](http://www.oreilly.com/programming/free/a-whirlwind-tour-of-python.csp) and the [Jupyter Notebooks](https://github.com/jakevdp/WhirlwindTourOfPython) behind. * [A Crash Course in Python for Scientists](http://nbviewer.jupyter.org/gist/rpmuller/5920182) * [Intro to Python for Data Science](https://www.datacamp.com/courses/intro-to-python-for-data-science) * [Learning Python for Data Science](http://www.datasciencecentral.com/profiles/blogs/learning-python-for-data-science) * [Introduction to Python for Data Science](https://www.edx.org/course/introduction-python-data-science-microsoft-dat208x-5) * [Programming with Python for Data Science](https://www.edx.org/course/programming-python-data-science-microsoft-dat210x-3) * [Python Data Science Handbook](https://github.com/jakevdp/PythonDataScienceHandbook) complete book in Jupyter Notebook format. * [NumPy Illustrated - The Visual Guide to NumPy](https://betterprogramming.pub/numpy-illustrated-the-visual-guide-to-numpy-3b1d4976de1d?sk=57b908a77aa44075a49293fa1631dd9b) * [Exploratory Computing with Python](http://mbakker7.github.io/exploratory_computing_with_python/) * [Data Carpentry: Python for Ecologists](http://www.datacarpentry.org/python-ecology-lesson/) * [Plotting and Programming in Python](http://swcarpentry.github.io/python-novice-gapminder/) * [Applied Plotting, Charting & Data Representation in Python](https://www.coursera.org/learn/python-plotting) * [Using Python for Research](https://www.edx.org/course/using-python-research-harvardx-ph526x) * [The Hitchhiker’s Guide to Machine Learning in Python](https://medium.freecodecamp.org/the-hitchhikers-guide-to-machine-learning-algorithms-in-python-bfad66adb378) * [SIOC 209: Python for Data Analysis](https://github.com/cuttlefishh/python-for-data-analysis) and its [associated videos](https://www.youtube.com/channel/UCVZrIrWtcvTzYlrNx7RcDyg/playlists) * [Reproducible analysis in Python](https://github.com/trallard/ReproduciblePython) * [Python Level 1](https://www.kaggle.com/learn/python) - free course at Kaggle. * [Pandas Cheat Sheet](https://pandas.pydata.org/Pandas_Cheat_Sheet.pdf) * [Python for Data Science Cheat Sheets](http://www.utc.fr/~jlaforet/Suppl/python-cheatsheets.pdf) ## Exercises and Games * [CheckiO](https://checkio.org/) * [CodeAbbey](http://www.codeabbey.com/) * [Empire of Code](https://empireofcode.com/) * [Project Euler](https://projecteuler.net/) * [Exercism](http://exercism.io/tracks/python/) * [HackerRank Challenges](https://www.hackerrank.com/domains/python/py-introduction) * [PyBites](http://pybit.es/) - [PyBites Code Challenges Platform](https://codechalleng.es/) * [Practice Python](http://www.practicepython.org/) * [Python Challenge](http://www.pythonchallenge.com/) * [Python for Fun](http://openbookproject.net/courses/python4fun/) * [CodingBat](http://codingbat.com/python) * [Reeborg's world](http://reeborg.ca/index_en.html) * [Python Koans](https://github.com/gregmalcolm/python_koans) * [Boston Python Puzzles](http://puzzles.bostonpython.com/) * [Norvig's pytudes](https://github.com/norvig/pytudes) - Python programs for perfecting programming skills * [Python Challenges](http://www.101computing.net/category/python-challenges/) * [Code & Conquer](http://www.codeandconquer.co/) * [CodeCombat](https://codecombat.com/) * [TeachCraft: Minecraft + Python](https://teachcraft.net/) - [Run your own TeachCraft Server](https://github.com/TeachCraft/TeachCraft-Server) * [Slice like a Ninja](http://bruab.github.io/slice_like_a_ninja/) * [Python Datasets: The Collection of Really Great, Interesting, Situated Datasets](https://think.cs.vt.edu/corgis/python/index.html) - (visit [CORGIS](https://think.cs.vt.edu/corgis/) for raw formats) * [Interactive Coding Challenges](https://github.com/donnemartin/interactive-coding-challenges) * [Pyweek Programming Challenge](https://pyweek.org/) * [CodingGame](https://www.codingame.com) * [CodeFights](https://codefights.com/) * [Edabit Python Challenges](https://edabit.com/challenges/python3) * [futurecoder](https://futurecoder.io/) - interactive beginner exercises - [gh repo](https://github.com/alexmojaki/futurecoder) * [DevProjects - Python Projects](https://www.codementor.io/python-projects) - Learn programming with curated Python projects ## Reference and forums ### Python suitability for education * [CP4E](https://www.python.org/doc/essays/cp4e/) by Guido van Rossum * [Python in Education: Teach, Learn, Program](http://www.oreilly.com/programming/free/python-in-education.csp) - free e-book on why Python is well suited for education by Nicholas Tollervey * ['Think Python like a Computer Scientist' book Foreword](http://interactivepython.org/courselib/static/thinkcspy/FrontBackMatter/foreword.html) by David Beazley * [Why I push for Python](http://lorenabarba.com/blog/why-i-push-for-python/) by Lorena Barba * [Why Python is a Great First Language](http://blog.trinket.io/why-python/) by Elliott Hauser (Trinket CEO) * [Why Python is a great language for teaching beginners in introductory programming classes](http://pgbovine.net/python-teaching.htm) by Philip Guo * [Python is Now the Most Popular Introductory Teaching Language at Top U.S. Universities](http://cacm.acm.org/blogs/blog-cacm/176450-python-is-now-the-most-popular-introductory-teaching-language-at-top-u-s-universities/fulltext) by Philip Guo (Communications of the ACM) * [Why Learn Python? Here Are 8 Data-Driven Reasons](https://dbader.org/blog/why-learn-python) by Elena Ruchko * [[Level 1] Programming: Python](http://web.archive.org/web/20160122210606/http://nzacditt.org.nz/resources/programming-and-cs/level-1-programming-python) - Archived version * [Python as a way of thinking](http://allendowney.blogspot.com/2017/04/python-as-way-of-thinking.html) ### Reference * [Official Python documentation](https://docs.python.org/3/) * [Python in Education](http://pythonineducation.org/) - [git repo](https://github.com/python/pythonineducation.org) * [Google's Python Class](https://developers.google.com/edu/python/) * [The Hitchhiker’s Guide to Python](http://python-guide.org/) * [Tiny Python 3.6 Notebook](https://github.com/mattharrison/Tiny-Python-3.6-Notebook/blob/master/python.rst) * [Real Python Tutorials](https://realpython.com/) - [First Steps](https://realpython.com/learn/python-first-steps/) * [PEP8 - Python Style Guide](http://pep8.org/) * [The Elements of Python Style](https://github.com/amontalenti/elements-of-python-style) * [PyMOTW3](https://pymotw.com/3/) - Python Module Of The Week * [Full Stack Python](http://www.fullstackpython.com/table-of-contents.html) - [(best python resources)](https://www.fullstackpython.com/best-python-resources.html) - [(learning programming)](https://www.fullstackpython.com/learning-programming.html) * [Learn X in Y minutes where X=python3](https://learnxinyminutes.com/docs/python3/) * [Tutorial - Learn Python in 10 minutes](https://www.stavros.io/tutorials/python/) but don't forget to [Teach Yourself Programming in Ten Years](http://norvig.com/21-days.html) * [PyCrumbs - Bits and bytes of Python from the Internet](https://github.com/kirang89/pycrumbs) * [CheckiO Python blog](https://py.checkio.org/blog/) - curated Python articles * [A Sheet of Python](https://tmont.es/2018/sheet-of-python/index.html): direct access to the [PDF](https://tmont.es/images/sheet-of-python-v1.pdf) * [A gallery of interesting Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki/A-gallery-of-interesting-Jupyter-Notebooks) * [CS1 Python Programming Projects Archive](http://www.cse.msu.edu/~cse231/PracticeOfComputingUsingPython/index.php) * [Python 3 Cheat Sheet](https://perso.limsi.fr/pointal/_media/python:cours:mementopython3-english.pdf)(PDF) * [Python cheatsheet](https://www.pythonsheets.com/) * [Python Crash Course - Cheat Sheets](http://ehmatthes.github.io/pcc/cheatsheets/README.html) * [Comprehensive Python Cheatsheet](https://github.com/gto76/python-cheatsheet/) * [Algorithms implemented in python (for education)](https://github.com/TheAlgorithms/Python) * [Algorithms](https://github.com/nryoung/algorithms) * [Minimal examples of data structures and algorithms in Python](https://github.com/keon/algorithms) * [awesome-python](https://github.com/vinta/awesome-python) * [Python GitHub Projects](https://github.com/checkcheckzz/python-github-projects) * [Python Reference](https://github.com/rasbt/python_reference) - useful functions, tutorials, and other Python-related things * [Pythonidae](https://github.com/svaksha/pythonidae) - curated decibans of scientific programming resources in Python * [Python Patterns](http://python-patterns.guide/) - by Brandon Rhodes ([repo](https://github.com/brandon-rhodes/python-patterns)) * [python-patterns](https://github.com/faif/python-patterns) - a collection of design patterns/idioms in Python * [PyPattyrn](https://github.com/tylerlaberge/PyPattyrn) * [Python 3 Patterns, Recipes and Idioms](http://python-3-patterns-idioms-test.readthedocs.io/) * [How to make mistakes in Python](http://www.oreilly.com/programming/free/files/how-to-make-mistakes-in-python.pdf) * [The Little Book of Python Anti-Patterns](http://docs.quantifiedcode.com/python-anti-patterns/) - small book of Python anti-patterns and worst practices * [Python IAQ: Infrequently Answered Questions](http://norvig.com/python-iaq.html) by Peter Norvig * [Anti-Patterns in Python Programming](http://lignos.org/py_antipatterns/) * [Python Code Disasters](https://github.com/sobolevn/python-code-disasters) - more anti-patterns. * [What the f*ck Python?](https://github.com/satwikkansal/wtfpython) - A collection of interesting and tricky Python examples * [DjangoGirls Introduction to Python](https://tutorial.djangogirls.org/en/python_introduction/) * [Experiments in Python Pedagogy](https://github.com/4dsolutions/Python5) - [rendered version](http://nbviewer.jupyter.org/github/4dsolutions/Python5/tree/master/) * [29 common beginner Python errors on one page](http://pythonforbiologists.com/index.php/29-common-beginner-python-errors-on-one-page/) from [Python for Biologists](https://pythonforbiologists.com/) * [Learn Python - Udacity](https://www.udacity.com/learn/python) * [Popular Python Recipes](http://code.activestate.com/recipes/langs/python/) * [Transforming Code into Beautiful, Idiomatic Python](https://gist.github.com/JeffPaine/6213790) * [Improve your Python skills (Dan Bader's blog)](https://dbader.org/blog/) * [Practical Business Python](http://pbpython.com/) * [Python Lessons](http://teachwithict.weebly.com/python.html) - 6 lessons from teachwithict * [Machine Learning and Python (and Math) Cheat Sheets](https://medium.com/machine-learning-in-practice/cheat-sheet-of-machine-learning-and-python-and-math-cheat-sheets-a4afe4e791b6) * [AIAMA Python implementation](https://github.com/aimacode/aima-python) - Python implementation of algorithms from Russell And Norvig's "Artificial Intelligence - A Modern Approach" * [PyFormat](https://pyformat.info/) - Using % and .format() for great good! * [Replacing Bash Scripting with Python](https://github.com/ninjaaron/replacing-bash-scripting-with-python) * [ugo_py_doc](https://ugoproto.github.io/ugo_py_doc/) - a Python documentation website * [The 35 Words You Need to Python](https://yawpitchroll.com/posts/the-35-words-you-need-to-python/) - The core vocabulary of Python you actually need to know to start to do meaningful work. ### Mailing lists * [Python EDU-SIG](https://www.python.org/community/sigs/current/edu-sig/) - Python.org subsite * [Python EDU-SIG](https://mail.python.org/mailman/listinfo/edu-sig) - Special Interest Group mailing list * [Python EDU-WG](https://mail.python.org/mailman/listinfo/pythonedu-wg) - Working Group mailing list * [Tutor](https://mail.python.org/mailman/listinfo/tutor) - (mailing list) Discussion for learning programming with Python * [Python-list](https://mail.python.org/mailman/listinfo/python-list) - General discussion list for the Python programming language (mailing list) * [jupyter-education](https://groups.google.com/forum/#!forum/jupyter-education) - Teaching with Jupyter Notebooks mailing list ### Forums * StackOverflow: ['python' tag](http://stackoverflow.com/questions/tagged/python) - [sopython.com community website](https://sopython.com/) * reddit: [r/Python](https://www.reddit.com/r/Python/) - [r/learnpython](https://www.reddit.com/r/learnpython/) - [r/pythontips](https://www.reddit.com/r/pythontips/) - [r/pygame](https://www.reddit.com/r/pygame/) ## Tools and Libraries * [Your Python Trinket](https://trinket.io/python) - Put Interactive Python Anywhere on the Web * [Python Tutor](http://pythontutor.com/visualize.html#mode=edit) - Visualize the execution of Python programs * [Livepython](https://github.com/agermanidis/livepython) - Visually trace Python code in real-time (alpha stage) * [Skulpt](http://www.skulpt.org/) - Skulpt is an entirely in-browser implementation of Python 2.X (!) * [SoloLearn Python 3 Tutorial](https://www.sololearn.com/Course/Python/) - mobile version * [Python Anywhere](https://www.pythonanywhere.com/details/education) * [repl.it](https://repl.it/site/languages/python3) * [Python AST Explorer](https://python-ast-explorer.com/) * [kite](https://kite.com/) - programming copilot * [EarSketch](https://earsketch.gatech.edu/) - learn to code by making music * [FoxDot](http://foxdot.org/) - Live Coding Music with Python & SuperCollider * [Ren'Py](https://www.renpy.org/) - a visual novel engine * [ColorZero](https://github.com/waveform80/colorzero) - Another color manipulation library for Python * [LogZero](https://github.com/metachris/logzero) - Robust and effective logging * [NetworkZero](https://github.com/tjguk/networkzero) - Make it easy for learning groups to use simple networking in Python ### Games, graphics and simulation * [Jupylet](https://github.com/nir/jupylet) - Create 2D and 3D games, graphics, live music and sound synthesizers, interactively in a Jupyter notebook. * [PyGame](http://www.pygame.org/) * [Pygame Zero](https://pygame-zero.readthedocs.io) for creating games without boilerplate * [Python Arcade Library](http://arcade.academy/) * [Pyglet](http://www.pyglet.org/) - a pure python cross-platform application framework intended for game development * [Python Mode for Processing](http://py.processing.org/) * [PythonTurtle](http://pythonturtle.org/) - A learning environment for Python programming suitable for beginners and children, inspired by Logo. Easy installer for Windows so it could be installed by children on computers without internet access. * [A Simple Tutorial for Python's turtle.py Module](https://github.com/asweigart/simple-turtle-tutorial-for-python/blob/master/simple_turtle_tutorial.md) * [VPython](http://vpython.org/) - 3D programming * [Pymunk](http://www.pymunk.org/) - 2D physics library * [PyPhysicsSandbox](https://github.com/jshaffstall/PyPhysicsSandbox) - a simple wrapper around Pymunk * [Kivy](https://kivy.org/) - innovative user interfaces, such as multi-touch apps * [PyQT 15 minute apps](https://github.com/mfitzp/15-minute-apps) - 15 minute (small) desktop apps built with PyQt * [PyQt5 tutorial](https://www.learnpyqt.com/) - Create GUI applications with Python * [Panda3D](http://www.panda3d.org/) - game engine and framework for 3D rendering * [Ursina Engine](https://www.ursinaengine.org/) - game engine based on Panda3D but really easy-to-use. Great for beginners in 3D game coding. * [gui zero](https://lawsie.github.io/guizero/) - to allow children to quickly and easily create GUIs for their programs * [Free Python Games](http://www.grantjenks.com/docs/freegames/) - collection of free Python games intended for education and fun * [Angry Birds in Python](https://github.com/estevaofon/angry-birds-python) - using pygame and pymunk * [Jappy](https://github.com/somosazucar/Jappy) - the app powering the http://educa.juegos/ collaborative coding platform * [Predigame](http://predigame.io/) - instructional platform that teaches the basics of coding through the creation of arcade games * [ThorPy](http://www.thorpy.org/) - A GUI library for pygame * [sc8pr](https://github.com/dmaccarthy/sc8pr) - A simple framework for new and experienced Python programmers to create animations, games, and other graphics-based programs * [pyxel](https://github.com/kitao/pyxel) - A retro game development environment in Python. * [PySimpleGUI](https://github.com/MikeTheWatchGuy/PySimpleGUI) - Super-simple GUI to use... Powerfully customizable. * [evennia](http://www.evennia.com/) - library and toolkit for building multi-player online text games * [adventurelib](https://github.com/lordmauve/adventurelib) - easy text adventures * [PythonStdioGames](https://github.com/asweigart/PythonStdioGames) - A compilation of text-based games written in Python that only use "standard i/o". * [PyperCard](https://github.com/ntoll/pypercard) - HyperCard inspired GUI framework for beginner developers in Python ([doc site](https://pypercard.rtfd.io/)) * [PyComic](https://github.com/pycomic/pycomic.github.io) - A static website for generating Pythonic comics ### Visualization * [Bokeh](http://bokeh.pydata.org/) - an interactive visualization library that targets modern web browsers for presentation. * [VisPy](http://vispy.org/) - library for interactive scientific visualization that is designed to be fast, scalable, and easy to use. * [Python Graph Gallery](https://python-graph-gallery.com/) - showcase hundreds of charts, always providing the reproducible python code. ### Jupyter * [Awesome Jupyter](https://github.com/markusschanta/awesome-jupyter) - A curated list of awesome Jupyter projects, libraries and resources * [Project Jupyter](https://jupyter.org/) * [github.com/jupyter4edu](https://github.com/jupyter4edu) - best practices and content for teaching with Jupyter notebooks * [jupyter4edu/jupyter-edu-book](https://github.com/jupyter4edu/jupyter-edu-book) - open source of the "Teaching and Learning with Jupyter" book * https://jupyter4edu.github.io/jupyter-edu-book/ - "Teaching and Learning with Jupyter" book * [github.com/IPython](https://github.com/ipython) * [github.com/Jupyter](https://github.com/jupyter) * [github.com/JupyterHub](https://github.com/jupyterhub) * [github.com/JupyterLab](https://github.com/jupyterlab) * [jupyter-education: Teaching with Jupyter Notebooks mailing list](https://groups.google.com/forum/#!forum/jupyter-education) - mailing list * [jupyterhub/JupyterHub](https://github.com/jupyterhub/jupyterhub) - multi-user server for Jupyter notebooks * [Zero to JupyterHub](https://zero-to-jupyterhub.readthedocs.io/) - documentation for setting up a multi-user JupyterHub server * [TLJH: The Littlest JupyterHub](https://tljh.jupyter.org/en/latest/) - documentation for "a simple JupyterHub distribution for a small (0-100) number of users on a single server" * [jupyterhub-deploy-teaching](https://github.com/jupyterhub/jupyterhub-deploy-teaching) - reference deployment of JupyterHub and nbgrader on a single server * [jupyterlab/JupyterLab](https://github.com/jupyterlab/jupyterlab) - rewrite of Jupyter Notebook with tabs, extensions, command list * [JupyterLab Documentation](https://jupyterlab.readthedocs.io/) * [mybinder.org](https://mybinder.org/) - "Binder": generate a container from a git repository (or a DOI) with repo2docker and run it in the cloud * [jupyterhub/binderhub](https://github.com/jupyterhub/binderhub/) - BinderHub is the application that powers https://mybinder.org (on k8s) * [jupyter/repo2docker](https://github.com/jupyter/repo2docker) - generate Jupyter-enabled Docker Images from repositories * [github.com/binder-examples](https://github.com/binder-examples) - examples of Binder-ready (REES-compatible) Jupyter notebooks * [REES: Reproducible Execution Environment Specification](https://repo2docker.readthedocs.io/en/latest/specification.html) - specification that repo2docker uses to build a container image for a given project and its dependencies * [REES Config files](https://repo2docker.readthedocs.io/en/latest/config_files.html) - requirements.txt, environment.yml, Pipfile.lock, postBuild, Dockerfile * [ipython/ipywidgets - IPython widgets](https://github.com/ipython/ipywidgets) * [jupyter/nbgrader](https://github.com/jupyter/nbgrader/) - nbgrader is a tool that facilitates creating and grading assignments in the Jupyter notebook * [nbgrader docs](https://nbgrader.readthedocs.io/) - docs for the nbgrader tool * [jupyterhub/jupyterhub-deploy-teaching](https://github.com/jupyterhub/jupyterhub-deploy-teaching) - reference deployment of JupyterHub and nbgrader on a single server * [jupyterlab/jupyterlab-google-drive](https://github.com/jupyterlab/jupyterlab-google-drive) - Google Drive for JupyterLab (see also: Google Colab) * [jupyterlab/debugger](https://github.com/jupyterlab/debugger) - a JupyterLab debugger extension for debugging code in notebook cells ### Hosted Jupyter notebooks * [awesome-jupyter > Hosted Notebook Solutions](https://github.com/markusschanta/awesome-jupyter#hosted-notebook-solutions) * [CoCalc's comparison of Online Jupyter Notebook services](https://cocalc.com/doc/compare.html) * [CoCalc](https://doc.cocalc.com/) - Jupyter notebook environment with Course Management, Handouts, Assignments, nbgrader, Time Travel history, chat * [Google Colab](https://colab.research.google.com/) - Jupyter notebook environment for machine learning education and research (requires no setup to use) * [IllumiDesk](https://www.illumidesk.com) - Jupyter notebook environment with LMS integration via LTI 1.1/1.3. * JupyterHub, BinderHub ### Jupyter Tools * [RISE](https://github.com/damianavila/RISE) - "Live" Reveal.js Jupyter/IPython Slideshow Extension * [fastpages](https://github.com/fastai/fastpages) - static/JAMstack blogging platform with support for Jupyter notebooks * [hugo-academic](https://github.com/gcushen/hugo-academic) - static/JAMstack website builder with support for Jupyter notebooks * [ipytest](https://github.com/chmp/ipytest) - run py.test tests within the notebook environment * [jupyter-contrib-nbextensions - Unofficial Jupyter Notebook Extensions](https://jupyter-contrib-nbextensions.readthedocs.io) * [jupyter-edx-colab-cloud-xblock](https://github.com/ibleducation/jupyter-edx-colab-cloud-xblock) - launch Google Colab notebooks from within an Open edX XBlock * [jupyter-edx-grader-xblock](https://github.com/ibleducation/jupyter-edx-grader-xblock) - auto-grade assignments with nbgrader and post the scores to an Open edX gradebook * [jupyter-themes](https://github.com/dunovank/jupyter-themes) - Custom Jupyter Notebook Themes * [jupyter-viewer-xblock](https://github.com/ibleducation/jupyter-viewer-xblock) - view Jupyter notebooks in an Open edX XBlock * [jupytext](https://github.com/mwouts/jupytext) - Jupyter Notebooks as Markdown, Julia, Python, or R scripts (that [auto-]save to *and from* the configured paired formats) * [lolviz](https://github.com/parrt/lolviz) - data-structure visualization tool for lists of lists, lists, dictionaries * [nbTranslate](https://github.com/jfbercher/jupyter_nbTranslate) - translate cells of a notebook from one language to another - Adds multi language support * [nbautoeval](https://github.com/parmentelat/nbautoeval) - creating auto-evaluated exercises * [nbconvert](https://nbconvert.readthedocs.io/) - convert Notebooks to other formats * [nbdev](https://github.com/fastai/nbdev) - export, sync, and document notebook cells to and from regular python modules * [nbdime](https://nbdime.readthedocs.io/) - diffing and merging of Jupyter Notebooks * [nbgallery](https://github.com/nbgallery/nbgallery) - platform for sharing and collaborating on Jupyter notebooks * [nbinteract](https://www.nbinteract.com/) - creates interactive webpages from Jupyter notebooks * [nbscan](https://github.com/conery/nbscan) - search for and print contents of cells in Jupyter notebooks * [nbsphinx](https://nbsphinx.readthedocs.io/en/latest) - Sphinx extension for publishing Jupyter Notebooks as static/JAMstack websites * [nbtranslate](https://github.com/devrt/nbtranslate) - translate content of Jupyter notebook using gettext tools * [nbtutor](https://github.com/lgpage/nbtutor) - visualize Python code execution (line-by-line) * [nbval](https://github.com/computationalmodelling/nbval) - Py.test plugin for validating Jupyter notebooks * [notedown](https://github.com/aaren/notedown/) - Convert IPython Notebooks to markdown (and back) * [pixiedebugger](https://medium.com/ibm-watson-data-lab/the-visual-python-debugger-for-jupyter-notebooks-youve-always-wanted-761713babc62) - The Visual Python Debugger for Jupyter Notebooks You’ve Always Wanted * [pynb](https://github.com/minodes/pynb) - Jupyter Notebooks as plain Python code with embedded Markdown text * [rst2ipynb](https://github.com/nthiery/rst-to-ipynb) - convert standalone reStructuredText files to Jupyter notebook file * [sphinxcontrib-jupyter](https://github.com/QuantEcon/sphinxcontrib-jupyter) - A Sphinx Extension for Generating Jupyter Notebooks ### Jupyter resources * [GitHub Trending Jupyter Notebooks](https://github.com/trending/jupyter-notebook) * [Jupyter Notebook cheatsheet](https://www.cheatography.com/weidadeyue/cheat-sheets/jupyter-notebook/) * [Jupyter tips, tricks and shortcuts](https://www.dataquest.io/blog/jupyter-notebook-tips-tricks-shortcuts/) * [IPythonBlocks](http://ipythonblocks.org/) * [Using the IPython Notebook as a Teaching Tool](https://software-carpentry.org/blog/2013/03/using-notebook-as-a-teaching-tool.html) * [LTI Launch JupyterHub Authenticator](https://github.com/jupyterhub/ltiauthenticator) - Implements LTI v1 authenticator for use with JupyterHub * [Lectures on scientific computing with Python](https://github.com/jrjohansson/scientific-python-lectures) * ["The world of Jupyter" —a tutorial](https://github.com/barbagroup/jupyter-tutorial) * [List of Jupyter Notebooks by Peter Norvig](http://norvig.com/ipython/) * [28 Jupyter Notebook tips, tricks and shortcuts](https://www.dataquest.io/blog/jupyter-notebook-tips-tricks-shortcuts/) * [VPython running in a Jupyter notebook](https://github.com/BruceSherwood/vpython-jupyter) ### IDEs * [bpython](https://bpython-interpreter.org/) * [ptpython](https://github.com/jonathanslenders/ptpython) * [Thonny](https://thonny.org) - Python IDE for beginners * [VIM](http://www.vim.org/) with [Python plugins](https://realpython.com/blog/python/vim-and-python-a-match-made-in-heaven/) * [Emacs](https://www.gnu.org/software/emacs/) with [Python plugins](https://realpython.com/blog/python/emacs-the-best-python-editor/) * [Sublime Text 3](http://www.sublimetext.com/3) with [Python plugins](https://realpython.com/blog/python/setting-up-sublime-text-3-for-full-stack-python-development/) * [PyCharm Edu](https://www.jetbrains.com/pycharm-edu/) - With [some courses](https://github.com/JetBrains/pycharm-courses) * [Spyder](https://github.com/spyder-ide/spyder) - The Scientific PYthon Development EnviRonment. * [Wingware Python IDE](https://wingware.com/) * [Ninja-IDE](http://ninja-ide.org/) * [PyDev](http://www.pydev.org/) - a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development. * [Visual Studio Code](https://code.visualstudio.com/) with [Python plugins](https://marketplace.visualstudio.com/items?itemName=ms-python.python) * [Mu](https://codewith.mu/) - a simple Python editor for beginner programmers. * [Rodeo](http://rodeo.yhat.com/) - A Native Python IDE for Data Science. * [Turing](https://github.com/TuringApp/Turing) - Free and cross-platform IDE for pseudocode and Python. * [PyScripter](https://github.com/pyscripter/pyscripter) - a feature-rich but lightweight Python IDE. * [Pyzo](http://www.pyzo.org/) - computing environment that plays well with conda. ### Debuggers * [pdb](https://docs.python.org/3/library/pdb.html) * [ipdb](https://pypi.org/project/ipdb/) * [PuDB](https://pypi.org/project/pudb/) * [pdb++](https://github.com/pdbpp/pdbpp) - a drop-in replacement for pdb * [Python Linter Online](http://pythonbuddy.com/) - Live Syntax Checking Using Pylint while Running Python * [PyTA](https://github.com/pyta-uoft/pyta) - static code analysis to help students find and fix common coding errors * [coala](http://coala.io/) - linting and fixing code * [wdb](https://github.com/Kozea/wdb) - An improbable web debugger through WebSockets * [QuantifiedCode](https://github.com/quantifiedcode/quantifiedcode) - a code analyis & automation platform * [birdseye](https://github.com/alexmojaki/birdseye) - graphical Python debugger using the AST * [Hunter](https://github.com/ionelmc/python-hunter) - a flexible code tracing toolkit ## Conferences and videos * [Taking Your Python Skills to the Next Level With Pythonic Code](http://www.datadependence.com/2016/07/pythonic-code-video-series-intro/) - 5 powerful Pythonic concepts and over 45 minutes of video examples. * [Weekly Python Chat](http://www.weeklypython.chat/) - Weekly live video chats about Python, teaching, open source, and more * [Python in Australian Education seminar](https://2016.pycon-au.org/programme/python_in_education_seminar) (2016) * [PyCon Australia 2015 Education Miniconf](https://www.youtube.com/playlist?list=PLs4CJRBY5F1I5vuApyUXp6bLWly1E-b0s) (youtube playlist) * [Python Education Summit Schedule](https://us.pycon.org/2016/events/edusummit/schedule/) (PyCon 2016) * [A one-day mini-conference about Python in Education](http://2016.pyconuk.org/teachers/) (PyConUK 2016) * [PyVideo tag 'education'](http://pyvideo.org/tag/education/) * [Khan Academy Computer Science (Python video playlist)](https://www.youtube.com/playlist?list=PL36E7A2B75028A3D6) * [Python Programming in one video](https://www.youtube.com/watch?v=N4mEzFDjqtA) - [Learn to Program with Python](https://www.youtube.com/playlist?list=PLGLfVvz_LVvTn3cK5e6LjhgGiSeVlIRwt) Derek Banas playlist * [CPython internals: A ten-hour codewalk through the Python interpreter source code](http://pgbovine.net/cpython-internals.htm) * [Teaching Python: The Hard Parts](http://pyvideo.org/pycon-us-2016/elana-hashman-teaching-python-the-hard-parts-pycon-2016.html) - PyCon 2016 * [Episode 14 – Allen Downey on Teaching Computer Science with Python](https://www.pythonpodcast.com/episode-14-allen-downey-on-teaching-computer-science-with-python/) from [podcast.\__init__('Python')](https://www.pythonpodcast.com/) * [Python For Informatics](https://www.youtube.com/playlist?list=PLlRFEj9H3Oj4JXIwMwN1_ss1Tk8wZShEJ) * [Python for Everybody - Exploring Information](https://www.youtube.com/playlist?list=PLlRFEj9H3Oj7Bp8-DfGpfAfDBiblRfl5p) * [sentdex youtube playlists](https://www.youtube.com/user/sentdex/playlists) or via [Python Programming](https://pythonprogramming.net/) * [Dan Bader's youtube channel](https://dbader.org/youtube/) * [Corey Schafer's youtube channel](https://www.youtube.com/user/schafer5) * [Python 3.4 Programming Tutorials](https://www.youtube.com/playlist?list=PL6gx4Cwl9DGAcbMi1sH6oAMk4JHw91mC_) * [Programming Foundations with Python](https://www.youtube.com/playlist?list=PLAwxTw4SYaPnYajEbZvqtcVWQ6XGhvtOW) from [Udacity](https://www.udacity.com/course/ud036) * [PySide Video Tutorials](http://wiki.qt.io/PySide_Video_Tutorials) * [Python Basics - Coding is for girls](https://www.youtube.com/playlist?list=PLbd_WhypdBbAMyFfKgSj27JO7CEpuIcEK) * [Python For Beginners - Learn To Code Tutorials ](https://www.youtube.com/playlist?list=PLW_tdZJKynZXgLKQAR2g52ut4c2IpUmOv) * [TheNewBoston Python 3 videotutorials](https://www.youtube.com/watch?v=HBxCHonP6Ro&list=PL6gx4Cwl9DGAcbMi1sH6oAMk4JHw91mC_) - also [Flask](https://www.youtube.com/watch?v=ZVGwqnjOKjk&list=PL6gx4Cwl9DGDi9F_slcQK7knjtO8TUvUs) and others on [their channel](https://www.youtube.com/user/thenewboston) * [Build applications in Python the antitextbook](https://www.youtube.com/playlist?list=PL41psiCma00wwvtQyLFMFpzWxUYmSZwZy) * [Socratica Python Programming Tutorials](https://www.youtube.com/playlist?list=PLi01XoE8jYohWFPpC17Z-wWhPOSuh8Er-) * [Python for Data Analysis - Pandas Cookbook](https://www.youtube.com/playlist?list=PLyBBc46Y6aAz54aOUgKXXyTcEmpMisAq3) ## Books * [The Computer Science Field Guide](http://www.csfieldguide.org.nz/en/) - ([repo](https://github.com/uccser/cs-field-guide)) * [Awesome Python Books](https://github.com/Junnplus/awesome-python-books) * [PythonBooks](http://pythonbooks.revolunet.com/) * [Build applications in Python the antitextbook](http://github.com/thewhitetulip/build-app-with-python-antitextbook) * [Algorithmic Problem Solving with Python](http://www.eecs.wsu.edu/~schneidj/PyBook/swan.pdf) * [Openlibra: Python](https://openlibra.com/en/collection/search/category/python/language/english/) * [Intermediate Python](http://book.pythontips.com/) - [github repo](https://github.com/yasoob/intermediatePython) * [Python Practice Book](http://anandology.com/python-practice-book/) * [Scipy Lecture Notes](http://www.scipy-lectures.org/) * [Problem Solving with Algorithms and Data Structures using Python](http://interactivepython.org/courselib/static/pythonds/index.html) - [accompanying videos](https://teklern.blogspot.com.es/p/blog-page.html) * [Python for Everybody - Exploring Data In Python 3](http://www.py4e.com/book) * [Composing Programs](http://composingprograms.com/) based on SICP textbook. * [Dive into Python 3](https://www.diveinto.org/python3/) * [Introduction to Programming with Python](http://opentechschool.github.io/python-beginners/en/) * [Learn Python, Break Python - A Beginner's Guide to Programming](http://learnpythonbreakpython.com/) * [Non-Programmer's Tutorial for Python 3](https://en.wikibooks.org/wiki/Non-Programmer%27s_Tutorial_for_Python_3) * [The Art and Craft of Programming (Python edition)](http://troll.cs.ua.edu/ACP-PY/) * [CS61A: Structure and Interpretation of Computer Programs](http://inst.eecs.berkeley.edu/~cs61a/sp12/book/index.html) * [Learn Python the hard way](https://learnpythonthehardway.org/python3/) * [Program Arcade Games With Python And Pygame](http://programarcadegames.com/) * [Python for you and me](http://pymbook.readthedocs.io/en/py3/) * [Object-Oriented Programming in Python](http://python-textbok.readthedocs.io) * [Violent Python. A Cookbook for Hackers, Forensic Analysts, Penetration Testers and Security Engineers](http://store.elsevier.com/Violent-Python/TJ-OConnor/isbn-9781597499576/) * [Natural Language Processing with Python – Analyzing Text with the Natural Language Toolkit](http://www.nltk.org/book/) * [Python for Scientists and Engineers](http://pythonforengineers.com/python-for-scientists-and-engineers/) * [PythonBooks](http://pythonbooks.org/) - categorized Python books ### Coding Club books * [Python Basics](http://www.codingclub.co.uk/book1_home.php) * [Python Next Steps](http://www.codingclub.co.uk/book2_home.php) * [Python: Building Big Apps](http://www.codingclub.co.uk/book3_home.php) * [Python: Programming Art](http://www.codingclub.co.uk/book4_home.php) * [Python: Interactive Adventures](http://www.codingclub.co.uk/book5_home.php) * [Black Flag: A Coding Club Mission](http://www.codingclub.co.uk/black_flag.php) * [Coding Cards](http://www.codingclub.co.uk/codecards/CC-CodeCards.pdf) [PDF] ### Green Tea Press * [Think Python: How To Think Like a Computer Scientist, 2nd ed.](http://greenteapress.com/thinkpython2/html/) * [Think Complexity: Exploring Complexity Science with Python, 2nd ed.](http://greenteapress.com/complexity2/html/) * [Think DSP: Digital Signal Processing in Python](http://greenteapress.com/thinkdsp/html/) * [Think Stats: Exploratory Data Analysis in Python, 2nd ed.](http://greenteapress.com/thinkstats2/html/) * [Think Bayes: Bayesian Statistics in Python](http://www.greenteapress.com/thinkbayes/html/) ### Invent with Python series * [Invent your own computer games with Python](https://inventwithpython.com/) * [Making Games with Python & Pygame](https://inventwithpython.com/pygame/) * [Hacking Secret Ciphers with Python](http://inventwithpython.com/hacking/) -> 2nd ed: [Cracking Codes with Python](http://inventwithpython.com/cracking/) * [Automate the Boring Stuff with Python](https://automatetheboringstuff.com/) ### Manning Publications * [Classic Computer Science Problems in Python](https://www.manning.com/books/classic-computer-science-problems-in-python) * [Hello! Python](https://www.manning.com/books/hello-python) * [Hello World! 2nd ed. Computer Programming for Kids and Other Beginners](https://www.manning.com/books/hello-world-second-edition) * [Hello Raspberry Pi!](https://www.manning.com/books/hello-raspberry-pi) - Python programming for kids and other beginners. * [The Quick Python Book, Third Edition](https://www.manning.com/books/the-quick-python-book-third-edition) * [Learn Programming with Python](https://www.manning.com/books/learn-programming-with-python) * [Grokking Algorithms](https://www.manning.com/books/grokking-algorithms) - An illustrated guide for programmers and other curious people. * [Practices of the Python Pro](https://www.manning.com/books/practices-of-the-python-pro) - Professional software development principles and best practices for beginning developers. * [The Well-Grounded Python Developer](https://www.manning.com/books/the-well-grounded-python-developer) - Helping programmers who know Python become and think like developers. * [Tiny Python Projects](https://www.manning.com/books/tiny-python-projects) - An introduction to Python fundamentals through puzzles and games. * [Publishing Python Packages](https://www.manning.com/books/publishing-python-packages) - Book that reveals best practices and standards for packaging your Python code in an easy, automated, and scalable way.. ### No Starch Press * [Python for Kids](https://www.nostarch.com/pythonforkids) * [Teach Your Kids to Code](https://www.nostarch.com/teachkids) * [Doing Math with Python: Use Programming to Explore Algebra, Statistics, Calculus, and More!](https://www.nostarch.com/doingmathwithpython) * [Python Crash Course. A Hands-On, Project-Based Introduction to Programming](https://www.nostarch.com/pythoncrashcourse) * [Python Playground. Geeky Projects for the Curious Programmer](https://www.nostarch.com/pythonplayground) * [Learn to Program with Minecraft. Transform Your World with the Power of Python](https://www.nostarch.com/programwithminecraft) * [Black Hat Python. Python Programming for Hackers and Pentesters](https://www.nostarch.com/blackhatpython) ### O'Reilly * [Raspberry Pi Cookbook. Software and Hardware Problems and Solutions](http://shop.oreilly.com/product/0636920196372.do) * [Head First Python, 2nd Edition](http://shop.oreilly.com/product/0636920036777.do) * [Python for Unix and Linux System Administration](http://shop.oreilly.com/product/9780596515829.do) (2008) ### Packt Pub * [Python Projects for Kids](https://www.packtpub.com/application-development/python-projects-kids) * [Raspberry Pi Projects for Kids](https://www.packtpub.com/hardware-and-creative/raspberry-pi-projects-kids-second-edition) * [Python Programming for Arduino](https://www.packtpub.com/application-development/python-programming-arduino) * [Pro Python System Administration](http://www.apress.com/us/book/9781430226055) (2010) ## Hardware * [Cozmo](https://developer.anki.com/) ### Raspberry Pi * [Raspberry Pi](https://www.raspberrypi.org/) * [Getting Started with Minecraft Pi](https://www.raspberrypi.org/learning/getting-started-with-minecraft-pi/) * [Create a "Whac-a-block" game in Minecraft](https://www.raspberrypi.org/learning/minecraft-whac-a-block-game/) * [MagPi issues](https://www.raspberrypi.org/magpi-issues/) * [The Raspberry Pi Platform and Python Programming for the Raspberry Pi](https://www.coursera.org/learn/raspberry-pi-platform) * [gpiozero](https://github.com/RPi-Distro/python-gpiozero) - A simple interface to GPIO devices with Raspberry Pi. ### Arduino * [Arduino and Python](http://playground.arduino.cc/Interfacing/Python) * [Using Python with Arduino](http://www.toptechboy.com/using-python-with-arduino-lessons/) ### BBC microbit * [The micro:bit Foundation](http://microbit.org/) * [BBC micro:bit MicroPython](https://microbit-micropython.readthedocs.io) * [Microbit Playground](https://github.com/microbit-playground) ### PyBoard * [MicroPython](http://micropython.org/) ### ESP32 * [MicroPython](https://github.com/micropython/micropython-esp32) ### Adafruit CircuitPython * [CircuitPython](https://github.com/adafruit/circuitpython) - a MicroPython fork for teaching coding with microcontrollers * [Awesome CircuitPython](https://github.com/adafruit/awesome-circuitpython) - A curated list of awesome CircuitPython guides, videos, libraries, frameworks, software and resources. ## License [](https://creativecommons.org/publicdomain/zero/1.0/)

Full Speed Python: a book for self-learners

# Full Speed Python Pdf and epub files can be downloaded from: https://github.com/joaoventura/full-speed-python/releases/ This book aims to teach the Python programming language using a practical approach. Its method is quite simple: after a short introduction to each topic, the reader is invited to learn more by solving the proposed exercises. These exercises have been used extensively in my web development and distributed computing classes at the Superior School of Technology of Setúbal. With these exercises, most students are up to speed with Python in less than a month. In fact, students of the distributed computing course, taught in the second year of the software engineering degree, become familiar with Python's syntax in two weeks and are able to implement a distributed client-server application with sockets in the third week. The source of this book is available on github (https://github.com/joaoventura/full-speed-python). I welcome any pull requests to correct misspellings, suggest new exercises or to provide clarification of the current content. ## Building Run `make pdf` or `make epub` to build the books. This project uses [pandoc](http://pandoc.org/) to build the books. The pdf file is built with pdflatex, so you may need to download a latex distribution.

Scripts I use during pentest engagements.

Scripts ======= Introduction ------------ This is a collection of scripts I have written to use in pentests. Let me know if there are any problems with the scripts. If you have any suggestions for new scripts let me know as well; I am always looking for new ideas. Organization ------------ * `bruteforce` - Password brute forcing. * `cloud` - Interacting with or testing cloud-based services. * `database` - Testing traditional databases. * `enumeration` - Enumerate DNS, web applications, and users. * `exploit` - Exploits and exploit development. * `nosql` - Testing non-traditional databases. * `osint` - Open source intelligence gathering. * `passwords` - Password. * `phishing` - Tools to facilitate phishing. * `postexploit` - Tools for gathering data post exploitation. * `scan` - Network scanners and parsers. * `shells` - No explanation necessary. * `webapp` - Tools for web application testing. * `wireless` - Wireless testing tools.

All Subjects of 42 School

# All subjects of 42 School (Paris) __All these subjects are the exclusive property of 42 School.__<br /> Any reproduction, use outside the school context of 42 or without authorization is prohibited and may be treated as copyright infringement. __If you want to see corrections files for these projects, go [HERE](https://github.com/Binary-Hackers/42_Corrections).__ ## Norme 42 - [Norme 2.0.0](https://github.com/BenjaminSouchet/42_Subjects/blob/master/04_Norme/norme_2_0_0.pdf) - [Norme 2.0.1](https://github.com/BenjaminSouchet/42_Subjects/blob/master/04_Norme/norme_2_0_1.pdf) ## Projects ### Global - [42 Commandements (T0)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/00_Global/42_commandements.pdf) - [Piscine Reloaded (T0)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/00_Global/piscine_reloaded.pdf) - [Libft (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/00_Global/libft.pdf) - [Fillit (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/00_Global/fillit.pdf) - [Get Next Line (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/00_Global/get_next_line.pdf) ### Unix branch - [Ft_ls (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_ls.pdf) - [minishell (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/minishell.pdf) - [ft_select (Optional Project) (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_select.pdf) - [21sh (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/21sh.pdf) - [Taskmaster (Optional Project) (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/taskmaster.pdf) - [42sh (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/42sh.pdf) - [Malloc (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/malloc.pdf) - [ft_script (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_script.pdf) - [Philosophers (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/philosophers.pdf) - [Nm-otool (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/nm-otool.pdf) - [Dr Quine (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/dr_quine.pdf) - [Famine (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/famine.pdf) - [LibftASM (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/asm_lib.pdf) - [Root-me | App-Systeme (T4)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/root_me_app_systeme.pdf) - [Root-me | Cracking (T4)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/root_me_cracking.pdf) - [Snow Crash (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/snow_crash.pdf) - [RainFall (T4)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/Rain-Fall.pdf) - [strace (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_strace.pdf) - [GBmu (T4)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/GBmu.pdf) - [ft_linux (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_linux.pdf) - [little-penguin-1 (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/little_penguin_1.pdf) - [Process and Memory (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/lk_process_and_mem.pdf) - [Drivers and Interrupts (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/lk_driver_and_keyboard.pdf) - [Filesystem (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/lk_filesystem.pdf) - [KFS-1 (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/kfs_1.pdf) - [KFS-2 (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/kfs_2.pdf) - [KFS-3 (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/kfs_3.pdf) - [KFS-4 (T3) _NEW_](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/kfs_4.pdf) - [Woody Woodpacker (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/woody_woodpacker.pdf) - [ft_p (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_p.pdf) - [IRC (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_irc.pdf) - [Matt Daemon (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/Matt_daemon.pdf) - [Lem-ipc (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/lemipc.pdf) - [Zappy (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/zappy.pdf) - [ft_ping (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_ping.pdf) - [ft_traceroute (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_traceroute.pdf) - [ft_nmap (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/01_Unix/ft_nmap.pdf) ### Algorithmic branch - [Ft_printf (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/ft_printf.pdf) - [Push Swap (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/push_swap.pdf) - [Filler (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/filler.pdf) - [Lem_in (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/lem-in.pdf) - [Mod1 (Optional Project) (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/mod1.pdf) - [Corewar (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/corewar.pdf) - [Corewar Championship (Optional Project) (T0)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/corewar-championship.pdf) - [ComputorV1 (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/computorv1.pdf) - [Expert System (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/expertsystem.pdf) - [N-puzzle (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/npuzzle.pdf) - [Ft_linear_regression (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/ft_linear_regression.pdf) - [Rubik (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/rubik.pdf) - [KrpSim (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/krpsim.pdf) - [Gomoku (T4)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/02_Algorithmic/gomoku.pdf) ### Graphic branch - [FDF (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/fdf.pdf) - [Fract'Ol (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/fract_ol.pdf) - [Wolf3D (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/wolf3d.pdf) - [RTv1 (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/rtv1.pdf) - [RT (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/rt.pdf) - [Scop (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/scop.pdf) - [42run (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/42run.pdf) - [HumanGL (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/humangl.pdf) - [Particle System (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/03_Graphic/ParticleSystem.pdf) ### Web branch - [Camagru (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/04_Web/camagru.pdf) - [Matcha (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/04_Web/matcha.pdf) - [Hypertube (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/04_Web/hypertube.pdf) - [Friends with Benefits (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/04_Web/friends_with_benefits.pdf) - [Red Tetris (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/04_Web/red_tetris.pdf) - [Darkly (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/04_Web/darkly.pdf) ### OCaml branch - [H42N42 (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/05_OCaml/subject.pdf) - [ft_turing (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/05_OCaml/ft_turing.pdf) - [ft_ality (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/05_OCaml/ft_ality.pdf) ### Android / iOS branch - [Swifty Companion (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/06_Android-iOS/swifty-companion.pdf) - [Swifty Proteins (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/06_Android-iOS/swifty-protein.pdf) - [ft_hangouts (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/06_Android-iOS/ft_hangouts.pdf) ### C++ branch - [Abstract VM (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/07_CPP/abstract-vm.pdf) - [Nibbler (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/07_CPP/nibbler.pdf) - [Bomberman (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/07_CPP/bomberman.pdf) ### Unity branch - [XV (T3)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/08_Unity/XV.pdf) - [In the Shadows (T2)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/08_Unity/In_the_shadow.pdf) ### Others - [cloud-1 (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/09_Others/cloud-1.pdf) - [roger-skyline-1 (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/09_Others/roger-skyline-1.pdf) - [roger-skyline-2 (T4)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/09_Others/roger-skyline-2.pdf) - [Docker (T1)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/09_Others/docker.pdf) - [Projet Libre (T4)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/00_Projects/09_Others/ProjetLibre.pdf) ## Piscines - [C (Languages EN & FR)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/C) - [C++ (T2)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/CPP) - [PHP (T1)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/PHP) - [Python-Django (T2)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/Python-Django) - [Ocaml (T2)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/OCaml) - [Ruby On Rails (T2)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/Ruby_On_Rails) - [Swift iOS (T2)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/iOS_Swift) - [Unity (T2)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/01_Piscines/Unity) ## Rushes - AlCu (Not Available) - [Alum1](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/alum1.pdf) - [Arkanoid](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/arkanoid.pdf) - [Carnifex (LISP)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/Carniflex.pdf) - [Cluedo (Prolog)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/cluedo.pdf) - [Domino](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/Domino.pdf) - [Factrace](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/factrace.pdf) - [Hotrace](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/hotrace.pdf) - [Introduction to iOS](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/sujet_ios.pdf) - [Introduction to Wordpress](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/wordpress.pdf) - [LLDB](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/LLDB.pdf) - [Mexican Standoff](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/mexican_standoff.pdf) - [Puissance 4](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/puissance4.pdf) - Rage Against The aPi (Not Available) - Rush admin sys et réseau 0 (Not Available) - Rush admin sys et réseau 1 (Not Available) - [wong_kar_wai (2048)](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/wong_kar_wai_2048.pdf) - [YASL](https://github.com/BenjaminSouchet/42_Subjects/blob/master/02_Rushes/yasl.pdf) ## Exam C Beginner - [See all subjects (Langs : EN / FR / RO)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/03_Exam_C) ## Others - [Peer-Evaluation (Langs : EN / FR)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/05_Others/Peer-Evaluation) - [Vogsphere Manual (Langs : EN / FR)](https://github.com/BenjaminSouchet/42_Subjects/tree/master/05_Others/Vogsphere)

Python MUD/MUX/MUSH/MU* development system

# Evennia MUD/MU\* Creation System ![][logo] [![unittestciimg]][unittestcilink] [![Coverage Status][coverimg]][coverlink] [![Pypi Version][pypibadge]][pypilink] [Evennia][homepage] is a modern library for creating [online multiplayer text games][wikimudpage] (MUD, MUSH, MUX, MUCK, MOO etc) in pure Python. It allows game creators to design and flesh out their ideas with great freedom. Evennia does not impose a particular style, genre or game mechanic. Instead it solves the boring networking and basic stuff all online games need. It provides a framework and tools for you to build the game you want. Coding in Evennia is done using normal Python modules imported into the server at runtime. Evennia has [extensive documentation][docs]. It also has a very active community with [discussion forums][group] and a [discord server][chat] to help and support you! ## Installation pip install evennia (windows users once: py -m evennia) evennia --init mygame cd mygame evennia migrate evennia start / stop / reload See [the full installation instructions][installation] for more help. Next, browse to `http://localhost:4001` or use your third-party mud client to connect to to `localhost`, port `4000` to see your working (if empty) game! ![screenshot][screenshot] _A game website is created automatically. Connect to your Evennia game from your web browser as well as using traditional third-party clients_. ## Where to go next If this piqued your interest, there is a [lengthier introduction][introduction] to read. You can also read our [Evennia in pictures][evenniapictures] overview. After that, why not check out the [Evennia Beginner tutorial][beginnertutorial]. Welcome! [homepage]: https://www.evennia.com [docs]: https://www.evennia.com/docs/latest [screenshot]: https://user-images.githubusercontent.com/294267/205434941-14cc4f59-7109-49f7-9d71-0ad3371b007c.jpg [logo]: https://github.com/evennia/evennia/blob/master/evennia/web/website/static/website/images/evennia_logo.png [unittestciimg]: https://github.com/evennia/evennia/workflows/test-suite/badge.svg [unittestcilink]: https://github.com/evennia/evennia/actions?query=workflow%3Atest-suite [coverimg]: https://coveralls.io/repos/github/evennia/evennia/badge.svg?branch=main [coverlink]: https://coveralls.io/github/evennia/evennia?branch=main [pypibadge]: https://img.shields.io/pypi/v/evennia?color=blue [pypilink]: https://pypi.org/project/evennia/ [introduction]: https://www.evennia.com/docs/latest/Evennia-Introduction.html [license]: https://www.evennia.com/docs/latest/Licensing.html [group]: https://github.com/evennia/evennia/discussions [chat]: https://discord.gg/AJJpcRUhtF [wikimudpage]: http://en.wikipedia.org/wiki/MUD [evenniapictures]: https://www.evennia.com/docs/latest/Evennia-In-Pictures.html [beginnertutorial]: https://www.evennia.com/docs/latest/Howtos/Howtos-Overview.html#beginner-tutorial [installation]: https://www.evennia.com/docs/latest/Setup/Setup-Overview.html#installation-and-running

MapReduce, Spark, Java, and Scala for Data Algorithms Book

[Data Algorithms Book](http://shop.oreilly.com/product/0636920033950.do) ====================== * Author: Mahmoud Parsian ([email protected]) * Title: [Data Algorithms: Recipes for Scaling up with Hadoop and Spark](http://shop.oreilly.com/product/0636920033950.do) * This GitHub repository will host all source code and scripts for [Data Algorithms Book](http://shop.oreilly.com/product/0636920033950.do). * Publisher: [O'Reilly Media](http://shop.oreilly.com/product/0636920033950.do) * Published date: July 2015 Git Repository ============== The book's codebase can also be downloaded from the git repository at: ```` git clone https://github.com/mahmoudparsian/data-algorithms-book.git ```` [2nd Edition! Coming Out @ the End of 2021](./misc/data-algorithms-2nd-ed-cover.jpg) =========================================== [Upgraded to Spark-3.1.2](http://spark.apache.org/releases/spark-release-3-1-2.html) ========================= [Production Version is Available NOW!](http://shop.oreilly.com/product/0636920033950.do) ====================================== [](http://shop.oreilly.com/product/0636920033950.do) [Java 8's LAMBDA Expressions to Spark...](./misc/jdk8_and_lambda.md) ================================================ [Scala Spark Solutions](./src/main/scala/org/dataalgorithms) ============================================================ [How To Build using Apache's Ant](./misc/ant/README.md) =============================== [How To Build using Apache's Maven](./misc/maven/README.md) =================================== [Machine Learning Algorithms using Spark](./src/main/java/org/dataalgorithms/machinelearning) ========================================= [Spark for Cancer Outlier Profile Analysis](http://hadoopsummit.uservoice.com/forums/344955-data-science-analytics-and-spark/suggestions/11664381-spark-solution-for-cancer-outlier-profile-analysis) ==================================================== [Webinars and Presentions on Data Algorithms](./misc/webinars.md) ================================================================= [Introduction to MapReduce](https://github.com/mahmoudparsian/data-algorithms-book/tree/master/src/main/java/org/dataalgorithms/chapB09/charcount) =========================== [Bonus Chapters](./misc/bonus-chapters.md) ================ [Author Book Signing](./misc/book-signing.md) ===================== <!--- your comment goes here and here Work in Progress... =================== Please note that this is a work in progress...  --> [How To Run Spark/Hadoop Programs](./misc/run_spark/README.md) ================================== [Submit a Spark Job from Java Code](./misc/how-to-submit-spark-job-from-java-code.md) =========================================== How To Run Python Programs ========================== To run python programs just call them with `spark-submit` together with the arguments to the program. [My favorite quotes...](./misc/favorite_quotes/README.md) ========================================================= Questions/Comments ================== * [View Mahmoud Parsian's profile on LinkedIn](http://www.linkedin.com/in/mahmoudparsian) * Please send me an email: <[email protected]> * [Twitter: @mahmoudparsian](http://twitter.com/mahmoudparsian) Thank you! ```` best regards, Mahmoud Parsian ```` [](http://shop.oreilly.com/product/0636920033950.do)

This repository contains all the DSA (Data-Structures, Algorithms, 450 DSA by Love Babbar Bhaiya, FAANG Questions), Technical Subjects (OS + DBMS + SQL + CN + OOPs) Theory+Questions, FAANG Interview questions, and Miscellaneous Stuff (Programming MCQs, Puzzles, Aptitude, Reasoning). The Programming languages used for demonstration are C++, Python, and Java.

<p align="center"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation#readme" target="_blank"> <img src="https://readme-typing-svg.herokuapp.com?font=Tourney&center=true&vCenter=true&color=2CFF00&size=75&pause=750&width=1280&height=80&lines=The+Complete+FAANG+Preparation"/> </a> </p> [](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation#readme) <p align="center"> <code><img src="https://profile-counter.glitch.me/{The-Complete-FAANG-Preparation}/count.svg" alt="Views Count" width="500px" height="80px" /></code> </p> <p align="center"> <img src="https://readme-jokes.vercel.app/api" width="450px" /> </p> <p align="center"> <a href="https://bit.ly/3FvaHo9" target="_blank"> <img align="center" src="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/images/codestudio-1.png" width="500px" height="150px" /> </a> <br> <a href="https://bit.ly/3FvaHo9" target="_blank"> <img src="https://readme-typing-svg.herokuapp.com?font=Impact&center=true&vCenter=true&color=F78D1AFF&size=75&width=620&height=80&lines=Learning+Resources"/> </a> </p> <div align="center"> # `🏆 Table of Contents 📋` | SNo. | Topics | Sub Topics | |------|--------|------------| | 1. | [📘Aptitude + Puzzle](https://www.codingninjas.com/codestudio/guided-paths?category=interview-preparation) | [1️⃣Aptitude](https://www.codingninjas.com/codestudio/guided-paths/aptitude-preparation) <br> [2️⃣Puzzle](https://www.codingninjas.com/codestudio/guided-paths/top-150-interview-puzzles) | | 2. | [📘Languages](https://www.codingninjas.com/codestudio/guided-paths) | [1️⃣C++](https://bit.ly/3YtE9n1) <br> [2️⃣Python](https://bit.ly/3V3lgnW) <br> [3️⃣Java](https://bit.ly/3FX11Eb)| | 3. | [📘DSA + CP](https://www.codingninjas.com/codestudio/guided-paths) <hr> [📘Top Problem Lists](https://bit.ly/3v0rudC) | [1️⃣Data Structures and Algorithms](https://bit.ly/3V5h7Qx) <br> [2️⃣Competitive Programming](https://www.codingninjas.com/codestudio/guided-paths/competitive-programming) <hr> [1️⃣Striver SDE Sheet](https://bit.ly/3hu7GfF) <br> [2️⃣Love Babbar DSA Sheet](https://bit.ly/3uTFyFM)| | 4. | [📘Technical Subject](https://www.codingninjas.com/codestudio/guided-paths?category=interview-preparation) | [1️⃣Operating System](https://bit.ly/3HKNaSK) <br> [2️⃣Database Management System](https://bit.ly/3FX5k2e) <br> [3️⃣Computer Networks](https://bit.ly/3BHlNFv) <br> [4️⃣Object Oriented Programming in C++](https://bit.ly/3WrQgzn) <br>&emsp; [4️⃣🅰️Object Oriented Programming in Python](https://www.codingninjas.com/codestudio/guided-paths/oops-in-python) <br>&emsp; [4️⃣🅱️Object Oriented Programming in Java](https://www.codingninjas.com/codestudio/guided-paths/oops-in-java) <br> [5️⃣System Design](https://www.codingninjas.com/codestudio/guided-paths/system-design)| <a href="https://bit.ly/3FvaHo9" target="_blank"> <img src="https://readme-typing-svg.herokuapp.com?font=Impact&center=true&vCenter=true&color=308D46&size=75&width=600&height=80&lines=Important+Books"/> </a> <table border="3"> <thead> <tr> <th> SNo. </th> <th> Topics </th> <th> Sub-Topics </th> </tr> </thead> <tbody> <tr> <th valign="top"> 1. </th> <th align="left" valign="top"> 📘Aptitude + Puzzles </th> <th align="left"> 📒Aptitude <table> <td align="center"><a href="https://amzn.to/3w5NS6e" target="_blank"><img src="https://m.media-amazon.com/images/W/WEBP_402378-T1/images/I/510vx4eIUoL._SX198_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/><br />_{<b>Quantitative Aptitude - <br> Dr. R S Aggarwal</b>}</a><br /></td> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 2. </th> <th align="left" valign="top"> 📘Programming Languages </th> <th align="left"> 📒C & C++ Language <table> <td align="center"><a href="https://amzn.to/3XwpgPK" target="_blank"><img src="https://m.media-amazon.com/images/I/41a4CcXfN4L._SY264_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/><br />_{<b>Let Us C</b>}</a><br /></td> <td align="center"><a href="https://amzn.to/3iEgyjy" target="_blank"><img src="https://m.media-amazon.com/images/I/51BFuRUjSWL._SY264_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/><br />_{<b>C in Depth</b>}</a><br /></td> <tr> <td align="center"><a href="https://amzn.to/3GJD8PN" target="_blank"><img src="https://m.media-amazon.com/images/I/51YkwADIq5L._SY264_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/><br />_{<b>Let Us C++</b>}</a><br /></td> <td align="center"><a href="https://amzn.to/3X9mUWZ" target="_blank"><img src="https://m.media-amazon.com/images/I/51Uqe5PHbML._SX381_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>The Complete Reference <br> C++</b>}</a><br /></td> </table> 📒Python Language <table> <td align="center"><a href="https://amzn.to/3kiXeso" target="_blank"><img src="https://m.media-amazon.com/images/I/51Ss-7j3v5L._SX362_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Core Python</b>}</a><br /></td> </table> 📒Java Language <table> <td align="center"><a href="https://amzn.to/3IKptdJ" target="_blank"><img src="https://m.media-amazon.com/images/I/51z+MsmqesL._SX258_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Core Java</b>}</a><br /></td> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 3. </th> <th align="left" valign="top"> 📘DSA <hr> 📘CP <hr> 📘Coding Interviews </th> <th align="left"> 📒Data Structures <table> <td align="center"><a href="https://amzn.to/3ZzIzJw" target="_blank"><img src="https://m.media-amazon.com/images/I/417ExARdRYL._SX384_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Data Structures <br> and Algorithms <br> Made Easy</b>}</a><br /></td> <td align="center"><a href="https://amzn.to/3WaqeQv" target="_blank"><img src="https://m.media-amazon.com/images/I/41fWWCgWk6L._SX384_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Data Structures <br> and Algorithms <br> Thinking with Python</b>}</a><br /></td> </table> 📒Algorithms <table> <td align="center"><a href="https://amzn.to/3COZXQW" target="_blank"><img src="https://m.media-amazon.com/images/I/513P8XoCAEL._SX376_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Introduction to Algorithms</b>}</a><br /></td> <td align="center"><a href="https://amzn.to/3QGrsSd" target="_blank"><img src="https://m.media-amazon.com/images/I/41-RWwEls6L._SX400_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Algorithms</b>}</a><br /></td> </table> <hr> 📒Competitive Programming <table> <td align="center"><a href="https://amzn.to/3X33UcN" target="_blank"><img src="https://m.media-amazon.com/images/I/41iVz+I5jOL._SY344_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Guide to <br> Competitive Programming</b>}</a><br /></td> </table> <hr> 📒Coding Interviews <table> <td align="center"><a href="https://amzn.to/3IWvkwy" target="_blank"><img src="https://m.media-amazon.com/images/I/41oYsXjLvZL._SY291_BO1,204,203,200_QL40_FMwebp_.jpg" width="100;" alt=""/><br />_{<b>Cracking the Coding Interview</b>}</a><br /></td> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 4. </th> <th align="left" valign="top"> 📘Technical Subject </th> <th align="left"> 📒Object Oriented Programming (OOP) <table> <td align="center"><a href="https://amzn.to/3GG9FpY" target="_blank"><img src="https://m.media-amazon.com/images/I/51N4A59EAiL.jpg" width="100" alt=""/><br />_{<b>Object Oriented Programming <br> with C++ <br> E Balagurusamy</b>}</a><br /></td> </table> 📒Operating System (OS) <table> <td align="center"><a href="https://amzn.to/3GG9UBo" target="_blank"><img src="https://m.media-amazon.com/images/I/51Qy2upM+aL._SY344_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Operating System</b>}</a><br /></td> </table> 📒Database Management System (DBMS) <table> <td align="center"><a href="https://amzn.to/3CN1FT0" target="_blank"><img src="https://m.media-amazon.com/images/I/51cq3aAdqNL._SX198_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/><br />_{<b>Database Management System</b>}</a><br /></td> </table> 📒Computer Network (CN) <table> <td align="center"><a href="https://amzn.to/3ixBcBX" target="_blank"><img src="https://m.media-amazon.com/images/I/51vT3X2tdtL._SX409_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>Computer Network</b>}</a><br /></td> </table> 📒System Design <table> <td align="center"><a href="https://amzn.to/3H3KKOf" target="_blank"><img src="https://m.media-amazon.com/images/I/4129HxbBnOL._SX331_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>System Design - Volume 1</b>}</a><br /></td> <td align="center"><a href="https://amzn.to/3H4iOtA" target="_blank"><img src="https://m.media-amazon.com/images/I/31wqdTUjz2L._SX348_BO1,204,203,200_.jpg" width="100" alt=""/><br />_{<b>System Design - Volume 2</b>}</a><br /></td> </table> </th> </tr> </tbody> </table> </div> <!-- # [`Community Exchange`](https://education.github.com/globalcampus/exchange?utf8=%E2%9C%93&q=sort%3Astar_desc) <code>[](https://education.github.com/globalcampus/exchange?utf8=%E2%9C%93&q=The-Complete-FAANG-Preparation) [](https://education.github.com/graduation/yearbook?sort=az&page=2&search=akashsingh3031#AkashSingh3031)</code> ## [`Welcome to The-Complete-FAANG-Preparation Discussions!`](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/discussions) <code>[](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/discussions)</code> --> --- [](https://github.com/AkashSingh3031) [](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation) [](https://github.com/AkashSingh3031?tab=followers) [](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/stargazers) [](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/network/members) [](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/watchers) [](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/LICENSE)         ### `Social Networks:` <table border="3"> <td align="center"><a href="https://github.com/AkashSingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/github-2.png" alt="Akash's GitHub" width="45"/></a></td> <td align="center"><a href="https://www.linkedin.com/in/akashsingh3031/" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/linked(color).png" alt="Akash's linkedin" width="45" /></a></td> <td align="center"><a href="https://wa.me/919794423031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/whatsapp(color).png" alt="Akash's WhatsApp" width="45" /></a></td> <td align="center"><a href="https://t.me/akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/telegram(color).png" alt="Akash's Telegram" width="45" /></a></td> <td align="center"><a href="https://www.facebook.com/akashsingh3031/" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/facebook%20(color).png" alt="Akash's Facebook" width="45" /></a></td> <td align="center"><a href="https://www.instagram.com/akash.singh3031/" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/Instagram%20(color).svg" alt="Akash's Instagram" width="45" /></a></a></td> <td align="center"><a href="https://twitter.com/intent/follow?screen_name=akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/twitter(color).png" alt="Akash's Twitter" width="45" /></a></td> <td align="center"><a href="https://mail.google.com/mail/u/0/?fs=1&[email protected]&tf=cm" target="_blank"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/Gmail_icon_(2020).svg" alt="Gmail" width="45"/> </a></td> <td align="center"><a href="https://www.youtube.com/@akashsingh3031?sub_confirmation=1" target="_blank" align="center"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/youtube(color).png" alt="YouTube" width="45" /></a></td> <td align="center"><a href="https://medium.com/@akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/medium.svg" alt="Akash's Medium" width="45"/></a></td> <tr> <td align="center"><a href="https://github.com/AkashSingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=black&logo=github&svgfill=white"></a></td> <td align="center"><a href="https://www.linkedin.com/in/akashsingh3031/"><img src="https://readme-components.vercel.app/api?component=logo&fill=0e76a8&logo=linkedin&svgfill=white"></a></td> <td align="center"><a href="https://wa.me/919794423031"><img src="https://readme-components.vercel.app/api?component=logo&fill=25D366&logo=whatsapp&svgfill=white"></a></td> <td align="center"><a href="https://t.me/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=1ca0f1&logo=telegram&svgfill=white"></a></td> <td align="center"><a href="https://www.facebook.com/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=4267B2&logo=facebook&svgfill=white"></a></td> <td align="center"><a href="https://www.instagram.com/akash.singh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=E1306C&logo=instagram&svgfill=white"></a></td> <td align="center"><a href="https://twitter.com/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=1DA1F2&logo=twitter&svgfill=white"></a></td> <td align="center"><a href="https://mail.google.com/mail/u/0/?fs=1&[email protected]&tf=cm"><img src="https://readme-components.vercel.app/api?component=logo&fill=DB4437&logo=gmail&svgfill=4285F4"></a></td> <td align="center"><a href="https://www.youtube.com/@akashsingh3031?sub_confirmation=1"><img src="https://readme-components.vercel.app/api?component=logo&fill=ff0000&logo=youtube&svgfill=white"></a></td> <td align="center"><a href="https://medium.com/@akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=black&logo=medium&svgfill=white"></a></td> </table> ### `Coding Profiles:` <table border="3"> <td align="center"><a href="https://leetcode.com/akashsingh3031/" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/LeetCode.png" alt="LeetCode" width="45"/></a></td> <td align="center"><a href="https://auth.geeksforgeeks.org/user/akashsingh3031/practice" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/GeeksforGeeks-1.png" alt="GeeksforGeeks" width="55"/></a></td> <td align="center"><a href="https://www.codingninjas.com/codestudio/profile/AkashSingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/Coding%20Ninjas.png" alt="Coding Ninjas" width="45"/></a></td> <td align="center"><a href="https://workat.tech/profile/akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/workattech.png" alt="work@tech" width="45"/></a></td> <td align="center"><a href="https://www.hackerrank.com/akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/HackerRank.png" alt="HackerRank" width="45"/></a></td> <td align="center"><a href="https://www.hackerearth.com/@akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/HackerEarth.png" alt="HackerEarth" width="45"/></a></td> <td align="center"><a href="https://www.interviewbit.com/profile/akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/InterviewBit.png" alt="InterviewBit" width="45"/></a></td> <td align="center"><a href="https://www.stopstalk.com/user/profile/akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/StopStalk.png" alt="StopStalk" width="45"/></a></td> <td align="center"><a href="https://stackoverflow.com/users/18910829/akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/StackOverflow.png" alt="Stack Overflow" width="45"/></a></td> <td align="center"><a href="https://www.kaggle.com/akashsingh3031" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/kaggle.png" alt="Akash's Kaggle" width="30"/></a></td> <tr> <td align="center"><a href="https://leetcode.com/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=FF7F50&logo=leetcode&svgfill=white"></a></td> <td align="center"><a href="https://auth.geeksforgeeks.org/user/akashsingh3031/practice"><img src="https://readme-components.vercel.app/api?component=logo&fill=308D46&logo=geeksforgeeks&svgfill=white"></a></td> <td align="center"><a href="https://www.codingninjas.com/codestudio/profile/AkashSingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=F78D1A&logo=coding%20ninjas&svgfill=white"></a></td> <td align="center"><a href="https://workat.tech/profile/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=blue&logo=work@tech&svgfill=white"></a></td> <td align="center"><a href="https://www.hackerrank.com/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=308D46&logo=hackerrank&svgfill=white"></a></td> <td align="center"><a href="https://www.hackerearth.com/@akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=650458&logo=hackerearth&svgfill=white"></a></td> <td align="center"><a href="https://www.interviewbit.com/profile/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=F78D1A&logo=interviewBit&svgfill=blue"></a></td> <td align="center"><a href="https://www.stopstalk.com/user/profile/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=ff0000&logo=StopStalk&svgfill=white"></a></td> <td align="center"><a href="https://stackoverflow.com/users/18910829/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=FE7A16&logo=stackoverflow&svgfill=white"></a></td> <td align="center"><a href="https://www.kaggle.com/akashsingh3031"><img src="https://readme-components.vercel.app/api?component=logo&fill=20BEFF&logo=kaggle&svgfill=white"></a></td> </table> <table border="3"> <td><img src="https://forthebadge.com/images/badges/for-you.svg" /></td> <td><img src="https://forthebadge.com/images/badges/built-with-love.svg" /></td> <td><img src="https://forthebadge.com/images/badges/open-source.svg" /></td> </table> <table border="3"> <td><img src="http://ForTheBadge.com/images/badges/made-with-python.svg" /></td> <td><img src="https://forthebadge.com/images/badges/made-with-c.svg" /></td> <td><img src="http://ForTheBadge.com/images/badges/made-with-c-plus-plus.svg" /></td> <td><img src="http://ForTheBadge.com/images/badges/made-with-java.svg" /></td> <td><img src="http://ForTheBadge.com/images/badges/made-with-javascript.svg" /></td> </table> <table border="3"> <td><img src="https://forthebadge.com/images/badges/built-by-developers.svg" /></td> <td><img src="https://forthebadge.com/images/badges/uses-html.svg" /></td> <td><img src="https://forthebadge.com/images/badges/uses-css.svg" /></td> <td><img src="https://forthebadge.com/images/badges/uses-js.svg" /></td> <td><img src="https://forthebadge.com/images/badges/uses-git.svg" /></td> </table> --- # `🏆 The Complete FAANG Preparation 🏆` ```js This repository contains all the DSA (Data-Structures, Algorithms, 450 DSA by Love Babbar Bhaiya, FAANG Questions), Technical Subjects (OS + DBMS + SQL + CN + OOP) Theory+Questions, FAANG Interview questions and Miscellaneous Stuff (Programming MCQs, Puzzles, Aptitude, Reasoning). The Programming languages used for demonstration are C++, Python, and Java. ``` <!-- <div align="center"> <p> <a href="https://simplify.jobs/?utm_source=github&utm_medium=faang_prep"> <b>Applying to internships?</b> <br> Autofill all your applications in a single click. <br> <div> <img src="https://res.cloudinary.com/dpeo4xcnc/image/upload/v1636594918/simplify_pittcsc.png" width="450" alt="Simplify"> </div> </a> _{<i>Stop manually re-entering your information. Simplify’s extension helps you autofill internship applications on millions of sites.</i>} </p> </div> --> --- <h1 align='center'> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/Repository_Status.md"> <code> Full Repository Status </code> </a><br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/Learn.md"> <code> Learning Index </code> </a> </h1> <table> <thead> <tr> <th> SNo. </th> <th> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/0%5D.%20Miscellaneous%20Stuff"> <img src="https://img.shields.io/badge/Miscellaneous_Stuff-orange?style=for-the-badge"> </a> </th> <th> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP"> <img src="https://img.shields.io/badge/DSA_+_CP-orange?style=for-the-badge"> </a> </th> <th> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/2%5D.%20Technical%20Subjects"> <img src="https://img.shields.io/badge/Technical_Subjects-orange?style=for-the-badge"> </a> </th> <th> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/3%5D.%20System%20Design"> <img src="https://img.shields.io/badge/System_Design-orange?style=for-the-badge"> </a> </th> <th> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/4%5D.%20Projects"> <img src="https://img.shields.io/badge/Projects-orange?style=for-the-badge"> </a> </th> <th> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/5%5D.%20Important%20Books%20and%20Resources"> <img src="https://img.shields.io/badge/Important_Books_and_Resources-orange?style=for-the-badge"> </a> </th> <th> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/6%5D.%20Behavioural%20Interview"> <img src="https://img.shields.io/badge/Behavioural_Interview-orange?style=for-the-badge"> </a> </th> </tr> </thead> <tbody> <tr> <td valign="top"> 1. </td> <td valign="top"> <table border="5"> <thead> <tr> <th> SNo. </th> <th> Contents </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/0%5D.%20Miscellaneous%20Stuff/Aptitude%20%26%20Reasoning"> Aptitude & Reasoning </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/0%5D.%20Miscellaneous%20Stuff/Basic%20Programming%20MCQs"> Basic Programming MCQs </a> </th> </tr> </tbody> <tbody> <tr> <th> 3. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/0%5D.%20Miscellaneous%20Stuff/Puzzles"> Puzzles </a> </th> </tr> </tbody> </table> </td> <td valign="top"> <table border="5"> <thead> <tr> <th> SNo. </th> <th> Contents </th> <th> Sub-Contents </th> </tr> </thead> <tbody> <tr> <th valign="top"> 1. </th> <th align="left" valign="top"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/1%5D.%20DSA"> DSA </a> </th> <th> <table border="3"> <thead> <tr> <th> SNo. </th> <th> Topics </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/1%5D.%20DSA/1%5D.%20Data%20Structures"> Data Structures </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/1%5D.%20DSA/2%5D.%20Algorithms"> Algorithms </a> </th> </tr> </tbody> <tbody> <tr> <th> 3. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/1%5D.%20DSA/3%5D.%20450%20DSA%20by%20Love%20Babbar"> 450 DSA by Love Babbar </a> </th> </tr> </tbody> <tbody> <tr> <th> 4. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/1%5D.%20DSA/4%5D.%20Striver%20Series"> Striver Series </a> </th> </tr> </tbody> <tbody> <tr> <th> 5. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/1%5D.%20DSA/5%5D.%20DSA%20Sheet%20by%20Apna%20College"> DSA Sheet by Apna College </a> </th> </tr> </tbody> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 2. </th> <th align="left" valign="top"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming"> CP </a> </th> <th> <table border="3"> <thead> <tr> <th> SNo. </th> <th> Topics </th> <th> Sub-Topics </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/01%5D.%20Google"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/google.png" width="15" height="15"> Google </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/01%5D.%20Google/1%5D.%20Code%20Jam"> 1️⃣Code Jam </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/01%5D.%20Google/2%5D.%20Hash%20Code"> 2️⃣Hash Code </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/01%5D.%20Google/3%5D.%20Kick%20Start"> 3️⃣Kick Start </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/02%5D.%20Facebook"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Social%20Media/meta.png" width="15" height="15"> Facebook (Meta) </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/02%5D.%20Facebook/1%5D.%20Hacker%20Cup"> 1️⃣Facebook Hackercup </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/02%5D.%20Facebook/2%5D.%20FB%20Hack"> 2️⃣FB Hack </a> </th> </tr> </tbody> <tbody> <tr> <th> 3. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/LeetCode.png" width="15" height="15"> LeetCode </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/1%5D.%20Problems"> 1️⃣Problems </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/2%5D.%20Contests"> 2️⃣Contests </a> <br>&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/2%5D.%20Contests/1%5D.%20Weekly%20Contests"> 📕Weekly Contests </a> <br>&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/2%5D.%20Contests/2%5D.%20Biweekly%20Contests"> 📕Biweekly Contests </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan"> 3️⃣Study Plan </a> <br>&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/1%5D.%20Comprehensive%20Study%20Plans"> 📕Comprehensive Study Plans </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/1%5D.%20Comprehensive%20Study%20Plans/1%5D.%20LeetCode%2075"> 📖LeetCode 75 </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/1%5D.%20Comprehensive%20Study%20Plans/2%5D.%20Data%20Structure"> 📖Data Structure </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/1%5D.%20Comprehensive%20Study%20Plans/3%5D.%20Algorithm"> 📖Algorithm </a> <br>&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/2%5D.%20In-Depth%20Topics"> 📕In-Depth Topics </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/2%5D.%20In-Depth%20Topics/1%5D.%20SQL"> 📖SQL </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/2%5D.%20In-Depth%20Topics/2%5D.%20Programming%20Skills"> 📖Programming Skills </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/2%5D.%20In-Depth%20Topics/3%5D.%20Binary%20Search"> 📖Binary Search </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/2%5D.%20In-Depth%20Topics/4%5D.%20Graph%20Theory"> 📖Graph Theory </a> <br>&emsp;&emsp; <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/03%5D.%20LeetCode/3%5D.%20Study%20Plan/2%5D.%20In-Depth%20Topics/5%5D.%20Dynamic%20Programming"> 📖Dynamic Programming </a> </th> </tr> </tbody> <tbody> <tr> <th> 4. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/04%5D.%20Coding%20Ninjas"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/Coding%20Ninjas.png" width="18" height="15"> Coding Ninjas </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/04%5D.%20Coding%20Ninjas/1%5D.%20Practice"> 1️⃣Practice </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/04%5D.%20Coding%20Ninjas/2%5D.%20Contests"> 2️⃣Contests </a> </th> </tr> </tbody> <tbody> <tr> <th> 5. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/05%5D.%20GeeksforGeeks"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/GeeksforGeeks-1.png" width="15" height="12"> GeeksforGeeks </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/05%5D.%20GeeksforGeeks/1%5D.%20Problems"> 1️⃣Problems </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/05%5D.%20GeeksforGeeks/2%5D.%20Events/Series"> 2️⃣Contests </a> </th> </tr> </tbody> <tbody> <tr> <th> 6. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/06%5D.%20InterviewBit"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/InterviewBit.png" width="15" height="15"> InterviewBit </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/06%5D.%20InterviewBit/1%5D.%20Practice"> 1️⃣Practice </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/06%5D.%20InterviewBit/2%5D.%20Resources"> 2️⃣Resources </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/06%5D.%20InterviewBit/3%5D.%20Contests/1%5D.%20CodeDrift"> 3️⃣Contests </a> </th> </tr> </tbody> <tbody> <tr> <th> 7. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/07%5D.%20PrepBytes"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/prepbytes.png" width="15" height="15"> PrepBytes </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/07%5D.%20PrepBytes/1%5D.%20Competitive%20Coding"> 1️⃣Competitive Coding </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/07%5D.%20PrepBytes/2%5D.%20Interview%20Coding"> 2️⃣Interview Coding </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/07%5D.%20PrepBytes/3%5D.%20Company%20Coding"> 3️⃣Company Coding </a> </th> </tr> </tbody> <tbody> <tr> <th> 8. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/08%5D.%20Work%40Tech"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/workattech.png" width="15" height="15"> Work@Tech </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/08%5D.%20Work%40Tech/1%5D.%20Basic%20Coding%20For%20Beginners"> 1️⃣Basic Coding For Beginners </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/08%5D.%20Work%40Tech/2%5D.%20Data%20Structures%20%26%20Algorithms"> 2️⃣Data Structures & Algorithms </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/08%5D.%20Work%40Tech/3%5D.%20Machine%20Coding"> 3️⃣Machine Coding </a> </th> </tr> </tbody> <tbody> <tr> <th> 9. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/09%5D.%20CodeSignal"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/codesignal.png" width="15" height="15"> CodeSignal </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/09%5D.%20CodeSignal/1%5D.%20Arcade"> 1️⃣Arcade </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/09%5D.%20CodeSignal/2%5D.%20Interview%20Practice"> 2️⃣Interview Practice </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/09%5D.%20CodeSignal/3%5D.%20Challenges"> 3️⃣Challenges </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/09%5D.%20CodeSignal/4%5D.%20Company%20Challenges"> 4️⃣Company Challenges </a> </th> </tr> </tbody> <tbody> <tr> <th> 10. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/10%5D.%20HackerRank"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/HackerRank.png" width="15" height="15"> HackerRank </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/10%5D.%20HackerRank/1%5D.%20Prepare"> 1️⃣Prepare </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/10%5D.%20HackerRank/2%5D.%20Compete"> 2️⃣Compete </a> </th> </tr> </tbody> <tbody> <tr> <th> 11. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/11%5D.%20HackerEarth"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/HackerEarth.png" width="15" height="15"> HackerEarth </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/11%5D.%20HackerEarth/1%5D.%20Practice"> 1️⃣Practice </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/11%5D.%20HackerEarth/2%5D.%20Compete"> 2️⃣Compete </a> </th> </tr> </tbody> <tbody> <tr> <th> 12. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/12%5D.%20CodeChef"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/CodeChef.png" width="15" height="15"> CodeChef </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/12%5D.%20CodeChef/1%5D.%20Learn"> 1️⃣Learn </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/12%5D.%20CodeChef/2%5D.%20Practice"> 2️⃣Practice </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/12%5D.%20CodeChef/3%5D.%20Compete"> 3️⃣Compete </a> </th> </tr> </tbody> <tbody> <tr> <th> 13. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/13%5D.%20CodeForces"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/CodeForces.png" width="15" height="15"> CodeForces </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/13%5D.%20CodeForces/1%5D.%20Problem%20Set"> 1️⃣Problem Set </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/13%5D.%20CodeForces/2%5D.%20Contests"> 2️⃣Contests </a> </th> </tr> </tbody> <tbody> <tr> <th> 14. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/14%5D.%20AtCoder"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/AtCoder.png" width="15" height="15"> AtCoder </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/14%5D.%20AtCoder/Contest"> 1️⃣Contest </a> </th> </tr> </tbody> <tbody> <tr> <th> 15. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/15%5D.%20Sphere%20Online%20Judge%20(SPOJ)"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/spoj.png" width="15" height="15"> Sphere Online Judge (SPOJ) </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/15%5D.%20Sphere%20Online%20Judge%20(SPOJ)/1%5D.%20Problems"> 1️⃣Problems </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/15%5D.%20Sphere%20Online%20Judge%20(SPOJ)/2%5D.%20Contests"> 2️⃣Contests </a> </th> </tr> </tbody> <tbody> <tr> <th> 16. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/16%5D.%20LightOJ"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/lightoj.png" width="15" height="15"> LightOJ </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/16%5D.%20LightOJ/1%5D.%20Problems"> 1️⃣Problems </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/16%5D.%20LightOJ/2%5D.%20Compete"> 2️⃣Compete </a> </th> </tr> </tbody> <tbody> <tr> <th> 17. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/17%5D.%20Toph"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/toph.png" width="15" height="15"> Toph </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/17%5D.%20Toph/1%5D.%20Problems"> 1️⃣Problems </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/17%5D.%20Toph/2%5D.%20Contests"> 2️⃣Contests </a> </th> </tr> </tbody> <tbody> <tr> <th> 18. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/18%5D.%20Australian%20%20Maths%20Trust%20(AMT)"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/AMT.png" width="25" height="15"> Australian Maths Trust (AMT) </a> </th> <th align="left"> </th> </tr> </tbody> <tbody> <tr> <th> 19. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/19%5D.%20CSES"> <img src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Tech%20Tools/CSES.png" width="25" height="15"> CSES </a> </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/19%5D.%20CSES/1%5D.%20CSES%20Problem%20Set"> 1️⃣CSES Problem Set </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/19%5D.%20CSES/2%5D.%20BOI%20Contest%20Collection"> 2️⃣BOI Contest Collection </a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/1%5D.%20DSA%20%2B%20CP/2%5D.%20Competitive%20Programming/19%5D.%20CSES/3%5D.%20CEOI%20Contest%20Collection"> 3️⃣CEOI Contest Collection </a> </th> </tr> </tbody> </table> </th> </tr> </tbody> </table> </td> <td valign="top"> <table border="5"> <thead> <tr> <th> SNo. </th> <th> Contents </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/2%5D.%20Technical%20Subjects/0%5D.%20Object%20Oriented%20Programming%20(OOP)"> OOP </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/2%5D.%20Technical%20Subjects/1%5D.%20Operating%20System%20(OS)"> OS </a> </th> </tr> </tbody> <tbody> <tr> <th> 3. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/2%5D.%20Technical%20Subjects/2%5D.%20Database%20Management%20System%20(DBMS)"> DBMS </a> </th> </tr> </tbody> <tbody> <tr> <th> 4. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/2%5D.%20Technical%20Subjects/3%5D.%20Structured%20Query%20Language%20(SQL)"> SQL </a> </th> </tr> </tbody> <tbody> <tr> <th> 5. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/2%5D.%20Technical%20Subjects/4%5D.%20Computer%20Network%20(CN)"> CN </a> </th> </tr> </tbody> </table> </td> <td valign="top"> <table border="5"> <thead> <tr> <th> SNo. </th> <th> Contents </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/3%5D.%20System%20Design/01%5D.%20Low%20Level%20Design"> Low Level Design </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/3%5D.%20System%20Design/02%5D.%20High%20Level%20Design"> High Level Design </a> </th> </tr> </tbody> </table> </td> <td valign="top"> <table border="5"> <thead> <tr> <th> SNo. </th> <th> Contents </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/4%5D.%20Projects/Blockchain%20Development"> Blockchain Development </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/4%5D.%20Projects/Data%20Science"> Data Science </a> </th> </tr> </tbody> <tbody> <tr> <th> 3. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/4%5D.%20Projects/Internet%20of%20Things%20(IOT)"> Internet of Things (IOT) </a> </th> </tr> </tbody> <tbody> <tr> <th> 4. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/4%5D.%20Projects/Web%20Development"> Web Development </a> </th> </tr> </tbody> <tbody> <tr> <th> 5. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/4%5D.%20Projects/Mobile%20Development"> Mobile Development </a> </th> </tr> </tbody> <tbody> <tr> <th> 6. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/tree/master/4%5D.%20Projects/Desktop%20Development"> Desktop Development </a> </th> </tr> </tbody> </table> </td> <td valign="top"> <table border="5"> <thead> <tr> <th> SNo. </th> <th> Contents </th> <th> Sub-Contents </th> </tr> </thead> <tbody> <tr> <th valign="top"> 1. </th> <th align="left" valign="top"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/5%5D.%20Important%20Books%20and%20Resources/Important_Books_Link.md"> 📚Important Books </a> </th> <th> <table border="3"> <thead> <tr> <th> SNo. </th> <th> Topics </th> <th> Sub-Topics </th> </tr> </thead> <tbody> <tr> <th valign="top"> 1. </th> <th align="left" valign="top"> 📘Aptitude + Puzzles </th> <th align="left"> 📒Aptitude <table> <td align="center"> <a href="https://amzn.to/3GDDG9H" target="_blank"> <img src="https://m.media-amazon.com/images/W/WEBP_402378-T1/images/I/510vx4eIUoL._SX198_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/> <br> _{<b>Quantitative Aptitude - <br> Dr. R S Aggarwal</b>} </a><br /> </td> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 2. </th> <th align="left" valign="top"> 📘Programming Languages </th> <th align="left"> 📒C & C++ Language <table> <td align="center"> <a href="https://amzn.to/3CMf51r" target="_blank"> <img src="https://m.media-amazon.com/images/I/41a4CcXfN4L._SY264_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/> <br> _{<b>Let Us C</b>} </a><br /> </td> <td align="center"> <a href="https://amzn.to/3CMfaCh" target="_blank"> <img src="https://m.media-amazon.com/images/I/51BFuRUjSWL._SY264_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/> <br> _{<b>C in Depth</b>} </a><br /> </td> <tr> <td align="center"> <a href="https://amzn.to/3kfkh7w" target="_blank"> <img src="https://m.media-amazon.com/images/I/51YkwADIq5L._SY264_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/> <br> _{<b>Let Us C++</b>} </a><br /> </td> <td align="center"> <a href="https://amzn.to/3XeVS0G" target="_blank"> <img src="https://m.media-amazon.com/images/I/51Uqe5PHbML._SX381_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>The Complete Reference <br> C++</b>} </a><br /> </td> </table> 📒Python Language <table> <td align="center"> <a href="https://amzn.to/3ZBGNrp" target="_blank"> <img src="https://m.media-amazon.com/images/I/51Ss-7j3v5L._SX362_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Core Python</b>} </a><br /> </td> </table> 📒Java Language <table> <td align="center"> <a href="https://amzn.to/3ZCI8yk" target="_blank"> <img src="https://m.media-amazon.com/images/I/51z+MsmqesL._SX258_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Core Java</b>} </a><br /> </td> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 3. </th> <th align="left" valign="top"> 📘DSA <hr> 📘CP <hr> 📘Coding Interviews </th> <th align="left"> 📒Data Structures <table> <td align="center"> <a href="https://amzn.to/3khiOO8" target="_blank"> <img src="https://m.media-amazon.com/images/I/417ExARdRYL._SX384_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Data Structures <br> and Algorithms <br> Made Easy</b>} </a><br /> </td> <td align="center"> <a href="https://amzn.to/3QGs0HL" target="_blank"> <img src="https://m.media-amazon.com/images/I/41fWWCgWk6L._SX384_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Data Structures <br> and Algorithms <br> Thinking with Python</b>} </a><br /> </td> </table> 📒Algorithms <table> <td align="center"> <a href="https://amzn.to/3kitQTm" target="_blank"> <img src="https://m.media-amazon.com/images/I/513P8XoCAEL._SX376_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Introduction to Algorithms</b>} </a><br /> </td> <td align="center"> <a href="https://amzn.to/3XwQXro" target="_blank"> <img src="https://m.media-amazon.com/images/I/41-RWwEls6L._SX400_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Algorithms</b>} </a><br /> </td> </table> <hr> 📒Competitive Programming <table> <td align="center"> <a href="https://amzn.to/3ZDtJle" target="_blank"> <img src="https://m.media-amazon.com/images/I/41iVz+I5jOL._SY344_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Guide to <br> Competitive Programming</b>} </a><br /> </td> </table> <hr> 📒Coding Interviews <table> <td align="center"> <a href="https://amzn.to/3kieVsf" target="_blank"> <img src="https://m.media-amazon.com/images/I/41oYsXjLvZL._SY291_BO1,204,203,200_QL40_FMwebp_.jpg" width="100;" alt=""/> <br> _{<b>Cracking the Coding Interview</b>} </a><br /> </td> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 4. </th> <th align="left" valign="top"> 📘Technical Subject </th> <th align="left"> 📒Object Oriented Programming (OOP) <table> <td align="center"> <a href="https://amzn.to/3GJECJI" target="_blank"> <img src="https://m.media-amazon.com/images/I/51N4A59EAiL.jpg" width="100" alt=""/> <br> _{<b>Object Oriented Programming <br> with C++ <br> E Balagurusamy</b>} </a><br /> </td> </table> 📒Operating System (OS) <table> <td align="center"> <a href="https://amzn.to/3w15IXN" target="_blank"> <img src="https://m.media-amazon.com/images/I/51Qy2upM+aL._SY344_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Operating System</b>} </a><br /> </td> </table> 📒Database Management System (DBMS) <table> <td align="center"> <a href="https://amzn.to/3GG6Gh5" target="_blank"> <img src="https://m.media-amazon.com/images/I/51cq3aAdqNL._SX198_BO1,204,203,200_QL40_FMwebp_.jpg" width="100" alt=""/> <br> _{<b>Database Management System</b>} </a><br /> </td> </table> 📒Computer Network (CN) <table> <td align="center"> <a href="https://amzn.to/3H3L27N" target="_blank"> <img src="https://m.media-amazon.com/images/I/51vT3X2tdtL._SX409_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>Computer Network</b>} </a><br /> </td> </table> 📒System Design <table> <td align="center"> <a href="https://amzn.to/3COeqws" target="_blank"> <img src="https://m.media-amazon.com/images/I/4129HxbBnOL._SX331_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>System Design - Volume 1</b>} </a><br /> </td> <td align="center"> <a href="https://amzn.to/3CIJk9x" target="_blank"> <img src="https://m.media-amazon.com/images/I/31wqdTUjz2L._SX348_BO1,204,203,200_.jpg" width="100" alt=""/> <br> _{<b>System Design - Volume 2</b>} </a><br /> </td> </table> </th> </tr> </tbody> </table> </th> </tr> </tbody> <tbody> <tr> <th valign="top"> 2. </th> <th align="left" valign="top"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/5%5D.%20Important%20Books%20and%20Resources/Readme.md"> 📓Learning Resources </a> </th> <th> <a href="https://bit.ly/3FvaHo9" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/images/codestudio-1.png" width="300px" height="80px" /></a> <br><img src="https://readme-typing-svg.herokuapp.com?font=Impact&center=true&color=F78D1AFF&size=50&width=420&height=80&lines=Learning+Resources" /> <table border="3"> <thead> <tr> <th> SNo. </th> <th> Topics </th> <th> Sub-Topics </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> 📘Aptitude + Puzzle </th> <th align="left"> <a href="https://www.codingninjas.com/codestudio/guided-paths/aptitude-preparation"> 1️⃣Aptitude </a> <br> <a href="https://www.codingninjas.com/codestudio/guided-paths/top-150-interview-puzzles"> 2️⃣Puzzle </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> 📘Languages </th> <th align="left"> <a href="https://bit.ly/3YtE9n1"> 1️⃣C++ </a> <br> <a href="https://bit.ly/3V3lgnW"> 2️⃣Python </a> <br> <a href="https://bit.ly/3FX11Eb">3️⃣Java </a> </th> </tr> </tbody> <tbody> <tr> <th> 3. </th> <th align="left"> 📘DSA + CP <hr> 📘Top Problem Lists </th> <th align="left"> <a href="https://bit.ly/3V5h7Qx"> 1️⃣Data Structures and Algorithms </a> <br> <a href="https://www.codingninjas.com/codestudio/guided-paths/competitive-programming"> 2️⃣Competitive Programming </a> <hr> <a href="https://bit.ly/3hu7GfF"> 1️⃣Striver SDE Sheet </a> <br> <a href="https://bit.ly/3uTFyFM"> 2️⃣Love Babbar DSA Sheet </a> </th> </tr> </tbody> <tbody> <tr> <th> 4. </th> <th align="left"> 📘Technical Subject </th> <th align="left"> <a href="https://bit.ly/3HKNaSK"> 1️⃣Operating System </a> <br> <a href="https://bit.ly/3FX5k2e"> 2️⃣Database Management System </a> <br> <a href="https://bit.ly/3BHlNFv"> 3️⃣Computer Networks </a> <br> <a href="https://bit.ly/3WrQgzn">4️⃣ Object Oriented Programming in C++ </a> <br>&emsp; <a href="https://www.codingninjas.com/codestudio/guided-paths/oops-in-python"> 4️⃣🅰️Object Oriented Programming in Python </a> <br>&emsp; <a href="https://www.codingninjas.com/codestudio/guided-paths/oops-in-java"> 4️⃣🅱️Object Oriented Programming in Java </a> <br> <a href="https://www.codingninjas.com/codestudio/guided-paths/system-design"> 5️⃣System Design </a> </th> </tr> </tbody> </table> <br> <a href="https://www.geeksforgeeks.org" target="_blank"><img align="center" src="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/images/GFG-1.png" width="300px" height="50px" /></a> <br><img src="https://readme-typing-svg.herokuapp.com?font=Impact&center=true&color=308D46&size=50&width=420&height=80&lines=Learning+Resources" /> <table border="3"> <thead> <tr> <th> SNo. </th> <th> Topics </th> <th> Sub-Topics </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> 📘Aptitude + Puzzles </th> <th align="left"> <a href="https://www.geeksforgeeks.org/aptitude-gq"> 1️⃣Aptitude </a> <br> <a href="https://www.geeksforgeeks.org/puzzles"> 2️⃣Puzzle </a> </th> </tr> </tbody> <tbody> <tr> <th> 2. </th> <th align="left"> 📘Languages </th> <th align="left"> <a href="https://www.geeksforgeeks.org/c-plus-plus"> 1️⃣C++ </a> <br> <a href="https://www.geeksforgeeks.org/python-programming-language"> 2️⃣Python </a> <br> <a href="https://www.geeksforgeeks.org/java"> 3️⃣Java </a> </th> </tr> </tbody> <tbody> <tr> <th> 3. </th> <th align="left"> 📘DSA + CP <hr> 📘Top Problem Lists </th> <th align="left"> <a href="https://www.geeksforgeeks.org/data-structures"> 1️⃣Data Structures </a> <br> <a href="https://www.geeksforgeeks.org/fundamentals-of-algorithms"> 2️⃣Algorithms </a> <br> <a href="https://www.geeksforgeeks.org/competitive-programming-a-complete-guide"> 3️⃣Competitive Programming </a> <hr> <a href="https://www.geeksforgeeks.org/sde-sheet-a-complete-guide-for-sde-preparation">1️⃣GFG SDE Sheet </a> <br>&emsp; <a href="https://www.geeksforgeeks.org/facebookmeta-sde-sheet-interview-questions-and-answers"> 🔵Facebook(Meta) SDE Sheet </a> <br>&emsp; <a href="https://www.geeksforgeeks.org/amazon-sde-sheet-interview-questions-and-answers"> 🟠Amazon SDE Sheet </a> <br>&emsp; <a href="https://www.geeksforgeeks.org/apple-sde-sheet-interview-questions-and-answers"> ⚫Apple SDE Sheet </a> <br>&emsp; <a href="https://www.geeksforgeeks.org/netflix-sde-sheet-interview-questions-and-answers"> 🔴Netflix SDE Sheet </a> <br>&emsp; <a href="https://www.geeksforgeeks.org/google-sde-sheet-interview-questions-and-answers"> 🟢Google SDE Sheet </a> <br> <a href="https://www.geeksforgeeks.org/dsa-sheet-by-love-babbar"> 2️⃣Love Babbar DSA Sheet </a> </th> </tr> </tbody> <tbody> <tr> <th> 4. </th> <th align="left"> 📘Technical Subject </th> <th align="left"> <a href="https://www.geeksforgeeks.org/operating-systems"> 1️⃣Operating System </a> <br> <a href="https://www.geeksforgeeks.org/dbms"> 2️⃣Database Management System </a> <br> <a href="https://www.geeksforgeeks.org/computer-network-tutorials"> 3️⃣Computer Networks </a> <br> <a href="https://www.geeksforgeeks.org/system-design-tutorial"> 4️⃣System Design </a> <br>&emsp; <a href="https://www.geeksforgeeks.org/software-design-patterns"> 4️⃣🅰️Software Design Patterns </a> </th> </tr> </tbody> <tbody> <tr> <th> 5. </th> <th align="left"> 📘Projects </th> <th align="left"> <a href="https://www.geeksforgeeks.org/computer-science-projects"> 1️⃣Computer Science Projects </a> </th> </tr> </tbody> </table> </th> </tr> </tbody> </table> </td> <td valign="top"> <table border="5"> <thead> <tr> <th> SNo. </th> <th> Contents </th> </tr> </thead> <tbody> <tr> <th> 1. </th> <th align="left"> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/6%5D.%20Behavioural%20Interview/behavioural-interview-ques.md"> Behavioural Interview Questions </a> </th> </tr> </tbody> </table> </td> </tr> </tbody> </table> </br> ## 🏆 `Project Admin` | <a href="https://github.com/AkashSingh3031"><img src="https://avatars.githubusercontent.com/u/60146338?s=400&u=0efcf847bb1584e6653c26096e9855ed09d2a5ad&v=4" width=200px height=200px /></a> | | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | **[Akash Singh](https://prepverse.github.io/)** <br><br> <a href="https://wa.me/919794423031"><img src="https://img.shields.io/badge/-WhatsApp-075E54?style=flat&amp;labelColor=white&amp;logo=whatsapp&amp;logoColor=075E54"></a> <a href="https://t.me/akashsingh3031"><img src="https://img.shields.io/badge/-Telegram-1ca0f1?style=flat&amp;labelColor=white&amp;logo=telegram&amp;logoColor=1ca0f1"></a> <br> <a href="https://www.linkedin.com/in/akashsingh3031/"><img src="https://img.shields.io/badge/-Linkedin-0e76a8?style=flat&amp;labelColor=white&amp;logo=linkedin&amp;logoColor=0e76a8"></a> <a href="https://www.facebook.com/akashsingh3031"><img src="https://img.shields.io/badge/-Facebook-4267B2?style=flat&amp;labelColor=white&amp;logo=facebook&amp;logoColor=4267B2"></a> <br> <a href="https://www.instagram.com/akash.singh3031"><img src="https://img.shields.io/badge/-Instagram-E1306C?style=flat&amp;labelColor=FCAF45&amp;logo=instagram&amp;logoColor=FD1D1D"></a> <a href="https://twitter.com/akashsingh3031"><img src="https://img.shields.io/badge/-Twitter-1DA1F2?style=flat&amp;labelColor=white&amp;logo=twitter&amp;logoColor=1DA1F2"></a> | ## `Awesome Contributors` ✨🎉 `81` Thanks goes to these **Wonderful People** 👨🏻‍💻: <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <!-- 1st Row --> <tr> <td align="center"><a href="https://github.com/AkashSingh3031"><img src="https://avatars.githubusercontent.com/u/60146338?s=400&u=0efcf847bb1584e6653c26096e9855ed09d2a5ad&v=4" width="100px;" alt=""/><br />_{<b>AkashSingh3031</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation" title="Project Management">📆</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=AkashSingh3031" title="Commits">✍️</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a> <br> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation" title="Design">🎨</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation" title="Code">👨🏻‍💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation" title="Document">📓</a></td> <td align="center"><a href="https://github.com/Anuradha0501"><img src="https://avatars.githubusercontent.com/u/71958796?v=4" width="100px;" alt=""/><br />_{<b>Anuradha0501</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Anuradha0501" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/RishikaGhosh"><img src="https://avatars.githubusercontent.com/u/58912231?v=4" width="100px;" alt=""/><br />_{<b>RishikaGhosh</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=RishikaGhosh" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/thecoder8890"><img src="https://avatars.githubusercontent.com/u/33773206?v=4" width="100px;" alt=""/><br />_{<b>thecoder8890</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=thecoder8890" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Ash515"><img src="https://avatars.githubusercontent.com/u/53136674?v=4" width="100px;" alt=""/><br />_{<b>Ash515</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Ash515" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/fame2105"><img src="https://avatars.githubusercontent.com/u/6636804?v=4" width="100px;" alt=""/><br />_{<b>fame2105</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=fame2105" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 2nd Row --> <tr> <td align="center"><a href="https://github.com/vkhurana25"><img src="https://avatars.githubusercontent.com/u/64976194?v=4" width="100px;" alt=""/><br />_{<b>vkhurana25</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=vkhurana25" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/RAUNAK-PANDEY"><img src="https://avatars.githubusercontent.com/u/65064180?v=4" width="100px;" alt=""/><br />_{<b>RAUNAK-PANDEY</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=RAUNAK-PANDEY" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/codeaholic-shub"><img src="https://avatars.githubusercontent.com/u/65807708?v=4" width="100px;" alt=""/><br />_{<b>codeaholic-shub</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=codeaholic-shub" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/aroravansh"><img src="https://avatars.githubusercontent.com/u/44532230?v=4" width="100px;" alt=""/><br />_{<b>aroravansh</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=aroravansh" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/tanmayChakrawarty"><img src="https://avatars.githubusercontent.com/u/75254780?v=4" width="100px;" alt=""/><br />_{<b>tanmayChakrawarty</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=tanmayChakrawarty" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/onlykingKD"><img src="https://avatars.githubusercontent.com/u/55577276?v=4" width="100px;" alt=""/><br />_{<b>onlykingKD</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=onlykingKD" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 3rd Row --> <tr> <td align="center"><a href="https://github.com/parajshah"><img src="https://avatars.githubusercontent.com/u/65371747?v=4" width="100px;" alt=""/><br />_{<b>parajshah</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=parajshah" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Pranjal-bisht"><img src="https://avatars.githubusercontent.com/u/58468853?v=4" width="100px;" alt=""/><br />_{<b>Pranjal-bisht</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Pranjal-bisht" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/SanandhKumar02"><img src="https://avatars.githubusercontent.com/u/72318041?v=4" width="100px;" alt=""/><br />_{<b>SanandhKumar02</b>}</a><br /></td> <td align="center"><a href="https://github.com/sainikhil1605"><img src="https://avatars.githubusercontent.com/u/35322884?v=4" width="100px;" alt=""/><br />_{<b>sainikhil1605</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=sainikhil1605" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/work-mohit"><img src="https://avatars.githubusercontent.com/u/46566524?v=4" width="100px;" alt=""/><br />_{<b>work-mohit</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=work-mohit" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Ayush7614"><img src="https://avatars.githubusercontent.com/u/67006255?v=4" width="100px;" alt=""/><br />_{<b>Ayush7614</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Ayush7614" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 4th Row --> <tr> <td align="center"><a href="https://github.com/sayeedajmal"><img src="https://avatars.githubusercontent.com/u/76242275?v=4" width="100px;" alt=""/><br />_{<b>sayeedajmal</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=sayeedajmal" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Wenodh"><img src="https://avatars.githubusercontent.com/u/63317955?v=4" width="100px;" alt=""/><br />_{<b>Wenodh</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Wenodh" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/devraj4522"><img src="https://avatars.githubusercontent.com/u/55313450?v=4" width="100px;" alt=""/><br />_{<b>devraj4522</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=devraj4522" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/RounakNeogy"><img src="https://avatars.githubusercontent.com/u/56738141?v=4" width="100px;" alt=""/><br />_{<b>RounakNeogy</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=RounakNeogy" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/ashwin3082002"><img src="https://avatars.githubusercontent.com/u/73417773?v=4" width="100px;" alt=""/><br />_{<b>ashwin3082002</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=ashwin3082002" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/VishnuSastryHK"><img src="https://avatars.githubusercontent.com/u/42547521?v=4" width="100px;" alt=""/><br />_{<b>VishnuSastryHK</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=VishnuSastryHK" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 5th Row --> <tr> <td align="center"><a href="https://github.com/muhiqsimui"><img src="https://avatars.githubusercontent.com/u/33776809?v=4" width="100px;" alt=""/><br />_{<b>muhiqsimui</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=muhiqsimui" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/adityagi02"><img src="https://avatars.githubusercontent.com/u/77538183?v=4" width="100px;" alt=""/><br />_{<b>adityagi02</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=adityagi02" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Satyamchaubey07"><img src="https://avatars.githubusercontent.com/u/55735057?v=4" width="100px;" alt=""/><br />_{<b>Satyamchaubey07</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Satyamchaubey07" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/vedudx"><img src="https://avatars.githubusercontent.com/u/53002423?v=4" width="100px;" alt=""/><br />_{<b>vedudx</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=vedudx" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/sheetalneeraj"><img src="https://avatars.githubusercontent.com/u/42382485?v=4" width="100px;" alt=""/><br />_{<b>sheetalneeraj</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=sheetalneeraj" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/amandewatnitrr"><img src="https://avatars.githubusercontent.com/u/52046981?v=4" width="100px;" alt=""/><br />_{<b>amandewatnitrr</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=amandewatnitrr" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 6th Row --> <tr> <td align="center"><a href="https://github.com/samnoon1971"><img src="https://avatars.githubusercontent.com/u/36998653?v=4" width="100px;" alt=""/><br />_{<b>samnoon1971</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=samnoon1971" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/draciel58"><img src="https://avatars.githubusercontent.com/u/58848892?v=4" width="100px;" alt=""/><br />_{<b>draciel58</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=draciel58" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/GJuceviciute"><img src="https://avatars.githubusercontent.com/u/57292801?v=4" width="100px;" alt=""/><br />_{<b>GJuceviciute</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=GJuceviciute" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Sukhendra523"><img src="https://avatars.githubusercontent.com/u/44740202?v=4" width="100px;" alt=""/><br />_{<b>Sukhendra523</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Sukhendra523" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Ranjul-Arumadi"><img src="https://avatars.githubusercontent.com/u/54582161?v=4" width="100px;" alt=""/><br />_{<b>Ranjul-Arumadi</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Ranjul-Arumadi" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/GouravRusiya30"><img src="https://avatars.githubusercontent.com/u/13219295?v=4" width="100px;" alt=""/><br />_{<b>GouravRusiya30</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=GouravRusiya30" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 7th Row --> <tr> <td align="center"><a href="https://github.com/Akashkhandelwal191"><img src="https://avatars.githubusercontent.com/u/67469131?v=4" width="100px;" alt=""/><br />_{<b>Akashkhandelwal191</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Akashkhandelwal191" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/RahulSurana123"><img src="https://avatars.githubusercontent.com/u/35515322?v=4" width="100px;" alt=""/><br />_{<b>RahulSurana123</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=RahulSurana123" title="Commits">💻</a></td> <td align="center"><a href="https://github.com/imsoumen"><img src="https://avatars.githubusercontent.com/u/43337272?v=4" width="100px;" alt=""/><br />_{<b>imsoumen</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=imsoumen" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/thisisbillall"><img src="https://avatars.githubusercontent.com/u/74954492?v=4" width="100px;" alt=""/><br />_{<b>thisisbillall</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=thisisbillall" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/nixmaldonado"><img src="https://avatars.githubusercontent.com/u/8680692?v=4" width="100px;" alt=""/><br />_{<b>nixmaldonado</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=nixmaldonado" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/thefool76"><img src="https://avatars.githubusercontent.com/u/69065938?v=4" width="100px;" alt=""/><br />_{<b>thefool76</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=thefool76" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 8th Row --> <tr> <td align="center"><a href="https://github.com/suniti0804"><img src="https://avatars.githubusercontent.com/u/72435330?v=4" width="100px;" alt=""/><br />_{<b>suniti0804</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=suniti0804" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/harish3124"><img src="https://avatars.githubusercontent.com/u/66413502?v=4" width="100px;" alt=""/><br />_{<b>harish3124</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=harish3124" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/poojitha2002"><img src="https://avatars.githubusercontent.com/u/58463372?v=4" width="100px;" alt=""/><br />_{<b>poojitha2002</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=poojitha2002" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/vk-2501"><img src="https://avatars.githubusercontent.com/u/73028420?v=4" width="100px;" alt=""/><br />_{<b>vk-2501</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=vk-2501" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/mgazdovic"><img src="https://avatars.githubusercontent.com/u/62848619?v=4" width="100px;" alt=""/><br />_{<b>mgazdovic</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=mgazdovic" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Anshir08"><img src="https://avatars.githubusercontent.com/u/69457505?v=4" width="100px;" alt=""/><br />_{<b>Anshir08</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Anshir08" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 9th Row --> <tr> <td align="center"><a href="https://github.com/harshil202"><img src="https://avatars.githubusercontent.com/u/83488223?v=4" width="100px;" alt=""/><br />_{<b>harshil202</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=harshil202" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Rei-x"><img src="https://avatars.githubusercontent.com/u/38581479?v=4" width="100px;" alt=""/><br />_<b>Rei-x</b></a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Rei-x" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/maanasvi999"><img src="https://avatars.githubusercontent.com/u/51221086?v=4" width="100px;" alt=""/><br />_{<b>maanasvi999</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=maanasvi999" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/mansijain980"><img src="https://avatars.githubusercontent.com/u/63226239?v=4" width="100px;" alt=""/><br />_{<b>mansijain980</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=mansijain980" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/tanyagupta0201"><img src="https://avatars.githubusercontent.com/u/66638392?v=4" width="100px;" alt=""/><br />_{<b>tanyagupta0201</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=tanyagupta0201" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/saikrithik"><img src="https://avatars.githubusercontent.com/u/55931692?v=4" width="100px;" alt=""/><br />_{<b>saikrithik</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=saikrithik" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 10th Row --> <tr> <td align="center"><a href="https://github.com/ankit200490"><img src="https://avatars.githubusercontent.com/u/4373228?v=4" width="100px;" alt=""/><br />_{<b>ankit200490</b>}</a><br /></td> <td align="center"><a href="https://github.com/Sumit4482"><img src="https://avatars.githubusercontent.com/u/61246873?v=4" width="100px;" alt=""/><br />_{<b>Sumit4482</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Sumit4482" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/GSAUC3"><img src="https://avatars.githubusercontent.com/u/55054089?v=4" width="100px;" alt=""/><br />_{<b>GSAUC3</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=GSAUC3" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/iamsinghashutosh"><img src="https://avatars.githubusercontent.com/u/44143541?v=4" width="100px;" alt=""/><br />_{<b>iamsinghashutosh</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=iamsinghashutosh" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Uchiha-Itachi0"><img src="https://avatars.githubusercontent.com/u/86482181?v=4" width="100px;" alt=""/><br />_{<b>Uchiha-Itachi0</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Uchiha-Itachi0" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/yan-michael"><img src="https://avatars.githubusercontent.com/u/15942983?v=4" width="100px;" alt=""/><br />_{<b>yan-michael</b>}</a><br /></td> <!-- 11th Row --> <tr> <td align="center"><a href="https://github.com/abhistark007"><img src="https://avatars.githubusercontent.com/u/58290134?v=4" width="100px;" alt=""/><br />_{<b>abhistark007</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=abhistark007" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/xor09"><img src="https://avatars.githubusercontent.com/u/70262740?v=4" width="100px;" alt=""/><br />_<b>xor09</b></a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=xor09" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/avnoor-488"><img src="https://avatars.githubusercontent.com/u/54592053?v=4" width="100px;" alt=""/><br />_{<b>avnoor-488</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=avnoor-488" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/VishnuVVR-369"><img src="https://avatars.githubusercontent.com/u/86388801?v=4" width="100px;" alt=""/><br />_{<b>VishnuVVR-369</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=VishnuVVR-369" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/oguilhermefigueiredo"><img src="https://avatars.githubusercontent.com/u/97318219?v=4" width="100px;" alt=""/><br />_{<b>oguilhermefigueiredo</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=oguilhermefigueiredo" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/gcnit"><img src="https://avatars.githubusercontent.com/u/4833751?v=4" width="100px;" alt=""/><br />_<b>gcnit</b></a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=gcnit" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 12th Row --> <tr> <td align="center"><a href="https://github.com/Yasien99"><img src="https://avatars.githubusercontent.com/u/55417069?v=4" width="100px;" alt=""/><br />_{<b>Yasien99</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Yasien99" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/ginny100"><img src="https://avatars.githubusercontent.com/u/58489398?v=4" width="100px;" alt=""/><br />_{<b>ginny100</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=ginny100" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/galin-chung-nguyen"><img src="https://avatars.githubusercontent.com/u/19767623?v=4" width="100px;" alt=""/><br />_{<b>galin-chung-nguyen</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=galin-chung-nguyen" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Phoenix-92"><img src="https://avatars.githubusercontent.com/u/102870015?v=4" width="100px;" alt=""/><br />_{<b>Phoenix-92</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Phoenix-92" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/edo-ce"><img src="https://avatars.githubusercontent.com/u/72577095?v=4" width="100px;" alt=""/><br />_{<b>edo-ce</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=edo-ce" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/nixrajput"><img src="https://avatars.githubusercontent.com/u/10887215?v=4" width="100px;" alt=""/><br />_{<b>nixrajput</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=nixrajput" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 13th Row --> <tr> <td align="center"><a href="https://github.com/anmolp476"><img src="https://avatars.githubusercontent.com/u/99687931?v=4" width="100px;" alt=""/><br />_{<b>anmolp476</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=anmolp476" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Vaishnaviamirayada"><img src="https://avatars.githubusercontent.com/u/108050528?v=4" width="100px;" alt=""/><br />_{<b>Vaishnaviamirayada</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Vaishnaviamirayada" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Mist57"><img src="https://avatars.githubusercontent.com/u/89301994?v=4" width="100px;" alt=""/><br />_{<b>Mist57</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Mist57" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/saurabh200014"><img src="https://avatars.githubusercontent.com/u/68815222?v=4" width="100px;" alt=""/><br />_{<b>saurabh200014</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=saurabh200014" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/chandru1003"><img src="https://avatars.githubusercontent.com/u/55582956?v=4" width="100px;" alt=""/><br />_{<b>chandru1003</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=chandru1003" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/csi-Abil"><img src="https://avatars.githubusercontent.com/u/101435994?v=4" width="100px;" alt=""/><br />_{<b>csi-Abil</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=csi-Abil" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <!-- 14th Row --> <tr> <td align="center"><a href="https://github.com/shubhanshurav"><img src="https://avatars.githubusercontent.com/u/87806305?v=4" width="100px;" alt=""/><br />_{<b>shubhanshurav</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=shubhanshurav" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/Pratyush0612"><img src="https://avatars.githubusercontent.com/u/86615560?v=4" width="100px;" alt=""/><br />_{<b>Pratyush0612</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=Pratyush0612" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> <td align="center"><a href="https://github.com/nisabmohd"><img src="https://avatars.githubusercontent.com/u/76525761?v=4" width="100px;" alt=""/><br />_{<b>nisabmohd</b>}</a><br /><a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/commits?author=nisabmohd" title="Commits">💻</a> <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/graphs/contributors" title="Contribution Graph">📊</a></td> </table> ## `Contributing` <img align="center" src="https://github.com/AkashSingh3031/AkashSingh3031/blob/main/images/Handshake.gif" height="30px"> We'd love your contributions! Kindly follow the steps below to get started: 0. Star <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation" title="this">this</a> repository. 1. Fork <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation" title="this">this</a> repository. 2. Clone the forked repository. ```css git clone https://github.com/<your-github-username>/The-Complete-FAANG-Preparation ``` 3. Navigate to the project directory. ```py cd The-Complete-FAANG-Preparation ``` 4. Create a new branch. ```css git checkout -b <your_branch_name> ``` 5. Make changes. 6. Stage your changes and commit ```css git add -A git commit -m "<your_commit_message>" ``` 7. Push your local commits to the remote repo. ```css git push -u origin <your_branch_name> ``` 8. Create a <a href="https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request" title="Pull Request">Pull-Request</a> to `develop` ! 9. Congratulations! 🎉 Sit and relax, you've made your contribution to <a href="https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation" title="The-Complete-FAANG-Preparation">The Complete FAANG Preparation</a>. ✌️ ❤️ 💥 --- ## `Stargazers Over Time 📊📈` <table> <td> <a href="https://starchart.cc/AkashSingh3031/The-Complete-FAANG-Preparation"><img src="https://starchart.cc/AkashSingh3031/The-Complete-FAANG-Preparation.svg" width="100%" height="100%"></a> </td> <tr> <td> <a href="https://star-history.com/#AkashSingh3031/The-Complete-FAANG-Preparation&Timeline"><img src="https://api.star-history.com/svg?repos=AkashSingh3031/The-Complete-FAANG-Preparation&type=Timeline" width="100%" height="100%"></a> </td> </table> <!-- [](https://starchart.cc/AkashSingh3031/The-Complete-FAANG-Preparation) --> ## [`MIT LICENSE 📜`](https://github.com/AkashSingh3031/The-Complete-FAANG-Preparation/blob/master/LICENSE) | Permissions | Limitations | Conditions | |-------------------|--------------|---------------------------------| | ✔ Commercial use | ❌ Liability | 🛈 License and copyright notice | | ✔ Modification | ❌ Warranty | | | ✔ Distribution | | | | ✔ Private use | | | > **Note** ```css MIT License Copyright (c) 2021 Akash Singh Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ```

The premiere source of truth powering network automation. Open source under Apache 2. Public demo: https://demo.netbox.dev

<div align="center"> <img src="https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg" width="400" alt="NetBox logo" /> The premiere source of truth powering network automation </div>  NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. Available as open source software under the Apache 2.0 license, NetBox serves as the cornerstone for network automation in thousands of organizations. * **Physical infrasucture:** Accurately model the physical world, from global regions down to individual racks of gear. Then connect everything - network, console, and power! * **Modern IPAM:** All the standard IPAM functionality you expect, plus VRF import/export tracking, VLAN management, and overlay support. * **Data circuits:** Confidently manage the delivery of crtical circuits from various service providers, modeled seamlessly alongside your own infrastructure. * **Power tracking:** Map the distribution of power from upstream sources to individual feeds and outlets. * **Organization:** Manage tenant and contact assignments natively. * **Powerful search:** Easily find anything you need using a single global search function. * **Comprehensive logging:** Leverage both automatic change logging and user-submitted journal entries to track your network's growth over time. * **Endless customization:** Custom fields, custom links, tags, export templates, custom validation, reports, scripts, and more! * **Flexible permissions:** An advanced permissions systems enables very flexible delegation of permissions. * **Integrations:** Easily connect NetBox to your other tooling via its REST & GraphQL APIs. * **Plugins:** Not finding what you need in the core application? Try one of many community plugins - or build your own!  ## Getting Started * Just want to explore? Check out [our public demo](https://demo.netbox.dev/) right now! * The [official documentation](https://docs.netbox.dev) offers a comprehensive introduction. * Choose your deployment: [self-hosted](https://github.com/netbox-community/netbox), [Docker](https://github.com/netbox-community/netbox-docker), or [NetBox Cloud](https://netboxlabs.com/netbox-cloud/). * Check out [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions) for even more projects to get the most out of NetBox! ## Get Involved * Follow [@NetBoxOfficial](https://twitter.com/NetBoxOfficial) on Twitter! * Join the conversation on [the discussion forum](https://github.com/netbox-community/netbox/discussions) and [Slack](https://netdev.chat/)! * Already a power user? You can [suggest a feature](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+feature&template=feature_request.yaml) or [report a bug](https://github.com/netbox-community/netbox/issues/new?assignees=&labels=type%3A+bug&template=bug_report.yaml) on GitHub. * Contributions from the community are encouraged and appreciated! Check out our [contributing guide](CONTRIBUTING.md) to get started. ## Project Stats <div align="center"> <a href="https://github.com/netbox-community/netbox/commits"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/31db894eee74b8a5475e3af307a81b6c_timeline.svg" alt="Timeline graph"></a> <a href="https://github.com/netbox-community/netbox/issues"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/31db894eee74b8a5475e3af307a81b6c_issues.svg" alt="Issues graph"></a> <a href="https://github.com/netbox-community/netbox/pulls"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/31db894eee74b8a5475e3af307a81b6c_prs.svg" alt="Pull requests graph"></a> <a href="https://github.com/netbox-community/netbox/graphs/contributors"><img src="https://images.repography.com/29023055/netbox-community/netbox/recent-activity/31db894eee74b8a5475e3af307a81b6c_users.svg" alt="Top contributors"></a> <br />Stats via <a href="https://repography.com">Repography</a> </div> ## Sponsors <div align="center"> [](https://netboxlabs.com) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [](https://try.digitalocean.com/developer-cloud) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [](https://ns1.com) <br /> [](https://sentry.io) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [](https://metal.equinix.com) </div> ## Screenshots    

An ongoing list of pandas quirks

# just-pandas-things This repo contains a few peculiar things I've learned about pandas that have made my life easier and my code faster. This post isn't a friendly tutorial for beginners, but a friendly introduction to pandas weirdness. ## What's in this repo? 1. pandas is column-major, which is why row-based operations are slow 2. `SettingWithCopyWarning`, or why we can't have nice things 3. Indexing and slicing 4. Accessors 5. Data exploration 6. Common pitfalls I'll continue updating this repo as I have more time. As I'm still learning pandas quirks, feedback is much appreciated. Thanks [Luke Metz](https://twitter.com/luke_metz), [Vikram Tiwari](https://twitter.com/Vikram_Tiwari), and [Karson Elmgren](https://karsonelmgren.com/) for reviewing!

Nginx UI allows you to access and modify the nginx configurations files without cli.

# nginx ui   Table of Contents - [nginx ui](#nginx-ui) - [Introduction](#introduction) - [Setup](#setup) - [Example](#example) - [Docker](#docker) - [UI](#ui) - [Authentication](#authentication) - [Configure the auth file](#configure-the-auth-file) - [Configure nginx](#configure-nginx) ## Introduction We use nginx in our company lab environment. It often happens that my colleagues have developed an application that is now deployed in our Stage or Prod environment. To make this application accessible nginx has to be adapted. Most of the time my colleagues don't have the permission to access the server and change the configuration files and since I don't feel like doing this for everyone anymore I thought a UI could help us all. If you feel the same way I wish you a lot of fun with the application and I am looking forward to your feedback, change requests or even a star. ## Setup Containerization is now state of the art and therefore the application is delivered in a container. ### Example - `-d` run as deamon in background - `--restart=always` restart on crash or server reboot - `--name nginxui` give the container a name - `-v /etc/nginx:/etc/nginx` map the hosts nginx directory into the container - `-p 8080:8080` map host port 8080 to docker container port 8080 ```bash docker run -d --restart=always --name nginxui -v /etc/nginx:/etc/nginx -p 8080:8080 schenkd/nginx-ui:latest ``` ### Docker Repository @ [DockerHub](https://hub.docker.com/r/schenkd/nginx-ui) Docker Compose excerpt ```yaml # Docker Compose excerpt services: nginx-ui: image: schenkd/nginx-ui:latest ports: - 8080:8080 volumes: - nginx:/etc/nginx ``` ## UI  With the menu item Main Config the Nginx specific configuration files can be extracted and updated. These are dynamically read from the Nginx directory. If a file has been added manually, it is immediately integrated into the Nginx UI Main Config menu item.  Adding a domain opens an exclusive editing window for the configuration file. This can be applied, deleted and enabled/disabled. ## Authentication [BasicAuth with nginx](https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-http-basic-authentication/) In general, this app does not come with authentication. However, it is easy to setup basic auth to restrict unwanted access. Here is how this can be done when using nginx. ### Configure the auth file 1. Verify that `apache2-utils` (Debian, Ubuntu) or `httpd-tools` (RHEL/CentOS/Oracle Linux) is installed 2. Run the htpasswd utility to create a new user and set a passwort. - Make sure, that the directory exists - Remove the `-c` flag, if you have created a user before, since it creates the inital user/passwort file - `sudo htpasswd -c /etc/apache2/.htpasswd user1` ### Configure nginx The following example adds basic auth to our nginxui app running in a docker container with a mapped port 8080. In this case, it will be accessible via nginx.mydomain.com ```none server { server_name nginx.mydomain.com; location / { proxy_pass http://127.0.0.1:8080/; } auth_basic "nginxui secured"; auth_basic_user_file /etc/apache2/.htpasswd; # [...] ommited ssl configuration } ``` 1. Add above nginx conf to your `/etc/nginx/my.conf` file 2. Run `nginx -t` to make sure, that your config is valid 3. Run `systemctl restart nginx` (or equivalent) to restart your nginx and apply the new settings 4. Your nginx ui is now accessible at nginx.mydomain.com and will correctly prompt for basic auth

General statistics, mathematical programming, and numerical/scientific computing scripts and notebooks in Python

# Statistics/ Mathematical Computing Notebooks Jupyter Notebooks on the topics of statistical analysis, mathematics, and numerical/sceintific computing (in Python). ### Please feel free to [connect with me on LinkedIn](https://www.linkedin.com/in/tirthajyoti-sarkar-2127aa7/) if you are interested in data science and like to connect. ---- ### Requirements * **Python 3.6+** * **NumPy (`$ pip install numpy`)** * **Pandas (`$ pip install pandas`)** * **Scikit-learn (`$ pip install scikit-learn`)** * **SciPy (`$ pip install scipy`)** * **Statsmodels (`$ pip install statsmodels`)** * **MatplotLib (`$ pip install matplotlib`)** * **Seaborn (`$ pip install seaborn`)** --- ### [Set Algebra basics](https://github.com/tirthajyoti/Stats-Maths-with-Python/blob/master/Set_Algebra_with_Python.ipynb)  ### [Permutations and Combinations](https://github.com/tirthajyoti/Stats-Maths-with-Python/blob/master/Permutations_and_Combinations.ipynb)  ### [Probability distributions (Discrete)](https://github.com/tirthajyoti/Stats-Maths-with-Python/blob/master/Prob_Distributions_Discrete.ipynb)  ### [Linear Regression Methods](https://github.com/tirthajyoti/Stats-Maths-with-Python/blob/master/Linear_Regression_Methods.ipynb)  ### [_R-style_ Statistical functions written using Python](https://github.com/tirthajyoti/Stats-Maths-with-Python/blob/master/R-style%20Functions.ipynb)  ### [Diagnostics of a linear regression problem](https://github.com/tirthajyoti/Stats-Maths-with-Python/blob/master/Regression_Diagnostics.ipynb) ### [Introduction to hypothesis testing](https://github.com/tirthajyoti/Stats-Maths-with-Python/blob/master/Intro_Hypothesis_Testing.ipynb) ## Articles Check out this article I wrote on Medium: ___[Essential Math for Data Science.](https://towardsdatascience.com/essential-math-for-data-science-why-and-how-e88271367fbd)___ Check out this article I wrote on Medium about ___["How to write your favorite R functions — in Python?"](https://towardsdatascience.com/how-to-write-your-favorite-r-functions-in-python-11e1e9c29089)___ Check out this article I wrote on Medium about ___["Mathematical programming — a key habit to build up for advancing in data science?"](https://towardsdatascience.com/mathematical-programming-a-key-habit-to-built-up-for-advancing-in-data-science-c6d5c29533be)___ Check out this article I wrote on Medium about ___["Bayes’ rule with a simple and practical example"](https://towardsdatascience.com/bayes-rule-with-a-simple-and-practical-example-2bce3d0f4ad0)___ Check out this article I wrote on Medium about ___["Statistical modeling with “Pomegranate” — fast and intuitive"](https://towardsdatascience.com/statistical-modeling-with-pomegranate-fast-and-intuitive-4d605d9c33a9)___

In this repository, I will share some useful notes and references about deploying deep learning-based models in production.

# Deep-Learning-in-Production In this repository, I will share some useful notes and references about deploying deep learning-based models in production. <p align="center"> <img src="./Final-Logo.jpg?raw=true" alt="Logo"/> </p> ## Convert PyTorch Models in Production: - [PyTorch Production Level Tutorials](https://pytorch.org/tutorials/#production-usage) [_Fantastic_] - [The road to 1.0: production ready PyTorch](https://pytorch.org/2018/05/02/road-to-1.0.html) - [PyTorch 1.0 tracing JIT and LibTorch C++ API to integrate PyTorch into NodeJS](http://blog.christianperone.com/2018/10/pytorch-1-0-tracing-jit-and-libtorch-c-api-to-integrate-pytorch-into-nodejs/) [_Good Article_] - [Model Serving in PyTorch](https://pytorch.org/blog/model-serving-in-pyorch/) - [PyTorch Summer Hackathon](https://pytorch.devpost.com/) [_Very Important_] - [Deploying PyTorch and Building a REST API using Flask](https://pytorch.org/tutorials/intermediate/flask_rest_api_tutorial.html) [_Important_] - [PyTorch model recognizing hotdogs and not-hotdogs deployed on flask](https://github.com/jaroslaw-weber/hotdog-not-hotdog) - [Serving PyTorch 1.0 Models as a Web Server in C++ ](https://github.com/Wizaron/pytorch-cpp-inference) [_Useful Example_] - [PyTorch Internals](http://blog.ezyang.com/2019/05/pytorch-internals/) [_Interesting & Useful Article_] - [Flask application to support pytorch model prediction](https://github.com/craigsidcarlson/PytorchFlaskApp) - [Serving PyTorch Model on Flask Thread-Safety](https://discuss.pytorch.org/t/serving-pytorch-model-on-flask-thread-safety/13921) - [Serving PyTorch Models on AWS Lambda with Caffe2 & ONNX](https://machinelearnings.co/serving-pytorch-models-on-aws-lambda-with-caffe2-onnx-7b096806cfac) - [Serving PyTorch Models on AWS Lambda with Caffe2 & ONNX (Another Version)](https://blog.waya.ai/deploy-deep-machine-learning-in-production-the-pythonic-way-a17105f1540e) - [Deep Dive into ONNX Runtime](https://medium.com/@mohsen.mahmoodzadeh/a-deep-dive-into-onnx-onnx-runtime-part-1-874517c66ffc) - [EuclidesDB - _multi-model machine learning feature database with PyTorch_](https://euclidesdb.readthedocs.io/en/latest/) - [EuclidesDB - GitHub](https://github.com/perone/euclidesdb/) - [WebDNN: Fastest DNN Execution Framework on Web Browser](https://github.com/mil-tokyo/webdnn) - [FastAI PyTorch Serverless API (with AWS Lambda)](https://github.com/alecrubin/pytorch-serverless/) - [FastAI PyTorch in Production (discussion)](http://forums.fast.ai/t/fastai-pytorch-in-production/16928) - [OpenMMLab Model Deployment Framework](https://github.com/open-mmlab/mmdeploy) - [TorchServe](https://github.com/pytorch/serve) [Great Tool] - [TorchServe Video Tutorial](https://www.youtube.com/watch?v=XlO7iQMV3Ik) ## Convert PyTorch Models to C++: - [**Loading a PyTorch Model in C++**](https://pytorch.org/tutorials/advanced/cpp_export.html) [_**Fantastic**_] - [**PyTorch C++ API**](https://pytorch.org/cppdocs/index.html) [_Bravo_] - [An Introduction To Torch (Pytorch) C++ Front-End](https://radicalrafi.github.io/posts/pytorch-cpp-intro/) [_Very Good_] - [Blogs on using PyTorch C++ API](https://discuss.pytorch.org/t/a-series-of-blogs-on-pytorch-c-api-transfer-learning-jupyter-notebook-with-libtorch-xeus-cling-and-more/54628) [_Good_] - [ATen: A TENsor library](https://github.com/pytorch/pytorch/tree/master/aten) - [Important Issue about PyTorch-like C++ interface](https://github.com/pytorch/pytorch/issues/3335) - [PyTorch C++ API Test](https://github.com/pytorch/pytorch/tree/master/test/cpp/api) - [PyTorch via C++](https://discuss.pytorch.org/t/pytorch-via-c/19234) [_Useful Notes_] - [AUTOGRADPP](https://github.com/pytorch/pytorch/tree/master/torch/csrc/api) - [PyTorch C++ Library](https://github.com/warmspringwinds/pytorch-cpp) - [Direct C++ Interface to PyTorch](https://github.com/ebetica/autogradpp) - [A Python module for compiling PyTorch graphs to C](https://github.com/lantiga/pytorch2c) ## Deploy TensorFlow Models in Production: - [How to deploy Machine Learning models with TensorFlow - _Part1_](https://towardsdatascience.com/how-to-deploy-machine-learning-models-with-tensorflow-part-1-make-your-model-ready-for-serving-776a14ec3198) - [How to deploy Machine Learning models with TensorFlow - _Part2_](https://towardsdatascience.com/how-to-deploy-machine-learning-models-with-tensorflow-part-2-containerize-it-db0ad7ca35a7) - [How to deploy Machine Learning models with TensorFlow - _Part3_](https://towardsdatascience.com/how-to-deploy-machine-learning-models-with-tensorflow-part-3-into-the-cloud-7115ff774bb6) - [Neural Structured Learning (NSL) in TensorFlow](https://medium.com/tensorflow/introducing-neural-structured-learning-in-tensorflow-5a802efd7afd) [_Great_] - [Building Robust Production-Ready Deep Learning Vision Models](https://medium.com/google-developer-experts/building-robust-production-ready-deep-learning-vision-models-in-minutes-acd716f6450a) - [Creating REST API for TensorFlow models](https://becominghuman.ai/creating-restful-api-to-tensorflow-models-c5c57b692c10) - ["How to Deploy a Tensorflow Model in Production" by _Siraj Raval_ on YouTube](https://www.youtube.com/watch?v=T_afaArR0E8) - [Code for the "How to Deploy a Tensorflow Model in Production" by _Siraj Raval_ on YouTube](https://github.com/llSourcell/How-to-Deploy-a-Tensorflow-Model-in-Production) - [How to deploy an Object Detection Model with TensorFlow serving](https://medium.freecodecamp.org/how-to-deploy-an-object-detection-model-with-tensorflow-serving-d6436e65d1d9) [_Very Good Tutorial_] - [Freeze Tensorflow models and serve on web](http://cv-tricks.com/how-to/freeze-tensorflow-models/) [_Very Good Tutorial_] - [How to deploy TensorFlow models to production using TF Serving](https://medium.freecodecamp.org/how-to-deploy-tensorflow-models-to-production-using-tf-serving-4b4b78d41700) [_Good_] - [How Zendesk Serves TensorFlow Models in Production](https://medium.com/zendesk-engineering/how-zendesk-serves-tensorflow-models-in-production-751ee22f0f4b) - [TensorFlow Serving Example Projects](https://github.com/Vetal1977/tf_serving_example) - [Serving Models in Production with TensorFlow Serving](https://www.youtube.com/watch?v=q_IkJcPyNl0) [_TensorFlow Dev Summit 2017 Video_] - [Building TensorFlow as a Standalone Project](https://tuatini.me/building-tensorflow-as-a-standalone-project/) - [TensorFlow C++ API Example](https://github.com/jhjin/tensorflow-cpp) - [TensorFlow.js](https://js.tensorflow.org/) - [Introducing TensorFlow.js: Machine Learning in Javascript](https://medium.com/tensorflow/introducing-tensorflow-js-machine-learning-in-javascript-bf3eab376db) ## Convert Keras Models in Production: - [Deep learning in production with Keras, Redis, Flask, and Apache](https://www.pyimagesearch.com/2018/02/05/deep-learning-production-keras-redis-flask-apache/) [_Rank: 1st & General Usefult Tutorial_] - [Deploying a Keras Deep Learning Model as a Web Application in Python](https://towardsdatascience.com/deploying-a-keras-deep-learning-model-as-a-web-application-in-p-fc0f2354a7ff) [_Very Good_] - [Deploying a Python Web App on AWS](https://towardsdatascience.com/deploying-a-python-web-app-on-aws-57ed772b2319) [_Very Good_] - [Deploying Deep Learning Models Part 1: Preparing the Model](https://blog.paperspace.com/deploying-deep-learning-models-flask-web-python/) - [Deploying your Keras model](https://medium.com/@burgalon/deploying-your-keras-model-35648f9dc5fb) - [Deploying your Keras model using Keras.JS](https://becominghuman.ai/deploying-your-keras-model-using-keras-js-2e5a29589ad8) - ["How to Deploy a Keras Model to Production" by _Siraj Raval_ on Youtube](https://github.com/llSourcell/how_to_deploy_a_keras_model_to_production) - [Deploy Keras Model with Flask as Web App in 10 Minutes](https://github.com/mtobeiyf/keras-flask-deploy-webapp) [Good Repository] - [Deploying Keras Deep Learning Models with Flask](https://towardsdatascience.com/deploying-keras-deep-learning-models-with-flask-5da4181436a2) - [keras2cpp](https://github.com/pplonski/keras2cpp) ## Deploy MXNet Models in Production: - [Model Server for Apache MXNet](https://github.com/awslabs/mxnet-model-server) - [Running the Model Server](https://github.com/awslabs/mxnet-model-server/blob/master/docs/server.md) - [Multi Model Server (MMS) Documentation](https://github.com/awslabs/multi-model-server/tree/master/docs) - [Introducing Model Server for Apache MXNet](https://aws.amazon.com/blogs/machine-learning/introducing-model-server-for-apache-mxnet/) - [Single Shot Multi Object Detection Inference Service](https://github.com/awslabs/mxnet-model-server/blob/master/examples/ssd/README.md) - [Amazon SageMaker](https://aws.amazon.com/sagemaker/) - [How can we serve MXNet models built with gluon api](https://discuss.mxnet.io/t/how-can-we-serve-mxnet-models-built-with-gluon-api/684) - [MXNet C++ Package](https://github.com/apache/incubator-mxnet/tree/master/cpp-package) - [MXNet C++ Package Examples](https://github.com/apache/incubator-mxnet/tree/master/cpp-package/example) - [MXNet Image Classification Example of C++](https://github.com/apache/incubator-mxnet/tree/master/example/image-classification/predict-cpp) - [MXNet C++ Tutorial](http://mxnet.incubator.apache.org/tutorials/c%2B%2B/basics.html) - [An introduction to the MXNet API](https://becominghuman.ai/an-introduction-to-the-mxnet-api-part-1-848febdcf8ab) [Very Good Tutorial for Learning MXNet] - [GluonCV](https://gluon-cv.mxnet.io/) - [GluonNLP](http://gluon-nlp.mxnet.io/) - [Model Quantization for Production-Level Neural Network Inference](https://medium.com/apache-mxnet/model-quantization-for-production-level-neural-network-inference-f54462ebba05) [_Excellent_] ## Deploy Machine Learning Models with Go: - [Cortex: Deploy machine learning models in production](https://github.com/cortexlabs/cortex) - [Cortex - Main Page](https://www.cortex.dev/) - [Why we deploy machine learning models with Go — not Python](https://towardsdatascience.com/why-we-deploy-machine-learning-models-with-go-not-python-a4e35ec16deb) - [Go-Torch](https://github.com/orktes/go-torch) - [Gotch - Go API for PyTorch](https://github.com/sugarme/gotch) - [TensorFlow Go Lang](https://www.tensorflow.org/install/lang_go) - [Go-onnx](https://github.com/dhdanie/goonnx) ## General Deep Learning Deployment Toolkits: - [OpenVINO Toolkit - Deep Learning Deployment Toolkit repository](https://github.com/openvinotoolkit/openvino) [_Great_] - [ClearML - ML/DL development and production suite](https://github.com/allegroai/clearml) - [Model Deployment Using Heroku: A Complete Guide on Heroku](https://www.analyticsvidhya.com/blog/2021/10/a-complete-guide-on-machine-learning-model-deployment-using-heroku/) [Good] - [NVIDIA Triton Inference Server](https://developer.nvidia.com/nvidia-triton-inference-server) [**Great**] - [NVIDIA Triton Inference Server - GitHub](https://github.com/triton-inference-server/server) [**Great**] - [Cohere Boosts Inference Speed With NVIDIA Triton Inference Server](https://txt.cohere.ai/nvidia-boosts-inference-speed-with-cohere/) - [NVIDIA Deep Learning Examples for Tensor Cores](https://github.com/NVIDIA/DeepLearningExamples) [Interesting] - [Deploying the Jasper Inference model using Triton Inference Server](https://github.com/NVIDIA/DeepLearningExamples/tree/master/PyTorch/SpeechRecognition/Jasper/triton) [Useful] - [Nvidia MLOPs Course via Triton](https://analyticsindiamag.com/nvidia-is-offering-a-four-hour-self-paced-course-on-mlops/) - [Awesome Production Machine Learning](https://github.com/EthicalML/awesome-production-machine-learning) [Great] ## Huawei Deep Learning Framework: - [MindSpore - Huawei Deep Learning Framework](https://github.com/mindspore-ai/mindspore) - [MindSpore - Tutorial](https://www.mindspore.cn/tutorial/en/0.1.0-alpha/quick_start/quick_start.html) ## General Deep Learning Compiler Stack: - [TVM Stack](https://tvm.ai/) ## Model Conversion between Deep Learning Frameworks: - [ONNX (Open Neural Network Exchange)](https://onnx.ai/) - [Tutorials for using ONNX](https://github.com/onnx/tutorials) - [MMdnn](https://github.com/Microsoft/MMdnn) [_Fantastic_] - [Convert Full ImageNet Pre-trained Model from MXNet to PyTorch](https://blog.paperspace.com/convert-full-imagenet-pre-trained-model-from-mxnet-to-pytorch/) [_Fantastic_, & Full ImageNet model means the model trained on ~ 14M images] ## Some Caffe2 Tutorials: - [Mnist using caffe2](http://vast.uccs.edu/~adhamija/blog/MNIST_singleGPU.html) - [Caffe2 C++ Tutorials and Examples](https://github.com/leonardvandriel/caffe2_cpp_tutorial) - [Make Transfer Learning of SqueezeNet on Caffe2](https://medium.com/@KazamiXHayato/make-transfer-learning-in-caffe2-21d96c47ba0e) - [Build Basic program by using Caffe2 framework in C++](https://medium.com/@KazamiXHayato/write-caffe2-program-in-c-5519e2646382) ## Some Useful Resources for Designing UI (Front-End Development): - [ReactJS vs Angular5 vs Vue.js](https://medium.com/@TechMagic/reactjs-vs-angular5-vs-vue-js-what-to-choose-in-2018-b91e028fa91d) - [A comparison between Angular and React and their core languages](https://medium.freecodecamp.org/a-comparison-between-angular-and-react-and-their-core-languages-9de52f485a76) - [A Guide to Becoming a Full-Stack Developer](https://medium.com/coderbyte/a-guide-to-becoming-a-full-stack-developer-in-2017-5c3c08a1600c) [_Very Good Tutorial_] - [Roadmap to becoming a web developer in 2018](https://github.com/kamranahmedse/developer-roadmap) [_Very Good Repository_] - [Modern Frontend Developer in 2018](https://medium.com/tech-tajawal/modern-frontend-developer-in-2018-4c2072fa2b9c) - [Roadmap to becoming a React developer in 2018](https://github.com/adam-golab/react-developer-roadmap) - [2019 UI and UX Design Trends](https://uxplanet.org/2019-ui-and-ux-design-trends-92dfa8323225) [_Good_] - [Streamlit](https://streamlit.io/) [_The fastest way to build custom ML tools_] - [Gradio](https://www.gradio.app/) [**Good**] - [Web Developer Monthly](https://medium.com/@andreineagoie/web-developer-monthly-july-2018-513e02f15fb6) - [23 Best React UI Component Frameworks](https://hackernoon.com/23-best-react-ui-component-libraries-and-frameworks-250a81b2ac42) - [9 React Styled-Components UI Libraries for 2018](https://blog.bitsrc.io/9-react-styled-components-ui-libraries-for-2018-4e1a0bd3e179) - [35 New Tools for UI Design](https://blog.prototypr.io/35-new-tools-for-ui-design-412cf1d701fd) - [5 Tools To Speed Up Your App Development](https://medium.com/swlh/5-tools-to-speed-up-your-app-development-6979d0e49e34) [_Very Good_] - [How to use ReactJS with Webpack 4, Babel 7, and Material Design](https://medium.freecodecamp.org/how-to-use-reactjs-with-webpack-4-babel-7-and-material-design-ff754586f618) - [Adobe Typekit](https://typekit.com/) [_Great fonts, where you need them_] - [Build A Real World Beautiful Web APP with Angular 6](https://medium.com/@hamedbaatour/build-a-real-world-beautiful-web-app-with-angular-6-a-to-z-ultimate-guide-2018-part-i-e121dd1d55e) - [You Don't Know JS](https://github.com/getify/You-Dont-Know-JS) - [JavaScript Top 10 Articles](https://medium.mybridge.co/javascript-top-10-articles-for-the-past-month-v-sep-2018-8f27a300d6c5) - [Web Design with Adobe XD](https://medium.freecodecamp.org/a-developers-guide-to-web-design-for-non-designers-1f64ce28c38d) - [INSPINIA Bootstrap Web Theme](https://wrapbootstrap.com/theme/inspinia-responsive-admin-theme-WB0R5L90S) - [A Learning Tracker for Front-End Developers](https://github.com/Syknapse/My-Learning-Tracker-first-ten-months) - [The best front-end hacking cheatsheets — all in one place](https://medium.freecodecamp.org/modern-frontend-hacking-cheatsheets-df9c2566c72a) [_Useful & Interesting_] - [GUI-fying the Machine Learning Workflow (Machine Flow)](https://towardsdatascience.com/gui-fying-the-machine-learning-workflow-towards-rapid-discovery-of-viable-pipelines-cab2552c909f) - [Electron - Build cross platform desktop apps with JavaScript](https://electronjs.org/) [_Very Good_] - [Opyrator - Turns Python functions into microservices with web API](https://github.com/ml-tooling/opyrator) [**Great**] - [A First Look at PyScript: Python in the Web Browser](https://realpython.com/pyscript-python-in-browser/) [**Interesting**] ## Mobile & Embedded Devices Development: - [PyTorch Mobile](https://pytorch.org/mobile/home/) [_Excellent_] - [Mobile UI Design Trends In 2018](https://uxplanet.org/mobile-ui-design-trends-in-2018-ccd26031dfd8) - [ncnn - high-performance neural network inference framework optimized for the mobile platform](https://github.com/Tencent/ncnn) [_Useful_] - [Alibaba - MNN](https://github.com/alibaba/MNN) - [Awesome Mobile Machine Learning](https://github.com/fritzlabs/Awesome-Mobile-Machine-Learning) - [EMDL - Embedded and Mobile Deep Learning](https://github.com/EMDL/awesome-emdl) - [Fritz - machine learning platform for iOS and Android](https://www.fritz.ai/) - [TensorFlow Lite](https://www.tensorflow.org/mobile/tflite/) - [Tiny Machine Learning: The Next AI Revolution](https://medium.com/@matthew_stewart/tiny-machine-learning-the-next-ai-revolution-495c26463868) - [TLT - NVIDIA Transfer Learning Toolkit](https://developer.nvidia.com/transfer-learning-toolkit) - [NVIDIA Jetson Inference](https://github.com/dusty-nv/jetson-inference) [_Great_] ## Back-End Development Part: - [Modern Backend Developer in 2018](https://medium.com/tech-tajawal/modern-backend-developer-in-2018-6b3f7b5f8b9) - [Deploying frontend applications — the fun way](https://hackernoon.com/deploying-frontend-applications-the-fun-way-bc3f69e15331) [_Very Good_] - [RabbitMQ](https://www.rabbitmq.com/) [_Message Broker Software_] - [Celery](http://www.celeryproject.org/) [_Distributed Task Queue_] - [Kafka](https://kafka.apache.org/) [_Distributed Streaming Platform_] - [Docker training with DockerMe](https://github.com/AhmadRafiee/Docker_training_with_DockerMe) - [Kubernetes - GitHub](https://github.com/kubernetes/kubernetes) - [Deploy Machine Learning Pipeline on Google Kubernetes Engine](https://towardsdatascience.com/deploy-machine-learning-model-on-google-kubernetes-engine-94daac85108b) - [An introduction to Kubernetes for Data Scientists](https://www.jeremyjordan.me/kubernetes/) - [Jenkins and Kubernetes with Docker Desktop](https://medium.com/@garunski/jenkins-and-kubernetes-with-docker-desktop-53a853486f7c) - [Helm: The package manager for Kubernetes](https://helm.sh/) - [Create Cluster using docker swarm](https://medium.com/tech-tajawal/create-cluster-using-docker-swarm-94d7b2a10c43) - [deepo - Docker Image for all DL Framewors](https://github.com/ufoym/deepo) - [Kubeflow](https://www.kubeflow.org/) [_deployments of ML workflows on Kubernetes_] - [kubespray - Deploy a Production Ready Kubernetes Cluster](https://github.com/kubernetes-sigs/kubespray) - [KFServing - Kubernetes for Serving ML Models](https://github.com/kubeflow/kfserving) - [Deploying a HuggingFace NLP Model with KFServing](http://www.pattersonconsultingtn.com/blog/deploying_huggingface_with_kfserving.html) [_Interesting_] - [Seldon Core - Deploying Machine Learning Models on Kubernetes](https://www.seldon.io/tech/products/core/) - [Seldon Core - GitHub](https://github.com/SeldonIO/seldon-core) - [Machine Learning: serving models with Kubeflow on Ubuntu, Part 1](https://ubuntu.com/blog/ml-serving-models-with-kubeflow-on-ubuntu-part-1) - [CoreWeave Kubernetes Cloud](https://github.com/coreweave/kubernetes-cloud/tree/master/online-inference/) - [MLOps References](https://github.com/visenger/mlops-references) [_DevOps for ML_] - [Data Version Control - DVC](https://dvc.org/) [_Great_] - [MLEM: package and deploy machine learning models](https://github.com/iterative/mlem) - [PySyft - A library for encrypted, privacy preserving deep learning](https://github.com/OpenMined/PySyft) - [LocalStack - A fully functional local AWS cloud stack](https://github.com/localstack/localstack) - [poetry: Python packaging and dependency management](https://python-poetry.org/) ## GPU Management Libraries: - [GPUtil](https://github.com/anderskm/gputil) - [py3nvml](https://github.com/fbcotter/py3nvml) [_Python 3 binding to the NVIDIA Management Library_] - [PyCUDA - GitHub](https://github.com/inducer/pycuda) - [PyCUDA](https://mathema.tician.de/software/pycuda/) - [PyCUDA Tutorial](https://documen.tician.de/pycuda/) - [setGPU](https://github.com/bamos/setGPU) - [Monitor your GPUs](https://github.com/msalvaris/gpu_monitor) [**Excellent**] - [GPU-Burn - Multi-GPU CUDA stress test](https://github.com/wilicc/gpu-burn) [_Useful_] - [Grafana - Monitoring and Observability](https://github.com/grafana/grafana) [**Excellent**] - [Prometheus](https://prometheus.io/) [_Excellent for monitoring solution & extract required metrics_] - [OpenAI Triton: Open-Source GPU Programming for Neural Networks](https://openai.com/blog/triton/) ## Speed-up & Scalabale Python Codes: - [Numba - makes Python code fast](http://numba.pydata.org/) - [Dask - natively scales Python](https://dask.org/) - [What is Dask](https://medium.com/better-programming/what-is-dask-and-how-can-it-help-you-as-a-data-scientist-72adec7cec57) - [Ray - running distributed applications](https://github.com/ray-project/ray) - [Neural Network Distiller](https://github.com/NervanaSystems/distiller/) [_Distillation & Quantization of Deep Learning Models in PyTorch_] - [PyTorch Pruning Tutorial](https://pytorch.org/tutorials/intermediate/pruning_tutorial.html) - [Can you remove 99% of a neural network without losing accuracy? - An introduction to weight pruning](https://towardsdatascience.com/can-you-remove-99-of-a-neural-network-without-losing-accuracy-915b1fab873b) - [PocketFlow - An Automatic Model Compression (AutoMC) framework](https://github.com/Tencent/PocketFlow) [**Great**] - [Introducing the Model Optimization Toolkit for TensorFlow](https://medium.com/tensorflow/introducing-the-model-optimization-toolkit-for-tensorflow-254aca1ba0a3) - [TensorFlow Model Optimization Toolkit — Post-Training Integer Quantization](https://medium.com/tensorflow/tensorflow-model-optimization-toolkit-post-training-integer-quantization-b4964a1ea9ba) - [TensorFlow Post-training Quantization](https://www.tensorflow.org/lite/performance/post_training_quantization) - [Dynamic Quantization in PyTorch](https://pytorch.org/tutorials/advanced/dynamic_quantization_tutorial.html) - [Static Quantization in PyTorch](https://pytorch.org/tutorials/advanced/static_quantization_tutorial.html) - [NVIDIA DALI - highly optimized data pre-processing in deep learning](https://github.com/NVIDIA/dali) - [Horovod - Distributed training framework](https://github.com/horovod/horovod) - [ONNX Float32 to Float16](https://github.com/onnx/onnx-docker/blob/master/onnx-ecosystem/converter_scripts/float32_float16_onnx.ipynb) - [Speeding Up Deep Learning Inference Using TensorRT](https://devblogs.nvidia.com/speeding-up-deep-learning-inference-using-tensorrt/) - [Speed up Training](https://ai.googleblog.com/2020/05/speeding-up-neural-network-training.html) - [Native PyTorch automatic mixed precision for faster training on NVIDIA GPUs](https://pytorch.org/blog/accelerating-training-on-nvidia-gpus-with-pytorch-automatic-mixed-precision/) - [JAX - Composable transformations of Python+NumPy programs](https://github.com/google/jax) - [TensorRTx - popular DL networks with tensorrt](https://github.com/wang-xinyu/tensorrtx) - [Speeding up Deep Learning Inference Using TensorFlow, ONNX, and TensorRT](https://devblogs.nvidia.com/speeding-up-deep-learning-inference-using-tensorflow-onnx-and-tensorrt/) - [TensorRT Developer Guide](https://docs.nvidia.com/deeplearning/sdk/tensorrt-developer-guide/index.html) - [How to Convert a Model from PyTorch to TensorRT and Speed Up Inference](https://www.learnopencv.com/how-to-convert-a-model-from-pytorch-to-tensorrt-and-speed-up-inference/) [_Good_] ## Hardware Notes for Deep Learning: - [Hardware for Deep Learning](https://blog.inten.to/hardware-for-deep-learning-part-3-gpu-8906c1644664) ## MLOPs Courses & Resources: - [MLOps-Basics](https://github.com/graviraja/MLOps-Basics) [Great] - [MLOPs-Zoomcamp](https://github.com/DataTalksClub/mlops-zoomcamp) [Great] - [A collection of resources to learn about MLOPs](https://github.com/dair-ai/MLOPs-Primer) [Great] - [Awesome MLOPs](https://github.com/visenger/awesome-mlops) [Great] - [Data Science Topics & MLOPs](https://github.com/khuyentran1401/Data-science#mlops) [Great] - [MLEM: package and deploy machine learning models](https://github.com/iterative/mlem) - [DevOps Exercises](https://github.com/bregman-arie/devops-exercises) - [MlOPs Sample Project](https://github.com/AntonisCSt/Mlops_project_semicon) - [prefect: Orchestrate and observe all of your workflows](https://www.prefect.io/) - [DataTalks Club: The place to talk about data](https://datatalks.club/) ## Other: - [A Guide to Production Level Deep Learning](https://github.com/alirezadir/Production-Level-Deep-Learning) - [Facebook Says Developers Will Love PyTorch 1.0](https://medium.com/syncedreview/facebook-says-developers-will-love-pytorch-1-0-ba2f89ebc9cc) - [Some PyTorch Workflow Changes](https://github.com/pytorch/pytorch/issues/6032) - [wandb - A tool for visualizing and tracking your machine learning experiments](https://github.com/wandb/client) - [PyTorch and Caffe2 repos getting closer together](https://github.com/caffe2/caffe2/issues/2439#issuecomment-391155017) - [PyTorch or TensorFlow?](https://awni.github.io/pytorch-tensorflow/) - [Choosing a Deep Learning Framework in 2018: Tensorflow or Pytorch?](http://cv-tricks.com/deep-learning-2/tensorflow-or-pytorch/) - [Deep Learning War between PyTorch & TensorFlow](https://hub.packtpub.com/can-a-production-ready-pytorch-1-0-give-tensorflow-a-tough-time/) - [Embedding Machine Learning Models to Web Apps (Part-1)](https://towardsdatascience.com/embedding-machine-learning-models-to-web-apps-part-1-6ab7b55ee428) - [Deploying deep learning models: Part 1 an overview](https://towardsdatascience.com/deploying-deep-learning-models-part-1-an-overview-77b4d01dd6f7) - [Machine Learning in Production](https://medium.com/contentsquare-engineering-blog/machine-learning-in-production-c53b43283ab1) - [how you can get a 2–6x speed-up on your data pre-processing with Python](https://towardsdatascience.com/heres-how-you-can-get-a-2-6x-speed-up-on-your-data-pre-processing-with-python-847887e63be5) - [Making your C library callable from Python](https://medium.com/@shamir.stav_83310/making-your-c-library-callable-from-python-by-wrapping-it-with-cython-b09db35012a3) - [MIL WebDNN](https://mil-tokyo.github.io/webdnn/) - [Multi-GPU Framework Comparisons](https://medium.com/@iliakarmanov/multi-gpu-rosetta-stone-d4fa96162986) [_Great_]

An open access book on Python, OpenGL and Scientific Visualization, Nicolas P. Rougier, 2018

Solutions for various coding/algorithmic problems and many useful resources for learning algorithms and data structures

# Coding Problems Here you can find [solutions](#Solutions) for various coding/algorithmic problems and many useful [resources](#Learning-Resources) for learning algorithms and data structures.\ Also, this repo will be updated with new solutions and resources from time to time. *Note that this repo is meant to be used for learning and researching purposes only and it is **not** meant to be used for production.* ## Solutions Algorithms and data structures are not language-specific (it's true that some languages are faster, and some are easier to use), but if you are good with the logic and pseudocode, any language would be good.\ So I've decided to use [Python](https://en.wikipedia.org/wiki/Python_(programming_language)) because I think it's very close to pseudocode and it's easily readable (so it'll be easy for someone from another environment to implement the same solutions).\ As I said previously, all solutions are written in [Python](https://www.python.org/) (more precisely, [Python 3](https://docs.python.org/3)), using the [Built-in Functions](https://docs.python.org/3/library/functions.html) (print, len, range, sorted, sum, min, max, etc...) and a few modules from the [Python Standard Library](https://docs.python.org/3/library/) like: - [math](https://docs.python.org/3/library/math.html) (used for constants like math.pi, math.inf and functions like math.ceil, math.floor, math.gcd, math.log, math.pow, math.sqrt, etc) - [collections](https://docs.python.org/3/library/collections.html) (used for [collections.deque](https://docs.python.org/3/library/collections.html#collections.deque) when there is a need for [Stack](https://en.wikipedia.org/wiki/Stack_(abstract_data_type)) or [Queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)) data structures) - [heapq](https://docs.python.org/3/library/heapq.html) (used when there is a need for [Priority Queue](https://en.wikipedia.org/wiki/Priority_queue) data structure). - [random](https://docs.python.org/3/library/random.html) (used for [nondeterministic algorithms](https://en.wikipedia.org/wiki/Nondeterministic_algorithm), like shuffling arrays ([Fisher–Yates shuffle](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle)), sampling arrays ([Reservoir sampling](https://en.wikipedia.org/wiki/Reservoir_sampling)) and [Monte Carlo methods](https://en.wikipedia.org/wiki/Monte_Carlo_method)). So, to execute these solutions there is no need from installing any external packages. \ Coding style and name conventions are described in the official [PEP8](https://www.python.org/dev/peps/pep-0008) page. *Note that I'm **not** the author of these problems, they are from sites like [LeetCode](https://leetcode.com/) (you can find more than 40 sites like this in the [Training Sites](#Training-Sites) section). **Only** the solutions and explanations are mine. If you find any **bug** or incorrect implementation (or faster/better implementation) in this repo, please let me know by opening an issue or pull request.* ### Template For easier navigation into the solutions, each file with a solution in this repo will have the following template: ```python ''' Problem Name Problem explanation. Input: XXX Output: XXX Output explanation: XXX ========================================= Solution 1 explanation. Time Complexity: O(X) Space Complexity: O(X) Solution 2 explanation. (some of the problems are solved in more than one way) Time Complexity: O(X) Space Complexity: O(X) ''' ############## # Solution 1 # ############## def name_of_solution_1(params): # description of code pass ############## # Solution 2 # ############## def name_of_solution_2(params): # description of code pass ########### # Testing # ########### # Test 1 # Correct result => 'result1' test_val = 'example1' print(name_of_solution_1(test_val)) print(name_of_solution_2(test_val)) # Test 2 # Correct result => 'result2' test_val = 'example2' print(name_of_solution_1(test_val)) print(name_of_solution_2(test_val)) ``` *Note that here I'm using the **simplest** way of testing, printing the results using the [print](https://docs.python.org/3/library/functions.html#print) method. Why? Because I think that the bigger part of the users of this repo isn't familiar with [unit testing](https://en.wikipedia.org/wiki/Unit_testing) and I wanted this part to be intuitive. Btw, I strongly recommend using some unit testing framework for this kind of testing. The Python Standard Library contains a **great** framework for unit testing called [unittest](https://docs.python.org/3/library/unittest.html), or you can install some third-party unit testing framework like [pytest](https://docs.pytest.org/en/latest/).* ### Categories Each solution/problem in this repo belongs to one of these categories: 1. [Arrays](https://github.com/MTrajK/coding-problems/tree/master/Arrays) - Array Manipulations, Sorting, Binary Search, Divide and Conquer, Sliding Window, etc. 2. [Linked Lists](https://github.com/MTrajK/coding-problems/tree/master/Linked%20Lists) - Linked List Searching, Pointer Manipulations, etc. 3. [Trees](https://github.com/MTrajK/coding-problems/tree/master/Trees) - Binary Search Trees, Tree Traversals: Breadth-First (Level Order) Traversal, Depth-First Traversal (Inorder, Preorder, Postorder), etc. 4. [Hashing DS](https://github.com/MTrajK/coding-problems/tree/master/Hashing%20DS) - Hashing Data Structures: Sets/HashSets and Dictionaries/HashMaps. 5. [Dynamic Programming](https://github.com/MTrajK/coding-problems/tree/master/Dynamic%20Programming) - 2D and 1D Dynamic Programming, LCS, LIS, Knapsack, etc. 6. [Strings](https://github.com/MTrajK/coding-problems/tree/master/Strings) - String Manipulations, Reversing, Encodings/Decodings, etc. 7. [Math](https://github.com/MTrajK/coding-problems/tree/master/Math) - GCD, LCM, Factorization, Geometry, Math Formulas, etc. 8. [Other](https://github.com/MTrajK/coding-problems/tree/master/Other) - Backtracking, BFS, DFS, Stacks, Queues, Deques, Priority Queues (Heaps), Matrices, etc. ## Learning Resources The learning resources are divided into 4 categories: [Courses](#Courses), [Books](#Books), [Training Sites](#Training-Sites), [Other Resources](#Other-Resources). ### Courses Collection of free courses from one of the best CS universities. 1. Stanford University - [Algorithms Specialization (Coursera)](https://www.coursera.org/specializations/algorithms) * [Divide and Conquer, Sorting and Searching, and Randomized Algorithms](https://www.coursera.org/learn/algorithms-divide-conquer) * [Graph Search, Shortest Paths, and Data Structures](https://www.coursera.org/learn/algorithms-graphs-data-structures) * [Greedy Algorithms, Minimum Spanning Trees, and Dynamic Programming](https://www.coursera.org/learn/algorithms-greedy) * [Shortest Paths Revisited, NP-Complete Problems and What To Do About Them](https://www.coursera.org/learn/algorithms-npcomplete) - [Introduction to Programming Contests - CS 97SI](http://web.stanford.edu/class/cs97si/) 2. Princeton University - [Algorithms Part 1 (Coursera)](https://www.coursera.org/learn/algorithms-part1) - [Algorithms Part 2 (Coursera)](https://www.coursera.org/learn/algorithms-part2) - [Analysis of Algorithms (Coursera)](https://www.coursera.org/learn/analysis-of-algorithms) 3. UC San Diego - [Data Structures and Algorithms Specialization (Coursera)](https://www.coursera.org/specializations/data-structures-algorithms) * [Algorithmic Toolbox](https://www.coursera.org/learn/algorithmic-toolbox) * [Data Structures](https://www.coursera.org/learn/data-structures) * [Algorithms on Graphs](https://www.coursera.org/learn/algorithms-on-graphs) * [Algorithms on Strings](https://www.coursera.org/learn/algorithms-on-strings) * [Advanced Algorithms and Complexity](https://www.coursera.org/learn/advanced-algorithms-and-complexity) - [Data Structures and Performance (Coursera)](https://www.coursera.org/learn/data-structures-optimizing-performance) - [edX](https://www.edx.org/school/uc-san-diegox) * [Data Structures Fundamentals](https://www.edx.org/course/data-structures-fundamentals) * [Algorithmic Design and Techniques](https://www.edx.org/course/algorithmic-design-and-techniques) * [Graph Algorithms](https://www.edx.org/course/graph-algorithms) * [Data Structures: An Active Learning Approach](https://www.edx.org/course/data-structures-an-active-learning-approach) 4. MIT University - [Introduction to algorithms 2005](https://www.youtube.com/playlist?list=PL8B24C31197EC371C) - *[Official MIT page with resources](https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-046j-introduction-to-algorithms-sma-5503-fall-2005/)*. Note: this course is the old 6.046J course (the new name is ***Design and analysis of algorithms***, you can find it below). - [Introduction to algorithms 2011 - 6.006](https://www.youtube.com/playlist?list=PLUl4u3cNGP61Oq3tWYp6V_F-5jb5L2iHb) - *[Official MIT page with resources](https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-006-introduction-to-algorithms-fall-2011/)* - [Design and analysis of algorithms - 6.046J](https://www.youtube.com/playlist?list=PLUl4u3cNGP6317WaSNfmCvGym2ucw3oGp) - *[Official MIT page with resources](https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-046j-design-and-analysis-of-algorithms-spring-2015/index.htm)* - [Advanced Data Structures - 6.851](https://www.youtube.com/playlist?list=PLUl4u3cNGP61hsJNdULdudlRL493b-XZf) - *[Official MIT page with resources](http://courses.csail.mit.edu/6.851/spring14/lectures/)* - [Advanced Algorithms 2016 - 6.854](https://www.youtube.com/playlist?list=PL6ogFv-ieghdoGKGg2Bik3Gl1glBTEu8c) - *[Official MIT page with resources](http://people.csail.mit.edu/moitra/854.html)* - [Programming for the Puzzled 2018 - 6.S095](https://www.youtube.com/playlist?list=PLUl4u3cNGP62QumaaZtCCjkID-NgqrleA) - *[Official MIT page with resources](https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-s095-programming-for-the-puzzled-january-iap-2018/)* 5. Harvard University - [Advanced algorithms - CS224](https://www.youtube.com/playlist?list=PL2SOU6wwxB0uP4rJgf5ayhHWgw7akUWSf) 6. UC Berkeley - [Data Structures - CS61B](https://inst.eecs.berkeley.edu/~cs61b/archives.html) - [Efficient Algorithms and Intractable Problems - CS170](https://cs170.org/) - *[YouTube videos](https://www.youtube.com/playlist?list=PLkFD6_40KJIx8lWWbE-Uk069aZ1R-W-VU)* ### Books Several books that have made an impression on me: 1. [Grokking Algorithms by Aditya Bhargava](https://www.goodreads.com/book/show/22847284-grokking-algorithms-an-illustrated-guide-for-programmers-and-other-curio) - **The best** book for complete beginners in algorithms! I wish this book existed when I started learning algorithms. 2. [Introduction to Algorithms by CLRS](https://www.goodreads.com/book/show/6752187-introduction-to-algorithms) - This book is called the "bible textbook of algorithms" by many programmers. 3. [Algorithms by Robert Sedgewick & Kevin Wayne](https://www.goodreads.com/book/show/10803540-algorithms) - These authors are instructors of the previously mentioned Coursera courses: [Algorithms Part 1](https://www.coursera.org/learn/algorithms-part1) and [Algorithms Part 2](https://www.coursera.org/learn/algorithms-part2). Also, this book has an excellent and free [site](http://algs4.cs.princeton.edu) with exercises, presentations, and examples. 4. [The Algorithm Design Manual by Steven Skiena](https://www.goodreads.com/book/show/425208.The_Algorithm_Design_Manual) - The book describes many advanced topics and algorithms and it focuses on real-life practical examples. This book has [one](http://www.algorist.com) of the best sites with resources ([solutions](http://www.algorist.com/algowiki/index.php/The_Algorithms_Design_Manual_(Second_Edition)), [algorithms and data structures](http://www.algorist.com/algorist.html), [python implementations](http://www.algorist.com/languages/Python.html)). 5. [Algorithms by S. Dasgupta, C. Papadimitriou, and U. Vazirani](https://www.goodreads.com/book/show/138563.Algorithms) - This book is an official book for algorithms and data structures classes in several famous universities. 6. [Competitive Programming 3 by Steven Halim & Felix Halim](https://www.goodreads.com/book/show/22820968-competitive-programming-3) - A great book that prepares you for competitive programming (not for complete beginners). You can learn many things and tricks about competitive programming. *But if your goal is to prepare for competitive programming then choose a faster language than Python, **C/C++** (or Java, it's faster than Python but not like C/C++).* 7. [Cracking the Coding Interview by Gayle Laakmann McDowell](https://www.goodreads.com/book/show/29350585-cracking-the-coding-interview) - A bit different from the previous books. Prepares you for coding interviews using great coding problems. ### Training Sites If the problems from [LeetCode](https://leetcode.com/) are not enough and you need more problems like those, you can find much more on these platforms: - [HackerRank](http://hackerrank.com/) - [CodeChef](http://codechef.com/) - [HackerEarth](http://hackerearth.com/) - [CodeForces](http://codeforces.com/) - [Topcoder](http://topcoder.com/) - [Project Euler](https://projecteuler.net/) - [SPOJ](http://www.spoj.com/) - [PEG](https://wcipeg.com/) - [Online Judge](https://onlinejudge.org/) - [E-Olymp](https://www.e-olymp.com/en/) - [VJudge](https://vjudge.net/) - [DMOJ](https://dmoj.ca/) - [USA CO](http://www.usaco.org/) - [Rosetta Code](http://rosettacode.org/) - [AtCoder](https://atcoder.jp/) - [LintCode](http://www.lintcode.com/en/) - [Kattis](https://www.kattis.com/developers) - [CodeAbbey](http://codeabbey.com/) - [CS Academy](https://csacademy.com/) - [Advent of Code](https://adventofcode.com/) - [Exercism](https://exercism.io/) - [CodeFu](https://codefu.mk/) - [Mendo](https://mendo.mk/Welcome.do) - [Z-Training](http://www.codah.club/) - [Codewars](http://www.codewars.com/) - [Wolfram Challenges](https://challenges.wolfram.com/) - [Google's Coding Competitions](https://codingcompetitions.withgoogle.com/) - [Cyber-dojo](https://cyber-dojo.org/) - [CodingBat](http://codingbat.com/) - [CodeKata](http://codekata.com/) - [Daily Coding Problem](https://www.dailycodingproblem.com/) - [Daily Interview Pro](http://dailyinterviewpro.com/) - [AlgoDaily](https://algodaily.com/) - [Codility](https://codility.com/) - [CoderByte](https://coderbyte.com/) - [AlgoExpert](https://www.algoexpert.io/) - [CodeSignal](https://codesignal.com/) - [Edabit](https://edabit.com/) - [DevPost](https://devpost.com/) - [Brilliant](http://brilliant.org/) - [Codingame](https://www.codingame.com/) - [CheckiO](http://www.checkio.org/) - [Kaggle](http://kaggle.com/) - [Rosalind](http://rosalind.info/problems/locations/) - [workat.tech](https://workat.tech/problem-solving/practice/) ### Other Resources 1. [Geeks For Geeks](https://www.geeksforgeeks.org/) - The site which **all** interested in algorithms (no matter if beginners or experts) should know! [YouTube channel](https://www.youtube.com/channel/UC0RhatS1pyxInC00YKjjBqQ) with many useful videos. 2. [The Algorithms - Python](https://github.com/TheAlgorithms/Python) - Great GitHub repo with many algorithms written in Python ([Link](https://github.com/TheAlgorithms) from the same repo written in other programming languages). 3. [CP Algorithms](http://cp-algorithms.com/) - Great page with excellent explanations for various algorithms. 4. Visualizers: - [USFCA Visualization Tool](https://www.cs.usfca.edu/~galles/visualization/Algorithms.html) - Great tool for visualizing data structures and algorithms, created by the University of San Francisco. - [VisuAlgo](https://visualgo.net/en) - Another great tool for visualizing data structures and algorithms through animation. - [Algorithm Visualizer](https://algorithm-visualizer.org/) - Interactive online platform that visualizes algorithms from code. This platform is an open-source project, [here](https://github.com/algorithm-visualizer/algorithm-visualizer) you can find the source code. 5. Courses and tutorials (but not from universities like the [Courses](#Courses) section): - [Google - Intro to Data Structures and Algorithms](https://www.udacity.com/course/data-structures-and-algorithms-in-python--ud513) - Free course on Udacity offered by Google. - [HackerEarth - Tutorials and Practice](https://www.hackerearth.com/practice/) - Practice problems and learn about many algorithms and data structures needed for competitive programming. - [KhanAcademy - Algorithms](https://www.khanacademy.org/computing/computer-science/algorithms) - Good explanations for some basic algorithms. - [Tutorialspoint - Data Structures and Algorithms](https://www.tutorialspoint.com/data_structures_algorithms/index.htm) - Another platform with good explanations, also Tutorialspoint has free tutorials for almost everything related to CS! - [Programiz - Data Structures and Algorithms](https://www.programiz.com/dsa) - One more platform which explains the data structures and algorithms in a simple and interesting way. - [Hackr.io - Data Structures and Algorithms Tutorials and Courses](https://hackr.io/tutorials/learn-data-structures-algorithms) - Big collection of tutorials and courses. - [Scaler - Data Structures Tutorial](https://www.scaler.com/topics/data-structures/) - Interesting and interactive explanations of some basic data structures. 6. YouTube playlists with tutorials: - [Data Structures by mycodeschool](https://www.youtube.com/playlist?list=PL2_aWCzGMAwI3W_JlcBbtYTwiQSsOTa6P) - [Data Structures by HackerRank](https://www.youtube.com/playlist?list=PLI1t_8YX-Apv-UiRlnZwqqrRT8D1RhriX) - [Algorithms by HackerRank](https://www.youtube.com/playlist?list=PLI1t_8YX-ApvMthLj56t1Rf-Buio5Y8KL)

Python Sorted Container Types: Sorted List, Sorted Dict, and Sorted Set

Instructional notebooks on music information retrieval.

stanford-mir ============ [](https://waffle.io/stevetjoa/stanford-mir) Instructional material for the [Music Information Retrieval Workshop](https://ccrma.stanford.edu/workshops/music-information-retrieval-mir) at CCRMA, Stanford University, 2014. **To register for the 2015 workshop, please [click here](https://ccrma.stanford.edu/workshops/music-information-retrieval-mir-2015).** How to Use This Repo -------------------- This repo contains a bunch of IPython notebooks related to music information retrieval. If you're a **visitor**, [browse this repo at nbviewer.ipython.org](http://nbviewer.ipython.org/github/stevetjoa/stanford-mir) which renders the notebooks in this repo so they can be viewed in a web browser. If you're a **workshop participant**, follow the steps below to get started with Git, Vagrant, and IPython. ### Install Git Git is a version control system. You will use Git to retrieve the latest version of our IPython notebooks and to track changes that you make to these notebooks. 1. [Download Git](http://git-scm.com), and install it on your local machine. 2. Clone this repo onto your local machine: macbook:~$ git clone https://github.com/stevetjoa/stanford-mir 3. Create a branch called `develop`. You will make changes to this branch. macbook:~$ cd stanford-mir macbook:~/stanford-mir$ git branch develop macbook:~/stanford-mir$ git checkout develop Switched to branch 'develop' ### Install Vagrant We use [Vagrant](http://vagrantup.com) to create a local virtual machine running Ubuntu 12.04. Vagrant ensures that every person has exactly the same development environment with the same installed packages. Vagrant is available for all major operating systems, including Windows, Mac OS X, and Linux. It's a breeze to install. 1. Install [VirtualBox](https://www.virtualbox.org) and [Vagrant](http://vagrantup.com). 2. Create a new virtual machine using [our customized Vagrant box](https://vagrantcloud.com/stevetjoa/stanford-mir) built upon Ubuntu 12.04 64-bit. macbook:~/stanford-mir$ vagrant up If this is your first time running `vagrant up`, this step may take five minutes to download the Vagrant box. 3. Finally, login to the new virtual machine: macbook:~/stanford-mir$ vagrant ssh This step logs you in to Ubuntu locally as user `vagrant` with default password `vagrant`. Note: do *not* upgrade the virtual machine to Ubuntu 14.04 when prompted. Note: outdated versions of Mac OS X may yield problems with `vagrant ssh`. To avoid such problems, please upgrade (for free) to the latest version of Mac OS X. #### Troubleshooting Vagrant * Problem: When on a Windows host machine, `vagrant ssh` results in a timeout error: `ssh_exchange_identification: read: Connection reset by peer`. Solution: Go into the BIOS, and make sure that Hardware Virtualization is enabled. For details, see [this answer on Stack Overflow](http://stackoverflow.com/questions/22575261/vagrant-stuck-connection-timeout-retrying/25504245#25504245). * Problem: The folder `stanford-mir` on the guest machine is empty. Solution: Vagrant probably failed to sync folders between the host and the guest machines. Try `vagrant provision` or `vagrant reload` from the host machine. ### Start IPython A majority of our instruction and laboratory work will occur inside the [IPython notebook](http://ipython.org/notebook.html). You can think of the IPython notebook like the Mathematica or Matlab desktop, except it's in Python and it runs inside your web browser. 1. In your Vagrant box, start the IPython notebook server: vagrant@stanford-mir:~$ ipython notebook 2. On your *host* machine, visit <http://localhost:8888>. 3. Open the notebook `stanford-mir/Table_of_Contents.ipynb`. Congratulations, you are now running an IPython notebook, and you can get started with the workshop material. Contributions ------------- Your contributions are very welcome! You can contribute in two ways: 1. Submit an issue. Click on "[Issues](https://github.com/stevetjoa/stanford-mir/issues)" in the right navigation bar, then "New Issue". Issues can include Python bugs, spelling mistakes, broken links, requests for new content, and more. For a prioritized list of open issues awaiting contribution, click on the blue "[Ready](https://waffle.io/stevetjoa/stanford-mir)" button above. 2. Submit changes to source code or documentation. [Fork this repo](https://help.github.com/articles/fork-a-repo), make edits, then [submit a pull request](https://help.github.com/articles/using-pull-requests).

A development tool for all your projects that is fast, easy, powerful and liberating

<div align="center"> <a href="https://lando.dev" target="_blank"><img width="250" src="https://docs.lando.dev/images/icon.svg" alt="Lando logo"></a> # Lando ### A Liberating Dev Tool For All Your Projects The local development and DevOps tool trusted by professional developers across the galaxy. Free yourself from the mind-forged manacles of lesser dev tools. Save time, headaches, frustration and do more real work. **[learn more](https://lando.dev) | [what is it good for?](https://docs.lando.dev/getting-started/#what-is-it-good-for) | [wait, doesn't docker compose do this?](https://docs.lando.dev/getting-started/#wait-doesn-t-docker-compose-do-this)** ## Support Lando Lando is and always will be FREE and OPEN SOURCE. As such it relies on generous contributions from its community to fund its development. Join our list of list of [great sponsors!](https://lando.dev/sponsor/) by contributing. [GitHub Sponsors](https://github.com/sponsors/lando) | [Patreon](https://www.patreon.com/devwithlando) | [OpenCollective](https://opencollective.com/lando) ## Documentation ### Getting Started [Introduction](https://docs.lando.dev/getting-started) | [CLI Usage](https://docs.lando.dev/cli/) | [Installation](https://docs.lando.dev/getting-started/installation) ### Recipes [Backdrop](https://docs.lando.dev/backdrop/) | [Drupal 6, 7, 8, 9, and 10](https://docs.lando.dev/drupal/) | [Joomla](https://docs.lando.dev/joomla/) | [Lagoon](https://docs.lando.dev/lagoon/) | [Laravel](https://docs.lando.dev/laravel/) | [LAMP](https://docs.lando.dev/lamp/) | [LEMP](https://docs.lando.dev/lemp/) | [MEAN](https://docs.lando.dev/mean/) | [Pantheon](https://docs.lando.dev/pantheon/) | [Platform.sh](https://docs.lando.dev/platformsh/) | [WordPress](https://docs.lando.dev/wordpress/) ### Services [Apache](https://docs.lando.dev/apache/) | [Compose](https://docs.lando.dev/compose/) | [dotnet](https://docs.lando.dev/dotnet/) | [Elasticsearch](https://docs.lando.dev/elasticsearch/) | [Go](https://docs.lando.dev/go/) | [MailHog](https://docs.lando.dev/mailhog/) | [MariaDB](https://docs.lando.dev/mariadb/) | [MySQL](https://docs.lando.dev/mysql/) | [MSSQL](https://docs.lando.dev/mssql/) | [nginx](https://docs.lando.dev/nginx/) | [Node](https://docs.lando.dev/node/) | [PHP](https://docs.lando.dev/php/) | [PhpMyAdmin](https://docs.lando.dev/phpmyadmin/) | [Postgres](https://docs.lando.dev/postgres/) | [Python](https://docs.lando.dev/python/) | [Redis](https://docs.lando.dev/redis/) | [Ruby](https://docs.lando.dev/ruby/) | [Solr](https://docs.lando.dev/solr/) | [Tomcat](https://docs.lando.dev/tomcat/) | [Varnish](https://docs.lando.dev/varnish/) ### Advanced Configuration [Landofile](https://docs.lando.dev/config/lando.html) | [Recipes](https://docs.lando.dev/config/recipes.html) | [Services & Build Steps](https://docs.lando.dev/config/services.html) | [Tooling](https://docs.lando.dev/config/tooling.html) | [Proxy & Nice Url Routing](https://docs.lando.dev/config/proxy.html) | [Environment](https://docs.lando.dev/config/env.html) | [Events & Automation](https://docs.lando.dev/config/events.html) | [Experimental](https://docs.lando.dev/config/experimental.html) | [Networking](https://docs.lando.dev/config/networking.html) | [Performance](https://docs.lando.dev/config/performance.html) | [Release Channels](https://docs.lando.dev/config/releases.html) | [SSH Keys](https://docs.lando.dev/config/ssh.html) | [Global Config](https://docs.lando.dev/config/global.html) ## Help, Troubleshooting & Support [Guides and Tutorials](https://docs.lando.dev/guides/lando-info.html) | [Examples](https://docs.lando.dev/getting-started/what-it-do.html#you-have-some-examples) | [Known Issues](https://docs.lando.dev/help/dns-rebind.html) | [Accessing Logs](https://docs.lando.dev/help/logs.html) | [GitHub Issue Queue](https://github.com/lando/lando/issues) | [Slack Channel](https://launchpass.com/devwithlando) | [YouTube Videos](https://www.youtube.com/channel/UCl_QBNuGJNoo7yH-n18K7Kg) ## Engage [Contribute to the Project](https://docs.lando.dev/contrib) | [Join the Alliance](https://docs.lando.dev/contrib) | [Events and Meetups](https://lando.dev/events/) | [Blog](https://lando.dev/blog/) | [Follow on Twitter](https://twitter.com/devwithlando) ## Security Issues If you have discovered a security issue with Lando, please contact the Lando Security Team directly at [[email protected]](mailto:[email protected]). We manage security issues separately in a private repository until the issue has been resolved. Even if you're not sure if it's a security problem, please contact the security team before filing an issue, blogging, or tweeting about it. ## Other Resources * [Mountain climbing advice](https://www.youtube.com/watch?v=tkBVDh7my9Q)

A curated list of awesome neuroscience libraries, software and any content related to the domain.

Beginners book on Python - start here if you don't know programming

# A Byte of Python "A Byte of Python" is a free book on programming using the Python language. It serves as a tutorial or guide to the Python language for a beginner audience. If all you know about computers is how to save text files, then this is the book for you. ## For Python version 3 This book will teach you to use Python version 3. There will also be guidance for you to adapt to the older and more common Python version 2 in the book. ## Who reads A Byte of Python? {#who-reads-bop} Here are what people are saying about the book: > Somewhere around 2004 - 05 when I was convinced I wasn’t smart enough to be a programmer , I came came across the original A Byte of #Python, and that changed my entire perspective on computing and life , I owe a lot to that book @swaroopch had written. > -- [Rahul](https://twitter.com/unrahu1/status/1288743029637959682) on Jul 30, 2020 > This is the book that got me into programming almost a decade ago. > Thank you @swaroopch. You changed my life. > -- [Stefan Froelich](https://twitter.com/TheDumbTechGuy/status/1157245235052929024) on Aug 2, 2019 <!-- --> > I am writing this email to thank you for the great help your book has done for me! It was a really good book that I enjoyed thoroughly. As a 15 year old who has never done programming before, trying to learn Python online was difficult and I couldn't understand anything. But I felt like your book gave was much easier to understand and eased me into the whole new world of programming. Thanks to you, I can now write a high level language with ease. I thought programming would be hard and boring, but with your book's help, I realised how fun and interesting yet simple it can be! I would like to thank you again for your hard work on helping out beginners like me. > -- [Prottyashita Tahiyat](mailto:[email protected]) on Sep 17, 2019 <!-- --> > This is the best beginner's tutorial I've ever seen! Thank you for your effort. > -- [Walt Michalik](mailto:[email protected]) <!-- --> > The best thing i found was "A Byte of Python", which is simply a brilliant book for a beginner. It's well written, the concepts are well explained with self evident examples. > -- [Joshua Robin](mailto:[email protected]) <!-- --> > Excellent gentle introduction to programming #Python for beginners > -- [Shan Rajasekaran](https://twitter.com/ShanRajasekaran/status/268910645842423809) <!-- --> > start to love python with every single page read > -- [Herbert Feutl](https://twitter.com/HerbertFeutl/status/11901471389913088) <!-- --> > perfect beginners guide for python, will give u key to unlock magical world of python > -- [Dilip](https://twitter.com/Dili_mathilakam/status/220033783066411008) <!-- --> > I should be doing my actual "work" but just found "A Byte of Python". A great guide with great examples. > -- [Biologist John](https://twitter.com/BiologistJohn/statuses/194726001803132928) <!-- --> > Recently started reading a Byte of python. Awesome work. And that too for free. Highly recommended for aspiring pythonistas. > -- [Mangesh](https://twitter.com/mangeshnanoti/status/225680668867321857) <!-- --> > A Byte of Python, written by Swaroop. (this is the book I'm currently reading). Probably the best to start with, and probably the best in the world for every newbie or even a more experienced user. > -- [Apostolos](http://apas.gr/2010/04/27/learning-python/) <!-- --> > Enjoying Reading #ByteOfPython by @swaroopch best book ever > -- [Yuvraj Sharma](https://twitter.com/YuvrajPoudyal/status/448050415356346368) <!-- --> > A Byte of Python by @swaroopch is still the "Best newbie guide to python" > -- [Nickson Kaigi](https://twitter.com/nickaigi/status/1136963950711648256) <!-- --> > Thank you so much for writing A Byte Of Python. I just started learning how to code two days ago and I'm already building some simple games. Your guide has been a dream and I just wanted to let you know how valuable it has been. > -- Franklin <!-- --> > I'm from Dayanandasagar College of Engineering (7th sem, CSE). Firstly i want to say that your book "The byte of python" is too good a book for a beginner in python like me.The concepts are so well explained with simple examples that helped me to easily learn python. Thank you so much. > -- Madhura <!-- --> > I am a 18 year old IT student studying at University in Ireland. I would like to express my gratitude to you for writing your book "A Byte of Python", I already had knowledge of 3 programming langagues - C, Java and Javascript, and Python was by far the easiest langague I have ever learned, and that was mainly because your book was fantastic and made learning python very simple and interesting. It is one of the best written and easy to follow programming books I have ever read. Congratulations and keep up the great work. > -- Matt <!-- --> > Hi, I'm from Dominican Republic. My name is Pavel, recently I read your book _A Byte of Python_ and I consider it excellent!! :). I learnt much from all the examples. Your book is of great help for newbies like me... > -- [Pavel Simo](mailto:[email protected]) <!-- --> > I am a student from China, Now ,I have read you book A byte of Python, Oh it's beautiful. The book is very simple but can help all the first learnners. You know I am interesting in Java and cloud computing many times, i have to coding programm for the server, so i think python is a good choice, finish your book, i think its not only a good choice its must use the Python. My English is not very well, the email to you, i just wanna thank you! Best Wishes for you and your family. > -- Roy Lau <!-- --> > I recently finished reading Byte of Python, and I thought I really ought to thank you. I was very sad to reach the final pages as I now have to go back to dull, tedious oreilly or etc. manuals for learning about python. Anyway, I really appreciate your book. > [Samuel Young](mailto:[email protected]) <!-- --> > Dear Swaroop, I am taking a class from an instructor that has no interest in teaching. We are using Learning Python, second edition, by O'Reilly. It is not a text for beginner without any programming knowledge, and an instructor that should be working in another field. Thank you very much for your book, without it I would be clueless about Python and programming. Thanks a million, you are able to _break the message down_ to a level that beginners can understand and not everyone can. > -- [Joseph Duarte](mailto:[email protected]) <!-- --> > I love your book! It is the greatest Python tutorial ever, and a very useful reference. Brilliant, a true masterpiece! Keep up the good work! > -- Chris-André Sommerseth <!-- --> > First of all, I want to say thanks to you for this great book. I think it is a good book for those who are looking for a beginner's tutorial for Python. > It is about two or there years ago, I think, when I first heard of this book. At that time, I was unable to read books in English yet, so I got a chinese translation, which took me into the gate of Python programming. > Recently, I reread this book. This time, of course, the english version. I couldn't believe that I can read the whole book without my dictionary at hand. Of course, it all dues to your effort to make this book an easy-to-understand one. > -- [myd7349](https://github.com/swaroopch/byte_of_python/pull/13) <!-- --> > I'm just e-mailing you to thank you for writing Byte of Python online. I had been attempting Python for a few months prior to stumbling across your book, and although I made limited success with pyGame, I never completed a program. > Thanks to your simplification of the categories, Python actually seems a reachable goal. It seems like I have finally learned the foundations and I can continue into my real goal, game development. > ... > Once again, thanks VERY much for placing such a structured and helpful guide to basic programming on the web. It shoved me into and out of OOP with an understanding where two text books had failed. > -- [Matt Gallivan](mailto:[email protected]) <!-- --> > I would like to thank you for your book _A Byte of Python_ which i myself find the best way to learn python. I am a 15 year old i live in egypt my name is Ahmed. Python was my second programming language i learn visual basic 6 at school but didn't enjoy it, however i really enjoyed learning python. I made the addressbook program and i was sucessful. i will try to start make more programs and read python programs (if you could tell me source that would be helpful). I will also start on learning java and if you can tell me where to find a tutorial as good as yours for java that would help me a lot. Thanx. > -- [Ahmed Mohammed](mailto:[email protected]) <!-- --> > A wonderful resource for beginners wanting to learn more about Python is the 110-page PDF tutorial A Byte of Python by Swaroop C H. It is well-written, easy to follow, and may be the best introduction to Python programming available. > -- [Drew Ames](http://www.linux.com/feature/126522) <!-- --> > Yesterday I got through most of Byte of Python on my Nokia N800 and it's the easiest and most concise introduction to Python I have yet encountered. Highly recommended as a starting point for learning Python. > -- [Jason Delport](http://paxmodept.com/telesto/blogitem.htm?id=627) <!-- --> > Byte of Vim and Python by @swaroopch is by far the best works in technical writing to me. Excellent reads #FeelGoodFactor > -- [Surendran](http://twitter.com/suren/status/12840485454) <!-- --> > "Byte of python" best one by far man > (in response to the question "Can anyone suggest a good, inexpensive resource for learning the basics of Python? ") > -- [Justin LoveTrue](http://www.facebook.com/pythonlang/posts/406873916788) <!-- --> > The Book Byte of python was very helpful ..Thanks bigtime :) > [Chinmay](https://twitter.com/a_chinmay/status/258822633741762560) <!-- --> > Always been a fan of A Byte of Python - made for both new and experienced programmers. > -- [Patrick Harrington](http://stackoverflow.com/a/457785/4869) <!-- --> > I started learning python few days ago from your book..thanks for such a nice book. it is so well written, you made my life easy..so you found a new fan of yours..thats me :) tons of thanks. > -- [Gadadhari Bheem](https://twitter.com/Pagal_e_azam/statuses/242865885256232960) <!-- --> > Before I started to learn Python, I've acquired basic programming skills in Assembly, C, C++, C# and Java. The very reason I wanted to learn Python is it's popular (people are talking about it) and powerful (reality). This book written by Mr. Swaroop is a very good guide for both brand-new programmers and new python programmers. Took 10 half days to go through it. Great Help! > -- [Fang Biyi (PhD Candidate ECE, Michigan State University)](mailto:[email protected]) <!-- --> > Thank you ever so much for this book!! > This book cleared up many questions I had about certain aspects of Python such as object oriented programming. > I do not feel like an expert at OO but I know this book helped me on a first step or two. > I have now written several python programs that actually do real things for me as a system administrator. They are all procedural oriented but they are small by most peoples standards. > Again, thanks for this book. Thank you for having it on the web. > -- Bob <!-- --> > I just want to thank you for writing the first book on programming I've ever really read. Python is now my first language, and I can just imagine all the possibilities. So thank you for giving me the tools to create things I never would have imagined I could do before. > -- "The Walrus" <!-- --> > I wanted to thank you for writing _A Byte Of Python_ (2 & 3 Versions). It has been invaluable to my learning experience in Python & Programming in general. > Needless to say, I am a beginner in the programming world, a couple of months of self study up to this point. I had been using youtube tutorials & some other online tutorials including other free books. I decided to dig into your book yesterday, & I've learned more on the first few pages than any other book or tutorial. A few things I had been confused about, were cleared right up with a GREAT example & explanation. Can't wait to read (and learn) more!! > Thank you so much for not only writing the book, but for putting it under the creative commons license (free). Thank goodness there are unselfish people like you out there to help & teach the rest of us. > -- Chris <!-- --> > I wrote you back in 2011 and I was just getting into Python and wanted to thank you for your tutorial "A Byte of Python". Without it, I would have fallen by the wayside. Since then I have gone on to program a number of functions in my organization with this language with yet more on the horizon. I would not call myself an advanced programmer by any stretch but I notice the occasional request for assistance now from others since I started using it. I discovered, while reading "Byte" why I had ceased studying C and C\++ and it was because the book given to me started out with an example containing an augmented assignment. Of course, there was no explanation for this arrangement of operators and I fell on my head trying to make sense of what was on the written page. As I recall it was a most frustrating exercise which I eventually abandoned. Doesn't mean C or C++ is impossible to learn, or even that I am stupid, but it does mean that the documentation I worked my way through did not define the symbols and words which is an essential part of any instruction. Just as computers will not be able to understand a computer word or computer symbol that is outside the syntax for the language being used, a student new to any field will not grasp his subject if he encounters words or symbols for which there are no definitions. You get a "blue screen" as it were in either case. The solution is simple, though: find the word or symbol and get the proper definition or symbol and lo and behold,the computer or student can proceed. Your book was so well put together that I found very little in it I couldn't grasp. So, thank you. I encourage you to continue to include full definitions of terms. The documentation with Python is good, once you know, (the examples are its strength from what I see) but in many cases it seems that you have to know in order to understand the documentation which to my mind is not what should be. Third party tutorials express the need for clarification of the documentation and their success largely depends on the words that are used to describe the terminology. I have recommended your book to many others. Some in Australia, some in the Caribbean and yet others in the US. It fills a niche no others do. I hope you are doing well and wish you all the success in the future. > -- Nick <!-- --> > hey, this is ankush(19). I was facing a great difficulty to start with python. I tried a lot of books but all were bulkier and not target oriented; and then i found this lovely one, which made me love python in no time. Thanks a lot for this "beautiful piece of book". > -- Ankush <!-- --> > I would like to thank you for your excellent guide on Python. I am a molecular biologist (with little programming background) and for my work I need to handle big datasets of DNA sequences and to analyse microscope images. For both things, programming in python has been useful, if not essential to complete and publish a 6-years project. > That such a guide is freely available is a clear sign that the forces of evil are not yet ruling the world! :) > -- Luca <!-- --> > Since this is going to be the first language you learn, you should use A Byte of Python. It really gives a proper introduction into programming in Python and it is paced well enough for the average beginner. The most important thing from then on will be actually starting to practice making your own little programs. > -- ["{Unregistered}"](http://www.overclock.net/t/1177951/want-to-learn-programming-where-do-i-start#post_15837176) <!-- --> > Just to say a loud and happy _thank you very much_ for publishing "A Byte of Python" and "A Byte of Vim". Those books were very useful to me four or five years ago when I starting learning programming. Right now I'm developing a project that was a dream for a long, long time and just want to say _thank you_. Keep walking. You are a source of motivation. All the best. > -- Jocimar <!-- --> > Finished reading A byte of Python in 3 days. It is thoroughly interesting. Not a single page was boring. I want to understand the Orca screen reader code. Your book has hopefully equipped me for it. > -- Dattatray <!-- --> > Hi, 'A byte of python' is really a good reading for python beginners. So, again, NICE WORK! > i'm a 4 years experienced Java&C developer from China. Recently, i want to do some work on zim-wiki note project which uses pygtk to implement. > i read your book in 6 days, and i can read and write python code examples now. > thx for your contribution. > plz keep your enthusiasm to make this world better, this is just a little encourage from China. > -- Lee <!-- --> > I am Isen from Taiwan, who is a graduating PhD student in Electrical Engineering Department of National Taiwan University. I would like to thank you for your great book. I think it is not only just easy to read but also comprehensive and complete for a new comer of Python. The reason I read your book is that I am starting to work on the GNU Radio framework. Your book let me catch most of important core ideas and skill of Python with a minimum time. > I also saw that you do not mind that readers send you a thank note in your book. So I really like your book and appreciate it. Thanks. > -- [Isen I-Chun Chao](mailto:[email protected]) The book is even used by NASA! It is used in their [Jet Propulsion Laboratory](https://web.archive.org/web/20130614003212/http://dsnra.jpl.nasa.gov/software/Python/byte-of-python/output/byteofpython_html/) with their Deep Space Network project. ## Academic Courses This book is/was being used as instructional material in various educational institutions: - 'Principles of Programming Languages' course at [Vrije Universiteit, Amsterdam](http://www.few.vu.nl/~nsilvis/PPL/2007/index.html) - 'Basic Concepts of Computing' course at [University of California, Davis](http://www.cs.ucdavis.edu/courses/exp_course_desc/10.html) - 'Programming With Python' course at [Harvard University](http://www.people.fas.harvard.edu/~preshman/python_winter.html) - 'Introduction to Programming' course at [University of Leeds](http://www.comp.leeds.ac.uk/acom1900/) - 'Introduction to Application Programming' course at [Boston University](http://www.cs.bu.edu/courses/cs108/materials.html) - 'Information Technology Skills for Meteorology' course at [University of Oklahoma](http://gentry.metr.ou.edu/byteofpython/) - 'Geoprocessing' course at [Michigan State University](http://www.msu.edu/~ashton/classes/825/index.html) - 'Multi Agent Semantic Web Systems' course at the [University of Edinburgh](http://homepages.inf.ed.ac.uk/ewan/masws/) - 'Introduction to Computer Science and Programming' at [MIT OpenCourseWare](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-00sc-introduction-to-computer-science-and-programming-spring-2011/references/) - 'Basic programming at the Faculty of Social Sciences, University of Ljubljana, Slovenia' -- [Aleš Žiberna](mailto:[email protected]) says _"I (and my predecessor) have been using your book as the main literature for this course"_ - 'Introduction to programming', Department of Information Sciences, University of Zadar, Croatia -- Krešimir Zauder says _"I would like to inform you that A Byte of Python is a mandatory read at my course"_ ## License This book is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/). This means: - You are free to Share i.e. to copy, distribute and transmit this book - You are free to Remix i.e. to make changes to this book (especially translations) - You are free to use it for commercial purposes Please note: - Please do *not* sell electronic or printed copies of the book unless you have clearly and prominently mentioned in the description that these copies are *not* from the original author of this book. - Attribution *must* be shown in the introductory description and front page of the document by linking back to {{ book.officialUrl }} and clearly indicating that the original text can be fetched from this location. - All the code/scripts provided in this book is licensed under the [3-clause BSD License](http://www.opensource.org/licenses/bsd-license.php) unless otherwise noted. ## Read Now You can read it online at {{ book.officialUrl }} ## Buy The Book A printed hardcopy of the book can be purchased at {{ book.buyBookUrl }} for your offline reading pleasure, and to support the continued development and improvement of this book. ## Download Visit {{ book.downloadUrl }} to download a PDF file (best for desktop reading) or an EPUB file (best for devices such as mobile, tablet, ebook readers). Visit {{ book.sourceUrl }} for the raw content (for suggesting corrections, changes, translating, etc.) ## Read the book in your native language If you are interested in reading or contributing translations of this book to other human languages, please see [Translations](./translations.md#translations).

Samples and bindings for the Google Assistant API

# Google Assistant SDK for devices - Python This repository contains the [Python][python] packages for the [Google Assistant SDK][google-assistant-sdk]. To get started, see the following developer guides: - [Introduction to the Google Assistant Service][getting-started-python]. ## Content - [google-assistant-grpc](google-assistant-grpc): autogenerated Python bindings to communicate with the [Google Assistant Service][google-assistant-api] *available for non-commercial use* - ~~google-assistant-library: Python bindings for the Google Assistant Library~~ *deprecated* - [google-assistant-sdk](google-assistant-sdk): tools and python samples to help developers get started with the [Google Assistant SDK][google-assistant-sdk] - [googlesamples/assistant/grpc](google-assistant-sdk/googlesamples/assistant/grpc): reference sample for the [Google Assistant Service][google-assistant-api] - ~~googlesamples/assistant/library: reference sample for the Google Assistant library~~ *deprecated* ## Contributing Contributions to this repository are always welcome and highly encouraged. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to get started. ## License Copyright (C) 2017 Google Inc. 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. [python]: https://www.python.org [google-assistant-api]: https://developers.google.com/assistant/sdk/reference/rpc [google-assistant-sdk]: https://developers.google.com/assistant/sdk [getting-started-python]: https://developers.google.com/assistant/sdk/guides/service/python/

LeetCode The Hard Way - From Absolute Beginner to Quitter. Join Discord: https://discord.com/invite/Nqm4jJcyBf

# Welcome!  ## Introduction For those who don't know, [LeetCode](https://leetcode.com/) is is a platform that offers a collection of coding problems and challenges that are designed to help developers improve their skills in data structures and algorithms. Initially, this project was created for my own personal education, however now it is publicly available and open for anyone to use. Our tutorial covers a wide range of Data Structures and Algorithms, from basic to advanced levels, by working through problems on LeetCode. We aim to provide in-depth explanations with detailed line-by-line comments and articles to help learners understand the solution. Additionally, we encourage learners to join our Discord community to discuss LeetCode topics with other members. Our intended audience is any individual who wishes to enhance their programming abilities or learn how to solve problems on LeetCode. ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md). ## Outro GLHF.

Modular file scanning/analysis framework

MultiScanner ============ [](https://travis-ci.org/mitre/multiscanner) Introduction ------------ MultiScanner is a file analysis framework that assists the user in evaluating a set of files by automatically running a suite of tools for the user and aggregating the output. Tools can be custom built Python scripts, web APIs, software running on another machine, etc. Tools are incorporated by creating modules that run in the MultiScanner framework. Modules are designed to be quickly written and easily incorporated into the framework. Currently written and maintained modules are related to malware analytics, but the framework is not limited to that scope. For a list of modules you can look in [modules/](modules). Descriptions and config options can be found on the [Analysis Modules](http://multiscanner.readthedocs.io/en/latest/use/use-analysis-mods.html) page. MultiScanner also supports a distributed workflow for sample storage, analysis, and report viewing. This functionality includes a web interface, a REST API, a distributed file system (GlusterFS), distributed report storage / searching (Elasticsearch), and distributed task management (Celery / RabbitMQ). Please see [Architecture](http://multiscanner.readthedocs.io/en/latest/arch.html) for more details. Usage ----- MultiScanner can be used as a command-line interface, a Python API, or a distributed system with a web interface. See the documentation for more detailed information on [installation](http://multiscanner.readthedocs.io/en/latest/install.html) and [usage](http://multiscanner.readthedocs.io/en/latest/use/index.html). ### Command-Line ### Install Python (2.7 or 3.4+) if you haven't already. Then run the following (substituting the actual file you want to scan for `<file>`): ``` bash $ git clone https://github.com/mitre/multiscanner.git $ cd multiscanner $ sudo -HE ./install.sh $ multiscanner init ``` This will generate a default configuration for you. Check `config.ini` to see what modules are enabled. See [Configuration](http://multiscanner.readthedocs.io/en/latest/install.html#configuration) for more information. Now you can scan a file (substituting the actual file you want to scan for `<file>`): ``` bash $ multiscanner <file> ``` You can run the following to get a list of all of MultiScanner's command-line options: ``` bash $ multiscanner --help ``` **Note**: If you are not on a RedHat or Debian based Linux distribution, instead of running the `install.sh` script, install pip (if you haven't already) and run the following: ``` bash $ pip install -r requirements.txt ``` ### Python API ### ``` python import multiscanner multiscanner.config_init(filepath) output = multiscanner.multiscan(file_list) results = multiscanner.parse_reports(output, python=True) ``` ### Web Interface ### Install the latest versions of [Docker](https://docs.docker.com/engine/installation/) and [Docker Compose](https://docs.docker.com/compose/install/) if you haven't already. ``` bash $ git clone https://github.com/mitre/multiscanner.git $ cd multiscanner $ docker-compose up ``` You may have to wait a while until all the services are up and running, but then you can use the web interface by going to `http://localhost:8000` in your web browser. *Note*: this should not be used in production; it is simply an introduction to what a full installation would look like. See [here](http://multiscanner.readthedocs.io/en/latest/install.html#standalone-docker-installation) for more details. Documentation ------------- For more information, see the [full documentation](http://multiscanner.readthedocs.io/) on ReadTheDocs.

Python for《Deep Learning》，该书为《深度学习》(花书) 数学推导、原理剖析与源码级别代码实现

# Deep Learning 《**深度学习**》是深度学习领域唯一的综合性图书，全称也叫做**深度学习 AI圣经(Deep Learning)**，由三位全球知名专家IanGoodfellow、YoshuaBengio、AaronCourville编著，全书囊括了数学及相关概念的背景知识，包括线性代数、概率论、信息论、数值优化以及机器学习中的相关内容。同时，它还介绍了工业界中实践者用到的深度学习技术，包括深度前馈网络、正则化、优化算法、卷积网络、序列建模和实践方法等，并且调研了诸如自然语言处理、语音识别、计算机视觉、在线推荐系统、生物信息学以及视频游戏方面的应用。最后，深度学习全书还提供了一些研究方向，涵盖的理论主题包括线性因子模型、自编码器、表示学习、结构化概率模型、蒙特卡罗方法、配分函数、近似推断以及深度生成模型，适用于相关专业的大学生或研究生使用。 <img src="https://github.com/MingchaoZhu/DeepLearning/blob/master/docs/cover.jpg" width="200" height="300" alt="深度学习封面" align=center> 可以下载《深度学习》的中文版 [pdf](https://github.com/MingchaoZhu/DeepLearning/releases/download/v0.0.1/DL_cn.pdf) 和英文版 [pdf](https://github.com/MingchaoZhu/DeepLearning/releases/download/v0.0.0/DL_en.pdf) 直接阅读。 对于本项目的工作，你可以直接下载 [深度学习_原理与代码实现.pdf](https://github.com/MingchaoZhu/DeepLearning/releases/download/v1.1.1/default.pdf) (后面会对该书不断更新) --- 《深度学习》可以说是深度学习与人工智能的入门宝典，许多算法爱好者、机器学习培训班、互联网企业的面试，很多都参考这本书。但本书晦涩，加上官方没有提供代码实现，因此某些地方较难理解。本项目**基于数学推导和产生原理重新描述了书中的概念**，并用**Python** (numpy 库为主) 复现了书本内容 ( **源码级代码实现。推导过程和代码实现均放在了下载区的 pdf 文件中**，重要部分的实现代码也放入 **code 文件夹**中 )。 然而我水平有限，但我真诚地希望这项工作可以帮助到更多人学习深度学习算法。我需要大家的建议和帮助。如果你在阅读中遇到有误或解释不清的地方，希望可以汇总你的建议，在 Issues 提出。如果你也想加入这项工作书写中或有其他问题，可以联系我的邮箱。如果你在你的工作或博客中用到了本书，还请可以注明引用链接。 写的过程中参考了较多网上优秀的工作，所有参考资源保存在了`reference.txt`文件中。 # 留言 这份工作就是在写这一本 [深度学习_原理与代码实现.pdf](https://github.com/MingchaoZhu/DeepLearning/releases/download/v1.1.1/default.pdf)。正如你在 pdf 文件中所见到的，《深度学习》涉及到的每一个概念，都会去给它详细的描述、原理层面的推导，以及用代码的实现。代码实现不会调用 Tensorflow、PyTorch、MXNet 等任何深度学习框架，甚至包括 sklearn (pdf 里用到 sklearn 的部分都是用来验证代码无误)，一切代码都是从原理层面实现 (Python 的基础库 NumPy)，并有详细注释，与代码区上方的原理描述区一致，你可以结合原理和代码一起理解。 这份工作的起因是我自身的热爱，但为完成这份工作我需要投入大量的时间精力，一般会写到凌晨两三点。推导、代码、作图都是慢慢打磨的，我会保证这份工作的质量。这份工作会一直更新完，已经上传的章节也会继续补充内容。如果你在阅读过程中遇到有想要描述的概念点或者错误点，请发邮件告知我。 真的很感谢你的认可与推广。最后，请等待下一次更新。 我是 朱明超，我的邮箱是：[email protected] # 更新说明 2020/3/： ```python 1. 修改第五章决策树部分，补充 ID3 和 CART 的原理，代码实现以 CART 为主。 2. 第七章添加 L1 和 L2 正则化最优解的推导 (即 L1稀疏解的原理)。 3. 第七章添加集成学习方法的推导与代码实现，包括 Bagging (随机森林)、Boosting (Adaboost、GBDT、XGBoost)。 4. 第八章添加牛顿法与拟牛顿法 (DFP、BFGS、L-BFGS) 的推导。 5. 第十一章节添加贝叶斯线性回归、高斯过程回归 (GPR) 与贝叶斯优化的推导与代码实现。 ``` 后面每次的更新内容会统一放在 `update.txt` 文件中。 # 章节目录与文件下载 除了《深度学习》书中的概念点，**本项目也在各章节添加一些补充知识，例如第七章集成学习部分的 随机森林、Adaboost、GBDT、XGBoost 的原理剖析和代码实现等，又或者第十二章对当前一些主流方法的描述**。大的章节目录和 pdf 文件下载链接可以详见下表，而具体 pdf 文件中的实际目录请参考 `contents.txt`。你可以在下面的 pdf 链接中下载对应章节，也可以在 [releases](https://github.com/MingchaoZhu/DeepLearning/releases) 界面直接下载所有文件。 | 中文章节 | 英文章节 | 下载<br />(含推导与代码实现) | | ------------ | ------------ | ------------ | | 第一章 前言 | 1 Introduction | | | 第二章 线性代数 | 2 Linear Algebra | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/2%20%E7%BA%BF%E6%80%A7%E4%BB%A3%E6%95%B0.pdf) | | 第三章 概率与信息论 | 3 Probability and Information Theory | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/3%20%E6%A6%82%E7%8E%87%E4%B8%8E%E4%BF%A1%E6%81%AF%E8%AE%BA.pdf) | | 第四章 数值计算 | 4 Numerical Computation | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/4%20%E6%95%B0%E5%80%BC%E8%AE%A1%E7%AE%97.pdf) | | 第五章 机器学习基础 | 5 Machine Learning Basics | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/5%20%E6%9C%BA%E5%99%A8%E5%AD%A6%E4%B9%A0%E5%9F%BA%E7%A1%80.pdf) | | 第六章 深度前馈网络 | 6 Deep Feedforward Networks | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/6%20%E6%B7%B1%E5%BA%A6%E5%89%8D%E9%A6%88%E7%BD%91%E7%BB%9C.pdf) | | 第七章 深度学习中的正则化 | 7 Regularization for Deep Learning | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/7%20%E6%B7%B1%E5%BA%A6%E5%AD%A6%E4%B9%A0%E4%B8%AD%E7%9A%84%E6%AD%A3%E5%88%99%E5%8C%96.pdf) | | 第八章 深度模型中的优化 | 8 Optimization for Training Deep Models | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/8%20%E6%B7%B1%E5%BA%A6%E6%A8%A1%E5%9E%8B%E4%B8%AD%E7%9A%84%E4%BC%98%E5%8C%96.pdf) | | 第九章 卷积网络 | 9 Convolutional Networks | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/9%20%E5%8D%B7%E7%A7%AF%E7%BD%91%E7%BB%9C.pdf) | | 第十章 序列建模：循环和递归网络 | 10 Sequence Modeling: Recurrent and Recursive Nets | | | 第十一章 实践方法论 | 11 Practical Methodology | [pdf](https://github.com/MingchaoZhu/DeepLearning/raw/master/11%20%E5%AE%9E%E8%B7%B5%E6%96%B9%E6%B3%95%E8%AE%BA.pdf) | | 第十二章 应用 | 12 Applications | | | 第十三章 线性因子模型 | 13 Linear Factor Models | | | 第十四章 自编码器 | 14 Autoencoders | | | 第十五章 表示学习 | 15 Representation Learning | | | 第十六章 深度学习中的结构化概率模型 | 16 Structured Probabilistic Models for Deep Learning | | | 第十七章 蒙特卡罗方法 | 17 Monte Carlo Methods | | | 第十八章 直面配分函数 | 18 Confronting the Partition Function | | | 第十九章 近似推断 | 19 Approximate Inference | | | 第二十章 深度生成模型 | 20 Deep Generative Models | | 尚未上传的章节会在后续陆续上传。 # 致谢 感谢对本项目的认可和推广。 + 专知：https://mp.weixin.qq.com/s/dVD-vKJsMGqnBz2v4O-Q3Q + GitHubDaily：https://m.weibo.cn/5722964389/4504392843690487 + 程序员遇见GitHub：https://mp.weixin.qq.com/s/EzFOnwpkv7mr2TSjPtVG9A + 爱可可：https://m.weibo.cn/1402400261/4503389646699745 # 赞助 本项目书写耗费时间精力。如果本项目对你有帮助，可以请作者吃份冰淇淋： <img src="./docs/pay.jpg" width="200" height="200" alt="支付" align=center>

A cluster computing framework for processing large-scale geospatial data

<img src="https://www.apache.org/logos/res/sedona/sedona.png" width="400"> [](https://github.com/apache/sedona/actions/workflows/java.yml) [](https://github.com/apache/sedona/actions/workflows/python.yml) [](https://github.com/apache/sedona/actions/workflows/r.yml) [](https://github.com/apache/sedona/actions/workflows/example.yml) [](https://github.com/apache/sedona/actions/workflows/docs.yml) Click [](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=binder) and play the interactive Sedona Python Jupyter Notebook immediately! [](https://discord.gg/9A3k5dEBsY) Apache Sedona™ is a cluster computing system for processing large-scale spatial data. Sedona equips cluster computing systems such as Apache Spark and Apache Flink with a set of out-of-the-box distributed Spatial Datasets and Spatial SQL that efficiently load, process, and analyze large-scale spatial data across machines. |Download statistics| **Maven** | **PyPI** | **CRAN** | |:-------------:|:------------------:|:--------------:|:---------:| | Apache Sedona | 180k/month |[](https://pepy.tech/project/apache-sedona) [](https://pepy.tech/project/apache-sedona)|[](https://cran.r-project.org/package=apache.sedona) [](https://cran.r-project.org/package=apache.sedona)| | Archived GeoSpark releases |10k/month|[](https://pepy.tech/project/geospark)[](https://pepy.tech/project/geospark)| | ## System architecture <img src="docs/image/architecture.svg" width="600"> ## Our users and code contributors are from ... <img src="docs/image/sedona-community.png" width="600"> ## Modules in the source code | Name | API | Introduction| |---|---|---| |Core | Scala/Java | Distributed Spatial Datasets and Query Operators | |SQL | Spark RDD/DataFrame in Scala/Java/SQL |Geospatial data processing on Apache Spark| |Flink | Flink DataStream/Table in Scala/Java/SQL | Geospatial data processing on Apache Flink |Viz | Spark RDD/DataFrame in Scala/Java/SQL | Geospatial data visualization on Apache Spark| |Python | Spark RDD/DataFrame in Python | Python wrapper for Sedona | |R | Spark RDD/DataFrame in R | R wrapper for Sedona | |Zeppelin | Apache Zeppelin | Plugin for Apache Zeppelin 0.8.1+| ### Sedona supports several programming languages: Scala, Java, SQL, Python and R. ## Compile the source code Please refer to [Sedona website](http://sedona.apache.org/setup/compile/) ## Contact Feedback to improve Apache Sedona: [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSeYHlc4cX5Pw0bIx2dQbhHDeWF2G2Wf7BgN_n29IzXsSzwptA/viewform) Twitter: [Sedona@Twitter](https://twitter.com/ApacheSedona) [](https://discord.gg/9A3k5dEBsY) [Sedona JIRA](https://issues.apache.org/jira/projects/SEDONA): Bugs, Pull Requests, and other similar issues [Sedona Mailing Lists](https://lists.apache.org/list.html?sedona.apache.org): [[email protected]](https://lists.apache.org/[email protected]): project development, general questions or tutorials. * Please first subscribe and then post emails. To subscribe, please send an email (leave the subject and content blank) to [email protected] # Please visit [Apache Sedona website](http://sedona.apache.org/) for detailed information ## Powered by <img src="https://www.apache.org/foundation/press/kit/asf_logo_wide.png" width="500">

another book on data science

# Another Book on Data Science - learn R and Python in parallel This is a short book about data science and quantitative analysis, using R and Python together. The current version of the book has seven chapters. ## Chapters #### 1. Introduction to R/Python Programming R and Python are the two most popular programming languages used in data science. In this chapter, we go through the basics of R and Python programming in parallel with examples. Specifically, the topics of this chapter include variable, type, function, control flow, data structures, and object-oriented programming. The chapter is designed for both beginners and intermediate audience. #### 2. More on R/Python Programming Following the first chapter, the topics of this chapter include debugging, vectorization, parallelism, working with C++ in R/Python, and functional programming. These topics are chosen to help the audience to get familiar with some intermediate/advanced topics in R/Python programming. Mastering these topics will greatly help with coding skills. Like the first chapter, in this chapter, I try to emphasize the differences between R and Python with coding examples. #### 3. data.table and pandas In the first two chapters, we focus on general-purpose programming techniques. In this chapter, we introduce the very basics of data science, i.e., data manipulation. For the audience with little experience in data science, we start from a brief introduction to SQL. The major part of this chapter focuses on the two widely used data.frame packages, i.e., data.table in R and pandas in Python. Side-by-side examples using the two packages not only enables the audience to learn basic usages of these tools but also can be used as a quick reference manual. #### 4. Random Variables & Distributions In this chapter, we focus on statistics, which is the foundation of data science. To better follow this chapter, I recommend any introductory level statistics course as a prerequisite. The topics of this chapter include random variable sampling methods, distribution fitting, joint distribution/copula simulation, confidence interval calculation, and hypothesis testing. #### 5. Linear Regression This is a short but important chapter. In this chapter, we talk about linear regression models from scratch. Many textbooks introduce the theories behind linear regressions but still don’t help much on the implementation. We will see how the linear regression is implemented as a toy example in both R and Python with the help of linear algebra. I will also show how the basic linear regression model can be used for L2 penalized linear regression, i.e., ridge regression. #### 6. Optimization in Practice Most machine learning models rely on optimization algorithms. In this chapter, we give a brief introduction to optimization. Specifically, we will talk about convexity, gradient descent, general-purpose optimization tools in R and Python, linear programming and metaheuristic algorithms, etc. Based on these techniques, we will see coding examples about maximum likelihood estimation, linear regression, logistic regression, portfolio construction, traveling salesman problem. #### 7. Machine Learning – A gentle introduction Machine learning is a huge topic. In this chapter, I try to give a very short and gentle introduction to machine learning. It starts with a brief introduction of supervised learning, unsupervised learning and reinforcement learning, respectively. For supervised learning, we will see the gradient boosting regression with a pure Python implementation from scratch, from which the audience could learn the translation from the mathematical models to object-oriented programs. For unsupervised learning, the finite Gaussian mixture model and PCA are discussed. And for reinforcement learning, we will also use a simple game as an example to show the usage of deep Q-networks. The goal of this chapter is two-fold. First, I would like to give the audience an impression of what machine learning looks like. Second, reading the code snippets in this chapter could help the audience review/recap the topics in previous chapters. ### Read online The book is now available on https://www.anotherbookondatascience.com/ And also a short link www.randpython.com ### FAQ **Q:** How to report errors? **A:** I appreciate it if you want to report errors found in the book. Please either email me [email protected] or open a github issue. **Q:** More chapters to come? **A:** Maybe in the future. **Q:** Why is `dplyr` not covered? **A:** I want to make the book concise with diversified topics about data science. Since `data.table` is introduced for data manipulation in the book, `dplyr` is not covered. `dplyr` is a great tool in R and there are many good learning resources.

A fast, scalable, high performance Gradient Boosting on Decision Trees library, used for ranking, classification, regression and other machine learning tasks for Python, R, Java, C++. Supports computation on CPU and GPU.

<img src=http://storage.mds.yandex.net/get-devtools-opensource/250854/catboost-logo.png width=300/> [Website](https://catboost.ai) | [Documentation](https://catboost.ai/docs/) | [Tutorials](https://catboost.ai/docs/concepts/tutorials.html) | [Installation](https://catboost.ai/docs/concepts/installation.html) | [Release Notes](https://github.com/catboost/catboost/releases) [](https://github.com/catboost/catboost/blob/master/LICENSE) [](https://badge.fury.io/py/catboost) [](https://anaconda.org/conda-forge/catboost) [](https://github.com/catboost/catboost/issues) [](https://t.me/catboost_en) [](https://twitter.com/CatBoostML) CatBoost is a machine learning method based on [gradient boosting](https://en.wikipedia.org/wiki/Gradient_boosting) over decision trees. Main advantages of CatBoost: -------------- - Superior quality when [compared](https://github.com/catboost/benchmarks/blob/master/README.md) with other GBDT libraries on many datasets. - Best in class [prediction](https://catboost.ai/docs/concepts/c-plus-plus-api.html) speed. - Support for both [numerical and categorical](https://catboost.ai/docs/concepts/algorithm-main-stages.html) features. - Fast GPU and multi-GPU support for training out of the box. - Visualization tools [included](https://catboost.ai/docs/features/visualization.html). - Fast and reproducible distributed training with [Apache Spark](https://catboost.ai/en/docs/concepts/spark-overview) and [CLI](https://catboost.ai/en/docs/concepts/cli-distributed-learning). Get Started and Documentation -------------- All CatBoost documentation is available [here](https://catboost.ai/docs/). Install CatBoost by following the guide for the * [Python package](https://catboost.ai/en/docs/concepts/python-installation) * [R-package](https://catboost.ai/en/docs/concepts/r-installation) * [Сommand line](https://catboost.ai/en/docs/concepts/cli-installation) * [Package for Apache Spark](https://catboost.ai/en/docs/concepts/spark-installation) Next you may want to investigate: * [Tutorials](https://github.com/catboost/tutorials/#readme) * [Training modes and metrics](https://catboost.ai/docs/concepts/loss-functions.html) * [Cross-validation](https://catboost.ai/docs/features/cross-validation.html#cross-validation) * [Parameters tuning](https://catboost.ai/docs/concepts/parameter-tuning.html) * [Feature importance calculation](https://catboost.ai/docs/features/feature-importances-calculation.html) * [Regular](https://catboost.ai/docs/features/prediction.html#prediction) and [staged](https://catboost.ai/docs/features/staged-prediction.html#staged-prediction) predictions * CatBoost for Apache Spark videos: [Introduction](https://youtu.be/47-mAVms-b8) and [Architecture](https://youtu.be/nrGt5VKZpzc) If you cannot open documentation in your browser try adding yastatic.net and yastat.net to the list of allowed domains in your privacy badger. Catboost models in production -------------- If you want to evaluate Catboost model in your application read [model api documentation](https://github.com/catboost/catboost/tree/master/catboost/CatboostModelAPI.md). Questions and bug reports -------------- * For reporting bugs please use the [catboost/bugreport](https://github.com/catboost/catboost/issues) page. * Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/catboost) with the catboost tag, we monitor this for new questions. * Seek prompt advice at [Telegram group](https://t.me/catboost_en) or Russian-speaking [Telegram chat](https://t.me/catboost_ru) Help to Make CatBoost Better ---------------------------- * Check out [open problems](https://github.com/catboost/catboost/blob/master/open_problems/open_problems.md) and [help wanted issues](https://github.com/catboost/catboost/labels/help%20wanted) to see what can be improved, or open an issue if you want something. * Add your stories and experience to [Awesome CatBoost](AWESOME.md). * To contribute to CatBoost you need to first read CLA text and add to your pull request, that you agree to the terms of the CLA. More information can be found in [CONTRIBUTING.md](https://github.com/catboost/catboost/blob/master/CONTRIBUTING.md) * Instructions for contributors can be found [here](https://catboost.ai/docs/concepts/development-and-contributions.html). News -------------- Latest news are published on [twitter](https://twitter.com/catboostml). Reference Paper ------- Anna Veronika Dorogush, Andrey Gulin, Gleb Gusev, Nikita Kazeev, Liudmila Ostroumova Prokhorenkova, Aleksandr Vorobev ["Fighting biases with dynamic boosting"](https://arxiv.org/abs/1706.09516). arXiv:1706.09516, 2017. Anna Veronika Dorogush, Vasily Ershov, Andrey Gulin ["CatBoost: gradient boosting with categorical features support"](http://learningsys.org/nips17/assets/papers/paper_11.pdf). Workshop on ML Systems at NIPS 2017. License ------- © YANDEX LLC, 2017-2022. Licensed under the Apache License, Version 2.0. See LICENSE file for more details.

Python books free to read online or download

 # Free Python Books A list of Python books in English that are free to read online or download. ## Table of Contents - [How the list got started](#how-the-list-got-started) - [What's in the list](#whats-in-the-list) - [Why free books?](#why-free-books) - [Acknowledgments](#acknowledgments) - [How to contribute](#how-to-contribute) - [List of free Python books](#list-of-free-python-books) - [Introductory](#introductory) - [Intermediate](#intermediate) - [Advanced](#advanced) - [AI and Machine Learning](#ai-and-machine-learning) - [Computer Science](#computer-science) - [Software Engineering and best practices](#software-engineering-and-best-practices) - [GUI](#gui) - [Tools](#tools) - [Web development](#web-development) - [Data science](#data-science) - [Science](#science) - [Jupyter Notebook](#jupyter-notebook) - [Engineering](#engineering) - [Cryptography](#cryptography) - [Games](#games) - [Lists of free Python books](#lists-of-free-python-books) - [License](#license) ## How the list got started I had been learning Python for a few weeks when, in January, 2019, I stumbled upon [a Reddit post in r/learnpython](https://www.reddit.com/r/learnpython/comments/amyryp/what_would_you_suggest_a_person_new_to/) seeking suggestions on how to become a better programmer. [One of the comments](https://www.reddit.com/r/learnpython/comments/amyryp/what_would_you_suggest_a_person_new_to/efps9cs/) asked for good books or websites about algorithms and data structures. I had collected links to useful Python learning resources among which the free ebook [Problem Solving with Algorithms and Data Structures using Python](https://interactivepython.org/runestone/static/pythonds/index.html#problem-solving-with-algorithms-and-data-structures-using-python), so I [shared the link in a comment](https://www.reddit.com/r/learnpython/comments/amyryp/what_would_you_suggest_a_person_new_to/efpvm1n/). My comment got a couple dozen upvotes, which hinted at the interest in good, easily accessible Python books. Therefore I later put together a list of all the free Python books I had found and [posted it to r/Python](https://www.reddit.com/r/Python/comments/anfdyh/free_python_books/). I was right. My post got hundreds of upvotes and several redditors contributed links to more books and lists, thus confirming the interest in such a resource. The next step was to make my list more useful and widely available by integrating it with the suggestions I got in the Reddit post, publishing it to GitHub, and expanding it with more books. It's the list you're reading now. ## What's in the list This list includes the entries I originally posted to Reddit, the books and other lists suggested in the comments, a few more I found since then, and any I'll discover. What's a free Python book? My definition is fuzzy and necessarily subjective. But I'd say it's an ebook file, a book-length document, or a website structured like a book that is about Python, is written in English, and can be read online or downloaded for free. Most short online tutorials and how-to pages probably don't qualify. But in the end I recognize a free Python book when I see one. The entries are grouped by category or application domain and include coverage at all skill levels, from basic to advanced. Within categories the entries are sorted alphabetically by title. Some redditors shared links to other list of free programming books, some of which are about Python. I've included them too but there's of course some overlap with mine. ## Why free books? I don't mind paid content. In fact, I also purchased great paid Python ebooks and online resources and I'm going to get more. However, free ebooks have several advantages such as often coming in additional handy or downloadable formats. It's also easier to get books on topics you may be interested in but don't have an immediate need for. ## Acknowledgments Thanks to the redditors who contributed book suggestions and links in [my original post](https://www.reddit.com/r/Python/comments/anfdyh/free_python_books/): AlSweigart, ASIC_SP, Bisalsn, bitcoin-dude, code_x_7777m isakar-elahim, lask757, mfitzp, pvc, warbird2k. ## How to contribute If you have books to suggest you can do a pull request or create an issue. Creating an issue is also a good way of providing other feedback. Thanks! ## List of free Python books ### Introductory - [100 Page Python Intro](https://learnbyexample.github.io/100_page_python_intro) - [A Byte of Python](https://python.swaroopch.com) - [An Introduction to Python for Linguists](https://v4py.github.io/intro.html) - [Code With Repl.it: Python Projects for Beginners](https://www.codewithrepl.it/python-projects-for-beginners.html) - [Exploring Python Basics](https://www.manning.com/books/exploring-python-basics) - [Full Speed Python](https://github.com/joaoventura/full-speed-python) - [How To Code in Python](https://www.digitalocean.com/community/books/digitalocean-ebook-how-to-code-in-python) - [Learn Python the Right Way](https://learnpythontherightway.com) - [Non-Programmer's Tutorial for Python 3](https://en.wikibooks.org/wiki/Non-Programmer%27s_Tutorial_for_Python_3) - [Python 101](https://python101.pythonlibrary.org/) - [Slither Into Python](https://www.slitherintopython.com) - [The Python Coding Book: Understanding what programming really is](https://thepythoncodingbook.com) ### Intermediate - [Boxes: Your Second Python Book](http://ralsina.gitlab.io/boxes-book/) - [Intermediate Python](https://leanpub.com/intermediatepython) - [Python re(gex)?](https://learnbyexample.github.io/py_regular_expressions/) - [Python Tips: Intermediate Python](http://book.pythontips.com/en/latest/index.html) ### Advanced - [A Python Book: Beginning Python, Advanced Python, and Python Exercises](http://www.davekuhlman.org/python_book_01.html) - [Python 3 Patterns, Recipes and Idioms](https://python-3-patterns-idioms-test.readthedocs.io/en/latest/index.html) - [Python Notes for Professionals](https://goalkicker.com/PythonBook/) ### AI and Machine Learning - [Machine Learning from Scratch: Derivations in Concept and Code](https://dafriedman97.github.io/mlbook/content/introduction.html) - [Natural Language Processing with Python](http://www.nltk.org/book/) - [Neural Networks and Deep Learning](http://neuralnetworksanddeeplearning.com/) - [Probabilistic Programming & Bayesian Methods for Hackers](http://camdavidsonpilon.github.io/Probabilistic-Programming-and-Bayesian-Methods-for-Hackers/) ### Computer Science - [Annotated Algorithms in Python - With applications in Physics, Biology, and Finance](https://github.com/mdipierro/nlib) - [Data Structures and Information Retrieval in Python](https://allendowney.github.io/DSIRP) - [How to Think Like a Computer Scientist: Interactive Edition](https://interactivepython.org/courselib/static/thinkcspy/index.html) - [Problem Solving with Algorithms and Data Structures using Python](https://interactivepython.org/runestone/static/pythonds/index.html#problem-solving-with-algorithms-and-data-structures-using-python) - [Think Python: How to Think Like a Computer Scientist](https://greenteapress.com/wp/think-python-2e/) ### Software Engineering and best practices - [Architecture Patterns with Python: Enabling Test-Driven Development, Domain-Driven Design, and Event-Driven Microservices](https://www.cosmicpython.com/) - [Clean Architectures in Python: A practical approach to better software design](https://leanpub.com/clean-architectures-in-python) - [Object Oriented Programming with Python: Learn essentials of OOP with Python 3](https://leanpub.com/PythonOOP) - [Python Packages](https://py-pkgs.org/) - [Test-Driven Development with Python](https://www.obeythetestinggoat.com/pages/book.html) - [The Hitchhiker’s Guide to Python!](https://docs.python-guide.org/) - [The Little Book of Python Anti-Patterns](https://docs.quantifiedcode.com/python-anti-patterns/) ### GUI - [Create Simple GUI Applications](https://leanpub.com/create-simple-gui-applications/read) ### Tools - [Automate the Boring Stuff with Python](https://automatetheboringstuff.com/) - [Practical Python Projects](https://practicalpython.yasoob.me/toc.html) ### Web development - [Create a Simple Flask Application with Cloud9, Heroku and MongoDB](https://leanpub.com/flask-cloud9-heroku-mongodb-ebook) - [Zero to production web apps](https://pgjones.gitlab.io/zero-to-production-book/introduction/) ### Data science - [Data Science in Production: Building Scalable Model Pipelines with Python](https://www.amazon.com/dp/B083H2YWP4) - [Effective Pandas](https://leanpub.com/effective-pandas) - [Python Data Science Handbook](https://jakevdp.github.io/PythonDataScienceHandbook/) - [Python for Everybody: Exploring Data In Python 3](https://py4e.com/book.php) ### Science - [Getting Started With Python In The Lab: An Introductory Python Tutorial For Life Scientists](https://leanpub.com/gettingstartedwithpythoninthelab) - [Python for Astronomers: An Introduction to Scientific Computing](https://prappleizer.github.io/) - [Python & OpenGL for Scientific Visualization](https://www.labri.fr/perso/nrougier/python-opengl/) - [Python for Scientists and Engineers](https://www.pythonforengineers.com/python-for-scientists-and-engineers/) - [Scientific Visualization: Python + Matplotlib](https://www.labri.fr/perso/nrougier/scientific-visualization.html) - [Think Complexity](https://greenteapress.com/complexity2/html/index.html) ### Jupyter Notebook - [Teaching and Learning with Jupyter](https://jupyter4edu.github.io/jupyter-edu-book/) ### Engineering - [PySDR: A Guide to SDR and DSP using Python](https://pysdr.org) - [Python for network engineers](https://pyneng.readthedocs.io/en/latest) - [Think DSP: Digital Signal Processing in Python](https://github.com/AllenDowney/ThinkDSP) ### Cryptography - [Cracking Codes with Python](https://inventwithpython.com/cracking/) ### Games - [Coding Games With Pygame Zero & Python](https://github.com/electronstudio/pygame-zero-book) - [Invent Your Own Computer Games with Python](https://inventwithpython.com/invent4thed/) - [Learn Python With Arcade Academy](https://arcade-book.readthedocs.io/en/latest/) - [Making Games with Python & Pygame](http://inventwithpython.com/pygame/) - [Program Arcade Games With Python And Pygame](http://programarcadegames.com/) ## Lists of free Python books - [101+ Free Python Books](https://blog.finxter.com/free-python-books/) - [Free Python books - pythonbooks](https://www.pythonbooks.org/free-books/) - [Legally Free Python Books List](https://www.pythonkitchen.com/legally-free-python-books-list/) ## License Each file in this repository is licensed under the [CC BY 4.0 License](/LICENSE). ## Sponsor this project <a href="https://www.buymeacoffee.com/amoroso" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/arial-red.png" alt="Buy Me A Coffee" width="220px"></a> If you find this resource useful and want to sponsor the project you can [buy me a coffee](https://www.buymeacoffee.com/amoroso).

A curated list of awesome Python asyncio frameworks, libraries, software and resources

# Awesome asyncio [](https://github.com/sindresorhus/awesome) > A carefully curated list of awesome Python asyncio frameworks, libraries, software and resources. The Python [asyncio](https://docs.python.org/3/library/asyncio.html) module introduced to the standard library with Python 3.4 provides infrastructure for writing single-threaded concurrent code using coroutines, multiplexing I/O access over sockets and other resources, running network clients and servers, and other related primitives. Asyncio is not really a brand-new technology however it appears to be very trending since a few years - especially in the Python community and with the release of Python 3.4 in March 2014. Thus, it's pretty hard to keep yourself up-to-date with the most awesome packages out there. Find some of those *awesome* packages here and if you are missing one we count on you to [create an Issue or a Pull Request](https://github.com/timofurrer/awesome-asyncio/blob/master/CONTRIBUTING.md) with your suggestion. ## Contents * [Web Frameworks](#web-frameworks) * [Message Queues](#message-queues) * [Database Drivers](#database-drivers) * [Networking](#networking) * [GraphQL](#graphql) * [Testing](#testing) * [Alternative Loops](#alternative-loops) * [Misc](#misc) * [Writings](#writings) * [Talks](#talks) * [Alternatives to asyncio](#alternatives-to-asyncio) *** ## Web Frameworks *Libraries to build web applications.* * [FastAPI](https://github.com/tiangolo/fastapi) - A very high performance Python 3.6+ API framework based on type hints. Powered by Starlette and Pydantic. * [Django](https://www.djangoproject.com/) - An established, high-level Python web framework with a huge community and ecosystem. * [Starlette](https://github.com/encode/starlette) - A lightweight ASGI framework/toolkit for building high performance services. * [aiohttp](https://github.com/KeepSafe/aiohttp) - Http client/server for asyncio (PEP-3156). * [sanic](https://github.com/channelcat/sanic) - Python 3.5+ web server that's written to go fast. * [Quart](https://github.com/pallets/quart) - An asyncio web microframework with the same API as Flask. * [autobahn](https://github.com/crossbario/autobahn-python) - WebSocket and WAMP supporting asyncio and Twisted, for clients and servers. * [websockets](https://github.com/aaugustin/websockets/) - A library for building WebSocket servers and clients in Python with a focus on correctness and simplicity. * [Tornado](http://www.tornadoweb.org/en/stable/) - Performant web framework and asynchronous networking library. * [uvicorn](https://github.com/encode/uvicorn) - The lightning-fast ASGI server. ## Message Queues *Libraries to implement applications using message queues.* * [aioamqp](https://github.com/Polyconseil/aioamqp) - AMQP implementation using asyncio. * [pyzmq](https://github.com/zeromq/pyzmq) - Python bindings for ZeroMQ. * [aiozmq](https://github.com/aio-libs/aiozmq) - Alternative Asyncio integration with ZeroMQ. * [crossbar](https://github.com/crossbario/crossbar) - Crossbar.io is a networking platform for distributed and microservice applications. * [asyncio-nats](https://github.com/nats-io/asyncio-nats) - Client for the NATS messaging system. * [aiokafka](https://github.com/aio-libs/aiokafka) - Client for Apache Kafka. ## Database Drivers *Libraries to connect to databases.* * [asyncpg](https://github.com/MagicStack/asyncpg) - Fast PostgreSQL Database Client Library for Python/asyncio. * [asyncpgsa](https://github.com/CanopyTax/asyncpgsa) - Asyncpg with sqlalchemy core support. * [aiopg](https://github.com/aio-libs/aiopg/) - Library for accessing a PostgreSQL database. * [aiomysql](https://github.com/aio-libs/aiomysql) - Library for accessing a MySQL database * [aioodbc](https://github.com/aio-libs/aioodbc) - Library for accessing a ODBC databases. * [motor](https://github.com/mongodb/motor) - The async Python driver for MongoDB. * [redis-py](https://github.com/redis/redis-py) - Redis Python Client (which includes [aioreadis](https://github.com/aio-libs/aioredis) now). * [aiocouchdb](https://github.com/aio-libs/aiocouchdb) - CouchDB client built on top of aiohttp (asyncio). * [aioinflux](https://github.com/plugaai/aioinflux) - InfluxDB client built on top of aiohttp. * [aioes](https://github.com/aio-libs/aioes) - Asyncio compatible driver for elasticsearch. * [peewee-async](https://github.com/05bit/peewee-async) - ORM implementation based on [peewee](https://github.com/coleifer/peewee) and aiopg. * [GINO](https://github.com/fantix/gino) - is a lightweight asynchronous Python ORM based on [SQLAlchemy](https://www.sqlalchemy.org/) core, with [asyncpg](https://github.com/MagicStack/asyncpg) dialect. * [Tortoise ORM](https://github.com/tortoise/tortoise-orm) - native multi-backend ORM with Django-like API and easy relations management. * [Databases](https://github.com/encode/databases) - Async database access for SQLAlchemy core, with support for PostgreSQL, MySQL, and SQLite. * [Prisma Client Python](https://github.com/RobertCraigie/prisma-client-py) - An auto-generated, fully type safe ORM powered by Pydantic and tailored specifically for your schema - supports SQLite, PostgreSQL, MySQL, MongoDB, MariaDB and more. * [Piccolo](https://github.com/piccolo-orm/piccolo) - An ORM / query builder which can work in async and sync modes, with a nice admin GUI, and ASGI middleware. * [Beanie](https://beanie-odm.dev) - An async MongoDB ODM built on [motor](https://github.com/mongodb/motor) and [Pydantic](https://pydantic-docs.helpmanual.io). ## Networking *Libraries to communicate in your network.* * [AsyncSSH](https://github.com/ronf/asyncssh) - Provides an asynchronous client and server implementation of the SSHv2 protocol. * [aiodns](https://github.com/saghul/aiodns) - Simple DNS resolver for asyncio. * [aioping](https://github.com/stellarbit/aioping) - Fast asyncio implementation of ICMP (ping) protocol. * [httpx](https://github.com/encode/httpx) - asynchronous HTTP client for Python 3 with [requests](https://github.com/psf/requests) compatible API. ## GraphQL *Libraries to build GraphQL servers.* * [Ariadne](https://ariadnegraphql.org) - Schema-first Python library for implementing GraphQL servers. * [Tartiflette](https://tartiflette.io/) - Schema-first Python 3.6+ GraphQL engine built on top of `libgraphqlparser`. * [Strawberry](https://strawberry.rocks) - Code-first Python 3 GraphQL server with Django, Flask and FastAPI/Starlette support. ## Testing *Libraries to test asyncio based applications.* * [aiomock](https://github.com/nhumrich/aiomock/) - A python mock library that supports async methods. * [asynctest](https://github.com/Martiusweb/asynctest/) - Enhance the standard unittest package with features for testing. asyncio libraries * [pytest-asyncio](https://github.com/pytest-dev/pytest-asyncio) - Pytest support for asyncio. * [aresponses](https://github.com/CircleUp/aresponses) - Asyncio http mocking. Similar to the [responses](https://github.com/getsentry/responses) library used for [requests](https://github.com/requests/requests). * [aioresponses](https://github.com/pnuckowski/aioresponses) - Helper for mock/fake web requests in Python aiohttp package. ## Alternative Loops *Alternative asyncio loop implementations.* * [uvloop](https://github.com/MagicStack/uvloop) - Ultra fast implementation of asyncio event loop on top of libuv. ## Misc *Other awesome asyncio libraries.* * [aiochan](https://github.com/zh217/aiochan) - CSP-style concurrency with channels, select and multiprocessing on top of asyncio. * [aiocache](https://github.com/argaen/aiocache) - Cache manager for different backends. * [aiofiles](https://github.com/Tinche/aiofiles/) - File support for asyncio. * [aiopath](https://github.com/alexdelorenzo/aiopath) - Asynchronous `pathlib` for asyncio. * [aiodebug](https://github.com/qntln/aiodebug) - A tiny library for monitoring and testing asyncio programs. * [aiorun](https://github.com/cjrh/aiorun) - A `run()` function that handles all the usual boilerplate for startup and graceful shutdown. * [aiosc](https://github.com/artfwo/aiosc) - Lightweight Open Sound Control implementation. * [aioserial](https://github.com/changyuheng/aioserial) - A drop-in replacement of [pySerial](https://github.com/pyserial/pyserial). * [aiozipkin](https://github.com/aio-libs/aiozipkin) - Distributed tracing instrumentation for asyncio with zipkin * [asgiref](https://github.com/django/asgiref) - Backend utils for ASGI to WSGI integration, includes sync_to_async and async_to_sync function wrappers. * [async_property](https://github.com/ryananguiano/async_property) - Python decorator for async properties. * [ruia](https://github.com/howie6879/ruia) - An async web scraping micro-framework based on asyncio. * [kubernetes_asyncio](https://github.com/tomplus/kubernetes_asyncio) - Asynchronous client library for Kubernetes. * [aiomisc](https://github.com/aiokitchen/aiomisc) - Miscellaneous utils for `asyncio`. * [taskiq](https://taskiq-python.github.io/) - Asynchronous distributed task manager (like celery, but async). ## Writings *Documentation, blog posts, and other awesome writing about asyncio.* * [Official asyncio documentation](https://docs.python.org/3/library/asyncio.html) - Asynchronous I/O, event loop, coroutines and tasks. * [Short well-written intro to asyncio](http://masnun.com/2015/11/13/python-generators-coroutines-native-coroutines-and-async-await.html) - Generators, Coroutines, Native Coroutines and async/await. * [AsyncIO for the Working Python Developer](https://hackernoon.com/asyncio-for-the-working-python-developer-5c468e6e2e8e) - A gentle introduction to asynchronous programming from basic examples working up to URL fetching. * [Test limits of Python aiohttp](https://pawelmhm.github.io/asyncio/python/aiohttp/2016/04/22/asyncio-aiohttp.html) - Making 1 million requests with python-aiohttp. * [ASGI (Asynchronous Server Gateway Interface)](https://asgi.readthedocs.io/en/latest/) - A spiritual successor to WSGI, intended to provide a standard interface between async-capable Python web servers, frameworks, and applications. * [First Principles Introduction to Asyncio](https://hackernoon.com/a-simple-introduction-to-pythons-asyncio-595d9c9ecf8c) - A no-buzzword first principles introduction to the internal workings of asyncio. * [Developing and Testing an Asynchronous API with FastAPI and Pytest](https://testdriven.io/blog/fastapi-crud/) - This tutorial looks at how to develop and test an asynchronous API with FastAPI using Test-Driven Development (TDD). * [Python Concurrency with asyncio](https://www.manning.com/books/python-concurrency-with-asyncio) - Learn how to speed up slow Python code with concurrent programming and the cutting-edge asyncio library. ## Talks *Recordings of awesome talks about asyncio.* * [Topics of Interest (Python Asyncio)](https://youtu.be/ZzfHjytDceU) | [screencast](https://youtu.be/lYe8W04ERnY) | [slides](https://speakerdeck.com/dabeaz/topics-of-interest-async) - PyCon Brasil 2015 keynote (David Beazley). * [Python Asynchronous I/O Walkthrough](https://www.youtube.com/playlist?list=PLpEcQSRWP2IjVRlTUptdD05kG-UkJynQT) - 8-part code walkthrough (Philip Guo). * [Async/await in Python 3.5 and why it is awesome](https://www.youtube.com/watch?v=m28fiN9y_r8&t=132s) - EuroPython 2016 (Yury Selivanov). * [Fear and Awaiting in Async: A Savage Journey to the Heart of the Coroutine Dream](https://www.youtube.com/watch?v=E-1Y4kSsAFc) | [screencast](https://www.youtube.com/watch?v=Bm96RqNGbGo) - PyOhio 2016 keynote (David Beazley). * [Asynchronous Python for the Complete Beginner](https://www.youtube.com/watch?v=iG6fr81xHKA) | [slides](https://speakerdeck.com/pycon2017/miguel-grinberg-asynchronous-python-for-the-complete-beginner) - PyCon 2017 (Miguel Grinberg). * [Demystifying Python's Async and Await Keywords](https://www.youtube.com/watch?v=F19R_M4Nay4) - JetBrains TV 2020 (Michael Kennedy) ## Alternatives to asyncio *Alternative approaches to async programming in Python, some of which attempt to support some compatibility with `asyncio`, others are not compatible at all.* * [curio](https://github.com/dabeaz/curio) - The coroutine concurrency library. * [Curio-Asyncio Bridge](https://github.com/dabeaz/curio/issues/190) - basic curio -> asyncio coroutine bridge. * [trio](https://github.com/python-trio/trio) - Pythonic async I/O for humans and snake people. * [trio-asyncio](https://github.com/python-trio/trio-asyncio) - re-implementation of the asyncio mainloop on top of Trio. * [AnyIO](https://github.com/agronholm/anyio) - High level asynchronous concurrency and networking framework that works on top of either trio or asyncio.

AI-related tutorials. Access any of them for free → https://towardsai.net/editorial

# Tutorials **Please know that only the code contained in this repository is under the MIT license found at "[LICENSE](https://github.com/towardsai/tutorials/blob/master/LICENSE)." All tutorials, articles, and books listed in this repository are property of Towards AI, Inc.** Please feel free to contribute. We'll review your pull requests ad-hoc. If you'd like to work with one of our data scientists in an editorial tutorial, please reach out via [[email protected]](mailto:[email protected]) and cc: [[email protected]](mailto:[email protected]). To **contribute** directly to Towards AI, check out our [guidelines to get published](https://contribute.towardsai.net). Join our [AI community](https://community.towardsai.net). If you'd like to support Towards AI, please support us by [buying one of our books](https://gumroad.com/towardsai) (listed below), [sponsoring this open-source work](https://paypal.me/towardsai). Thank you for reading and for being a supporter of Towards AI! Access any [tutorial for free](https://towardsai.net/p/category/editorial). **[Terms](https://towardsai.net/terms) | [Privacy Policy](https://towardsai.net/privacy)** ________________________________________________________________________________ [Machine Learning Algorithms For Beginners with Code Examples in Python](https://towardsai.net/p/machine-learning/machine-learning-algorithms-for-beginners-with-python-code-examples-ml-19c6afd60daa) [Neural Networks from Scratch with Python Code and Math in Detail— I](https://towardsai.net/p/machine-learning/building-neural-networks-from-scratch-with-python-code-and-math-in-detail-i-536fae5d7bbf) [Building Neural Networks with Python Code and Math in Detail — II](https://towardsai.net/p/machine-learning/building-neural-networks-with-python-code-and-math-in-detail-ii-bbe8accbf3d1) [Natural Language Processing (NLP) with Python — Tutorial](https://towardsai.net/p/nlp/natural-language-processing-nlp-with-python-tutorial-for-beginners-1f54e610a1a0) [Monte Carlo Simulation An In-depth Tutorial with Python](https://towardsai.net/p/machine-learning/monte-carlo-simulation-an-in-depth-tutorial-with-python-bcf6eb7856c8) [Survival Analysis with Python Tutorial — How, What, When, and Why](https://towardsai.net/p/machine-learning/survival-analysis-with-python-tutorial-how-what-when-and-why-19a5cfb3c312) [Moment Generating Function for Probability Distribution with Python](https://towardsai.net/p/data-science/moment-generating-function-for-probability-distribution-with-python-tutorial-34857e93d8f6) [Bernoulli Distribution — Probability Tutorial with Python](https://towardsai.net/p/statistics/bernoulli-distribution-probability-tutorial-with-python-90061ee078a) [Recommendation System Tutorial with Python using Collaborative Filtering](https://towardsai.net/p/machine-learning/recommendation-system-in-depth-tutorial-with-python-for-netflix-using-collaborative-filtering-533ff8a0e444) [Linear Algebra for Deep Learning and Machine Learning (ML) Python Tutorial](https://towardsai.net/p/machine-learning/basic-linear-algebra-for-deep-learning-and-machine-learning-ml-python-tutorial-444e23db3e9e) [Principal Component Analysis (PCA) with Python Examples — Tutorial](https://towardsai.net/p/data-science/principal-component-analysis-pca-with-python-examples-tutorial-67a917bae9aa) [Decision Trees in Machine Learning (ML) with Python Tutorial](https://towardsai.net/p/machine-learning/decision-trees-in-machine-learning-ml-with-python-tutorial-3bfb457bce67) [Convolutional Neural Networks (CNNs) Tutorial with Python](https://towardsai.net/p/deeplearning/convolutional-neural-networks-cnns-tutorial-with-python-417c29f0403f) [Sentiment Analysis (Opinion Mining) with Python - NLP Tutorial](https://towardsai.net/p/nlp/sentiment-analysis-opinion-mining-with-python-nlp-tutorial-d1f173ca4e3c) [Gradient Descent for Machine Learning (ML) 101 with Python Tutorial](https://towardsai.net/p/data-science/gradient-descent-algorithm-for-machine-learning-python-tutorial-ml-9ded189ec556) [Random Number Generator Tutorial with Python](https://towardsai.net/p/data-science/random-number-generator-tutorial-with-python-3b35986132c7) [What is Deep Learning?](https://towardsai.net/p/deep-learning/what-is-deep-learning-34767bb10366) [Genetic Algorithm (GA) Introduction with Example Code](https://towardsai.net/p/programming/genetic-algorithm-ga-introduction-with-example-code-e59f9bc58eaf) [K-Nearest Neighbors (KNN) Algorithm Tutorial — Machine Learning Basics](https://news.towardsai.net/knn) [What is a GPU? Are GPUs Needed for Deep Learning?](https://news.towardsai.net/gpu) # Books [Descriptive Statistics for Data-driven Decision Making with Python](https://gumroad.com/l/descriptive-statistics) # Sponsors Big thank you to C4H3I LLC for sponsoring us in June, 2022!

An enterprise social network

Notes for the Reinforcement Learning course by David Silver along with implementation of various algorithms.

# David-Silver-Reinforcement-learning [](https://twitter.com/intent/tweet?text=David%20Silver%20Reinforcement%20Learning%20course%20notes%20along%20with%20implementation&url=https://github.com/dalmia/David-Silver-Reinforcement-learning&hashtags=deeplearning,reinforcementlearning,python,machinelearning,keras) []() [](https://travis-ci.org/athityakumar/colorls) [](http://makeapullrequest.com) This repository contains the notes for the Reinforcement Learning [course](www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching.html) by [David Silver](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Home.html) along with the implementation of the various algorithms discussed, both in Keras (with TensorFlow backend) and [OpenAI](https://openai.com/)'s [gym](https://github.com/openai/gym) framework. ## Syllabus: - Week 1: Introduction to Reinforcement Learning [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/intro_RL.pdf)][[video](https://www.youtube.com/watch?v=2pWv7GOvuf0&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=1)] - Week 2: Markov Decision Processes [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/MDP.pdf)][[video](https://www.youtube.com/watch?v=lfHX2hHRMVQ&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=2&t=3223s)] - Week 3: Planning by Dynamic Programming [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/DP.pdf)][[video](https://www.youtube.com/watch?v=Nd1-UUMVfz4&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=3&t=417s)] - Week 4: Model-Free Prediction [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/MC-TD.pdf)][[video](https://www.youtube.com/watch?v=PnHCvfgC_ZA&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=4)] - Week 5: Model-Free Control [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/control.pdf)][[video](https://www.youtube.com/watch?v=0g4j2k_Ggc4&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=5)] - Week 6: Value Function Approximation [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/FA.pdf)][[video](https://www.youtube.com/watch?v=UoPei5o4fps&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=6)] - Week 7: Policy Gradient Methods [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/pg.pdf)][[video](https://www.youtube.com/watch?v=KHZVXao4qXs&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=7)] - Week 8: Integrating Learning and Planning [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/dyna.pdf)][[video](https://www.youtube.com/watch?v=ItMutbeOHtc&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=8)] - Week 9: Exploration and Exploitation [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/XX.pdf)][[video](https://www.youtube.com/watch?v=sGuiWX07sKw&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=9)] - Week 10: Case Study: RL in Classic Games [[slide](http://www0.cs.ucl.ac.uk/staff/d.silver/web/Teaching_files/games.pdf)][[video](https://www.youtube.com/watch?v=kZ_AUmFcZtk&list=PL7-jPKtc4r78-wCZcQn5IqyuWhBZ8fOxT&index=10)] ## Dependencies - TensorFlow - Keras - Gym - Numpy Install them using [pip](https://www.google.co.in/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=0ahUKEwjRhLWLnfHYAhVEtY8KHRqfCc4QFggoMAA&url=https%3A%2F%2Fpip.pypa.io%2Fen%2Fstable%2F&usg=AOvVaw18gydNGbBQg6WMxXoxO97K). ## Contributing Please feel free to create a Pull Request for adding implementations of the algorithms discussed in different frameworks like PyTorch, Caffe, etc. or improving the existing implementations. If you are a beginner, you can refer [this](https://opensource.guide/how-to-contribute/) for getting started. ## Support If you found this useful, please consider starring(★) the repo so that it can reach a broader audience. ## License This project is licensed under the MIT License - see the [LICENSE](https://github.com/dalmia/David-Silver-Reinforcement-learning/blob/master/LICENSE) file for details. ## References - https://github.com/dennybritz/reinforcement-learning - https://github.com/llSourcell/AI_for_Video_Games_Syllabus

Apache Spark & Python (pySpark) tutorials for Big Data Analysis and Machine Learning as IPython / Jupyter notebooks

# Spark Python Notebooks [](https://gitter.im/jadianes/spark-py-notebooks?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) This is a collection of [IPython notebook](http://ipython.org/notebook.html)/[Jupyter](https://jupyter.org/) notebooks intended to train the reader on different [Apache Spark](http://spark.apache.org/) concepts, from basic to advanced, by using the **Python** language. If Python is not your language, and it is R, you may want to have a look at our [R on Apache Spark (SparkR) notebooks](https://github.com/jadianes/spark-r-notebooks) instead. Additionally, if your are interested in being introduced to some basic Data Science Engineering, you might find [these series of tutorials](https://github.com/jadianes/data-science-your-way) interesting. There we explain different concepts and applications using Python and R. ## Instructions A good way of using these notebooks is by first cloning the repo, and then starting your own [IPython notebook](http://ipython.org/notebook.html)/[Jupyter](https://jupyter.org/) in **pySpark mode**. For example, if we have a *standalone* Spark installation running in our `localhost` with a maximum of 6Gb per node assigned to IPython: MASTER="spark://127.0.0.1:7077" SPARK_EXECUTOR_MEMORY="6G" IPYTHON_OPTS="notebook --pylab inline" ~/spark-1.5.0-bin-hadoop2.6/bin/pyspark Notice that the path to the `pyspark` command will depend on your specific installation. So as requirement, you need to have [Spark installed](https://spark.apache.org/docs/latest/index.html) in the same machine you are going to start the `IPython notebook` server. For more Spark options see [here](https://spark.apache.org/docs/latest/spark-standalone.html). In general it works the rule of passing options described in the form `spark.executor.memory` as `SPARK_EXECUTOR_MEMORY` when calling IPython/pySpark. ## Datasets We will be using datasets from the [KDD Cup 1999](http://kdd.ics.uci.edu/databases/kddcup99/kddcup99.html). The results of this competition can be found [here](http://cseweb.ucsd.edu/~elkan/clresults.html). ## References The reference book for these and other Spark related topics is: - *Learning Spark* by Holden Karau, Andy Konwinski, Patrick Wendell, and Matei Zaharia. ## Notebooks The following notebooks can be examined individually, although there is a more or less linear 'story' when followed in sequence. By using the same dataset they try to solve a related set of tasks with it. ### [RDD creation](https://github.com/jadianes/spark-py-notebooks/blob/master/nb1-rdd-creation/nb1-rdd-creation.ipynb) About reading files and parallelize. ### [RDDs basics](https://github.com/jadianes/spark-py-notebooks/blob/master/nb2-rdd-basics/nb2-rdd-basics.ipynb) A look at `map`, `filter`, and `collect`. ### [Sampling RDDs](https://github.com/jadianes/spark-py-notebooks/blob/master/nb3-rdd-sampling/nb3-rdd-sampling.ipynb) RDD sampling methods explained. ### [RDD set operations](https://github.com/jadianes/spark-py-notebooks/blob/master/nb4-rdd-set/nb4-rdd-set.ipynb) Brief introduction to some of the RDD pseudo-set operations. ### [Data aggregations on RDDs](https://github.com/jadianes/spark-py-notebooks/blob/master/nb5-rdd-aggregations/nb5-rdd-aggregations.ipynb) RDD actions `reduce`, `fold`, and `aggregate`. ### [Working with key/value pair RDDs](https://github.com/jadianes/spark-py-notebooks/blob/master/nb6-rdd-key-value/nb6-rdd-key-value.ipynb) How to deal with key/value pairs in order to aggregate and explore data. ### [MLlib: Basic Statistics and Exploratory Data Analysis](https://github.com/jadianes/spark-py-notebooks/blob/master/nb7-mllib-statistics/nb7-mllib-statistics.ipynb) A notebook introducing Local Vector types, basic statistics in MLlib for Exploratory Data Analysis and model selection. ### [MLlib: Logistic Regression](https://github.com/jadianes/spark-py-notebooks/blob/master/nb8-mllib-logit/nb8-mllib-logit.ipynb) Labeled points and Logistic Regression classification of network attacks in MLlib. Application of model selection techniques using correlation matrix and Hypothesis Testing. ### [MLlib: Decision Trees](https://github.com/jadianes/spark-py-notebooks/blob/master/nb9-mllib-trees/nb9-mllib-trees.ipynb) Use of tree-based methods and how they help explaining models and feature selection. ### [Spark SQL: structured processing for Data Analysis](https://github.com/jadianes/spark-py-notebooks/blob/master/nb10-sql-dataframes/nb10-sql-dataframes.ipynb) In this notebook a schema is inferred for our network interactions dataset. Based on that, we use Spark's SQL `DataFrame` abstraction to perform a more structured exploratory data analysis. ## Applications Beyond the basics. Close to real-world applications using Spark and other technologies. ### [Olssen: On-line Spectral Search ENgine for proteomics](https://github.com/jadianes/olssen) Same tech stack this time with an AngularJS client app. ### [An on-line movie recommendation web service](https://github.com/jadianes/spark-movie-lens) This tutorial can be used independently to build a movie recommender model based on the MovieLens dataset. Most of the code in the first part, about how to use ALS with the public MovieLens dataset, comes from my solution to one of the exercises proposed in the [CS100.1x Introduction to Big Data with Apache Spark by Anthony D. Joseph on edX](https://www.edx.org/course/introduction-big-data-apache-spark-uc-berkeleyx-cs100-1x), that is also [**publicly available since 2014 at Spark Summit**](https://databricks-training.s3.amazonaws.com/movie-recommendation-with-mllib.html). There I've added with minor modifications to use a larger dataset and also code about how to store and reload the model for later use. On top of that we build a Flask web service so the recommender can be use to provide movie recommendations on-line. ### [KDD Cup 1999](https://github.com/jadianes/kdd-cup-99-spark) My try using Spark with this classic dataset and Knowledge Discovery competition. ## Contributing Contributions are welcome! For bug reports or requests please [submit an issue](https://github.com/jadianes/spark-py-notebooks/issues). ## Contact Feel free to contact me to discuss any issues, questions, or comments. * Twitter: [@ja_dianes](https://twitter.com/ja_dianes) * GitHub: [jadianes](https://github.com/jadianes) * LinkedIn: [jadianes](https://www.linkedin.com/in/jadianes) * Website: [jadianes.me](http://jadianes.me) ## License This repository contains a variety of content; some developed by Jose A. Dianes, and some from third-parties. The third-party content is distributed under the license provided by those parties. The content developed by Jose A. Dianes is distributed under the following license: Copyright 2016 Jose A Dianes 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 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.

A middle-to-high level open source algorithm book designed with coding interview at heart!

<div align="center"> <h1> Hands-on Algorithmic Problem Solving</h1> <h3> A 100% open source one-stop coding interview prep book! </a> <h3> <br> DSA · Python · LeetCode · Principles · Problem patterns<br> </div> <br> <div align="center"> <!-- <a target="_blank" href="https://www.liyinscience.com/"><img src="https://img.shields.io/badge/Subscribe-30K-brightgreen"></a>&nbsp; --> <a target="_blank" href="https://github.com/liyin2015/python-coding-interview"><img src="https://img.shields.io/github/stars/liyin2015/python-coding-interview.svg?style=social&label=Star"></a>&nbsp; <a target="_blank" href="https://www.linkedin.com/in/li-yin-00b0456b/"><img src="https://img.shields.io/badge/style--5eba00.svg?label=LinkedIn&logo=linkedin&style=social"></a>&nbsp; <a target="_blank" href="https://twitter.com/liyinscience"><img src="https://img.shields.io/twitter/url?url=https%3A%2F%2Fshields.io"></a> <br> 🔥&nbsp; Among the <a href="https://github.com/topics/algorithms-and-data-structures" target="_blank">top DSA</a> repositories on GitHub </div> <br> <hr> ## Contributing The book is written in latex, and all contents except the code is located under [**Easy-Book** folder](Easy-Book). Feel free to send me [pull requests](https://github.com/liyin2015/python-coding-interview/pulls) or email ([email protected]) to contribute contents. Before you start to improve the contents, it would be helpful to know the [high-level structure of the book](#about-this-book). Read [How to contribute?](how_to_contribute.md) for more details. All contributors (with decent amount of contributions) will be listed as authors in the project. <hr> ## About this book <p align="center"> <img src="figures/book_structure.png" alt="book_structure" width="500" height="300" title="Figure 1. Four umbrellas: each row indicates corresponding parts as outlined in this book."/> </p> In short, this is a middle-to-high level algorithm book designed with cracking coding interviews at hearts. It offers a one-stop coding interview prep experience. The structure of the book: * **Preparation**: introduce the global picture of algorithmic problem solving and coding interviews, learn abstract data structures and highly related and useful math such as recurrence relation, and hands-on Python practice by relating the abstract data structures to Python data structures. *Coding is not just code after all.*, * **Principles**: we organize the design and principle here so that readers can use them as guidance while not seeking for peculiar algorithm for solving a problem. * **Classical algorithms**: We enhance our algorithm database via learning how to apply the core principles to a variety of classical problems. A database that we can quickly relate to when seeing problems. * **Coding interview problem patterns**: We close our book with the analyzing and categorizing problems by patterns. We address classical and best solutions for each problem pattern. Besides trying to make the content easy to follow, here summarizes the uniqueness of this book: (1) it offers Python source code that is tailored to be simple so that it would be natural for you to use in interviews (2) all the exercises and examples are from Leetcode problems so that you get to practise online (3) Classical algorithms are explained with design principles. No algorithm is magic. (Check out [advanced graph algorithms](https://github.com/liyin2015/Hands-on-Algorithmic-Problem-Solving/blob/master/chapters_pdf/chapter_advanced_graph_algorithm.pdf) as an example) (4) problem patterns to help you tackle coding interview questions topic by topic. <hr> ## How did I come up with this book? Preparing for the coding interview is not easy! Cracking the coding interview? Nearly impossible for most of us! Luck does play a role in the outcome. So, let's just treat it as a learning process and have some fun! Computer Science is really not just computer science. It is a combination of all fields; our normal interview problems fall into the enumerative combinatorics and our computer vision mostly consists of Linear Algebra. What really matters is our passion to learn and the ability to apply this knowledge to solve real-life problems. There are plenty of books out there focusing on either teaching algorithmic knowledge (*Introduction to Algorithms*, *Algorithmic Problem Solving*, etc) or introducing the interview process and solving interview problems(*Cracking the Coding Interview*, *Coding Interview Questions*, etc), but none of these books truly combine the two. This is a book designed to make up this role in the categorization. Principle, Pattern, and Leetcode Problems make up the core of this book. This is **NOT** a book that provides hiring statistics for each company or gives the reader quick tricks in order to pass a few coding interviews. Its purpose is to show you the beauty of algorithmic problem solving in the hope that you will be more passionate and confident about software engineering; the interview questions just set up a playground where we strengthen what we learn. <hr> ## For Readers [The whole book](Easy-Book/main.pdf) is compiled as pdf. For readers, you can read the book as a whole or read chapters selectively following the below links. ## Table of Contents <hr> ### Warm Up: Abstract Data Structures and Tools * [Abstract Data Structures](chapters_pdf/Abstract_Data_Structures.pdf) * Discrete Programming * Recurrence Relation ### Get Started: Programming and Python Data Structures * Iteration and Recursion * Bit Manipulation * [**Python Data Structures**](chapters_pdf/Python_Data_Structure.pdf)( [source code](Colab_Codes/chapter_python_datastrcutures.ipynb) ) ### Core Principles: Algorithm Design and Analysis * Complexity Analysis * [Search Strategies](chapters_pdf/search_strategies.pdf)([source code: Graph Search](Colab_Codes/chapter_search_strategies.ipynb), [source code: Tree Traversal](Colab_Codes/chapter_tree_data_structure_and_traversal.ipynb)) * [Combinatorial Search](chapters_pdf/combinatorial_search.pdf)( [source code](Colab_Codes/chapter_combinatorial_search.ipynb)) * Reduce and Conquer * **Decrease and Conquer** > * [Binary Search, Binary Search Tree, and Segment Tree](chapters_pdf/decrease_and_conquer.pdf)( [source code](Colab_Codes/chapter_decrease_and_conquer.ipynb)) * [**Sorting and Selection**](chapters_pdf/sorting_algorithms_with_python3.pdf)( source code: [ sorting algorithms](Colab_Codes/chapter_sorting_and_selection_algorithms.ipynb),[ Python comparison and sort functions](Colab_Codes/chapter_python_comparison_sorting.ipynb)) * Dynamic Programming * Greedy Algorithms ### Advanced Algorithms * Advanced Data Structures * [**Advanced Search on Linear Data Structures**](chapters_pdf/advanced_search_on_linear_data_structures.pdf)( [source code](Colab_Codes/Advanced_Search_on_Linear_Data_Structures.ipynb)) * [Advanced Graph Algorithms](chapters_pdf/chapter_advanced_graph_algorithm.pdf) * String Pattern Matches * Math and Geometry Algorithms ### Problem Patterns * Dynamic Programming Questions (15%) * Array Questions (15%) * Linked List, Stack, Queue, and Heap Questions (12%) * String Questions (15%) * [Tree Questions (10%)](unorganized_pdf/tree_questions.pdf) * Graph Questions (15%) *Note: everything is still in progress, so use it with caution.* <hr> ## Referring Books and Materials * Skiena, Steven S. The algorithm design manual: Text. Vol. 1. Springer Science & Business Media, 1998. * T. H. Cormen, Introduction to algorithms, MIT press, 2009. * Manber, Udi. Introduction to algorithms: a creative approach. Addison-Wesley Longman Publishing Co., Inc., 1989. * Kleinberg, Jon, and Eva Tardos. Algorithm design. Pearson Education India, 2006. * Russell, Stuart J., and Peter Norvig. Artificial intelligence: a modern approach. Malaysia; Pearson Education Limited,, 2016. (**Best book ever in explaining searching problem-solving, differentiate tree-search and graph-search**) * D. M. Beazley, Python essential reference, Addison-Wesley Professional,2009. * S. Halim and F. Halim, Competitive Programming 3, Lulu Independent Publish, 2013. * B. Slatkin, Effective Python: 59 Specific Ways to Write Better Python,Pearson Education, 2015. * H. hua jiang, “Leetcode blogs,” https://zxi.mytechroad.com/blog/category, 2018, [Online; accessed 19-July-2018]. * B. Baka, “Python data structures and algorithms: Improve application performance with graphs, stacks, and queues,” 2017. * “Competitive Programming,”https://cp-algorithms.com/, 2019, [Online; accessed 19-July-2018]. * “cs princeton,”https://aofa.cs.princeton.edu/60trees/, 2019, [Online; accessed 19-July-2018] * https://stanford-cs161.github.io/winter2021/schedule/ <hr> ## Tools * Graph Visualize with [graphviz](http://www.webgraphviz.com/). [Examples](https://graphs.grevian.org/example). [Tutorial to use Python](https://graphviz.readthedocs.io/en/stable/manual.html) <hr> ## Mocking Interviews Practice is important. Schedule some mocking interviews with [interviewing.io](https://interviewing.io/). If you cant manage to register, you can join us in [discord server](https://discord.gg/ZXnSag7fMP) and ask peers for practice interview. <hr> ## Community **Join me on discord server: https://discord.gg/ZXnSag7fMP, for a supportive community** <hr> ## Feedback If you have ideas to improve the book, about formatting, more contents, or correct the errors, do not hesitate to let me know. <!-- Citation --> To cite this content, please use: <hr> ```bibtex @misc{handsondsa, author = {Li Yin}, title = {Hands-on Algorithmic Problem Solving}, howpublished = {\url{https://github.com/liyin2015/python-coding-interview/}}, year = {2021} } ```

Native Python WFDB package

# The WFDB Python Package  [](https://github.com/MIT-LCP/wfdb-python/actions?query=workflow%3Arun-tests+event%3Apush+branch%3Amain) [](https://pypi.org/project/wfdb/) [](https://doi.org/10.13026/egpf-2788) [](https://pypi.org/project/wfdb) ## Introduction A Python-native package for reading, writing, processing, and plotting physiologic signal and annotation data. The core I/O functionality is based on the Waveform Database (WFDB) [specifications](https://github.com/wfdb/wfdb-spec/). This package is heavily inspired by the original [WFDB Software Package](https://www.physionet.org/content/wfdb/), and initially aimed to replicate many of its command-line APIs. However, the projects are independent, and there is no promise of consistency between the two, beyond each package adhering to the core specifications. ## Documentation and Usage See the [documentation site](http://wfdb.readthedocs.io) for the public APIs. See the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb) notebook file for example use cases. ## Installation The distribution is hosted on PyPI at: <https://pypi.python.org/pypi/wfdb/>. The package can be directly installed from PyPI using either pip or poetry: ```sh pip install wfdb poetry add wfdb ``` On Linux systems, accessing _compressed_ WFDB signal files requires installing `libsndfile`, by running `sudo apt-get install libsndfile1` or `sudo yum install libsndfile`. Support for Apple M1 systems is a work in progess (see <https://github.com/bastibe/python-soundfile/issues/310> and <https://github.com/bastibe/python-soundfile/issues/325>). The development version is hosted at: <https://github.com/MIT-LCP/wfdb-python>. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run: ```sh # Without dev dependencies pip install . poetry install # With dev dependencies pip install ".[dev]" poetry install -E dev # Install the dependencies only poetry install -E dev --no-root ``` **See the [note](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#package-and-dependency-management) about dev dependencies.** ## Developing Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions. ## Citing When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.

Lecture notes, tutorial tasks including solutions as well as online videos for the reinforcement learning course hosted by Paderborn University

Reinforcement Learning Course Materials ======================================= [](https://github.com/upb-lea/reinforcement_learning_course_materials/actions/workflows/blank.yml) [](https://github.com/upb-lea/reinforcement_learning_course_materials/blob/master/LICENSE) [](https://www.python.org/) [](https://www.latex-project.org/) Lecture notes, tutorial tasks including solutions as well as online videos for the reinforcement learning course hosted by Paderborn University. Source code for the entire course material is open and everyone is cordially invited to use it for self-learning (students) or to set up your own course (lecturers).  # Lecture Content 01. Introduction to Reinforcement Learning * [Lecture video](https://www.youtube.com/watch?v=9LLzaIJuu-E&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture01.pdf) 02. Markov Decision Processes * [Lecture video](https://www.youtube.com/watch?v=WswYbJOyJUo&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture02.pdf) 03. Dynamic Programming * [Lecture video](https://www.youtube.com/watch?v=RPHaH0c6k-I&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture03.pdf) 04. Monte Carlo Methods * [Lecture video](https://www.youtube.com/watch?v=YsAm3w2ev0g&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture04.pdf) 05. Temporal-Difference Learning * [Lecture video](https://www.youtube.com/watch?v=w10WMaYgCMQ) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture05.pdf) 06. n-Step Bootstrapping * [Lecture video](https://www.youtube.com/watch?v=HEt9z3CASn0&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture06.pdf) 07. Planning and Learning with Tabular Methods * [Lecture video](https://www.youtube.com/watch?v=bLl3s2VgRag&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture07.pdf) 08. Function Approximation with Supervised Learning * [Lecture video](https://www.youtube.com/watch?v=xitBw9azPKE&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture08.pdf) 09. On-Policy Prediction with Function Approximation * [Lecture video](https://www.youtube.com/watch?v=vxenJGAFM4g&feature=youtu.be) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture09.pdf) 10. Value-Based Control with Function Approximation * [Lecture video](https://www.youtube.com/watch?v=YNf-ezTKB78) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture10.pdf) 11. Eligibility Traces * [Lecture video](https://www.youtube.com/watch?v=xLUXeASnqwE) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture11.pdf) 12. Policy Gradient Methods * [Lecture video](https://www.youtube.com/watch?v=IrQQyWkFJwk) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture12.pdf) 13. Further Contemporary RL Algorithms (DDPG, TD3, TRPO, PPO) * [Lecture video](https://www.youtube.com/watch?v=aYeDmT-y-4g) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Lecture13.pdf) * Summary of Part One: Reinforcement Learning in Finite State and Action Spaces * [Lecture video](https://www.youtube.com/watch?v=bRpWfOSvMTg) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Summary_Part_One.pdf) * Summary of Part Two: Course Completion and Outlook * [Lecture video](https://www.youtube.com/watch?v=F_dkTOlVACM) * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/Summary_Part_Two.pdf) * Full course slides * [Lecture slides](https://groups.uni-paderborn.de/lea/share/lehre/reinforcementlearning/lecture_slides/built/main.pdf) # Exercise Content 01. Basics of Python for Scientific Computing * [Tutorial video](https://www.youtube.com/watch?v=MJXVQXkOEAA&feature=youtu.be) * [Tutorial template](../master/exercises/templates/ex01) * [Tutorial solution](../master/exercises/solutions/ex01) 02. Manually Solving Basic Markov Chain, Reward and Decision Problems * [Tutorial video](https://www.youtube.com/watch?v=3PPIHd3lO4k) * [Tutorial template](../master/exercises/templates/ex02) * [Tutorial solution](../master/exercises/solutions/ex02) 03. The Beer-Bachelor and Dynamic Programming (the Shortest Beer Problem) * [Tutorial video](https://www.youtube.com/watch?v=Z9QTRtJfZaM&feature=youtu.be) * [Tutorial template](../master/exercises/templates/ex03) * [Tutorial solution](../master/exercises/solutions/ex03) 04. Drive Through the Race Track with Monte Carlo Learning * [Tutorial video](https://www.youtube.com/watch?v=GlL1d4Ivo_g&t=880s) * [Tutorial template](../master/exercises/templates/ex04) * [Tutorial solution](../master/exercises/solutions/ex04) 05. Drive even Faster Using Temporal-Difference Learning * [Tutorial video](https://www.youtube.com/watch?v=eTFugChiOaE&feature=youtu.be) * [Tutorial template](../master/exercises/templates/ex05) * [Tutorial solution](../master/exercises/solutions/ex05) 06. Stabilizing the Inverted Pendulum by Tabular n-Step Methods * [Tutorial video](https://www.youtube.com/watch?v=4ACrTBFRw50) * [Tutorial template](../master/exercises/templates/ex06) * [Tutorial solution](../master/exercises/solutions/ex06) 07. Boosting the Inverted Pendulum by Integrating Learning & Planning (Dyna Framework) * [Tutorial video](https://www.youtube.com/watch?v=KXNu7xDZ9Bg&feature=youtu.be) * [Tutorial template](../master/exercises/templates/ex07) * [Tutorial solution](../master/exercises/solutions/ex07) 08. Predicting the Operating Behavior of a Real Electric Drive Systems with Supervised Learning * [Tutorial video](https://www.youtube.com/watch?v=zxC87jRnT08) * [Tutorial template](../master/exercises/templates/ex08) * [Tutorial solution](../master/exercises/solutions/ex08) 09. Evaluate the Performance of Given Agents in the Mountain Car Problem Using Function Approximation * [Tutorial video](https://www.youtube.com/watch?v=zCv29hVyxNk&t=2162s) * [Tutorial template](../master/exercises/templates/ex09) * [Tutorial solution](../master/exercises/solutions/ex09) 10. Escape from the Mountain Car Valley Using Semi-Gradient Sarsa & Least Square Policy Iteration * [Tutorial video](https://www.youtube.com/watch?v=FrMSB7Dgp7c&feature=youtu.be) * [Tutorial template](../master/exercises/templates/ex10) * [Tutorial solution](../master/exercises/solutions/ex10) 11. Improve the Value-Based Mount Car Solution using Sarsa(Lambda) * [Tutorial video](https://www.youtube.com/watch?v=bhZGpuh5-6M) * [Tutorial template](../master/exercises/templates/ex11) * [Tutorial solution](../master/exercises/solutions/ex11) 12. Landing on the Moon with REINFORCE and Actor-Critic Methods * [Tutorial video](https://www.youtube.com/watch?v=LeVDStyEjAo) * [Tutorial template](../master/exercises/templates/ex12) * [Tutorial solution](../master/exercises/solutions/ex12) 13. Shoot to the moon with DDPG & PPO * [Tutorial video](https://www.youtube.com/watch?v=4RyX7L-MbsU) * [Tutorial template](../master/exercises/templates/ex13) * [Tutorial solution](../master/exercises/solutions/ex13) # Citation Please use the following BibTeX entry for citing us: @Misc{KSWW2020, author = {Wilhelm Kirchgässner and Maximilian Schenke and Oliver Wallscheid and Daniel Weber}, note = {Paderborn University}, title = {Reinforcement Learning Course Material}, year = {2020}, url = {https://github.com/upb-lea/reinforcement_learning_course_materials}, } # Contributions We highly appreciate any feedback and input to the course material e.g. * typos or content-related discussions (please raise an issue) * adding new contents (please provide a pull request) If you like to contribute to the repo to a larger extent, please do not hesitate to contact us directly. # Credits The lecture notes are inspired by * [Richard S. Sutton, Andrew G. Barto, 'Reinforcement Learning: An Introduction' Second Edition MIT Press, Cambridge, MA, 2018](http://www.incompleteideas.net/book/the-book-2nd.html) * [David Silver, UCL Course on Reinforcement Learning, 2015](https://www.davidsilver.uk/teaching/) The tutorials are partly using pre-packed environments from * [OpenAI Gym](https://gym.openai.com/)

Repository of notes, code and notebooks in Python for the book Pattern Recognition and Machine Learning by Christopher Bishop

# Pattern Recognition and Machine Learning (PRML)  [](https://nbviewer.jupyter.org/github/gerdm/prml/tree/master/) This project contains Jupyter notebooks of many the algorithms presented in Christopher Bishop's Pattern Recognition and Machine Learning book, as well as replicas for many of the graphs presented in the book. ## Discussions (new) If you have any questions and/or requests, check out the [discussions](https://github.com/gerdm/prml/discussions) page! ## Useful Links * [PRML Book](https://www.microsoft.com/en-us/research/publication/pattern-recognition-machine-learning) * [Matrix Calculus](http://www.matrixcalculus.org/matrixCalculus) * [The Matrix Cookbook](https://www.math.uwaterloo.ca/~hwolkowi/matrixcookbook.pdf) * [PRML Errata](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/05/prml-errata-1st-20110921.pdf) * [More PRML Errata (repo)](https://github.com/yousuketakada/prml_errata) ## Content ``` . ├── README.md ├── chapter01 │   ├── einsum.ipynb │   ├── exercises.ipynb │   └── introduction.ipynb ├── chapter02 │   ├── Exercises.ipynb │   ├── bayes-binomial.ipynb │   ├── bayes-normal.ipynb │   ├── density-estimation.ipynb │   ├── exponential-family.ipynb │   ├── gamma-distribution.ipynb │   ├── mixtures-of-gaussians.ipynb │   ├── periodic-variables.ipynb │   ├── robbins-monro.ipynb │   └── students-t-distribution.ipynb ├── chapter03 │   ├── bayesian-linear-regression.ipynb │   ├── equivalent-kernel.ipynb │   ├── evidence-approximation.ipynb │   ├── linear-models-for-regression.ipynb │   ├── ml-vs-map.ipynb │   ├── predictive-distribution.ipynb │   └── sequential-bayesian-learning.ipynb ├── chapter04 │   ├── exercises.ipynb │   ├── fisher-linear-discriminant.ipynb │   ├── least-squares-classification.ipynb │   ├── logistic-regression.ipynb │   └── perceptron.ipynb ├── chapter05 │   ├── backpropagation.ipynb │   ├── bayesian-neural-networks.ipynb │   ├── ellipses.ipynb │   ├── imgs │   │   └── f51.png │   ├── mixture-density-networks.ipynb │   ├── soft-weight-sharing.ipynb │   └── weight-space-symmetry.ipynb ├── chapter06 │   ├── gaussian-processes.ipynb │   └── kernel-regression.ipynb ├── chapter07 │   ├── relevance-vector-machines.ipynb │   └── support-vector-machines.ipynb ├── chapter08 │   ├── exercises.ipynb │   ├── graphical-model-inference.ipynb │   ├── img.jpeg │   ├── markov-random-fields.ipynb │   ├── sum-product.ipynb │   └── trees.ipynb ├── chapter09 │   ├── gaussian-mixture-models.ipynb │   ├── k-means.ipynb │   └── mixture-of-bernoulli.ipynb ├── chapter10 │   ├── exponential-mixture-gaussians.ipynb │   ├── local-variational-methods.ipynb │   ├── mixture-gaussians.ipynb │   ├── variational-logistic-regression.ipynb │   └── variational-univariate-gaussian.ipynb ├── chapter11 │   ├── adaptive-rejection-sampling.ipynb │   ├── gibbs-sampling.ipynb │   ├── hybrid-montecarlo.ipynb │   ├── markov-chain-motecarlo.ipynb │   ├── rejection-sampling.ipynb │   ├── slice-sampling.ipynb │   └── transformation-random-variables.ipynb ├── chapter12 │   ├── bayesian-pca.ipynb │   ├── kernel-pca.ipynb │   ├── ppca.py │   ├── principal-component-analysis.ipynb │   └── probabilistic-pca.ipynb ├── chapter13 │   ├── em-hidden-markov-model.ipynb │   ├── hidden-markov-model.ipynb │   └── linear-dynamical-system.ipynb ├── chapter14 │   ├── CART.ipynb │   ├── boosting.ipynb │   ├── cmm-linear-regression.ipynb │   ├── cmm-logistic-regression.ipynb │   └── tree.py └── misc └── tikz ├── ch13-hmm.tex └── ch8-sum-product.tex 17 directories, 73 files ```

Enable Self-Service Operations: Give specific users access to your existing tools, services, and scripts

Rundeck ======== | Travis | Deb | RPM | War | |--------|-----|-----|-----| |[](https://travis-ci.org/rundeck/rundeck/builds#)|[Download](https://www.rundeck.com/downloads)|[Download](https://www.rundeck.com/downloads)|[Download](https://www.rundeck.com/downloads)| Rundeck is an open source automation service with a web console, command line tools and a WebAPI. It lets you easily run automation tasks across a set of nodes. * Site: <https://www.rundeck.com> * Latest documentation: <https://docs.rundeck.com/docs/> * Get Help: <https://docs.rundeck.com/docs/introduction/getting-help.html> * Installation: <https://docs.rundeck.com/docs/administration/install/installing-rundeck.html> See the [Release Notes](https://docs.rundeck.com/docs/history/) for the latest version information. How To Build: ===== Primary build is supported with gradle. More info in the [wiki](https://github.com/rundeck/rundeck/wiki/Building-and-Testing). Requirements: Java 1.8, NodeJs 16 Build with Gradle --- Produces: `rundeckapp/build/libs/rundeck-X.Y.war` ./gradlew build Docker Build --- Uses the war artifact and produces a docker image. Creates image `rundeck/rundeck:SNAPSHOT`, you can define `-PdockerTags` to add additional tags ./gradlew :docker:officialBuild Documentation ====== Available online at <https://docs.rundeck.com/docs> FAQ: <https://github.com/rundeck/rundeck/wiki/FAQ> Development ====== Refer to the [IDE Development Environment](https://github.com/rundeck/rundeck/wiki/IDE-Development-Environment) to get set up using IntelliJ IDEA or Eclipse/STS. * [Issue tracker](https://github.com/rundeck/rundeck/issues) at github.com Do you have changes to contribute? Please see the [Development](https://github.com/rundeck/rundeck/wiki/Development) wiki page. License ====== Copyright 2020 Rundeck, Inc. 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 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.

Litmus helps SREs and developers practice chaos engineering in a Cloud-native way. Chaos experiments are published at the ChaosHub (https://hub.litmuschaos.io). Community notes is at https://hackmd.io/a4Zu_sH4TZGeih-xCimi3Q

<img alt="LitmusChaos" src="https://avatars.githubusercontent.com/u/49853472?s=200&v=4" width="200" align="left"> # [LitmusChaos](https://litmuschaos.io/) ### Open Source Chaos Engineering Platform [](https://slack.litmuschaos.io)  [](https://hub.docker.com/r/litmuschaos/chaos-operator) [](https://github.com/litmuschaos/litmus/stargazers) [](https://github.com/litmuschaos/litmus/issues) [](https://twitter.com/LitmusChaos) [](https://bestpractices.coreinfrastructure.org/projects/3202) [](https://bettercodehub.com/) [](https://app.fossa.io/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus?ref=badge_shield) [](https://www.youtube.com/channel/UCa57PMqmz_j0wnteRa9nCaw) <br><br><br><br> #### *Read this in [other languages](translations/TRANSLATIONS.md).* [🇰🇷](translations/README-ko.md) [🇨🇳](translations/README-chn.md) [🇧🇷](translations/README-pt-br.md) [🇮🇳](translations/README-hi.md) ## Overview LitmusChaos is an open source Chaos Engineering platform that enables teams to identify weaknesses & potential outages in infrastructures by inducing chaos tests in a controlled way. Developers & SREs can practice Chaos Engineering with LitmusChaos as it is easy to use, based on modern Chaos Engineering principles & community collaborated. It is 100% open source & a CNCF project. LitmusChaos takes a cloud-native approach to create, manage and monitor chaos. The platform itself runs as a set of microservices and uses Kubernetes custom resources to define the chaos intent, as well as the steady state hypothesis. At a high-level, Litmus comprises of: - **Chaos Control Plane**: A centralized chaos management tool called chaos-center, which helps construct, schedule and visualize Litmus chaos workflows - **Chaos Execution Plane Services**: Made up of a chaos agent and multiple operators that execute & monitor the experiment within a defined target Kubernetes environment.  At the heart of the platform are the following chaos custom resources: - **ChaosExperiment**: A resource to group the configuration parameters of a particular fault. ChaosExperiment CRs are essentially installable templates that describe the library carrying out the fault, indicate permissions needed to run it & the defaults it will operate with. Through the ChaosExperiment, Litmus supports BYOC (bring-your-own-chaos) that helps integrate (optional) any third-party tooling to perform the fault injection. - **ChaosEngine**: A resource to link a Kubernetes application workload/service, node or an infra component to a fault described by the ChaosExperiment. It also provides options to tune the run properties and specify the steady state validation constraints using 'probes'. ChaosEngine is watched by the Chaos-Operator, which reconciles it (triggers experiment execution) via runners. The ChaosExperiment & ChaosEngine CRs are embedded within a Workflow object that can string together one or more experiments in a desired order. - **ChaosResult**: A resource to hold the results of the experiment run. It provides details of the success of each validation constraint, the revert/rollback status of the fault as well as a verdict. The Chaos-exporter reads the results and exposes information as prometheus metrics. ChaosResults are especially useful during automated runs. ChaosExperiment CRs are hosted on <a href="https://hub.litmuschaos.io" target="_blank">hub.litmuschaos.io</a>. It is a central hub where the application developers or vendors share their chaos experiments so that their users can use them to increase the resilience of the applications in production.  ## Use cases - **For Developers**: To run chaos experiments during application development as an extension of unit testing or integration testing. - **For CI/CD pipeline builders**: To run chaos as a pipeline stage to find bugs when the application is subjected to fail paths in a pipeline. - **For SREs**: To plan and schedule chaos experiments into the application and/or surrounding infrastructure. This practice identifies the weaknesses in the deployment system and increases resilience. ## Getting Started with Litmus To get started, check out the <a href="https://docs.litmuschaos.io/docs/introduction/what-is-litmus" target="_blank">Litmus Docs</a> and specifically the <a href="https://docs.litmuschaos.io/docs/getting-started/installation#prerequisites" target="_blank">Installation section</a> of the <a href="https://docs.litmuschaos.io/docs/getting-started/installation" target="_blank">Getting Started with Litmus</a> page. ## Contributing to Chaos Hub Check out the <a href="https://github.com/litmuschaos/community-charts/blob/master/CONTRIBUTING.md" target="_blank">Contributing Guidelines for the Chaos Hub</a> ## Community ### Community Resources: Feel free to reach out if you have any queries,concerns, or feature requests - Give us a star ⭐️ - If you are using LitmusChaos or think it is an interesting project, we would love a star ❤️ - Follow LitmusChaos on Twitter [@LitmusChaos](https://twitter.com/LitmusChaos). - Subscribe to the [LitmusChaos YouTube channel](https://www.youtube.com/channel/UCa57PMqmz_j0wnteRa9nCaw) for regular updates & meeting recordings. - To join our [Slack Community](https://slack.litmuschaos.io/) and meet our community members, put forward your questions & opinions, join the #litmus channel on the [Kubernetes Slack](https://slack.k8s.io/). ### Community Meetings The Litmus community meets on the third wednesday of every month at 10:00PM IST/6:30 PM CEST/9:30 AM PST. - [Sync Up Meeting Link](https://harness-io.zoom.us/j/95100368978?pwd=b2VrdCtaakE5U3dhOElFMUJOaXVOUT09) - [Sync Up Agenda & Meeting Notes](https://hackmd.io/a4Zu_sH4TZGeih-xCimi3Q) - [Release Tracker](https://github.com/litmuschaos/litmus/milestones) ### Videos - [Cloud Native Live: Litmus Chaos Engine and a microservices demo app](https://youtu.be/hOghvd9qCzI) - [Chaos Engineering hands-on - An SRE ideating Chaos Experiments and using LitmusChaos | July 2022](https://youtu.be/_x_7SiesjF0) - [Achieve Digital Product Resiliency with Chaos Engineering](https://youtu.be/PQrmBHgk0ps) - [How to create Chaos Experiments with Litmus | Litmus Chaos tutorial](https://youtu.be/mwu5eLgUKq4) @ [Is it Observable](https://www.youtube.com/c/IsitObservable) - [Cloud Native Chaos Engineering Preview With LitmusChaos](https://youtu.be/pMWqhS-F3tQ) - [Get started with Chaos Engineering with Litmus](https://youtu.be/5CI8d-SKBfc) @ [Containers from the Couch](https://www.youtube.com/c/ContainersfromtheCouch) - [Litmus 2 - Chaos Engineering Meets Argo Workflows](https://youtu.be/B8DfYnDh2F4) @ [DevOps Toolkit](https://youtube.com/c/devopstoolkit) - [Hands-on with Litmus 2.0 | Rawkode Live](https://youtu.be/D0t3emVLLko) @ [Rawkode Academy](https://www.youtube.com/channel/UCrber_mFvp_FEF7D9u8PDEA) - [Introducing LitmusChaos 2.0 / Dok Talks #74](https://youtu.be/97BiCNtJbDw) @ [DoK.community](https://www.youtube.com/channel/UCUnXJbHQ89R2uSfKsqQwGvQ) - [Introduction to Cloud Native Chaos Engineering](https://youtu.be/LK0oDLQE4S8) @ [Kunal Kushwaha](https://www.youtube.com/channel/UCBGOUQHNNtNGcGzVq5rIXjw) - [#EveryoneCanContribute cafe: Litmus - Chaos Engineering for your Kubernetes](https://youtu.be/IiyrEiK4stQ) @ [GitLab Unfiltered](https://www.youtube.com/channel/UCMtZ0sc1HHNtGGWZFDRTh5A) - [Litmus - Chaos Engineering for Kubernetes (CNCFMinutes 9)](https://youtu.be/rDQ9XKbSJIc) @ [Saiyam Pathak](https://www.youtube.com/channel/UCi-1nnN0eC9nRleXdZA6ncg) - [Chaos Engineering with Litmus Chaos by Prithvi Raj || HACKODISHA Workshop](https://youtu.be/eyAG0svCsQA) @ [Webwiz](https://www.youtube.com/channel/UC9yM_PkV0QIIsPA3qPrp) [And More....](https://www.youtube.com/channel/UCa57PMqmz_j0wnteRa9nCaw) ### Blogs - CNCF: [Introduction to LitmusChaos](https://www.cncf.io/blog/2020/08/28/introduction-to-litmuschaos/) - Hackernoon: [Manage and Monitor Chaos via Litmus Custom Resources](https://hackernoon.com/solid-tips-on-how-to-manage-and-monitor-chaos-via-litmus-custom-resources-5g1s33m9) - [Observability Considerations in Chaos: The Metrics Story](https://dev.to/ksatchit/observability-considerations-in-chaos-the-metrics-story-6cb) Community Blogs: - Daniyal Rayn: [Do I need Chaos Engineering on my environment? Trust me you need it!](https://maveric-systems.com/blog/do-i-need-chaos-engineering-on-my-environment-trust-me-you-need-it/) - LiveWyer: [LitmusChaos Showcase: Chaos Experiments in a Helm Chart Test Suite](https://livewyer.io/blog/2021/03/22/litmuschaos-showcase-chaos-experiments-in-a-helm-chart-test-suite/) - Jessica Cherry: [Test Kubernetes cluster failures and experiments in your terminal](https://opensource.com/article/21/6/kubernetes-litmus-chaos) - Yang Chuansheng(KubeSphere): [KubeSphere 部署 Litmus 至 Kubernetes 开启混沌实验](https://kubesphere.io/zh/blogs/litmus-kubesphere/) - Saiyam Pathak(Civo): [Chaos Experiments on Kubernetes using Litmus to ensure your cluster is production ready](https://www.civo.com/learn/chaos-engineering-kubernetes-litmus) - Andreas Krivas(Container Solutions):[Comparing Chaos Engineering Tools for Kubernetes Workloads](https://blog.container-solutions.com/comparing-chaos-engineering-tools) - Akram Riahi(WeScale):[Chaos Engineering : Litmus sous tous les angles](https://blog.wescale.fr/2021/03/11/chaos-engineering-litmus-sous-tous-les-angles/) - Prashanto Priyanshu(LensKart):[Lenskart’s approach to Chaos Engineering-Part 2](https://blog.lenskart.com/lenskarts-approach-to-chaos-engineering-part-2-6290e4f3a74e) - DevsDay.ru(Russian):[LitmusChaos at Kubecon EU '21](https://devsday.ru/blog/details/40746) - Ryan Pei(Armory): [LitmusChaos in your Spinnaker Pipeline](https://www.armory.io/blog/litmuschaos-in-your-spinnaker-pipeline/) - David Gildeh(Zebrium): [Using Autonomous Monitoring with Litmus Chaos Engine on Kubernetes](https://www.zebrium.com/blog/using-autonomous-monitoring-with-litmus-chaos-engine-on-kubernetes) ## Adopters Check out the <a href="https://github.com/litmuschaos/litmus/blob/master/ADOPTERS.md" target="_blank">Adopters of LitmusChaos</a> (_Send a PR to the above page if you are using Litmus in your chaos engineering practice_) ## License Litmus is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text. Some of the projects used by the Litmus project may be governed by a different license, please refer to its specific license. [](https://app.fossa.io/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus?ref=badge_large) Litmus Chaos is part of the CNCF Projects. [](https://landscape.cncf.io/?selected=litmus) ## Important Links <a href="https://docs.litmuschaos.io"> Litmus Docs <img src="https://avatars0.githubusercontent.com/u/49853472?s=200&v=4" alt="Litmus Docs" height="15"> </a> <br> <a href="https://landscape.cncf.io/?selected=litmus"> CNCF Landscape <img src="https://landscape.cncf.io/images/left-logo.svg" alt="Litmus on CNCF Landscape" height="15"> </a>

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.

Awesome Ansible List

# Awesome Ansible [](https://awesome.re) <!--lint disable double-link--> [<img src="ansible_logo.svg" align="right" width="90">](https://www.ansible.com/) > A collaborative curated list of awesome Ansible resources, tools, Roles, tutorials and other related stuff. [Ansible](https://www.ansible.com/) is an open source toolkit, written in Python, it is used for configuration management, application deployment, continuous delivery, IT infrastructure automation and automation in general. <!--lint enable double-link--> ## Contents - [Official resources](#official-resources) - [Community](#community) - [Tutorials](#tutorials) - [Books](#books) - [Videos](#videos) - [Tools](#tools) - [Blog posts and opinions](#blog-posts-and-opinions) - [Playbooks, Roles and Collections](#playbooks-roles-and-collections) - [Editor and IDE Integrations](#editor-and-ide-integrations) ## Official resources > Official resources by and for Ansible. - [Latest Ansible Documentation](https://docs.ansible.com/ansible/latest/user_guide/index.html) - Latest user guide and documentation for Ansible. - [Ansible Galaxy Website](https://galaxy.ansible.com/) - Official repository and community site for Ansible Roles. - [Ansible Blog](https://www.ansible.com/blog) - Official Ansible blog. ## Community > Places where to chat with the Ansible community - About code - [GitHub.com/ansible](https://github.com/ansible), [GitHub.com/ansible-collections](https://github.com/ansible-collections) and [GitHub.com/ansible-community](https://github.com/ansible-community). - [reddit.com/r/ansible](https://old.reddit.com/r/ansible/) - The Ansible subreddit. - [Discord](https://old.reddit.com/r/ansible/comments/jv5shj/ansible_discord_server_come_get_ansible_help_in/) - The Ansible discord. - [ansible.com/community](https://ansible.com/community) - Twitter, mailing lists, meetups and more. There are also many Ansible IRC channels on [libera.chat](https://libera.chat/) that are bridged to [Matrix](https://matrix.org/). You can find the full list and how to connect in the official documentation [documentation](https://docs.ansible.com/ansible/latest/community/communication.html) but here's a few: | IRC | Matrix | Topic | |--------------------|------------------------|----------------------------------------------------------------------------------| | #ansible | #users:ansible.com | General Ansible user support and discussion | | #ansible-devel | #devel:ansible.com | Developer discussions around code, bugs and features | | #ansible-community | #community:ansible.com | Community working group, wide range of topics including weekly meetings | | #ansible-docs | #docs:ansible.com | Documentation working group, discuss docs and participate in weekly meetings | | #ansible-devtools | #devtools:ansible.com | For devtools such as ansible-lint, molecule and the vscode plugin | | #ansible-awx | #awx:ansible.com | For the AWX open source project, upstream of Ansible Tower/Automation controller | | #ansible-network | #network:ansible.com | For general support and discussion around network automation with Ansible | | #ansible-fr | #francais:ansible.com | For discussion about Ansible in french | ## Tutorials > Tutorials and courses to learn Ansible. - [How To Manage Remote Servers with Ansible](https://www.digitalocean.com/community/tutorial_series/how-to-manage-remote-servers-with-ansible) - This Tutorial goes over how to use Ansible to manage remote servers. - [Ansible Tutorial by leucos](https://github.com/leucos/ansible-tuto) - 12 Step Tutorial for Ansible. - [Programming Community Curated Resources for learning Ansible](https://hackr.io/tutorials/learn-ansible) - A list of recommended resources. - [Ansible TopTechSkills.com Tutorial Series on Ansible](https://www.toptechskills.com/ansible-tutorials-courses/) - Tutorials on how to Install and use Ansible. - [Official Ansible labs by Red Hat](https://ansible.github.io/workshops/exercises/ansible_rhel/) - Training Course for Ansible Automation Platform. - [Ansible Tutorials on DigitalOcean](https://www.digitalocean.com/community/tags/ansible?subtype=tutorial) - Basic tutorials on DigitalOcean.com. - [Ansible Tutorial by BlueBanquise team](http://bluebanquise.com/documentation/releases/1.5.0/training_ansible.html) - Basic Ansible tutorial. - [Ansible Tutorial for Beginners: Playbook & Examples](https://spacelift.io/blog/ansible-tutorial) - Introduction to Ansible for beginners. - [Ansible Tutorials for Beginners and Advanced](https://ansible.puzzle.ch/) - Workshop on multiple topics with different levels of difficulty. ## Books > Books about Ansible. - [Ansible for DevOps](https://www.ansiblefordevops.com/) - This book helps to start using Ansible to provision and manage anywhere from one to thousands of servers. Free sample can be read [here](https://leanpub.com/ansible-for-devops/read_sample). - [Ansible for Kubernetes](https://www.ansibleforkubernetes.com/) - Deploy and maintain real-world massively-scalable and high-available applications with Ansible. - [How To Manage Remote Servers with Ansible eBook](https://www.digitalocean.com/community/books/how-to-manage-remote-servers-with-ansible-ebook) - This book is based on the "How To Manage Remote Servers with Ansible" tutorial series. ## Videos > Video tutorials and Ansible training. - [Ansible YouTube Channel](https://www.youtube.com/channel/UCPJo5UY1KsP7J1BuHmiWNzQ) - Official Ansible YouTube channel. - [Introduction to Ansible](https://youtu.be/iVWmbStE1MM) - Introduction to Ansible by Cloud Academy. - [Ansible 101 by Jeff Geerling](https://www.jeffgeerling.com/blog/2020/ansible-101-jeff-geerling-youtube-streaming-series) - Great video series on Ansible, by Jeff Geerling. - [Ansible TopTechSkills.com Tutorial Series on YouTube](https://www.youtube.com/playlist?list=PLMyOob-UkeytIleCbMlFfCzaunOh27hm6) - Video tutorials on Ansible. - [Ansible Essentials - Course](https://www.redhat.com/en/services/training/do007-ansible-essentials-simplicity-automation-technical-overview) - Free Video Classroom on Ansible essentials by Red Hat. - [Complete Ansible Course 2020 by DevOps Journey](https://www.youtube.com/watch?v=KuiAiUyuDY4&list=PLnFWJCugpwfzTlIJ-JtuATD2MBBD7_m3u&index=1) - Free Video Course on Ansible including labs to follow along. - [Getting started with Ansible](https://youtube.com/playlist?list=PLT98CRl2KxKEUHie1m24-wkyHpEsa4Y70) - YouTube tutorial series by LearnLinuxTV. ## Tools > Tools for and using Ansible. - [Automation Controller](https://www.ansible.com/products/controller) - Automation Controller (formally Ansible Tower) by Red Hat helps you scale IT automation, manage complex deployments and speed productivity. Extend the power of Ansible to your entire team. - [AWX](https://github.com/ansible/awx) - AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is the upstream project for Tower, a commercial derivative of AWX. - [Ansible Lint](https://github.com/ansible/ansible-lint) - Checks Playbooks for best practices and behavior that could potentially be improved. - [Ansible Later](https://github.com/thegeeklab/ansible-later) - Another best practice scanner. Checks Playbooks and Roles for best practices and behavior that could potentially be improved. - [Ansible Doctor](https://github.com/thegeeklab/ansible-doctor) - Simple annotation like documentation generator for Ansible roles based on Jinja2 templates. - [Ansible cmdb](https://github.com/fboender/ansible-cmdb) - Takes the output of Ansible's fact gathering and converts it into a static HTML page. - [ARA](https://github.com/ansible-community/ara) - ARA Records Ansible playbooks and makes them easier to understand and troubleshoot with a reporting API, UI and CLI. - [Mitogen for Ansible](https://mitogen.networkgenomics.com/ansible_detailed.html) - Speed up Ansible substantially with Mitogen. - [Molecule](https://molecule.readthedocs.io/en/latest/) - Molecule aids in the development and testing of Ansible roles. - [Packer Ansible Provisioner](https://www.packer.io/plugins/provisioners/ansible/ansible-local) - This Provisioner can be used to automate VM Image creation via Packer with Ansible. - [Excel Ansible Inventory](https://github.com/KeyboardInterrupt/ansible_xlsx_inventory) - Turn any Excel Spreadsheet into an Ansible Inventory. - [terraform.py](https://github.com/mantl/terraform.py) - Ansible dynamic inventory script for parsing Terraform state files. - [ansible-navigator](https://github.com/ansible/ansible-navigator) - A text-based user interface (TUI) for Ansible. - [squest](https://hewlettpackard.github.io/squest/) - Self-service portal for Ansible Tower job templates. - [ansible-bender](https://ansible-community.github.io/ansible-bender/build/html/index.html) - Tool which bends containers using Ansible playbooks and turns them into container images. - [ansible-runner](https://github.com/ansible/ansible-runner) - A tool and python library that helps when interfacing with Ansible directly or as part of another system whether that be through a container image interface, as a standalone tool, or as a Python module that can be imported. - [ansible-builder](https://ansible-builder.readthedocs.io/en/latest/) - Using Ansible content that depends on non-default dependencies can be tricky. Packages must be installed on each node, play nicely with other software installed on the host system, and be kept in sync. - [kics](https://github.com/Checkmarx/kics) - SAST Tool that scans your ansible infrastructure as code playbooks for security vulnverables, compliance issues and misconfigurations. - [php-ansible Library](https://github.com/maschmann/php-ansible) - OOP-Wrapper for Ansible, making Ansible available in PHP. - [TD4A](https://github.com/cidrblock/td4a) - Design aid for building and testing jinja2 templates, combines data in yaml format with a jinja2 template and render the output. - [Ansible Playbook Grapher](https://github.com/haidaraM/ansible-playbook-grapher) - Command line tool to create a graph representing your Ansible playbook plays, tasks and roles. - [ansible-doc-extractor](https://github.com/xlab-steampunk/ansible-doc-extractor) - A tool that extracts documentation from Ansible modules in the HTML form. - [Ansible Semaphore](https://github.com/ansible-semaphore/semaphore) - Ansible Semaphore is a modern UI for Ansible. - [Steampunk Spotter](https://steampunk.si/spotter/) - Provides an Assisted Automation Writing tool that analyzes and offers recommendations for your Ansible Playbooks. ## Blog posts and opinions > Best practices and other opinions on Ansible. - [Ansible (Real Life) Good Practices](https://reinteractive.com/posts/167-ansible-real-life-good-practices) - Best practice guidelines. - [Testing Ansible Roles Against Windows with Test-Kitchen](https://hodgkins.io/testing-ansible-roles-windows-test-kitchen) - Using Test-Kitchen with Ansible to apply playbooks to Windows machines and test them with [Pester](https://github.com/pester/Pester/). - [Ansible Best Practices by AndiDog](https://andidog.de/blog/2017-04-24-ansible-best-practices) - Practices covering many aspects of an Ansible setup, including hints to support different environments (testing, staging, production). - [Getting started with Ansible](https://steampunk.si/blog/getting-started-with-ansible/) - Introduces Ansible, provides installation instructions and gives an interactive walkthrough of Ansible's basic functionalities, like running Ansible playbooks and installing Ansible content. - [Taking Ansible apart](https://steampunk.si/blog/taking-ansible-apart/) - Describes and shows how most commonly used Ansible components work. ### German - [Ansible – Was ich am Ad-hoc-Modus schätze](https://www.my-it-brain.de/wordpress/ansible-was-ich-am-ad-hoc-modus-schaetze/) - Opinion what the author likes about the Ansible Ad-Hoc mode. ### French - [Apprendre et Maitriser Ansible l'outil de gestion de configuration](https://blog.stephane-robert.info/post/introduction-ansible/) - A large of courses on Ansible in French. ## Playbooks, Roles and Collections > Awesome production ready Playbooks, Roles and Collections to get you up and running. - [Ansible Vagrant Examples by geerlingguy](https://github.com/geerlingguy/ansible-vagrant-examples) - Ansible examples using Vagrant to deploy to local VMs. - [Ansible playbook for Linux machine setup](https://github.com/olivomarco/my-ansible-linux-setup) - Ansible playbook for setting up a self-updating, hardened Debian/Ubuntu machine with Docker daemon. - [DevSec Hardening Framework](https://dev-sec.io/) - The DevSec collection helps you harden your Linux Based OS as well as MySQL, NGINX and SSH Server/Services. - [T.A.D.S. boilerplate](https://github.com/Thomvaill/tads-boilerplate) - Provision and deploy a Docker Swarm cluster to development environment and to production. Infrastructure as Code and DevOps best practices. - [Openstack Ansible](https://github.com/openstack/openstack-ansible) - Ansible Playbooks for deploying [OpenStack](https://www.openstack.org/). - [Robert de Bock](https://robertdebock.nl) - A extensive collection of Ansible roles. - [DebOps](https://docs.debops.org/en/master/) - A extensive collection of Debian based Ansible Playbooks. - [ansible-ssm](https://github.com/HQarroum/ansible-ssm) - An ansible role to provision physical and virtual hosts with the AWS SSM agent. - [BlueBanquise](https://github.com/bluebanquise/bluebanquise) - An ansible coherent roles collection to deploy clusters. ## Editor and IDE Integrations > Awesome Integrations into Text Editors and IDE's to make development with/for Ansible easier. - [Ansible Language Server](https://github.com/ansible/ansible-language-server) - Language Server that adds support for Ansible, to compatible Editors. - [Emacs - Ansible client for Language Server Protocol](https://emacs-lsp.github.io/lsp-mode/page/lsp-ansible/) - Emacs support for Ansible Language Server Protocol. - [VS Code - official Ansible Extension](https://marketplace.visualstudio.com/items?itemName=redhat.ansible) - Adds language support for Ansible to Visual Studio Code and OpenVSX compatible editors by leveraging ansible-language-server.

Modern self-hosting framework, fully automated from empty disk to operating services with a single command.

# Khue's Homelab **[Features](#features) • [Get Started](#get-started) • [Documentation](https://homelab.khuedoan.com)** [](https://github.com/khuedoan/homelab/tags) [](https://homelab.khuedoan.com) [](https://www.gnu.org/licenses/gpl-3.0.html) [](https://github.com/khuedoan/homelab) This project utilizes [Infrastructure as Code](https://en.wikipedia.org/wiki/Infrastructure_as_code) and [GitOps](https://www.weave.works/technologies/gitops) to automate provisioning, operating, and updating self-hosted services in my homelab. It can be used as a highly customizable framework to build your own homelab. > **What is a homelab?** > > Homelab is a laboratory at home where you can self-host, experiment with new technologies, practice for certifications, and so on. > For more information about homelab in general, see the [r/homelab introduction](https://www.reddit.com/r/homelab/wiki/introduction). ## Overview Project status: **ALPHA** This project is still in the experimental stage, and I don't use anything critical on it. Expect breaking changes that may require a complete redeployment. A proper upgrade path is planned for the stable release. More information can be found in [the roadmap](#roadmap) below. ### Hardware  - 4 × NEC SFF `PC-MK26ECZDR` (Japanese version of the ThinkCentre M700): - CPU: `Intel Core i5-6600T @ 2.70GHz` - RAM: `16GB` - SSD: `128GB` - TP-Link `TL-SG108` switch: - Ports: `8` - Speed: `1000Mbps` ### Features - [x] Common applications: Gitea, Seafile, Jellyfin, Paperless... - [x] Automated bare metal provisioning with PXE boot - [x] Automated Kubernetes installation and management - [x] Installing and managing applications using GitOps - [x] Automatic rolling upgrade for OS and Kubernetes - [x] Automatically update apps (with approval) - [x] Modular architecture, easy to add or remove features/components - [x] Automated certificate management - [x] Automatically update DNS records for exposed services - [x] VPN without port forwarding - [x] Expose services to the internet securely with [Cloudflare Tunnel](https://www.cloudflare.com/products/tunnel/) - [x] CI/CD platform - [x] Private container registry - [x] Distributed storage - [x] Support multiple environments (dev, prod) - [ ] Monitoring and alerting 🚧 - [ ] Automated offsite backups 🚧 - [ ] Single sign-on 🚧 - [x] Infrastructure testing Some demo videos and screenshots are shown here. They can't capture all the project's features, but they are sufficient to get a concept of it. | Demo | | :--: | | [![][deploy-demo]](https://asciinema.org/a/xkBRkwC6e9RAzVuMDXH3nGHp7) | | Deploy with a single command (after updating the configuration files) | | [![][pxe-demo]](https://www.youtube.com/watch?v=y-d7btNNAT8) | | PXE boot | | [![][homepage-demo]][homepage-demo] | | Homepage with Ingress discovery powered by [Hajimari](https://github.com/toboshii/hajimari) | | [![][grafana-demo]][grafana-demo] | | Monitoring dashboard powered by [Grafana](https://grafana.com/) | | [![][gitea-demo]][gitea-demo] | | Git server powered by [Gitea](https://gitea.io/en-us/) | | [![][matrix-demo]][matrix-demo] | | [Matrix](https://matrix.org/) chat server | | [![][tekton-demo]][tekton-demo] | | Continuous integration with [Tekton](https://tekton.dev/) | | [![][argocd-demo]][argocd-demo] | | Continuous deployment with [ArgoCD](https://argoproj.github.io/cd/) | | [![][lens-demo]][lens-demo] | | Cluster management using [Lens](https://k8slens.dev/) | | [![][vault-demo]][vault-demo] | | Secret management with [Vault](https://www.vaultproject.io/) | [deploy-demo]: https://asciinema.org/a/xkBRkwC6e9RAzVuMDXH3nGHp7.svg [pxe-demo]: https://user-images.githubusercontent.com/27996771/157303477-df2e7410-8f02-4648-a86c-71e6b7e89e35.png [homepage-demo]: https://user-images.githubusercontent.com/27996771/149445807-0f869eb7-d8f5-4fef-ab97-ac281df91a06.png [grafana-demo]: https://user-images.githubusercontent.com/27996771/149446631-1c5d056b-1fdc-48e6-96ba-e1abe1762be0.png [gitea-demo]: https://user-images.githubusercontent.com/27996771/149444871-38889c9d-862f-41ff-8c05-8ece21da3e9c.png [matrix-demo]: https://user-images.githubusercontent.com/27996771/149448510-7163310c-2049-4ccd-901d-f11f605bfc32.png [tekton-demo]: https://user-images.githubusercontent.com/27996771/149445374-58fd0605-bb9a-46e4-81d6-5e584d2b94a9.png [argocd-demo]: https://user-images.githubusercontent.com/27996771/149444716-fc0d7282-4cf7-4ddb-97a4-1a3fb47ff2b8.png [lens-demo]: https://user-images.githubusercontent.com/27996771/149448896-9d79947d-468c-45c6-a81d-b43654e8ab6b.png [vault-demo]: https://user-images.githubusercontent.com/27996771/149452309-de4a893b-e94c-4ba8-9119-ea87449cf77e.png ### Tech stack <table> <tr> <th>Logo</th> <th>Name</th> <th>Description</th> </tr> <tr> <td><img width="32" src="https://simpleicons.org/icons/ansible.svg"></td> <td><a href="https://www.ansible.com">Ansible</a></td> <td>Automate bare metal provisioning and configuration</td> </tr> <tr> <td><img width="32" src="https://cncf-branding.netlify.app/img/projects/argo/icon/color/argo-icon-color.svg"></td> <td><a href="https://argoproj.github.io/cd">ArgoCD</a></td> <td>GitOps tool built to deploy applications to Kubernetes</td> </tr> <tr> <td><img width="32" src="https://github.com/jetstack/cert-manager/raw/master/logo/logo.png"></td> <td><a href="https://cert-manager.io">cert-manager</a></td> <td>Cloud native certificate management</td> </tr> <tr> <td><img width="32" src="https://avatars.githubusercontent.com/u/314135?s=200&v=4"></td> <td><a href="https://www.cloudflare.com">Cloudflare</a></td> <td>DNS and Tunnel</td> </tr> <tr> <td><img width="32" src="https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png"></td> <td><a href="https://www.docker.com">Docker</a></td> <td>Ephemeral PXE server and convenient tools container</td> </tr> <tr> <td><img width="32" src="https://github.com/kubernetes-sigs/external-dns/raw/master/docs/img/external-dns.png"></td> <td><a href="https://github.com/kubernetes-sigs/external-dns">ExternalDNS</a></td> <td>Synchronizes exposed Kubernetes Services and Ingresses with DNS providers</td> </tr> <tr> <td><img width="32" src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3f/Fedora_logo.svg/267px-Fedora_logo.svg.png"></td> <td><a href="https://getfedora.org/en/server">Fedora Server</a></td> <td>Base OS for Kubernetes nodes</td> </tr> <tr> <td><img width="32" src="https://upload.wikimedia.org/wikipedia/commons/b/bb/Gitea_Logo.svg"></td> <td><a href="https://gitea.com">Gitea</a></td> <td>Self-hosted Git service</td> </tr> <tr> <td><img width="32" src="https://grafana.com/static/img/menu/grafana2.svg"></td> <td><a href="https://grafana.com">Grafana</a></td> <td>Operational dashboards</td> </tr> <tr> <td><img width="32" src="https://cncf-branding.netlify.app/img/projects/helm/icon/color/helm-icon-color.svg"></td> <td><a href="https://helm.sh">Helm</a></td> <td>The package manager for Kubernetes</td> </tr> <tr> <td><img width="32" src="https://cncf-branding.netlify.app/img/projects/k3s/icon/color/k3s-icon-color.svg"></td> <td><a href="https://k3s.io">K3s</a></td> <td>Lightweight distribution of Kubernetes</td> </tr> <tr> <td><img width="32" src="https://cncf-branding.netlify.app/img/projects/kubernetes/icon/color/kubernetes-icon-color.svg"></td> <td><a href="https://kubernetes.io">Kubernetes</a></td> <td>Container-orchestration system, the backbone of this project</td> </tr> <tr> <td><img width="32" src="https://github.com/grafana/loki/blob/main/docs/sources/logo.png?raw=true"></td> <td><a href="https://grafana.com/oss/loki">Loki</a></td> <td>Log aggregation system</td> </tr> <tr> <td><img width="32" src="https://cncf-branding.netlify.app/img/projects/longhorn/icon/color/longhorn-icon-color.svg"></td> <td><a href="https://longhorn.io">Longhorn</a></td> <td>Cloud native distributed block storage for Kubernetes</td> </tr> <tr> <td><img width="32" src="https://avatars.githubusercontent.com/u/60239468?s=200&v=4"></td> <td><a href="https://metallb.org">MetalLB</a></td> <td>Bare metal load-balancer for Kubernetes</td> </tr> <tr> <td><img width="32" src="https://avatars.githubusercontent.com/u/1412239?s=200&v=4"></td> <td><a href="https://www.nginx.com">NGINX</a></td> <td>Kubernetes Ingress Controller</td> </tr> <tr> <td><img width="32" src="https://cncf-branding.netlify.app/img/projects/prometheus/icon/color/prometheus-icon-color.svg"></td> <td><a href="https://prometheus.io">Prometheus</a></td> <td>Systems monitoring and alerting toolkit</td> </tr> <tr> <td><img width="32" src="https://docs.renovatebot.com/assets/images/logo.png"></td> <td><a href="https://www.whitesourcesoftware.com/free-developer-tools/renovate">Renovate</a></td> <td>Automatically update dependencies</td> </tr> <tr> <td><img width="32" src="https://avatars.githubusercontent.com/u/47602533?s=200&v=4"></td> <td><a href="https://tekton.dev">Tekton</a></td> <td>Cloud native solution for building CI/CD systems</td> </tr> <tr> <td><img width="32" src="https://trow.io/trow.png"></td> <td><a href="https://trow.io">Trow</a></td> <td>Private container registry</td> </tr> <tr> <td><img width="32" src="https://simpleicons.org/icons/vault.svg"></td> <td><a href="https://www.vaultproject.io">Vault</a></td> <td>Secrets and encryption management system</td> </tr> <tr> <td><img width="32" src="https://docs.zerotier.com/img/ZeroTierIcon.png"></td> <td><a href="https://zerotier.com">ZeroTier</a></td> <td>VPN without port forwarding</td> </tr> </table> ## Get Started - [Try it out locally](https://homelab.khuedoan.com/installation/sandbox) without any hardware (just 4 commands!) - [Deploy on real hardware](https://homelab.khuedoan.com/installation/production/prerequisites) for production workload ## Roadmap See [roadmap](https://homelab.khuedoan.com/reference/roadmap) and [open issues](https://github.com/khuedoan/homelab/issues) for a list of proposed features and known issues. ## Contributing Any contributions you make are greatly appreciated. Please see [contributing guide](https://homelab.khuedoan.com/reference/contributing) for more information. ## License Copyright &copy; 2020 - 2022 Khue Doan Distributed under the GPLv3 License. See [license page](https://homelab.khuedoan.com/reference/license) or `LICENSE.md` file for more information. ## Acknowledgements References: - [Ephemeral PXE server inspired by Minimal First Machine in the DC](https://speakerdeck.com/amcguign/minimal-first-machine-in-the-dc) - [ArgoCD usage and monitoring configuration in locmai/humble](https://github.com/locmai/humble) - [README template](https://github.com/othneildrew/Best-README-Template) - [Run the same Cloudflare Tunnel across many `cloudflared` processes](https://developers.cloudflare.com/cloudflare-one/tutorials/many-cfd-one-tunnel) - [MAC address environment variable in GRUB config](https://askubuntu.com/questions/1272400/how-do-i-automate-network-installation-of-many-ubuntu-18-04-systems-with-efi-and) - [Official k3s systemd service file](https://github.com/k3s-io/k3s/blob/master/k3s.service) - [Official Cloudflare Tunnel examples](https://github.com/cloudflare/argo-tunnel-examples) - [Initialize GitOps repository on Gitea and integrate with Tekton by RedHat](https://github.com/redhat-scholars/tekton-tutorial/tree/master/triggers) - [SSO configuration from xUnholy/k8s-gitops](https://github.com/xUnholy/k8s-gitops) - [Pre-commit config from k8s-at-home/flux-cluster-template](https://github.com/k8s-at-home/flux-cluster-template) - [Diátaxis technical documentation framework](https://diataxis.fr) - [Official Terratest examples](https://github.com/gruntwork-io/terratest/tree/master/test) Here is a list of the contributors who have helped to improve this project. Big shout-out to them! -  [@locmai](https://github.com/locmai) -  [@MatthewJohn](https://github.com/MatthewJohn) -  [@karpfediem](https://github.com/karpfediem) -  [@linhng98](https://github.com/linhng98) -  [@BlueHatbRit](https://github.com/BlueHatbRit) -  [@dotdiego](https://github.com/dotdiego) -  [@Crimrose](https://github.com/Crimrose) -  [@eventi](https://github.com/eventi) -  [@Bourne-ID](https://github.com/Bourne-ID) -  [@akwan](https://github.com/akwan) -  [@trangmaiq](https://github.com/trangmaiq) If you feel you're missing from this list, feel free to add yourself in a PR. ## Stargazers over time [](https://starchart.cc/khuedoan/homelab)

A vim plugin for syntax highlighting Ansible's common filetypes

## introduction This is a vim syntax plugin for Ansible 2.x, it supports YAML playbooks, Jinja2 templates, and Ansible's `hosts` files. - YAML playbooks are detected if: - they are in the `group_vars` or `host_vars` folder - they are in the `tasks`, `roles`, or `handlers` folder and have either a *.yml* or *.yaml* suffix - they are named `playbook.y(a)ml`, `site.y(a)ml`, or `main.y(a)ml` - Jinja2 templates are detected if they have a *.j2* suffix - Files named `hosts` will be treated as Ansible hosts files You can also set the filetype to `yaml.ansible`, `*.jinja2`, or `ansible_hosts` if auto-detection does not work (e.g. `:set ft=yaml.ansible` or `:set ft=ruby.jinja2`). **Note**: If you want to detect a custom pattern of your own, you can easily add this in your `.vimrc` using something like this: ```vim au BufRead,BufNewFile */playbooks/*.yml set filetype=yaml.ansible ``` If you want to override the default file type detection you can easily do this in your `.vimrc`. For example if you use YAML syntax for `hosts` include something like this: ```vim augroup ansible_vim_fthosts autocmd! autocmd BufNewFile,BufRead hosts setfiletype yaml.ansible augroup END ``` This plugin should be quite reliable, as it sources the original formats and simply modifies the highlights as appropriate. This also enables a focus on simplicity and configurability instead of patching bad syntax detection. ##### examples (with [solarized](https://github.com/altercation/vim-colors-solarized) colorscheme) Bright (and selective highlight) | Dim :-----------------------------------:|:-------------------------:  |  ##### installation Use your favorite plugin manager, or try [vim-plug](https://github.com/junegunn/vim-plug) if you're looking for a really nice one! **vim-plug:** `Plug 'pearofducks/ansible-vim'` **vim-plug with post-update hook:** `Plug 'pearofducks/ansible-vim', { 'do': './UltiSnips/generate.sh' }` *Note: Because of Ansible API changes, `generate.sh` may require the latest (or near-latest) version of Ansible.* *Note2: `generate.sh` can receive some parameters, for more info see its [Readme](https://github.com/pearofducks/ansible-vim/tree/master/UltiSnips#script-parameters)* **vundle:** `Plugin 'pearofducks/ansible-vim'` **pathogen:** `git clone https://github.com/pearofducks/ansible-vim ~/.vim/bundle/ansible-vim` **Arch Linux:** Package [vim-ansible](https://www.archlinux.org/packages/community/any/vim-ansible/) is available in the *community* repository. **Fedora:** The [vim-ansible](https://src.fedoraproject.org/rpms/vim-ansible) package is available in the default repository. **RHEL/CentOS:** The [vim-ansible](https://src.fedoraproject.org/rpms/vim-ansible) package is available in the [EPEL](https://fedoraproject.org/wiki/EPEL) repository. ## options ##### g:ansible_unindent_after_newline `let g:ansible_unindent_after_newline = 1` When this variable is set, indentation will completely reset (unindent to column 0) after two newlines in insert-mode. The normal behavior of YAML is to always keep the previous indentation, even across multiple newlines with no content. ##### g:ansible_yamlKeyName `let g:ansible_yamlKeyName = 'yamlKey'` This option exists to provide additional compatibility with [stephpy/vim-yaml](https://github.com/stephpy/vim-yaml). ##### g:ansible_attribute_highlight `let g:ansible_attribute_highlight = "ob"` Ansible modules use a `key=value` format for specifying module-attributes in playbooks. This highlights those as specified. This highlight option is also used when highlighting key/value pairs in `hosts` files. Available flags (bold are defaults): - **a**: highlight *all* instances of `key=` - o: highlight *only* instances of `key=` found on newlines - **d**: *dim* the instances of `key=` found - b: *brighten* the instances of `key=` found - n: turn this highlight off completely ##### g:ansible_name_highlight `let g:ansible_name_highlight = 'd'` Ansible modules commonly start with a `name:` key for self-documentation of playbooks. This option enables/changes highlight of this. Available flags (this feature is off by default): - d: *dim* the instances of `name:` found - b: *brighten* the instances of `name:` found ##### g:ansible_extra_keywords_highlight `let g:ansible_extra_keywords_highlight = 1` *Note:* This option is enabled when set, and disabled when not set. Highlight the following additional keywords: `become become_exe become_flags become_method become_user become_pass prompt_l10n debugger always_run check_mode diff no_log args tags force_handlers vars vars_files vars_prompt delegate_facts delegate_to any_errors_fatal ignore_errors ignore_unreachable max_fail_percentage connection hosts port remote_user module_defaults environment fact_path gather_facts gather_subset gather_timeout async poll throttle timeout order run_once serial strategy`. By default we only highlight: `include include_role include_tasks include_vars import_role import_playbook import_tasks when changed_when failed_when block rescue always notify listen register action local_action post_tasks pre_tasks tasks handlers roles collections` and loop keywords `with_.+`, `loop`, `loop_control`, `until`, `retries`, `delay`. ##### g:ansible_extra_keywords_highlight_group `let g:ansible_extra_keywords_highlight_group = 'Statement'` Accepts any syntax group name from `:help E669` - e.g. _Comment_, _Constant_, _Identifier_ *Note:* Defaults to 'Structure' when not set. ##### g:ansible_normal_keywords_highlight `let g:ansible_normal_keywords_highlight = 'Constant'` Accepts any syntax group name from `:help E669` - e.g. _Comment_, _Constant_, _Identifier_ *Note:* Defaults to 'Statement' when not set. This option change the highlight of the following common keywords: `include include_role include_tasks include_vars import_role import_playbook import_tasks when changed_when failed_when block rescue always notify listen register action local_action post_tasks pre_tasks tasks handlers roles collections`. ##### g:ansible_loop_keywords_highlight `let g:ansible_loop_keywords_highlight = 'Constant'` Accepts any syntax group-name from `:help E669` - e.g. _Comment_, _Constant_, _Identifier_ *Note:* Defaults to 'Statement' when not set. This option changes the highlight of all `with_.+`, `loop`, `loop_control`, `until`, `retries` and `delay` keywords. ##### g:ansible_template_syntaxes `let g:ansible_template_syntaxes = { '*.rb.j2': 'ruby' }` Accepts a dictionary in the form of `'regex-for-file': 'filetype'`. - _regex-for-file_ will receive the full filepath, so directory matching can be done. - _filetype_ is the root filetype to be applied, `jinja2` will be automatically appended All files ending in `*.j2` that aren't matched will simply get the `jinja2` filetype. ##### g:ansible_ftdetect_filename_regex `let g:ansible_ftdetect_filename_regex = '\v(playbook|site|main|local|requirements)\.ya?ml$'` Accepts a regex string that is used to match the filename to determine if the file should use the Ansible filetype Can be used to avoid clashes with other files that are named the same - e.g. main.yaml used in github workflows by removing `main` from the regex ## goto role under cursor (similar to gf) This behavior is not supported out of the box, but you can use [this snippet](https://gist.github.com/mtyurt/3529a999af675a0aff00eb14ab1fdde3) in your vimrc. You'll then be able to go to a role's definition with `<leader>gr`. ## bugs, suggestions/requests, & contributions ##### bugs It's unlikely that there will be bugs in highlighting that don't exist in the core format. Where appropriate these will be fixed in this plugin, but if the problem is with the original syntax we should probably focus on fixing that instead. Indenting a full document - e.g with `gg=G` - will not be supported and is not a goal of this plugin (unless someone else develops it!). Please do not file a bug report on this. ##### suggestions/requests Suggestions for improvements are welcome, pull-requests with completed features even more so. :)

Linux, Jenkins, AWS, SRE, Prometheus, Docker, Python, Ansible, Git, Kubernetes, Terraform, OpenStack, SQL, NoSQL, Azure, GCP, DNS, Elastic, Network, Virtualization. DevOps Interview Questions

<p align="center"><img src="images/devops_exercises.png"/></p> :information_source: &nbsp;This repo contains questions and exercises on various technical topics, sometimes related to DevOps and SRE :bar_chart: &nbsp;There are currently **2619** exercises and questions :warning: &nbsp;You can use these for preparing for an interview but most of the questions and exercises don't represent an actual interview. Please read [FAQ page](faq.md) for more details :stop_sign: &nbsp;If you are interested in pursuing a career as DevOps engineer, learning some of the concepts mentioned here would be useful, but you should know it's not about learning all the topics and technologies mentioned in this repository :pencil: &nbsp;You can add more exercises by submitting pull requests :) Read about contribution guidelines [here](CONTRIBUTING.md) **** <!-- ALL-TOPICS-LIST:START --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <center> <table> <tr> <td align="center"><a href="topics/devops"><img src="images/devops.png" width="75px;" height="75px;" alt="DevOps" /><br /><b>DevOps</b></a></td> <td align="center"><a href="topics/cicd"><img src="images/cicd.png" width="75px;" height="75px;" alt="cicd"/><br /><b>CI/CD</b></a></td> <td align="center"><a href="topics/git"><img src="images/git.png" width="75px;" height="75px;" alt="Git"/><br /><b>Git</b></a></td> <td align="center"><a href="topics/ansible"><img src="images/ansible.png" width="75px;" height="75px;" alt="ansible"/><br /><b>Ansible</b></a></td> <td align="center"><a href="#network"><img src="images/network.png" width="75px;" height="75px;" alt="Network"/><br /><b>Network</b></a></td> </tr> <tr> <td align="center"><a href="topics/software_development"><img src="images/programming.png" width="75px;" height="75px;" alt="programming"/><br /><b>Software Development</b></a></td> <td align="center"><a href="https://github.com/bregman-arie/python-exercises"><img src="images/python.png" width="75px;" height="75px;" alt="Python"/><br /><b>Python</b></a></td> <td align="center"><a href="https://github.com/bregman-arie/go-exercises"><img src="images/Go.png" width="75px;" height="75px;" alt="go"/><br /><b>Go</b></a></td> <td align="center"><a href="topics/shell"><img src="images/bash.png" width="75px;" height="75px;" alt="Bash"/><br /><b>Shell Scripting</b></a></td> <td align="center"><a href="topics/kubernetes"><img src="images/kubernetes.png" width="75px;" height="75px;" alt="kubernetes"/><br /><b>Kubernetes</b></a></td> </tr> <tr> <td align="center"><a href="topics/cloud"><img src="images/cloud.png" width="75px;" height="75px;" alt="Cloud"/><br /><b>Cloud</b></a></td> <td align="center"><a href="topics/aws"><img src="images/aws.png" width="100px;" height="75px;" alt="aws"/><br /><b>AWS</b></a></td> <td align="center"><a href="topics/azure"><img src="images/azure.png" width="75px;" height="75px;" alt="azure"/><br /><b>Azure</b></a></td> <td align="center"><a href="topics/gcp"><img src="images/googlecloud.png" width="70px;" height="70px;" alt="Google Cloud Platform"/><br /><b>Google Cloud Platform</b></a></td> <td align="center"><a href="#openstack"><img src="images/openstack.png" width="75px;" height="75px;" alt="openstack"/><br /><b>OpenStack</b></a></td> </tr> <tr> <td align="center"><a href="#operating-system"><img src="images/os.png" width="75px;" height="75px;" alt="Operating System"/><br /><b>Operating System</b></a></td> <td align="center"><a href="#monitoring"><img src="images/monitoring.png" width="75px;" height="75px;" alt="Monitoring"/><br /><b>Monitoring</b></a></td> <td align="center"><a href="#elastic"><img src="images/elastic.png" width="75px;" height="75px;" alt="Elastic"/><br /><b>Elastic</b></a></td> <td align="center"><a href="#virtualization"><img src="images/virtualization.png" width="75px;" height="75px;" alt="Virtualization"/><br /><b>Virtualization</b></a></td> <td align="center"><a href="topics/dns"><img src="images/dns.png" width="75px;" height="75px;" alt="DNS"/><br /><b>DNS</b></a></td> </tr> <tr> <td align="center"><a href="#testing"><img src="images/testing.png" width="75px;" height="75px;" alt="Testing"/><br /><b>Testing</b></a></td> <td align="center"><a href="#databases"><img src="images/databases.png" width="75px;" height="75px;" alt="Databases"/><br /><b>Databases</b></a></td> <td align="center"><a href="#regex"><img src="images/regex.png" width="75px;" height="75px;" alt="RegEx"/><br /><b>Regex</b></a></td> <td align="center"><a href="#system-design"><img src="images/design.png" width="75px;" height="75px;" alt="Design"/><br /><b>System Design</b></a></td> <td align="center"><a href="#hardware"><img src="images/hardware.png" width="75px;" height="75px;" alt="Hardware"/><br /><b>Hardware</b></a></td> </tr> <tr> <td align="center"><a href="#certificates"><img src="images/certificates.png" width="75px;" height="75px;" alt="Certificates"/><br /><b>Certificates</b></a></td> <td align="center"><a href="topics/containers"><img src="images/containers.png" width="75px;" height="75px;" alt="Containers"/><br /><b>Containers</b></a></td> <td align="center"><a href="#sql"><img src="images/sql.png" width="75px;" height="75px;" alt="sql"/><br /><b>SQL</b></a></td> <td align="center"><a href="topics/openshift"><img src="images/openshift.png" width="75px;" height="75px;" alt="OpenShift"/><br /><b>OpenShift</b></a></td> <td align="center"><a href="#storage"><img src="images/storage.png" width="75px;" height="75px;" alt="Storage"/><br /><b>Storage</b></a></td> </tr> <tr> <td align="center"><a href="topics/terraform"><img src="images/terraform.png" width="75px;" height="75px;" alt="Terraform"/><br /><b>Terraform</b></a></td> <td align="center"><a href="#mongo"><img src="images/mongo.png" width="75px;" height="75px;" alt="Mongo"/><br /><b>Mongo</b></a></td> <td align="center"><a href="#puppet"><img src="images/puppet.png" width="75px;" height="75px;" alt="puppet"/><br /><b>Puppet</b></a></td> <td align="center"><a href="#distributed"><img src="images/distributed.png" width="75px;" height="75px;" alt="Distributed"/><br /><b>Distributed</b></a></td> <td align="center"><a href="#questions-you-ask"><img src="images/you.png" width="75px;" height="75px;" alt="you"/><br /><b>Questions you can ask</b></a></td> </tr> <tr> <td align="center"><a href="topics/circleci"><img src="images/logos/circleci.png" width="70px;" height="70px;" alt="Circle CI"/><br /><b>Circle CI</b></a></td> <td align="center"><a href="topics/argo"><img src="images/logos/argo.png" width="80px;" height="80px;" alt="Argo"/><br /><b>Argo</b></a></td> <td align="center"><a href="topics/kafka"><img src="images/logos/kafka.png" width="85px;" height="80px;" alt="Kafka"/><br /><b>Kafka</b></a></td> <td align="center"><a href="topics/datadog"><img src="images/logos/datadog.png" width="80px;" height="80px;" alt="DataDog"/><br /><b></b></a></td> <td align="center"><a href="topics/perl"><img src="images/perl.png" width="75px;" height="75px;" alt="perl"/><br /><b>Perl</b></a></td> </tr> <tr> <td align="center"><a href="topics/linux"><img src="images/logos/linux.png" width="75px;" height="75px;" alt="Linux"/><br /><b>Linux</b></a></td> <td align="center"><a href="#prometheus"><img src="images/prometheus.png" width="75px;" height="75px;" alt="Prometheus"/><br /><b>Prometheus</b></a></td> <td align="center"><a href="#big-data"><img src="images/big-data.png" width="75px;" height="75px;" alt="Big Data"/><br /><b>Big Data</b></a></td> <td align="center"><a href="topics/soft_skills"><img src="images/HR.png" width="75px;" height="75px;" alt="HR"/><br /><b>Soft Skills</b></a></td> <td align="center"><a href="topics/security"><img src="images/security.png" width="75px;" height="75px;" alt="security"/><br /><b>Security</b></a></td> </tr> <tr> <td align="center"><a href="topics/chaos_engineering"><img src="images/logos/chaos_engineering.png" width="75px;" height="75px;" alt="Chaos Engineering"/><br /><b>Chaos Engineering</b></a></td> <td align="center"><a href="#Misc"><img src="images/general.png" width="75px;" height="75px;" alt="Misc"/><br /><b>Misc</b></a></td> </tr> </table> </center> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-TOPICS-LIST:END --> ## Network <details> <summary>In general, what do you need in order to communicate?</summary><br><b> - A common language (for the two ends to understand) - A way to address who do you want to communicate with - A Connection (so the content of the communication can reach the recipients) </b></details> <details> <summary>What is TCP/IP?</summary><br><b> A set of protocols that define how two or more devices can communicate with each other. To learn more about TCP/IP, read [here](http://www.penguintutor.com/linux/basic-network-reference) </b></details> <details> <summary>What is Ethernet?</summary><br><b> Ethernet simply refers to the most common type of Local Area Network (LAN) used today. A LAN—in contrast to a WAN (Wide Area Network), which spans a larger geographical area—is a connected network of computers in a small area, like your office, college campus, or even home. </b></details> <details> <summary>What is a MAC address? What is it used for?</summary><br><b> A MAC address is a unique identification number or code used to identify individual devices on the network. Packets that are sent on the ethernet are always coming from a MAC address and sent to a MAC address. If a network adapter is receiving a packet, it is comparing the packet’s destination MAC address to the adapter’s own MAC address. </b></details> <details> <summary>When is this MAC address used?: ff:ff:ff:ff:ff:ff</summary><br><b> When a device sends a packet to the broadcast MAC address (FF:FF:FF:FF:FF:FF​), it is delivered to all stations on the local network. Ethernet broadcasts are used to resolve IP addresses to MAC addresses (by ARP) at the datalink layer . </b></details> <details> <summary>What is an IP address?</summary><br><b> An Internet Protocol address (IP address) is a numerical label assigned to each device connected to a computer network that uses the Internet Protocol for communication.An IP address serves two main functions: host or network interface identification and location addressing. </b></details> <details> <summary>Explain subnet mask and given an example</summary><br><b> A Subnet mask is a 32-bit number that masks an IP address, and divides the IP address into network address and host address. Subnet Mask is made by setting network bits to all "1"s and setting host bits to all "0"s. Within a given network, out of the total usable host addresses, two are always reserved for specific purposes and cannot be allocated to any host. These are the first address, which is reserved as a network address (a.k.a network ID) and the last address used for network broadcast. [Example](https://github.com/philemonnwanne/o0o0o/tree/main/exes/exe-09) </b></details> <details> <summary>What is a private IP address? In which scenarios/system designs, one should use it?</summary><br><b> Private IP addresses are assigned to the hosts in the same network to communicate among one another. As the name "private" suggests, the devices having the private IP addresses assigned can't be reached by the devices from any external network. For example, if I am living in a hostel and I want my hostelmates to join the game server I have hosted, I will ask them to join via my server's private IP address, since the network is local to the hostel. </b></details> <details> <summary>What is a public IP address? In which scenarios/system designs, one should use it?</summary><br><b> A public IP address is the public facing IP address. In the event that you was hosting a game server that you want your friends to join, you will give your friends your public IP address to allow their computers to identify and locate your network and server in order for the connection to take place. One time that you would not need to use a public facing IP address is in the event that you was playing with friends who was connected to the same network as you, in that case, you would use a private ip address. In order for someone to be able to connect to your server that is located internally, you will have to setup a port forward to tell your router to allow traffic from the public domain into your network and vice versa. </b></details> <details> <summary>Explain the OSI model. What layers there are? What each layer is responsible for?</summary><br><b> - Application: user end (HTTP is here) - Presentation: establishes context between application-layer entities (Encryption is here) - Session: establishes, manages and terminates the connections - Transport: transfers variable-length data sequences from a source to a destination host (TCP & UDP are here) - Network: transfers datagrams from one network to another (IP is here) - Data link: provides a link between two directly connected nodes (MAC is here) - Physical: the electrical and physical spec the data connection (Bits are here) You can read more about the OSI model in [penguintutor.com](http://www.penguintutor.com/linux/basic-network-reference) </b></details> <details> <summary>For each of the following determines to which OSI layer it belongs: * Error correction * Packets routing * Cables and electrical signals * MAC address * IP address * Terminate connections * 3 way handshake</summary><br><b> * Error correction - Data link * Packets routing - Network * Cables and electrical signals - Physical * MAC address - Data link * IP address - Network * Terminate connections - Session * 3 way handshake - Transport </b></details> <details> <summary>What delivery schemes are you familiar with?</summary><br><b> Unitcast: One to one communication where there is one sender and one receiver. Broadcast: Sending a message to everyone in the network. The address ff:ff:ff:ff:ff:ff is used for broadcasting. Two common protocols which use broadcast are ARP and DHCP. Multicast: Sending a message to a group of subscribers. It can be one-to-many or many-to-many. </b></details> <details> <summary>What is CSMA/CD? Is it used in modern ethernet networks?</summary><br><b> CSMA/CD stands for Carrier Sense Multiple Access / Collision Detection. Its primarily focus it to manage access to shared medium/bus where only one host can transmit at a given point of time. CSMA/CD algorithm: 1. Before sending a frame, it checks whether another host already transmitting a frame. 2. If no one transmitting, it starts transmitting the frame. 3. If two hosts transmitted at the same time, we have a collision. 4. Both hosts stop sending the frame and they send to everyone a 'jam signal' notifying everyone that a collision occurred 5. They are waiting for a random time before sending again 6. Once each host waited for a random time, they try to send the frame again and so the </b></details> <details> <summary>Describe the following network devices and the difference between them: * router * switch * hub</summary><br><b> </b></details> <details> <summary>What is a "Collision Domain"?</summary><br><b> A collision domain is a network segment in which devices can potentially interfere with each other by attempting to transmit data at the same time. When two devices transmit data at the same time, it can cause a collision, resulting in lost or corrupted data. In a collision domain, all devices share the same bandwidth, and any device can potentially interfere with the transmission of data by other devices. </b></details> <details> <summary>What is a "Broadcast Domain"?</summary><br><b> A broadcast domain is a network segment in which all devices can communicate with each other by sending broadcast messages. A broadcast message is a message that is sent to all devices in a network rather than a specific device. In a broadcast domain, all devices can receive and process broadcast messages, regardless of whether the message was intended for them or not. </b></details> <details> <summary>three computers connected to a switch. How many collision domains are there? How many broadcast domains?</summary><br><b> Three collision domains and one broadcast domain </b></details> <details> <summary>How does a router works?</summary><br><b> A router is a physical or virtual appliance that passes information between two or more packet-switched computer networks. A router inspects a given data packet's destination Internet Protocol address (IP address), calculates the best way for it to reach its destination and then forwards it accordingly. </b></details> <details> <summary>What is NAT?</summary><br><b> Network Address Translation (NAT) is a process in which one or more local IP address is translated into one or more Global IP address and vice versa in order to provide Internet access to the local hosts. </b></details> <details> <summary>What is a proxy? How does it works? What do we need it for?</summary><br><b> A proxy server acts as a gateway between you and the internet. It’s an intermediary server separating end users from the websites they browse. If you’re using a proxy server, internet traffic flows through the proxy server on its way to the address you requested. The request then comes back through that same proxy server (there are exceptions to this rule), and then the proxy server forwards the data received from the website to you. Proxy servers provide varying levels of functionality, security, and privacy depending on your use case, needs, or company policy. </b></details> <details> <summary>What is TCP? How does it works? What is the 3 way handshake?</summary><br><b> TCP 3-way handshake or three-way handshake is a process which is used in a TCP/IP network to make a connection between server and client. A three-way handshake is primarily used to create a TCP socket connection. It works when: - A client node sends a SYN data packet over an IP network to a server on the same or an external network. The objective of this packet is to ask/infer if the server is open for new connections. - The target server must have open ports that can accept and initiate new connections. When the server receives the SYN packet from the client node, it responds and returns a confirmation receipt – the ACK packet or SYN/ACK packet. - The client node receives the SYN/ACK from the server and responds with an ACK packet. </b></details> <details> <summary>What is round-trip delay or round-trip time?</summary><br><b> From [wikipedia](https://en.wikipedia.org/wiki/Round-trip_delay): "the length of time it takes for a signal to be sent plus the length of time it takes for an acknowledgement of that signal to be received" Bonus question: what is the RTT of LAN? </b></details> <details> <summary>How does SSL handshake work?</summary><br><b> SSL handshake is a process that establishes a secure connection between a client and a server. 1. The client sends a Client Hello message to the server, which includes the client's version of the SSL/TLS protocol, a list of the cryptographic algorithms supported by the client, and a random value. 2. The server responds with a Server Hello message, which includes the server's version of the SSL/TLS protocol, a random value, and a session ID. 3. The server sends a Certificate message, which contains the server's certificate. 4. The server sends a Server Hello Done message, which indicates that the server is done sending messages for the Server Hello phase. 5. The client sends a Client Key Exchange message, which contains the client's public key. 6. The client sends a Change Cipher Spec message, which notifies the server that the client is about to send a message encrypted with the new cipher spec. 7. The client sends an Encrypted Handshake Message, which contains the pre-master secret encrypted with the server's public key. 8. The server sends a Change Cipher Spec message, which notifies the client that the server is about to send a message encrypted with the new cipher spec. 9. The server sends an Encrypted Handshake Message, which contains the pre-master secret encrypted with the client's public key. 10. The client and server can now exchange application data. </b></details> <details> <summary>What is the difference between TCP and UDP?</summary><br><b> TCP establishes a connection between the client and the server to guarantee the order of the packages, on the other hand, UDP does not establish a connection between client and server and doesn't handle package order. This makes UDP more lightweight than TCP and a perfect candidate for services like streaming. [Penguintutor.com](http://www.penguintutor.com/linux/basic-network-reference) provides a good explanation. </b></details> <details> <summary>What TCP/IP protocols are you familiar with?</summary><br><b> </b></details> <details> <summary>Explain "default gateway"</summary><br><b> A default gateway serves as an access point or IP router that a networked computer uses to send information to a computer in another network or the internet. </b></details> <details> <summary>What is ARP? How does it works?</summary><br><b> ARP stands for Address Resolution Protocol. When you try to ping an IP address on your local network, say 192.168.1.1, your system has to turn the IP address 192.168.1.1 into a MAC address. This involves using ARP to resolve the address, hence its name. Systems keep an ARP look-up table where they store information about what IP addresses are associated with what MAC addresses. When trying to send a packet to an IP address, the system will first consult this table to see if it already knows the MAC address. If there is a value cached, ARP is not used. </b></details> <details> <summary>What is TTL? What does it helps to prevent?</summary><br><b> </b></details> <details> <summary>What is DHCP? How does it works?</summary><br><b> It stands for Dynamic Host Configuration Protocol, and allocates IP addresses, subnet masks and gateways to hosts. This is how it works: * A host upon entering a network, broadcasts a message in search of a DHCP server (DHCP DISCOVER) * An offer message is sent back by the DHCP server as a packet containing lease time, subnet mask, IP addresses, etc (DHCP OFFER) * Depending on which offer accepted, the client sends back a reply broadcast letting all DHCP servers know (DHCP REQUEST) * Server sends an acknowledgment (DHCP ACK) Read more [here](https://linuxjourney.com/lesson/dhcp-overview) </b></details> <details> <summary>Can you have two DHCP servers in the same network? How it works?</summary><br><b> </b></details> <details> <summary>What is SSL tunneling? How does it works?</summary><br><b> </b></details> <details> <summary>What is a socket? Where can you see the list of sockets in your system?</summary><br><b> </b></details> <details> <summary>What is IPv6? Why should we consider using it if we have IPv4?</summary><br><b> </b></details> <details> <summary>What is VLAN?</summary><br><b> </b></details> <details> <summary>What is MTU?</summary><br><b> MTU stands for Maximum Transmission Unit. It's the size of the largest PDU (protocol Data Unit) that can be sent in a single transaction. </b></details> <details> <summary>What happens if you send a packet that is bigger than the MTU?</summary><br><b> With IPv4 protocol, router can fragment the PDU then sending all the fragmented PDU through the transaction. With IPv6 protocol, it issues a error to the user's computer. </b></details> <details> <summary>True or False?. Ping is using UDP because it doesn't care about reliable connection</summary><br><b> </b></details> <details> <summary>What is SDN?</summary><br><b> </b></details> <details> <summary>What is ICMP? What is it used for?</summary><br><b> </b></details> <details> <summary>What is NAT? How does it work?</summary><br><b> NAT stands for network address translation. It’s a way to map multiple local private addresses to a public one before transferring the information. Organizations that want multiple devices to employ a single IP address use NAT, as do most home routers. For example, your computer's private IP could be 192.168.1.100, but your router maps the traffic to it's public IP (e.g. 1.1.1.1). Any device on the internet would see the traffic coming from your public IP (1.1.1.1) instead of your private IP (192.168.1.100). </b></details> <details> <summary>Which factors affect network performances</summary><br><b> </b></details> <details> <summary>Which port number is used in each of the following protocols?: * SSH * SMTP * HTTP * DNS * HTTPS * FTP * SFTP </summary><br><b> * SSH - 22 * SMTP - 25 * HTTP - 80 * DNS - 53 * HTTPS - 443 * FTP - 21 * SFTP - 22 </b></details> <details> <summary>Which factors affect network performances</summary><br><b> </b></details> <details> <summary>What is APIPA?</summary><br><b> APIPA is a set of it addresses that devices are allocated when the main DHCP server is not reachable </b></details> <details> <summary>What ip range does APIPA use?</summary><br><b> APIPA uses the ip range: 169.254.0.1 - 169.254.255.254. </b></details> #### Control Plane and Data Plane <details> <summary>What "control plane" refers to?</summary><br><b> The control plane is the part of the network that decides how to route and forward packets to a different location. </b></details> <details> <summary>What "data plane" refers to?</summary><br><b> The data plane is the part of the network that actually forwards the data/packets. </b></details> <details> <summary>What "management plane" refers to?</summary><br><b> Refers to monitoring and management functions. </b></details> <details> <summary>To which plane (data, control, ...) is creating routing tables belongs to?</summary><br><b> Control Plane. </b></details> <details> <summary>Explain Spanning Tree Protocol (STP)</summary><br><b> </b></details> <details> <summary>What is link aggregation? Why is it used?</summary><br><b> </b></details> <details> <summary>What is Asymmetric Routing? How do deal with it?</summary><br><b> </b></details> <details> <summary>What overlay (tunnel) protocols are you familiar with?</summary><br><b> </b></details> <details> <summary>What is GRE? How does it works?</summary><br><b> </b></details> <details> <summary>What is VXLAN? How does it works?</summary><br><b> </b></details> <details> <summary>What is SNAT?</summary><br><b> </b></details> <details> <summary>Explain OSPF</summary><br><b> </b></details> <details> <summary>What is latency?</summary><br><b> Latency is the time taken for an information to reach its destination from the source. </b></details> <details> <summary>What is bandwidth?</summary><br><b> Bandwidth is the capacity of a communication channel to measure how much data the latter can handle over a specific time period. More bandwidth would imply more traffic handling and thus more data transfer. </b></details> <details> <summary>What is throughput?</summary><br><b> Throughput refers to the measurement of the real amount of data transferred over a certain period of time across any transmission channel. </b></details> <details> <summary>When performing a search query, what is more important, latency or throughput? And how to assure that what managing global infrastructure?</summary><br><b> Latency. To have a good latency, a search query should be forwarded to the closest datacenter. </b></details> <details> <summary>When uploading a video, what is more important, latency or throughput? And how to assure that?</summary><br><b> Throughput. To have a good throughput, the upload stream should be routed to an underutilized link. </b></details> <details> <summary>What other considerations (except latency and throughput) are there when forwarding requests?</summary><br><b> * Keep caches updated (which means the request could be forwarded not to the closest datacenter) </b></details> <details> <summary>Explain Spine & Leaf</summary><br><b> </b></details> <details> <summary>What is Network Congestion? What can cause it?</summary><br><b> </b></details> <details> <summary>What can you tell me about UDP packet format? What about TCP packet format? How is it different?</summary><br><b> </b></details> <details> <summary>What is the exponential backoff algorithm? Where is it used?</summary><br><b> </b></details> <details> <summary>Using Hamming code, what would be the code word for the following data word 100111010001101?</summary><br><b> 00110011110100011101 </b></details> <details> <summary>Give examples of protocols found in the application layer</summary><br><b> * Hypertext Transfer Protocol (HTTP) - used for the webpages on the internet * Simple Mail Transfer Protocol (SMTP) - email transmission * Telecommunications Network - (TELNET) - terminal emulation to allow client access to telnet server * File Transfer Protocol (FTP) - facilitates transfer of files between any two machines * Domain Name System (DNS) - domain name translation * Dynamic Host Configuration Protocol (DHCP) - allocates IP addresses, subnet masks and gateways to hosts * Simple Network Management Protocol (SNMP) - gathers data of devices on the network </b></details> <details> <summary>Give examples of protocols found in the network Layer</summary><br><b> * Internet Protocol (IP) - assists in routing packets from one machine to another * Internet Control Message Protocol (ICMP) - lets one know what is going such as error messages and debugging information </b></details> <details> <summary>What is HSTS?</summary><br><b> HTTP Strict Transport Security is a web server directive that informs user agents and web browsers how to handle its connection through a response header sent at the very beginning and back to the browser. This forces connections over HTTPS encryption, disregarding any script's call to load any resource in that domain over HTTP. Read more [here](https://www.globalsign.com/en/blog/what-is-hsts-and-how-do-i-use-it#:~:text=HTTP%20Strict%20Transport%20Security%20(HSTS,and%20back%20to%20the%20browser.) </b></details> #### Network - Misc <details> <summary>What is the Internet? Is it the same as the World Wide Web?</summary><br><b> The internet refers to network of networks, transferring huge amounts of data around the globe.<br> The World Wide Web is an application running on millions of server, on top of the internet, accessed through what is know as the web browser </b></details> <details> <summary>What is the ISP?</summary><br><b> ISP (Internet Service Provider) is the local internet company provider. </b></details> ## Operating System ### Operating System Exercises |Name|Topic|Objective & Instructions|Solution|Comments| |--------|--------|------|----|----| |Fork 101|Fork|[Link](topics/os/fork_101.md)|[Link](topics/os/solutions/fork_101_solution.md) |Fork 102|Fork|[Link](topics/os/fork_102.md)|[Link](topics/os/solutions/fork_102_solution.md) ### Operating System - Self Assessment <details> <summary>What is an operating system?</summary><br><b> From the book "Operating Systems: Three Easy Pieces": "responsible for making it easy to run programs (even allowing you to seemingly run many at the same time), allowing programs to share memory, enabling programs to interact with devices, and other fun stuff like that". </b></details> #### Operating System - Process <details> <summary>Can you explain what is a process?</summary><br><b> A process is a running program. A program is one or more instructions and the program (or process) is executed by the operating system. </b></details> <details> <summary>If you had to design an API for processes in an operating system, what would this API look like?</summary><br><b> It would support the following: * Create - allow to create new processes * Delete - allow to remove/destroy processes * State - allow to check the state of the process, whether it's running, stopped, waiting, etc. * Stop - allow to stop a running process </b></details> <details> <summary>How a process is created?</summary><br><b> * The OS is reading program's code and any additional relevant data * Program's code is loaded into the memory or more specifically, into the address space of the process. * Memory is allocated for program's stack (aka run-time stack). The stack also initialized by the OS with data like argv, argc and parameters to main() * Memory is allocated for program's heap which is required for dynamically allocated data like the data structures linked lists and hash tables * I/O initialization tasks are performed, like in Unix/Linux based systems where each process has 3 file descriptors (input, output and error) * OS is running the program, starting from main() </b></details> <details> <summary>True or False? The loading of the program into the memory is done eagerly (all at once)</summary><br><b> False. It was true in the past but today's operating systems perform lazy loading which means only the relevant pieces required for the process to run are loaded first. </b></details> <details> <summary>What are different states of a process?</summary><br><b> * Running - it's executing instructions * Ready - it's ready to run but for different reasons it's on hold * Blocked - it's waiting for some operation to complete. For example I/O disk request </b></details> <details> <summary>What are some reasons for a process to become blocked?</summary><br><b> - I/O operations (e.g. Reading from a disk) - Waiting for a packet from a network </b></details> <details> <summary>What is Inter Process Communication (IPC)?</summary><br><b> </b></details> <details> <summary>What is "time sharing"?</summary><br><b> Even when using a system with one physical CPU, it's possible to allow multiple users to work on it and run programs. This is possible with time sharing where computing resources are shared in a way it seems to the user the system has multiple CPUs but in fact it's simply one CPU shared by applying multiprogramming and multi-tasking. </b></details> <details> <summary>What is "space sharing"?</summary><br><b> Somewhat the opposite of time sharing. While in time sharing a resource is used for a while by one entity and then the same resource can be used by another resource, in space sharing the space is shared by multiple entities but in a way where it's not being transferred between them.<br> It's used by one entity until this entity decides to get rid of it. Take for example storage. In storage, a file is yours until you decide to delete it. </b></details> <details> <summary>What component determines which process runs at a given moment in time?</summary><br><b> CPU scheduler </b></details> #### Operating System - Memory <details> <summary>What is "virtual memory" and what purpose it serves?</summary><br><b> Virtual memory combines your computer's RAM with temporary space on your hard disk. When RAM runs low, virtual memory helps to move data from RAM to a space called a paging file. Moving data to paging file can free up the RAM so your computer can complete its work. In general, the more RAM your computer has, the faster the programs run. https://www.minitool.com/lib/virtual-memory.html </b></details> <details> <summary>What is demand paging?</summary><br><b> </b></details> <details> <summary>What is copy-on-write?</summary><br><b> Copy-on-write (COW) is a resource management concept, with the goal to reduce unnecessary copying of information. It is a concept which is implemented for instance within the POSIX fork syscall, which creates a duplicate process of the calling process. The idea: 1. If resources are shared between 2 or more entities (for example shared memory segments between 2 processes) the resources don't need to be copied for every entity, but rather every entity has a READ operation access permission on the shared resource. (the shared segements are marked as read-only) (Think of every entity having a pointer to the location of the shared resource which can be dereferenced to read its value) 2. If one entity would perform a WRITE operation on a shared resource a problem would arise since the resource also would be permanently changed for ALL other entities sharing it. (Think of a process modifying some variables on the stack, or allocatingy some data dynamically on the heap, these changes to the shared resource would also apply for ALL other processes, this is definetly an undesirable behaviour) 3. As a solution only if a WRITE operation is about to be performed on a shared resource, this resource gets COPIED first and then the changes are applied. </b></details> <details> <summary>What is a kernel, and what does it do?</summary><br><b> The kernel is part of the operating system and is responsible for tasks like: * Allocating memory * Schedule processes * Control CPU </b></details> <details> <summary>True or False? Some pieces of the code in the kernel are loaded into protected areas of the memory so applications can't overwritten them</summary><br><b> True </b></details> <details> <summary>What is POSIX?</summary><br><b> </b></details> <details> <summary>Explain what is Semaphore and what its role in operating systems</summary><br><b> </b></details> <details> <summary>What is cache? What is buffer?</summary><br><b> Buffer: Reserved place in RAM which is used to hold data for temporary purposes Cache: Cache is usually used when processes reading and writing to the disk to make the process faster by making similar data used by different programs easily accessible. </b></details> ## Virtualization <details> <summary>What is Virtualization?</summary><br><b> Virtualization uses software to create an abstraction layer over computer hardware that allows the hardware elements of a single computer—processors, memory, storage and more - to be divided into multiple virtual computers, commonly called virtual machines (VMs). </b></details> <details> <summary>What is a hypervisor?</summary><br><b> Red Hat: "A hypervisor is software that creates and runs virtual machines (VMs). A hypervisor, sometimes called a virtual machine monitor (VMM), isolates the hypervisor operating system and resources from the virtual machines and enables the creation and management of those VMs." Read more [here](https://www.redhat.com/en/topics/virtualization/what-is-a-hypervisor) </b></details> <details> <summary>What types of hypervisors are there?</summary><br><b> Hosted hypervisors and bare-metal hypervisors. </b></details> <details> <summary>What are the advantages and disadvantges of bare-metal hypervisor over a hosted hypervisor?</summary><br><b> Due to having its own drivers and a direct access to hardware components, a baremetal hypervisor will often have better performances along with stability and scalability. On the other hand, there will probably be some limitation regarding loading (any) drivers so a hosted hypervisor will usually benefit from having a better hardware compatibility. </b></details> <details> <summary>What types of virtualization are there?</summary><br><b> Operating system virtualization Network functions virtualization Desktop virtualization </b></details> <details> <summary>Is containerization is a type of Virtualization?</summary><br><b> Yes, it's a operating-system-level virtualization, where the kernel is shared and allows to use multiple isolated user-spaces instances. </b></details> <details> <summary>How the introduction of virtual machines changed the industry and the way applications were deployed?</summary><br><b> The introduction of virtual machines allowed companies to deploy multiple business applications on the same hardware while each application is separated from each other in secured way, where each is running on its own separate operating system. </b></details> #### Virtual Machines <details> <summary>Do we need virtual machines in the age of containers? Are they still relevant?</summary><br><b> </b></details> ## Monitoring <details> <summary>Explain monitoring. What is it? What its goal?</summary><br><b> Google: "Monitoring is one of the primary means by which service owners keep track of a system’s health and availability". </b></details> <details> <summary>What is wrong with the old approach of watching for a specific value and trigger an email/phone alert while value is exceeded?</summary><br><b> This approach require from a human to always check why the value exceeded and how to handle it while today, it is more effective to notify people only when they need to take an actual action. If the issue doesn't require any human intervention, then the problem can be fixed by some processes running in the relevant environment. </b></details> <details> <summary>What types of monitoring outputs are you familiar with and/or used in the past?</summary><br><b> Alerts<br> Tickets<br> Logging<br> </b></details> <details> <summary>What is the difference between infrastructure monitoring and application monitoring? (methods, tools, ...)</summary><br><b> </b></details> ### Application Performance Management <details> <summary>What is Application Performance Management?</summary><br><b> - IT metrics translated into business insights - Practices for monitoring applications insights so we can improve performances, reduce issues and improve overall user experience </b></details> <details> <summary>Name three aspects of a project you can monitor with APM (e.g. backend)</summary><br><b> - Frontend - Backend - Infra - ... </b></details> <details> <summary>What can be collected/monitored to perform APM monitoring?</summary><br><b> - Metrics - Logs - Events Traces </b></details> ## Prometheus <details> <summary>What is Prometheus? What are some of Prometheus's main features?</summary><br><b> </b></details> <details> <summary>In what scenarios it might be better to NOT use Prometheus?</summary><br><b> From Prometheus documentation: "if you need 100% accuracy, such as for per-request billing". </b></details> <details> <summary>Describe Prometheus architecture and components</summary><br><b> </b></details> <details> <summary>Can you compare Prometheus to other solutions like InfluxDB for example?</summary><br><b> </b></details> <details> <summary>What is an Alert?</summary><br><b> </b></details> <details> <summary>Describe the following Prometheus components: * Prometheus server * Push Gateway * Alert Manager</summary><br><b> Prometheus server is responsible for scraping and storing the data<br> Push gateway is used for short-lived jobs<br> Alert manager is responsible for alerts ;) </b></details> <details> <summary>What is an Instance? What is a Job?</summary><br><b> </b></details> <details> <summary>What core metrics types Prometheus supports?</summary><br><b> </b></details> <details> <summary>What is an exporter? What is it used for?</summary><br><b> </b></details> <details> <summary>Which Prometheus best practices are you familiar with?. Name at least three</summary><br><b> </b></details> <details> <summary>How to get total requests in a given period of time?</summary><br><b> </b></details> <details> <summary>What HA in Prometheus means?</summary><br><b> </b></details> <details> <summary>How do you join two metrics?</summary><br><b> </b></details> <details> <summary>How to write a query that returns the value of a label?</summary><br><b> </b></details> <details> <summary>How do you convert cpu_user_seconds to cpu usage in percentage?</summary><br><b> </b></details> ## Go <details> <summary>What are some characteristics of the Go programming language?</summary><br><b> * Strong and static typing - the type of the variables can't be changed over time and they have to be defined at compile time * Simplicity * Fast compile times * Built-in concurrency * Garbage collected * Platform independent * Compile to standalone binary - anything you need to run your app will be compiled into one binary. Very useful for version management in run-time. Go also has good community. </b></details> <details> <summary>What is the difference between <code>var x int = 2</code> and <code>x := 2</code>?</summary><br><b> The result is the same, a variable with the value 2. With <code>var x int = 2</code> we are setting the variable type to integer while with <code>x := 2</code> we are letting Go figure out by itself the type. </b></details> <details> <summary>True or False? In Go we can redeclare variables and once declared we must use it.</summary> False. We can't redeclare variables but yes, we must used declared variables. </b></details> <details> <summary>What libraries of Go have you used?</summary><br><b> This should be answered based on your usage but some examples are: * fmt - formatted I/O </b></details> <details> <summary>What is the problem with the following block of code? How to fix it? ``` func main() { var x float32 = 13.5 var y int y = x } ``` </summary><br><b> </b></details> <details> <summary>The following block of code tries to convert the integer 101 to a string but instead we get "e". Why is that? How to fix it? ```go package main import "fmt" func main() { var x int = 101 var y string y = string(x) fmt.Println(y) } ``` </summary><br><b> It looks what unicode value is set at 101 and uses it for converting the integer to a string. If you want to get "101" you should use the package "strconv" and replace <code>y = string(x)</code> with <code>y = strconv.Itoa(x)</code> </b></details> <details> <summary>What is wrong with the following code?: ``` package main func main() { var x = 2 var y = 3 const someConst = x + y } ``` </summary><br><b> Constants in Go can only be declared using constant expressions. But `x`, `y` and their sum is variable. <br> <code>const initializer x + y is not a constant</code> </b></details> <details> <summary>What will be the output of the following block of code?: ```go package main import "fmt" const ( x = iota y = iota ) const z = iota func main() { fmt.Printf("%v\n", x) fmt.Printf("%v\n", y) fmt.Printf("%v\n", z) } ``` </summary><br><b> Go's iota identifier is used in const declarations to simplify definitions of incrementing numbers. Because it can be used in expressions, it provides a generality beyond that of simple enumerations. <br> `x` and `y` in the first iota group, `z` in the second. <br> [Iota page in Go Wiki](https://github.com/golang/go/wiki/Iota) </b></details> <details> <summary>What _ is used for in Go?</summary><br><b> It avoids having to declare all the variables for the returns values. It is called the [blank identifier](https://golang.org/doc/effective_go.html#blank). <br> [answer in SO](https://stackoverflow.com/questions/27764421/what-is-underscore-comma-in-a-go-declaration#answer-27764432) </b></details> <details> <summary>What will be the output of the following block of code?: ```go package main import "fmt" const ( _ = iota + 3 x ) func main() { fmt.Printf("%v\n", x) } ``` </summary><br><b> Since the first iota is declared with the value `3` (` + 3`), the next one has the value `4` </b></details> <details> <summary>What will be the output of the following block of code?: ```go package main import ( "fmt" "sync" "time" ) func main() { var wg sync.WaitGroup wg.Add(1) go func() { time.Sleep(time.Second * 2) fmt.Println("1") wg.Done() }() go func() { fmt.Println("2") }() wg.Wait() fmt.Println("3") } ``` </summary><br><b> Output: 2 1 3 [Aritcle about sync/waitgroup](https://tutorialedge.net/golang/go-waitgroup-tutorial/) [Golang package sync](https://golang.org/pkg/sync/) </b></details> <details> <summary>What will be the output of the following block of code?: ```go package main import ( "fmt" ) func mod1(a []int) { for i := range a { a[i] = 5 } fmt.Println("1:", a) } func mod2(a []int) { a = append(a, 125) // ! for i := range a { a[i] = 5 } fmt.Println("2:", a) } func main() { s1 := []int{1, 2, 3, 4} mod1(s1) fmt.Println("1:", s1) s2 := []int{1, 2, 3, 4} mod2(s2) fmt.Println("2:", s2) } ``` </summary><br><b> Output: <code><br> 1 [5 5 5 5]<br> 1 [5 5 5 5]<br> 2 [5 5 5 5 5]<br> 2 [1 2 3 4]<br> </code> In `mod1` a is link, and when we're using `a[i]`, we're changing `s1` value to. But in `mod2`, `append` creats new slice, and we're changing only `a` value, not `s2`. [Aritcle about arrays](https://golangbot.com/arrays-and-slices/), [Blog post about `append`](https://blog.golang.org/slices) </b></details> <details> <summary>What will be the output of the following block of code?: ```go package main import ( "container/heap" "fmt" ) // An IntHeap is a min-heap of ints. type IntHeap []int func (h IntHeap) Len() int { return len(h) } func (h IntHeap) Less(i, j int) bool { return h[i] < h[j] } func (h IntHeap) Swap(i, j int) { h[i], h[j] = h[j], h[i] } func (h *IntHeap) Push(x interface{}) { // Push and Pop use pointer receivers because they modify the slice's length, // not just its contents. *h = append(*h, x.(int)) } func (h *IntHeap) Pop() interface{} { old := *h n := len(old) x := old[n-1] *h = old[0 : n-1] return x } func main() { h := &IntHeap{4, 8, 3, 6} heap.Init(h) heap.Push(h, 7) fmt.Println((*h)[0]) } ``` </summary><br><b> Output: 3 [Golang container/heap package](https://golang.org/pkg/container/heap/) </b></details> ## Mongo <details> <summary>What are the advantages of MongoDB? Or in other words, why choosing MongoDB and not other implementation of NoSQL?</summary><br><b> MongoDB advantages are as followings: - Schemaless - Easy to scale-out - No complex joins - Structure of a single object is clear </b></details> <details> <summary>What is the difference between SQL and NoSQL?</summary><br><b> The main difference is that SQL databases are structured (data is stored in the form of tables with rows and columns - like an excel spreadsheet table) while NoSQL is unstructured, and the data storage can vary depending on how the NoSQL DB is set up, such as key-value pair, document-oriented, etc. </b></details> <details> <summary>In what scenarios would you prefer to use NoSQL/Mongo over SQL?</summary><br><b> * Heterogeneous data which changes often * Data consistency and integrity is not top priority * Best if the database needs to scale rapidly </b></details> <details> <summary>What is a document? What is a collection?</summary><br><b> * A document is a record in MongoDB, which is stored in BSON (Binary JSON) format and is the basic unit of data in MongoDB. * A collection is a group of related documents stored in a single database in MongoDB. </b></details> <details> <summary>What is an aggregator?</summary><br><b> * An aggregator is a framework in MongoDB that performs operations on a set of data to return a single computed result. </b></details> <details> <summary>What is better? Embedded documents or referenced?</summary><br><b> * There is no definitive answer to which is better, it depends on the specific use case and requirements. Some explainations : Embedded documents provide atomic updates, while referenced documents allow for better normalization. </b></details> <details> <summary>Have you performed data retrieval optimizations in Mongo? If not, can you think about ways to optimize a slow data retrieval?</summary><br><b> * Some ways to optimize data retrieval in MongoDB are: indexing, proper schema design, query optimization and database load balancing. </b></details> ##### Queries <details> <summary>Explain this query: <code>db.books.find({"name": /abc/})</code></summary><br><b> </b></details> <details> <summary>Explain this query: <code>db.books.find().sort({x:1})</code></summary><br><b> </b></details> <details> <summary>What is the difference between find() and find_one()?</code></summary><br><b> * `find()` returns all documents that match the query conditions. * find_one() returns only one document that matches the query conditions (or null if no match is found). </b></details> <details> <summary>How can you export data from Mongo DB?</code></summary><br><b> * mongoexport * programming languages </b></details> ## SQL ### SQL Exercises |Name|Topic|Objective & Instructions|Solution|Comments| |--------|--------|------|----|----| | Functions vs. Comparisons | Query Improvements | [Exercise](topics/sql/improve_query.md) | [Solution](topics/sql/solutions/improve_query.md) ### SQL Self Assessment <details> <summary>What is SQL?</summary><br><b> SQL (Structured Query Language) is a standard language for relational databases (like MySQL, MariaDB, ...).<br> It's used for reading, updating, removing and creating data in a relational database. </b></details> <details> <summary>How is SQL Different from NoSQL</summary><br><b> The main difference is that SQL databases are structured (data is stored in the form of tables with rows and columns - like an excel spreadsheet table) while NoSQL is unstructured, and the data storage can vary depending on how the NoSQL DB is set up, such as key-value pair, document-oriented, etc. </b></details> <details> <summary>When is it best to use SQL? NoSQL?</summary><br><b> SQL - Best used when data integrity is crucial. SQL is typically implemented with many businesses and areas within the finance field due to it's ACID compliance. NoSQL - Great if you need to scale things quickly. NoSQL was designed with web applications in mind, so it works great if you need to quickly spread the same information around to multiple servers Additionally, since NoSQL does not adhere to the strict table with columns and rows structure that Relational Databases require, you can store different data types together. </b></details> ##### Practical SQL - Basics For these questions, we will be using the Customers and Orders tables shown below: **Customers** Customer_ID | Customer_Name | Items_in_cart | Cash_spent_to_Date ------------ | ------------- | ------------- | ------------- 100204 | John Smith | 0 | 20.00 100205 | Jane Smith | 3 | 40.00 100206 | Bobby Frank | 1 | 100.20 **ORDERS** Customer_ID | Order_ID | Item | Price | Date_sold ------------ | ------------- | ------------- | ------------- | ------------- 100206 | A123 | Rubber Ducky | 2.20 | 2019-09-18 100206 | A123 | Bubble Bath | 8.00 | 2019-09-18 100206 | Q987 | 80-Pack TP | 90.00 | 2019-09-20 100205 | Z001 | Cat Food - Tuna Fish | 10.00 | 2019-08-05 100205 | Z001 | Cat Food - Chicken | 10.00 | 2019-08-05 100205 | Z001 | Cat Food - Beef | 10.00 | 2019-08-05 100205 | Z001 | Cat Food - Kitty quesadilla | 10.00 | 2019-08-05 100204 | X202 | Coffee | 20.00 | 2019-04-29 <details> <summary>How would I select all fields from this table?</summary><br><b> Select * <br> From Customers; </b></details> <details> <summary>How many items are in John's cart?</summary><br><b> Select Items_in_cart <br> From Customers <br> Where Customer_Name = "John Smith"; </b></details> <details> <summary>What is the sum of all the cash spent across all customers?</summary><br><b> Select SUM(Cash_spent_to_Date) as SUM_CASH <br> From Customers; </b></details> <details> <summary>How many people have items in their cart?</summary><br><b> Select count(1) as Number_of_People_w_items <br> From Customers <br> where Items_in_cart > 0; </b></details> <details> <summary>How would you join the customer table to the order table?</summary><br><b> You would join them on the unique key. In this case, the unique key is Customer_ID in both the Customers table and Orders table </b></details> <details> <summary>How would you show which customer ordered which items?</summary><br><b> Select c.Customer_Name, o.Item <br> From Customers c <br> Left Join Orders o <br> On c.Customer_ID = o.Customer_ID; </b></details> <details> <summary>Using a with statement, how would you show who ordered cat food, and the total amount of money spent?</summary><br><b> with cat_food as ( <br> Select Customer_ID, SUM(Price) as TOTAL_PRICE <br> From Orders <br> Where Item like "%Cat Food%" <br> Group by Customer_ID <br> ) <br> Select Customer_name, TOTAL_PRICE <br> From Customers c <br> Inner JOIN cat_food f <br> ON c.Customer_ID = f.Customer_ID <br> where c.Customer_ID in (Select Customer_ID from cat_food); Although this was a simple statement, the "with" clause really shines when a complex query needs to be run on a table before joining to another. With statements are nice, because you create a pseudo temp when running your query, instead of creating a whole new table. The Sum of all the purchases of cat food weren't readily available, so we used a with statement to create the pseudo table to retrieve the sum of the prices spent by each customer, then join the table normally. </b></details> <details> <summary>Which of the following queries would you use? ``` SELECT count(*) SELECT count(*) FROM shawarma_purchases FROM shawarma_purchases WHERE vs. WHERE YEAR(purchased_at) == '2017' purchased_at >= '2017-01-01' AND purchased_at <= '2017-31-12' ``` </summary><br><b> ``` SELECT count(*) FROM shawarma_purchases WHERE purchased_at >= '2017-01-01' AND purchased_at <= '2017-31-12' ``` When you use a function (`YEAR(purchased_at)`) it has to scan the whole database as opposed to using indexes and basically the column as it is, in its natural state. </b></details> ## OpenStack <details> <summary>What components/projects of OpenStack are you familiar with?</summary><br><b> </b></details> <details> <summary>Can you tell me what each of the following services/projects is responsible for?: - Nova - Neutron - Cinder - Glance - Keystone</summary><br><b> * Nova - Manage virtual instances * Neutron - Manage networking by providing Network as a service (NaaS) * Cinder - Block Storage * Glance - Manage images for virtual machines and containers (search, get and register) * Keystone - Authentication service across the cloud </b></details> <details> <summary>Identify the service/project used for each of the following: * Copy or snapshot instances * GUI for viewing and modifying resources * Block Storage * Manage virtual instances </summary><br><b> * Glance - Images Service. Also used for copying or snapshot instances * Horizon - GUI for viewing and modifying resources * Cinder - Block Storage * Nova - Manage virtual instances </b></details> <details> <summary>What is a tenant/project?</summary><br><b> </b></details> <details> <summary>Determine true or false: * OpenStack is free to use * The service responsible for networking is Glance * The purpose of tenant/project is to share resources between different projects and users of OpenStack</summary><br><b> </b></details> <details> <summary>Describe in detail how you bring up an instance with a floating IP</summary><br><b> </b></details> <details> <summary>You get a call from a customer saying: "I can ping my instance but can't connect (ssh) it". What might be the problem?</summary><br><b> </b></details> <details> <summary>What types of networks OpenStack supports?</summary><br><b> </b></details> <details> <summary>How do you debug OpenStack storage issues? (tools, logs, ...)</summary><br><b> </b></details> <details> <summary>How do you debug OpenStack compute issues? (tools, logs, ...)</summary><br><b> </b></details> #### OpenStack Deployment & TripleO <details> <summary>Have you deployed OpenStack in the past? If yes, can you describe how you did it?</summary><br><b> </b></details> <details> <summary>Are you familiar with TripleO? How is it different from Devstack or Packstack?</summary><br><b> You can read about TripleO right [here](https://docs.openstack.org/tripleo-docs/latest) </b></details> #### OpenStack Compute <details> <summary>Can you describe Nova in detail?</summary><br><b> * Used to provision and manage virtual instances * It supports Multi-Tenancy in different levels - logging, end-user control, auditing, etc. * Highly scalable * Authentication can be done using internal system or LDAP * Supports multiple types of block storage * Tries to be hardware and hypervisor agnostice </b></details> <details> <summary>What do you know about Nova architecture and components?</summary><br><b> * nova-api - the server which serves metadata and compute APIs * the different Nova components communicate by using a queue (Rabbitmq usually) and a database * a request for creating an instance is inspected by nova-scheduler which determines where the instance will be created and running * nova-compute is the component responsible for communicating with the hypervisor for creating the instance and manage its lifecycle </b></details> #### OpenStack Networking (Neutron) <details> <summary>Explain Neutron in detail</summary><br><b> * One of the core component of OpenStack and a standalone project * Neutron focused on delivering networking as a service * With Neutron, users can set up networks in the cloud and configure and manage a variety of network services * Neutron interacts with: * Keystone - authorize API calls * Nova - nova communicates with neutron to plug NICs into a network * Horizon - supports networking entities in the dashboard and also provides topology view which includes networking details </b></details> <details> <summary>Explain each of the following components: - neutron-dhcp-agent - neutron-l3-agent - neutron-metering-agent - neutron-*-agtent - neutron-server</summary><br><b> * neutron-l3-agent - L3/NAT forwarding (provides external network access for VMs for example) * neutron-dhcp-agent - DHCP services * neutron-metering-agent - L3 traffic metering * neutron-*-agtent - manages local vSwitch configuration on each compute (based on chosen plugin) * neutron-server - exposes networking API and passes requests to other plugins if required </b></details> <details> <summary>Explain these network types: - Management Network - Guest Network - API Network - External Network</summary><br><b> * Management Network - used for internal communication between OpenStack components. Any IP address in this network is accessible only within the datacetner * Guest Network - used for communication between instances/VMs * API Network - used for services API communication. Any IP address in this network is publicly accessible * External Network - used for public communication. Any IP address in this network is accessible by anyone on the internet </b></details> <details> <summary>In which order should you remove the following entities: * Network * Port * Router * Subnet</summary><br><b> - Port - Subnet - Router - Network There are many reasons for that. One for example: you can't remove router if there are active ports assigned to it. </b></details> <details> <summary>What is a provider network?</summary><br><b> </b></details> <details> <summary>What components and services exist for L2 and L3?</summary><br><b> </b></details> <details> <summary>What is the ML2 plug-in? Explain its architecture</summary><br><b> </b></details> <details> <summary>What is the L2 agent? How does it works and what is it responsible for?</summary><br><b> </b></details> <details> <summary>What is the L3 agent? How does it works and what is it responsible for?</summary><br><b> </b></details> <details> <summary>Explain what the Metadata agent is responsible for</summary><br><b> </b></details> <details> <summary>What networking entities Neutron supports?</summary><br><b> </b></details> <details> <summary>How do you debug OpenStack networking issues? (tools, logs, ...)</summary><br><b> </b></details> #### OpenStack - Glance <details> <summary>Explain Glance in detail</summary><br><b> * Glance is the OpenStack image service * It handles requests related to instances disks and images * Glance also used for creating snapshots for quick instances backups * Users can use Glance to create new images or upload existing ones </b></details> <details> <summary>Describe Glance architecture</summary><br><b> * glance-api - responsible for handling image API calls such as retrieval and storage. It consists of two APIs: 1. registry-api - responsible for internal requests 2. user API - can be accessed publicly * glance-registry - responsible for handling image metadata requests (e.g. size, type, etc). This component is private which means it's not available publicly * metadata definition service - API for custom metadata * database - for storing images metadata * image repository - for storing images. This can be a filesystem, swift object storage, HTTP, etc. </b></details> #### OpenStack - Swift <details> <summary>Explain Swift in detail</summary><br><b> * Swift is Object Store service and is an highly available, distributed and consistent store designed for storing a lot of data * Swift is distributing data across multiple servers while writing it to multiple disks * One can choose to add additional servers to scale the cluster. All while swift maintaining integrity of the information and data replications. </b></details> <details> <summary>Can users store by default an object of 100GB in size?</summary><br><b> Not by default. Object Storage API limits the maximum to 5GB per object but it can be adjusted. </b></details> <details> <summary>Explain the following in regards to Swift: * Container * Account * Object </summary><br><b> - Container - Defines a namespace for objects. - Account - Defines a namespace for containers - Object - Data content (e.g. image, document, ...) </b></details> <details> <summary>True or False? there can be two objects with the same name in the same container but not in two different containers</summary><br><b> False. Two objects can have the same name if they are in different containers. </b></details> #### OpenStack - Cinder <details> <summary>Explain Cinder in detail</summary><br><b> * Cinder is OpenStack Block Storage service * It basically provides used with storage resources they can consume with other services such as Nova * One of the most used implementations of storage supported by Cinder is LVM * From user perspective this is transparent which means the user doesn't know where, behind the scenes, the storage is located or what type of storage is used </b></details> <details> <summary>Describe Cinder's components</summary><br><b> * cinder-api - receives API requests * cinder-volume - manages attached block devices * cinder-scheduler - responsible for storing volumes </b></details> #### OpenStack - Keystone <details> <summary>Can you describe the following concepts in regards to Keystone? - Role - Tenant/Project - Service - Endpoint - Token </summary><br><b> - Role - A list of rights and privileges determining what a user or a project can perform - Tenant/Project - Logical representation of a group of resources isolated from other groups of resources. It can be an account, organization, ... - Service - An endpoint which the user can use for accessing different resources - Endpoint - a network address which can be used to access a certain OpenStack service - Token - Used for access resources while describing which resources can be accessed by using a scope </b></details> <details> <summary>What are the properties of a service? In other words, how a service is identified?</summary><br><b> Using: - Name - ID number - Type - Description </b></details> <details> <summary>Explain the following: - PublicURL - InternalURL - AdminURL</summary><br><b> - PublicURL - Publicly accessible through public internet - InternalURL - Used for communication between services - AdminURL - Used for administrative management </b></details> <details> <summary>What is a service catalog?</summary><br><b> A list of services and their endpoints </b></details> #### OpenStack Advanced - Services <details> <summary>Describe each of the following services * Swift * Sahara * Ironic * Trove * Aodh * Ceilometer </summary><br><b> * Swift - highly available, distributed, eventually consistent object/blob store * Sahara - Manage Hadoop Clusters * Ironic - Bare Metal Provisioning * Trove - Database as a service that runs on OpenStack * Aodh - Alarms Service * Ceilometer - Track and monitor usage </b></details> <details> <summary>Identify the service/project used for each of the following: * Database as a service which runs on OpenStack * Bare Metal Provisioning * Track and monitor usage * Alarms Service * Manage Hadoop Clusters * highly available, distributed, eventually consistent object/blob store </summary><br><b> * Database as a service which runs on OpenStack - Trove * Bare Metal Provisioning - Ironic * Track and monitor usage - Ceilometer * Alarms Service - Aodh * Manage Hadoop Clusters * Manage Hadoop Clusters - Sahara * highly available, distributed, eventually consistent object/blob store - Swift </b></details> #### OpenStack Advanced - Keystone <details> <summary>Can you describe Keystone service in detail?</summary><br><b> * You can't have OpenStack deployed without Keystone * It Provides identity, policy and token services * The authentication provided is for both users and services * The authorization supported is token-based and user-based. * There is a policy defined based on RBAC stored in a JSON file and each line in that file defines the level of access to apply </b></details> <details> <summary>Describe Keystone architecture</summary><br><b> * There is a service API and admin API through which Keystone gets requests * Keystone has four backends: * Token Backend - Temporary Tokens for users and services * Policy Backend - Rules management and authorization * Identity Backend - users and groups (either standalone DB, LDAP, ...) * Catalog Backend - Endpoints * It has pluggable environment where you can integrate with: * LDAP * KVS (Key Value Store) * SQL * PAM * Memcached </b></details> <details> <summary>Describe the Keystone authentication process</summary><br><b> * Keystone gets a call/request and checks whether it's from an authorized user, using username, password and authURL * Once confirmed, Keystone provides a token. * A token contains a list of user's projects so there is no to authenticate every time and a token can submitted instead </b></details> #### OpenStack Advanced - Compute (Nova) <details> <summary>What each of the following does?: * nova-api * nova-compuate * nova-conductor * nova-cert * nova-consoleauth * nova-scheduler </summary><br><b> * nova-api - responsible for managing requests/calls * nova-compute - responsible for managing instance lifecycle * nova-conductor - Mediates between nova-compute and the database so nova-compute doesn't access it directly </b></details> <details> <summary>What types of Nova proxies are you familiar with?</summary><br><b> * Nova-novncproxy - Access through VNC connections * Nova-spicehtml5proxy - Access through SPICE * Nova-xvpvncproxy - Access through a VNC connection </b></details> #### OpenStack Advanced - Networking (Neutron) <details> <summary>Explain BGP dynamic routing</summary><br><b> </b></details> <details> <summary>What is the role of network namespaces in OpenStack?</summary><br><b> </b></details> #### OpenStack Advanced - Horizon <details> <summary>Can you describe Horizon in detail?</summary><br><b> * Django-based project focusing on providing an OpenStack dashboard and the ability to create additional customized dashboards * You can use it to access the different OpenStack services resources - instances, images, networks, ... * By accessing the dashboard, users can use it to list, create, remove and modify the different resources * It's also highly customizable and you can modify or add to it based on your needs </b></details> <details> <summary>What can you tell about Horizon architecture?</summary><br><b> * API is backward compatible * There are three type of dashboards: user, system and settings * It provides core support for all OpenStack core projects such as Neutron, Nova, etc. (out of the box, no need to install extra packages or plugins) * Anyone can extend the dashboards and add new components * Horizon provides templates and core classes from which one can build its own dashboard </b></details> ## Puppet <details> <summary>What is Puppet? How does it works?</summary><br><b> * Puppet is a configuration management tool ensuring that all systems are configured to a desired and predictable state. </b></details> <details> <summary>Explain Puppet architecture</summary><br><b> * Puppet has a primary-secondary node architecture. The clients are distributed across the network and communicate with the primary-secondary environment where Puppet modules are present. The client agent sends a certificate with its ID to the server; the server then signs that certificate and sends it back to the client. This authentication allows for secure and verifiable communication between the client and the master. </b></details> <details> <summary>Can you compare Puppet to other configuration management tools? Why did you chose to use Puppet?</summary><br><b> * Puppet is often compared to other configuration management tools like Chef, Ansible, SaltStack, and cfengine. The choice to use Puppet often depends on an organization's needs, such as ease of use, scalability, and community support. </b></details> <details> <summary>Explain the following: * Module * Manifest * Node </summary><br><b> * Modules - are a collection of manifests, templates, and files * Manifests - are the actual codes for configuring the clients * Node - allows you to assign specific configurations to specific nodes </b></details> <details> <summary>Explain Facter</summary><br><b> * Facter is a standalone tool in Puppet that collects information about a system and its configuration, such as the operating system, IP addresses, memory, and network interfaces. This information can be used in Puppet manifests to make decisions about how resources should be managed, and to customize the behavior of Puppet based on the characteristics of the system. Facter is integrated into Puppet, and its facts can be used within Puppet manifests to make decisions about resource management. </b></details> <details> <summary>What is MCollective?</summary><br><b> * MCollective is a middleware system that integrates with Puppet to provide orchestration, remote execution, and parallel job execution capabilities. </b></details> <details> <summary>Do you have experience with writing modules? Which module have you created and for what?</summary><br><b> </b></details> <details> <summary>Explain what is Hiera</summary><br><b> * Hiera is a hierarchical data store in Puppet that is used to separate data from code, allowing data to be more easily separated, managed, and reused. </b></details> ## Elastic <details> <summary>What is the Elastic Stack?</summary><br><b> The Elastic Stack consists of: * Elasticsearch * Kibana * Logstash * Beats * Elastic Hadoop * APM Server Elasticserach, Logstash and Kibana are also known as the ELK stack. </b></details> <details> <summary>Explain what is Elasticsearch</summary><br><b> From the official [docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/documents-indices.html): "Elasticsearch is a distributed document store. Instead of storing information as rows of columnar data, Elasticsearch stores complex data structures that have been serialized as JSON documents" </b></details> <details> <summary>What is Logstash?</summary><br><b> From the [blog](https://logit.io/blog/post/the-top-50-elk-stack-and-elasticsearch-interview-questions): "Logstash is a powerful, flexible pipeline that collects, enriches and transports data. It works as an extract, transform & load (ETL) tool for collecting log messages." </b></details> <details> <summary>Explain what beats are</summary><br><b> Beats are lightweight data shippers. These data shippers installed on the client where the data resides. Examples of beats: Filebeat, Metricbeat, Auditbeat. There are much more.<br> </b></details> <details> <summary>What is Kibana?</summary><br><b> From the official docs: "Kibana is an open source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis and visualize your data in a variety of charts, tables, and maps." </b></details> <details> <summary>Describe what happens from the moment an app logged some information until it's displayed to the user in a dashboard when the Elastic stack is used</summary><br><b> The process may vary based on the chosen architecture and the processing you may want to apply to the logs. One possible workflow is: 1. The data logged by the application is picked by filebeat and sent to logstash 2. Logstash process the log based on the defined filters. Once done, the output is sent to Elasticsearch 2. Elasticsearch stores the document it got and the document is indexed for quick future access 4. The user creates visualizations in Kibana which based on the indexed data 5. The user creates a dashboard which composed out of the visualization created in the previous step </b></details> ##### Elasticsearch <details> <summary>What is a data node?</summary><br><b> This is where data is stored and also where different processing takes place (e.g. when you search for a data). </b></details> <details> <summary>What is a master node?</summary><br><b> Part of a master node responsibilites: * Track the status of all the nodes in the cluster * Verify replicas are working and the data is available from every data node. * No hot nodes (no data node that works much harder than other nodes) While there can be multiple master nodes in reality only of them is the elected master node. </b></details> <details> <summary>What is an ingest node?</summary><br><b> A node which responsible for parsing the data. In case you don't use logstash then this node can recieve data from beats and parse it, similarly to how it can be parsed in Logstash. </b></details> <details> <summary>What is Coordinating node?</summary><br><b> A Coordinating node responsible for routing requests out and in to the cluser (data nodes). </b></details> <details> <summary>How data is stored in elasticsearch?</summary><br><b> * Data is stored in an index * The index is spread across the cluster using shards </b></details> <details> <summary>What is an Index?</summary><br><b> Index in Elastic is in most cases compared to a whole database from the SQL/NoSQL world.<br> You can choose to have one index to hold all the data of your app or have multiple indices where each index holds different type of your app (e.g. index for each service your app is running). The official docs also offer a great explanation (in general, it's really good documentation, as every project should have): "An index can be thought of as an optimized collection of documents and each document is a collection of fields, which are the key-value pairs that contain your data" </b></details> <details> <summary>Explain Shards</summary><br><b> An index is split into shards and documents are hashed to a particular shard. Each shard may be on a different node in a cluster and each one of the shards is a self contained index.<br> This allows Elasticsearch to scale to an entire cluster of servers. </b></details> <details> <summary>What is an Inverted Index?</summary><br><b> From the official docs: "An inverted index lists every unique word that appears in any document and identifies all of the documents each word occurs in." </b></details> <details> <summary>What is a Document?</summary><br><b> Continuing with the comparison to SQL/NoSQL a Document in Elastic is a row in table in the case of SQL or a document in a collection in the case of NoSQL. As in NoSQL a Document is a JSON object which holds data on a unit in your app. What is this unit depends on the your app. If your app related to book then each document describes a book. If you are app is about shirts then each document is a shirt. </b></details> <details> <summary>You check the health of your elasticsearch cluster and it's red. What does it mean? What can cause the status to be yellow instead of green?</summary><br><b> Red means some data is unavailable. Yellow can be caused by running single node cluster instead of multi-node. </b></details> <details> <summary>True or False? Elasticsearch indexes all data in every field and each indexed field has the same data structure for unified and quick query ability</summary><br><b> False. From the official docs: "Each indexed field has a dedicated, optimized data structure. For example, text fields are stored in inverted indices, and numeric and geo fields are stored in BKD trees." </b></details> <details> <summary>What reserved fields a document has?</summary><br><b> * _index * _id * _type </b></details> <details> <summary>Explain Mapping</summary><br><b> </b></details> <details> <summary>What are the advantages of defining your own mapping? (or: when would you use your own mapping?)</summary><br><b> * You can optimize fields for partial matching * You can define custom formats of known fields (e.g. date) * You can perform language-specific analysis </b></details> <details> <summary>Explain Replicas</summary><br><b> In a network/cloud environment where failures can be expected any time, it is very useful and highly recommended to have a failover mechanism in case a shard/node somehow goes offline or disappears for whatever reason. To this end, Elasticsearch allows you to make one or more copies of your index’s shards into what are called replica shards, or replicas for short. </b></details> <details> <summary>Can you explain Term Frequency & Document Frequency?</summary><br><b> Term Frequency is how often a term appears in a given document and Document Frequency is how often a term appears in all documents. They both are used for determining the relevance of a term by calculating Term Frequency / Document Frequency. </b></details> <details> <summary>You check "Current Phase" under "Index lifecycle management" and you see it's set to "hot". What does it mean?</summary><br><b> "The index is actively being written to". More about the phases [here](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/ilm-policy-definition.html) </b></details> <details> <summary>What this command does? <code>curl -X PUT "localhost:9200/customer/_doc/1?pretty" -H 'Content-Type: application/json' -d'{ "name": "John Doe" }'</code></summary><br><b> It creates customer index if it doesn't exists and adds a new document with the field name which is set to "John Dow". Also, if it's the first document it will get the ID 1. </b></details> <details> <summary>What will happen if you run the previous command twice? What about running it 100 times?</code></summary><br><b> 1. If name value was different then it would update "name" to the new value 2. In any case, it bumps version field by one </b></details> <details> <summary>What is the Bulk API? What would you use it for?</code></summary><br><b> Bulk API is used when you need to index multiple documents. For high number of documents it would be significantly faster to use rather than individual requests since there are less network roundtrips. </b></details> ##### Query DSL <details> <summary>Explain Elasticsearch query syntax (Booleans, Fields, Ranges)</summary><br><b> </b></details> <details> <summary>Explain what is Relevance Score</summary><br><b> </b></details> <details> <summary>Explain Query Context and Filter Context</summary><br><b> From the official docs: "In the query context, a query clause answers the question “How well does this document match this query clause?” Besides deciding whether or not the document matches, the query clause also calculates a relevance score in the _score meta-field." "In a filter context, a query clause answers the question “Does this document match this query clause?” The answer is a simple Yes or No — no scores are calculated. Filter context is mostly used for filtering structured data" </b></details> <details> <summary>Describe how would an architecture of production environment with large amounts of data would be different from a small-scale environment</summary><br><b> There are several possible answers for this question. One of them is as follows: A small-scale architecture of elastic will consist of the elastic stack as it is. This means we will have beats, logstash, elastcsearch and kibana.<br> A production environment with large amounts of data can include some kind of buffering component (e.g. Reddis or RabbitMQ) and also security component such as Nginx. </b></details> ##### Logstash <details> <summary>What are Logstash plugins? What plugins types are there?</summary><br><b> * Input Plugins - how to collect data from different sources * Filter Plugins - processing data * Output Plugins - push data to different outputs/services/platforms </b></details> <details> <summary>What is grok?</summary><br><b> A logstash plugin which modifies information in one format and immerse it in another. </b></details> <details> <summary>How grok works?</summary><br><b> </b></details> <details> <summary>What grok patterns are you familiar with?</summary><br><b> </b></details> <details> <summary>What is `_grokparsefailure?`</summary><br><b> </b></details> <details> <summary>How do you test or debug grok patterns?</summary><br><b> </b></details> <details> <summary>What are Logstash Codecs? What codecs are there?</summary><br><b> </b></details> ##### Kibana <details> <summary>What can you find under "Discover" in Kibana?</summary><br><b> The raw data as it is stored in the index. You can search and filter it. </b></details> <details> <summary>You see in Kibana, after clicking on Discover, "561 hits". What does it mean?</summary><br><b> Total number of documents matching the search results. If not query used then simply the total number of documents. </b></details> <details> <summary>What can you find under "Visualize"?</summary><br><b> "Visualize" is where you can create visual representations for your data (pie charts, graphs, ...) </b></details> <details> <summary>What visualization types are supported/included in Kibana?</summary><br><b> </b></details> <details> <summary>What visualization type would you use for statistical outliers</summary><br><b> </b></details> <details> <summary>Describe in detail how do you create a dashboard in Kibana</summary><br><b> </b></details> #### Filebeat <details> <summary>What is Filebeat?</summary><br><b> </b></details> <details> <summary>If one is using ELK, is it a must to also use filebeat? In what scenarios it's useful to use filebeat?</summary><br><b> </b></details> <details> <summary>What is a harvester?</summary><br><b> Read [here](https://www.elastic.co/guide/en/beats/filebeat/current/how-filebeat-works.html#harvester) </b></details> <details> <summary>True or False? a single harvester harvest multiple files, according to the limits set in filebeat.yml</summary><br><b> False. One harvester harvests one file. </b></details> <details> <summary>What are filebeat modules?</summary><br><b> </b></details> #### Elastic Stack <details> <summary>How do you secure an Elastic Stack?</summary><br><b> You can generate certificates with the provided elastic utils and change configuration to enable security using certificates model. </b></details> ## Distributed <details> <summary>Explain Distributed Computing (or Distributed System)</summary><br><b> According to Martin Kleppmann: "Many processes running on many machines...only message-passing via an unreliable network with variable delays, and the system may suffer from partial failures, unreliable clocks, and process pauses." Another definition: "Systems that are physically separated, but logically connected" </b></details> <details> <summary>What can cause a system to fail?</summary><br><b> * Network * CPU * Memory * Disk </b></details> <details> <summary>Do you know what is "CAP theorem"? (aka as Brewer's theorem)</summary><br><b> According to the CAP theorem, it's not possible for a distributed data store to provide more than two of the following at the same time: * Availability: Every request receives a response (it doesn't has to be the most recent data) * Consistency: Every request receives a response with the latest/most recent data * Partition tolerance: Even if some the data is lost/dropped, the system keeps running </b></details> <details> <summary>What are the problems with the following design? How to improve it?<br> <img src="images/distributed/distributed_design_standby.png" width="500x;" height="350px;"/> </summary><br><b> 1. The transition can take time. In other words, noticeable downtime. 2. Standby server is a waste of resources - if first application server is running then the standby does nothing </b></details> <details> <summary>What are the problems with the following design? How to improve it?<br> <img src="images/distributed/distributed_design_lb.png" width="700x;" height="350px;"/> </summary><br><b> Issues: If load balancer dies , we lose the ability to communicate with the application. Ways to improve: * Add another load balancer * Use DNS A record for both load balancers * Use message queue </b></details> <details> <summary>What is "Shared-Nothing" architecture?</summary><br><b> It's an architecture in which data is and retrieved from a single, non-shared, source usually exclusively connected to one node as opposed to architectures where the request can get to one of many nodes and the data will be retrieved from one shared location (storage, memory, ...). </b></details> <details> <summary>Explain the Sidecar Pattern (Or sidecar proxy)</summary><br><b> </b></details> ## Misc |Name|Topic|Objective & Instructions|Solution|Comments| |--------|--------|------|----|----| | Highly Available "Hello World" | [Exercise](topics/devops/ha_hello_world.md) | [Solution](topics/devops/solutions/ha_hello_world.md) <details> <summary>What happens when you type in a URL in an address bar in a browser?</summary><br><b> 1. The browser searches for the record of the domain name IP address in the DNS in the following order: * Browser cache * Operating system cache * The DNS server configured on the user's system (can be ISP DNS, public DNS, ...) 2. If it couldn't find a DNS record locally, a full DNS resolution is started. 3. It connects to the server using the TCP protocol 4. The browser sends an HTTP request to the server 5. The server sends an HTTP response back to the browser 6. The browser renders the response (e.g. HTML) 7. The browser then sends subsequent requests as needed to the server to get the embedded links, javascript, images in the HTML and then steps 3 to 5 are repeated. TODO: add more details! </b></details> #### API <details> <summary>Explain what is an API</summary><br><b> I like this definition from [blog.christianposta.com](https://blog.christianposta.com/microservices/api-gateways-are-going-through-an-identity-crisis): "An explicitly and purposefully defined interface designed to be invoked over a network that enables software developers to get programmatic access to data and functionality within an organization in a controlled and comfortable way." </b></details> <details> <summary>What is an API specification?</summary><br><b> From [swagger.io](https://swagger.io/resources/articles/difference-between-api-documentation-specification): "An API specification provides a broad understanding of how an API behaves and how the API links with other APIs. It explains how the API functions and the results to expect when using the API" </b></details> <details> <summary>True or False? API Definition is the same as API Specification</summary><br><b> False. From [swagger.io](https://swagger.io/resources/articles/difference-between-api-documentation-specification): "An API definition is similar to an API specification in that it provides an understanding of how an API is organized and how the API functions. But the API definition is aimed at machine consumption instead of human consumption of APIs." </b></details> <details> <summary>What is an API gateway?</summary><br><b> </b></details> <details> <summary>What are the advantages of using/implementing an API gateway?</summary><br><b> </b></details> <details> <summary>What is a Payload in API?</summary><br><b> </b></details> <details> <summary>What is Automation? How it's related or different from Orchestration?</summary><br><b> Automation is the act of automating tasks to reduce human intervention or interaction in regards to IT technology and systems.<br> While automation focuses on a task level, Orchestration is the process of automating processes and/or workflows which consists of multiple tasks that usually across multiple systems. </b></details> <details> <summary>Tell me about interesting bugs you've found and also fixed</summary><br><b> </b></details> <details> <summary>What is a Debuggger and how it works?</summary><br><b> </b></details> <details> <summary>What services an application might have?</summary><br><b> * Authorization * Logging * Authentication * Ordering * Front-end * Back-end ... </b></details> <details> <summary>What is Metadata?</summary><br><b> Data about data. Basically, it describes the type of information that an underlying data will hold. </b></details> <details> <summary>You can use one of the following formats: JSON, YAML, XML. Which one would you use? Why?</summary><br><b> I can't answer this for you :) </b></details> <details> <summary>What's KPI?</summary><br><b> </b></details> <details> <summary>What's OKR?</summary><br><b> </b></details> <details> <summary>What's DSL (Domain Specific Language)?</summary><br><b> Domain Specific Language (DSLs) are used to create a customised language that represents the domain such that domain experts can easily interpret it. </b></details> <details> <summary>What's the difference between KPI and OKR?</summary><br><b> </b></details> #### YAML <details> <summary>What is YAML?</summary><br><b> Data serialization language used by many technologies today like Kubernetes, Ansible, etc. </b></details> <details> <summary>True or False? Any valid JSON file is also a valid YAML file</summary><br><b> True. Because YAML is superset of JSON. </b></details> <details> <summary>What is the format of the following data? ``` { applications: [ { name: "my_app", language: "python", version: 20.17 } ] } ``` </summary><br><b> JSON </b></details> <details> <summary>What is the format of the following data? ``` applications: - app: "my_app" language: "python" version: 20.17 ``` </summary><br><b> YAML </b></details> <details> <summary>How to write a multi-line string with YAML? What use cases is it good for?</summary><br><b> ``` someMultiLineString: | look mama I can write a multi-line string I love YAML ``` It's good for use cases like writing a shell script where each line of the script is a different command. </b></details> <details> <summary>What is the difference between <code>someMultiLineString: |</code> to <code>someMultiLineString: ></code>?</summary><br><b> using `>` will make the multi-line string to fold into a single line ``` someMultiLineString: > This is actually a single line do not let appearances fool you ``` </b></details> <details> <summary>What are placeholders in YAML?</summary><br><b> They allow you reference values instead of directly writing them and it is used like this: ``` username: {{ my.user_name }} ``` </b></details> <details> <summary>How can you define multiple YAML components in one file?</summary><br><b> Using this: `---` For Examples: ``` document_number: 1 --- document_number: 2 ``` </b></details> #### Firmware <details> <summary>Explain what is a firmware</summary><br><b> [Wikipedia](https://en.wikipedia.org/wiki/Firmware): "In computing, firmware is a specific class of computer software that provides the low-level control for a device's specific hardware. Firmware, such as the BIOS of a personal computer, may contain basic functions of a device, and may provide hardware abstraction services to higher-level software such as operating systems." </b></details> ## Cassandra <details> <summary>When running a cassandra cluster, how often do you need to run nodetool repair in order to keep the cluster consistent? * Within the columnFamily GC-grace Once a week * Less than the compacted partition minimum bytes * Depended on the compaction strategy </summary><br><b> </b></details> ## HTTP <details> <summary>What is HTTP?</summary><br><b> [Avinetworks](https://avinetworks.com/glossary/layer-7/): HTTP stands for Hypertext Transfer Protocol. HTTP uses TCP port 80 to enable internet communication. It is part of the Application Layer (L7) in OSI Model. </b></details> <details> <summary>Describe HTTP request lifecycle</summary><br><b> * Resolve host by request to DNS resolver * Client SYN * Server SYN+ACK * Client SYN * HTTP request * HTTP response </b></details> <details> <summary>True or False? HTTP is stateful</summary><br><b> False. It doesn't maintain state for incoming request. </b></details> <details> <summary>How HTTP request looks like?</summary><br><b> It consists of: * Request line - request type * Headers - content info like length, enconding, etc. * Body (not always included) </b></details> <details> <summary>What HTTP method types are there?</summary><br><b> * GET * POST * HEAD * PUT * DELETE * CONNECT * OPTIONS * TRACE </b></details> <details> <summary>What HTTP response codes are there?</summary><br><b> * 1xx - informational * 2xx - Success * 3xx - Redirect * 4xx - Error, client fault * 5xx - Error, server fault </b></details> <details> <summary>What is HTTPS?</summary><br><b> </b></details> <details> <summary>Explain HTTP Cookies</summary><br><b> HTTP is stateless. To share state, we can use Cookies. TODO: explain what is actually a Cookie </b></details> <details> <summary>What is HTTP Pipelining?</summary><br><b> </b></details> <details> <summary>You get "504 Gateway Timeout" error from an HTTP server. What does it mean?</summary><br><b> The server didn't receive a response from another server it communicates with in a timely manner. </b></details> <details> <summary>What is a proxy?</summary><br><b> </b></details> <details> <summary>What is a reverse proxy?</summary><br><b> </b></details> <details> <summary>When you publish a project, you usually publish it with a license. What types of licenses are you familiar with and which one do you prefer to use?</summary><br><b> </b></details> <details> <summary>Explain what is "X-Forwarded-For"</summary><br><b> [Wikipedia](https://en.wikipedia.org/wiki/X-Forwarded-For): "The X-Forwarded-For (XFF) HTTP header field is a common method for identifying the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer." </b></details> #### Load Balancers <details> <summary>What is a load balancer?</summary><br><b> A load balancer accepts (or denies) incoming network traffic from a client, and based on some criteria (application related, network, etc.) it distributes those communications out to servers (at least one). </b></details> <details> <summary>Why to used a load balancer?</summary><br><b> * Scalability - using a load balancer, you can possibly add more servers in the backend to handle more requests/traffic from the clients, as opposed to using one server. * Redundancy - if one server in the backend dies, the load balancer will keep forwarding the traffic/requests to the second server so users won't even notice one of the servers in the backend is down. </b></details> <details> <summary>What load balancer techniques/algorithms are you familiar with?</summary><br><b> * Round Robin * Weighted Round Robin * Least Connection * Weighted Least Connection * Resource Based * Fixed Weighting * Weighted Response Time * Source IP Hash * URL Hash </b></details> <details> <summary>What are the drawbacks of round robin algorithm in load balancing?</summary><br><b> * A simple round robin algorithm knows nothing about the load and the spec of each server it forwards the requests to. It is possible, that multiple heavy workloads requests will get to the same server while other servers will got only lightweight requests which will result in one server doing most of the work, maybe even crashing at some point because it unable to handle all the heavy workloads requests by its own. * Each request from the client creates a whole new session. This might be a problem for certain scenarios where you would like to perform multiple operations where the server has to know about the result of operation so basically, being sort of aware of the history it has with the client. In round robin, first request might hit server X, while second request might hit server Y and ask to continue processing the data that was processed on server X already. </b></details> <details> <summary>What is an Application Load Balancer?</summary><br><b> </b></details> <details> <summary>In which scenarios would you use ALB?</summary><br><b> </b></details> <details> <summary>At what layers a load balancer can operate?</summary><br><b> L4 and L7 </b></details> <details> <summary>Can you perform load balancing without using a dedicated load balancer instance?</summary><br><b> Yes, you can use DNS for performing load balancing. </b></details> <details> <summary>What is DNS load balancing? What its advantages? When would you use it?</summary><br><b> </b></details> #### Load Balancers - Sticky Sessions <details> <summary>What are sticky sessions? What are their pros and cons?</summary><br><b> Recommended read: * [Red Hat Article](https://access.redhat.com/solutions/900933) Cons: * Can cause uneven load on instance (since requests routed to the same instances) Pros: * Ensures in-proc sessions are not lost when a new request is created </b></details> <details> <summary>Name one use case for using sticky sessions</summary><br><b> You would like to make sure the user doesn't lose the current session data. </b></details> <details> <summary>What sticky sessions use for enabling the "stickiness"?</summary><br><b> Cookies. There are application based cookies and duration based cookies. </b></details> <details> <summary>Explain application-based cookies</summary><br><b> * Generated by the application and/or the load balancer * Usually allows to include custom data </b></details> <details> <summary>Explain duration-based cookies</summary><br><b> * Generated by the load balancer * Session is not sticky anymore once the duration elapsed </b></details> #### Load Balancers - Load Balancing Algorithms <details> <summary>Explain each of the following load balancing techniques * Round Robin * Weighted Round Robin * Least Connection * Weighted Least Connection * Resource Based * Fixed Weighting * Weighted Response Time * Source IP Hash * URL Hash </summary><br><b> </b></details> <details> <summary>Explain use case for connection draining?</summary><br><b> To ensure that a Classic Load Balancer stops sending requests to instances that are de-registering or unhealthy, while keeping the existing connections open, use connection draining. This enables the load balancer to complete in-flight requests made to instances that are de-registering or unhealthy. The maximum timeout value can be set between 1 and 3,600 seconds on both GCP and AWS. </b></details> #### Licenses <details> <summary>Are you familiar with "Creative Commons"? What do you know about it?</summary><br><b> </b></details> <details> <summary>Explain the differences between copyleft and permissive licenses</summary><br><b> In Copyleft, any derivative work must use the same licensing while in permissive licensing there are no such condition. GPL-3 is an example of copyleft license while BSD is an example of permissive license. </b></details> #### Random <details> <summary>How a search engine works?</summary><br><b> </b></details> <details> <summary>How auto completion works?</summary><br><b> </b></details> <details> <summary>What is faster than RAM?</summary><br><b> CPU cache. [Source](https://www.enterprisestorageforum.com/hardware/cache-memory/) </b></details> <details> <summary>What is a memory leak?</summary><br><b> </b></details> <details> <summary>What is your favorite protocol?</summary><br><b> SSH HTTP DHCP DNS ... </b></details> <details> <summary>What is Cache API?</summary><br><b> </b></details> <details> <summary>What is the C10K problem? Is it relevant today?</summary><br><b> https://idiallo.com/blog/c10k-2016 </b></details> ## Storage <details> <summary>What types of storage are there?</summary><br><b> * File * Block * Object </b></details> <details> <summary>Explain Object Storage</summary><br><b> - Data is divided to self-contained objects - Objects can contain metadata </b></details> <details> <summary>What are the pros and cons of object storage?</summary><br><b> Pros: - Usually with object storage, you pay for what you use as opposed to other storage types where you pay for the storage space you allocate - Scalable storage: Object storage mostly based on a model where what you use, is what you get and you can add storage as need Cons: - Usually performs slower than other types of storage - No granular modification: to change an object, you have re-create it </b></details> <details> <summary>What are some use cases for using object storage?</summary><br><b> </b></details> <details> <summary>Explain File Storage</summary><br><b> - File Storage used for storing data in files, in a hierarchical sturcture - Some of the devices for file storage: hard drive, flash drive, cloud-based file storage - Files usually organized in directories </b></details> <details> <summary>What are the pros and cons of File Storage?</summary><br><b> Pros: - Users have full control of their own files and can run variety of operations on the files: delete, read, write and move. - Security mechanism allows for users to have a better control at things such as file locking </b></details> <details> <summary>What are some examples of file storage?</summary><br><b> Local filesystem Dropbox Google Drive </b></details> <details> <summary>What types of storage devices are there?</summary><br><b> </b></details> <details> <summary>Explain IOPS</summary><br><b> </b></details> <details> <summary>Explain storage throughput</summary><br><b> </b></details> <details> <summary>What is a filesystem?</summary><br><b> </b></details> <details> <summary>Explain Dark Data</summary><br><b> </b></details> <details> <summary>Explain MBR</summary><br><b> </b></details> <a name="questions-you-ask"></a> ## Questions you CAN ask A list of questions you as a candidate can ask the interviewer during or after the interview. These are only a suggestion, use them carefully. Not every interviewer will be able to answer these (or happy to) which should be perhaps a red flag warning for your regarding working in such place but that's really up to you. <details> <summary>What do you like about working here?</summary><br><b> </b></details> <details> <summary>How does the company promote personal growth?</summary><br><b> </b></details> <details> <summary>What is the current level of technical debt you are dealing with?</summary><br><b> Be careful when asking this question - all companies, regardless of size, have some level of tech debt. Phrase the question in the light that all companies have the deal with this, but you want to see the current pain points they are dealing with <br> This is a great way to figure how managers deal with unplanned work, and how good they are at setting expectations with projects. </b></details> <details> <summary>Why I should NOT join you? (or 'what you don't like about working here?')</summary><br><b> </b></details> <details> <summary>What was your favorite project you've worked on?</summary><br><b> This can give you insights in some of the cool projects a company is working on, and if you would enjoy working on projects like these. This is also a good way to see if the managers are allowing employees to learn and grow with projects outside of the normal work you'd do. </b></details> <details> <summary>If you could change one thing about your day to day, what would it be?</summary><br><b> Similar to the tech debt question, this helps you identify any pain points with the company. Additionally, it can be a great way to show how you'd be an asset to the team.<br> For Example, if they mention they have problem X, and you've solved that in the past, you can show how you'd be able to mitigate that problem. </b></details> <details> <summary>Let's say that we agree and you hire me to this position, after X months, what do you expect that I have achieved?</summary><br><b> Not only this will tell you what is expected from you, it will also provide big hint on the type of work you are going to do in the first months of your job. </b></details> ## Testing <details> <summary>Explain white-box testing</summary><br><b> </b></details> <details> <summary>Explain black-box testing</summary><br><b> </b></details> <details> <summary>What are unit tests?</summary><br><b> </b></details> <details> <summary>What types of tests would you run to test a web application?</summary><br><b> </b></details> <details> <summary>Explain test harness?</summary><br><b> </b></details> <details> <summary>What is A/B testing?</summary><br><b> </b></details> <details> <summary>What is network simulation and how do you perform it?</summary><br><b> </b></details> <details> <summary>What types of performances tests are you familiar with?</summary><br><b> </b></details> <details> <summary>Explain the following types of tests: * Load Testing * Stress Testing * Capacity Testing * Volume Testing * Endurance Testing </summary><br><b> </b></details> ## Databases |Name|Topic|Objective & Instructions|Solution|Comments| |--------|--------|------|----|----| | Message Board Tables | Relational DB Tables | [Exercise](topics/databases/table_for_message_board_system.md) | [Solution](topics/databases/solutions/table_for_message_board_system.md) <details> <summary>What is a relational database?</summary><br><b> * Data Storage: system to store data in tables * SQL: programming language to manage relational databases * Data Definition Language: a standard syntax to create, alter and delete tables </b></details> <details> <summary>What does it mean when a database is ACID compliant?</summary><br> ACID stands for Atomicity, Consistency, Isolation, Durability. In order to be ACID compliant, the database must meet each of the four criteria **Atomicity** - When a change occurs to the database, it should either succeed or fail as a whole. For example, if you were to update a table, the update should completely execute. If it only partially executes, the update is considered failed as a whole, and will not go through - the DB will revert back to it's original state before the update occurred. It should also be mentioned that Atomicity ensures that each transaction is completed as it's own stand alone "unit" - if any part fails, the whole statement fails. **Consistency** - any change made to the database should bring it from one valid state into the next. For example, if you make a change to the DB, it shouldn't corrupt it. Consistency is upheld by checks and constraints that are pre-defined in the DB. For example, if you tried to change a value from a string to an int when the column should be of datatype string, a consistent DB would not allow this transaction to go through, and the action would not be executed **Isolation** - this ensures that a database will never be seen "mid-update" - as multiple transactions are running at the same time, it should still leave the DB in the same state as if the transactions were being run sequentially. For example, let's say that 20 other people were making changes to the database at the same time. At the time you executed your query, 15 of the 20 changes had gone through, but 5 were still in progress. You should only see the 15 changes that had completed - you wouldn't see the database mid-update as the change goes through. **Durability** - Once a change is committed, it will remain committed regardless of what happens (power failure, system crash, etc.). This means that all completed transactions must be recorded in non-volatile memory. Note that SQL is by nature ACID compliant. Certain NoSQL DB's can be ACID compliant depending on how they operate, but as a general rule of thumb, NoSQL DB's are not considered ACID compliant </details> <details> <summary>What is sharding?</summary><br><b> Sharding is a horizontal partitioning. Are you able to explain what is it good for? </b></details> <details> <summary>You find out your database became a bottleneck and users experience issues accessing data. How can you deal with such situation?</summary><br><b> Not much information provided as to why it became a bottleneck and what is current architecture, so one general approach could be<br> to reduce the load on your database by moving frequently-accessed data to in-memory structure. </b></details> <details> <summary>What is a connection pool?</summary><br><b> Connection Pool is a cache of database connections and the reason it's used is to avoid an overhead of establishing a connection for every query done to a database. </b></details> <details> <summary>What is a connection leak?</summary><br><b> A connection leak is a situation where database connection isn't closed after being created and is no longer needed. </b></details> <details> <summary>What is Table Lock?</summary><br><b> </b></details> <details> <summary>Your database performs slowly than usual. More specifically, your queries are taking a lot of time. What would you do?</summary><br><b> * Query for running queries and cancel the irrelevant queries * Check for connection leaks (query for running connections and include their IP) * Check for table locks and kill irrelevant locking sessions </b></details> <details> <summary>What is a Data Warehouse?</summary><br><b> "A data warehouse is a subject-oriented, integrated, time-variant and non-volatile collection of data in support of organisation's decision-making process" </b></details> <details> <summary>Explain what is a time-series database</summary><br><b> </b></details> <details> <summary>What is OLTP (Online transaction processing)?</summary><br><b> </b></details> <details> <summary>What is OLAP (Online Analytical Processing)?</summary><br><b> </b></details> <details> <summary>What is an index in a database?</summary><br><b> A database index is a data structure that improves the speed of operations in a table. Indexes can be created using one or more columns, providing the basis for both rapid random lookups and efficient ordering of access to records. </b></details> <details> <summary>What data types are there in relational databases?</summary><br><b> </b></details> <details> <summary>Explain Normalization</summary><br><b> Data that is used multiple times in a database should be stored once and referenced with a foreign key.<br> This has the clear benefit of ease of maintenance where you need to change a value only in a single place to change it everywhere. </b></details> <details> <summary>Explain Primary Key and Foreign Key</summary><br><b> Primary Key: each row in every table should a unique identifier that represents the row.<br> Foreign Key: a reference to another table's primary key. This allows you to join table together to retrieve all the information you need without duplicating data. </b></details> <details> <summary>What types of data tables have you used?</summary><br><b> * Primary data table: main data you care about * Details table: includes a foreign key and has one to many relationship * Lookup values table: can be one table per lookup or a table containing all the lookups and has one to many relationship * Multi reference table </b></details> <details> <summary>What is ORM? What benefits it provides in regards to relational databases usage?</summary><br><b> [Wikipedia](https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping): "is a programming technique for converting data between incompatible type systems using object-oriented programming languages" In regards to the relational databases: * Database as code * Database abstraction * Encapsulates SQL complexity * Enables code review process * Enables usage as a native OOP structure </b></details> <details> <summary>What is DDL?</summary><br><b> [Wikipedia](https://en.wikipedia.org/wiki/Data_definition_language): "In the context of SQL, data definition or data description language (DDL) is a syntax for creating and modifying database objects such as tables, indices, and users." </b></details> ## Regex Given a text file, perform the following exercises #### Extract <details> <summary>Extract all the numbers</summary><br><b> </b></details> <details> <summary>Extract the first word of each line</summary><br><b> Bonus: extract the last word of each line </b></details> <details> <summary>Extract all the IP addresses</summary><br><b> </b></details> <details> <summary>Extract dates in the format of yyyy-mm-dd or yyyy-dd-mm</summary><br><b> </b></details> <details> <summary>Extract email addresses</summary><br><b> </b></details> #### Replace <details> <summary>Replace tabs with four spaces</summary><br><b> </b></details> <details> <summary>Replace 'red' with 'green'</summary><br><b> </b></details> ## System Design <details> <summary>Explain what is a "Single point of failure"?</summary><br><b> </b></details> <details> <summary>What is CDN?</summary><br><b> CDN (Content Delivery Network) responsible for distributing content geographically. Part of it, is what is known as edge locations, aka cache proxies, that allows users to get their content quickly due to cache features and geographical distribution. </b></details> <details> <summary>Explain Multi-CDN</summary><br><b> In single CDN, the whole content is originated from content delivery network.<br> In multi-CDN, content is distributed across multiple different CDNs, each might be on a completely different provider/cloud. </b></details> <details> <summary>What are the benefits of Multi-CDN over a single CDN?</summary><br><b> * Resiliency: Relying on one CDN means no redundancy. With multiple CDNs you don't need to worry about your CDN being down * Flexibility in Costs: Using one CDN enforces you to specific rates of that CDN. With multiple CDNs you can take into consideration using less expensive CDNs to deliver the content. * Performance: With Multi-CDN there is bigger potential in choosing better locations which more close to the client asking the content * Scale: With multiple CDNs, you can scale services to support more extreme conditions </b></details> <details> <summary>Explain "3-Tier Architecture" (including pros and cons)</summary><br><b> </b></details> <details> <summary>Explain Mono-repo vs. Multi-repo. What are the cons and pros of each approach?</summary><br><b> </b></details> <details> <summary>What are the drawbacks of monolithic architecture?</summary><br><b> * Not suitable for frequent code changes and the ability to deploy new features * Not designed for today's infrastructure (like public clouds) * Scaling a team to work monolithic architecture is more challenging </b></details> <details> <summary>What are the advantages of microservices architecture over a monolithic architecture?</summary><br><b> * Each of the services individually fail without escalating into an application-wide outage. * Each service can be developed and maintained by a separate team and this team can choose its own tools and coding language </b></details> <details> <summary>What's a service mesh?</summary><br><b> [This article](https://www.redhat.com/en/topics/microservices/what-is-a-service-mesh) provides a great explanation. </b></details> <details> <summary>Explain "Loose Coupling"</summary><br><b> </b></details> <details> <summary>What is a message queue? When is it used?</summary><br><b> </b></details> #### Scalability <details> <summary>Explain Scalability</summary><br><b> The ability easily grow in size and capacity based on demand and usage. </b></details> <details> <summary>Explain Elasticity</summary><br><b> The ability to grow but also to reduce based on what is required </b></details> <details> <summary>Explain Disaster Recovery</summary><br><b> </b></details> <details> <summary>Explain Fault Tolerance and High Availability</summary><br><b> Fault Tolerance - The ability to self-heal and return to normal capacity. Also the ability to withstand a failure and remain functional. High Availability - Being able to access a resource (in some use cases, using different platforms) </b></details> <details> <summary>What is the difference between high availability and Disaster Recovery?</summary><br><b> [wintellect.com](https://www.wintellect.com/high-availability-vs-disaster-recovery): "High availability, simply put, is eliminating single points of failure and disaster recovery is the process of getting a system back to an operational state when a system is rendered inoperative. In essence, disaster recovery picks up when high availability fails, so HA first." </b></details> <details> <summary>Explain Vertical Scaling</summary><br><b> Vertical Scaling is the process of adding resources to increase power of existing servers. For example, adding more CPUs, adding more RAM, etc. </b></details> <details> <summary>What are the disadvantages of Vertical Scaling?</summary><br><b> With vertical scaling alone, the component still remains a single point of failure. In addition, it has hardware limit where if you don't have more resources, you might not be able to scale vertically. </b></details> <details> <summary>Which type of cloud services usually support vertical scaling?</summary><br><b> Databases, cache. It's common mostly for non-distributed systems. </b></details> <details> <summary>Explain Horizontal Scaling</summary><br><b> Horizontal Scaling is the process of adding more resources that will be able handle requests as one unit </b></details> <details> <summary>What is the disadvantage of Horizontal Scaling? What is often required in order to perform Horizontal Scaling?</summary><br><b> A load balancer. You can add more resources, but if you would like them to be part of the process, you have to serve them the requests/responses. Also, data inconsistency is a concern with horizontal scaling. </b></details> <details> <summary>Explain in which use cases will you use vertical scaling and in which use cases you will use horizontal scaling</summary><br><b> </b></details> <details> <summary>Explain Resiliency and what ways are there to make a system more resilient</summary><br><b> </b></details> <details> <summary>Explain "Consistent Hashing"</summary><br><b> </b></details> <details> <summary>How would you update each of the services in the following drawing without having app (foo.com) downtime?<br> <img src="images/design/cdn-no-downtime.png" width="300x;" height="400px;"/> </summary><br><b> </b></details> <details> <summary>What is the problem with the following architecture and how would you fix it?<br> <img src="images/design/producers_consumers_issue.png" width="400x;" height="300px;"/> </summary><br><b> The load on the producers or consumers may be high which will then cause them to hang or crash.<br> Instead of working in "push mode", the consumers can pull tasks only when they are ready to handle them. It can be fixed by using a streaming platform like Kafka, Kinesis, etc. This platform will make sure to handle the high load/traffic and pass tasks/messages to consumers only when the ready to get them. <img src="images/design/producers_consumers_fix.png" width="300x;" height="200px;"/> </b></details> <details> <summary>Users report that there is huge spike in process time when adding little bit more data to process as an input. What might be the problem?<br> <img src="images/design/input-process-output.png" width="300x;" height="200px;"/> </summary><br><b> </b></details> <details> <summary>How would you scale the architecture from the previous question to hundreds of users?</summary><br><b> </b></details> #### Cache <details> <summary>What is "cache"? In which cases would you use it?</summary><br><b> </b></details> <details> <summary>What is "distributed cache"?</summary><br><b> </b></details> <details> <summary>What is a "cache replacement policy"?</summary><br><b> Take a look [here](https://en.wikipedia.org/wiki/Cache_replacement_policies) </b></details> <details> <summary>Which cache replacement policies are you familiar with?</summary><br><b> You can find a list [here](https://en.wikipedia.org/wiki/Cache_replacement_policies) </b></details> <details> <summary>Explain the following cache policies: * FIFO * LIFO * LRU</summary><br><b> Read about it [here](https://en.wikipedia.org/wiki/Cache_replacement_policies) </b></details> <details> <summary>Why not writing everything to cache instead of a database/datastore?</summary><br><b> </b></details> #### Migrations <details> <summary>How you prepare for a migration? (or plan a migration)</summary><br><b> You can mention: roll-back & roll-forward cut over dress rehearsals DNS redirection </b></details> <details> <summary>Explain "Branch by Abstraction" technique</summary><br><b> </b></details> #### Design a system <details> <summary>Can you design a video streaming website?</summary><br><b> </b></details> <details> <summary>Can you design a photo upload website?</summary><br><b> </b></details> <details> <summary>How would you build a URL shortener?</summary><br><b> </b></details> #### More System Design Questions Additional exercises can be found in [system-design-notebook repository](https://github.com/bregman-arie/system-design-notebook). <p align="center"><a href="https://github.com/bregman-arie/system-design-notebook"><img src="images/system_design_notebook.png"/></a></p> ## Hardware <details> <summary>What is a CPU?</summary><br><b> A central processing unit (CPU) performs basic arithmetic, logic, controlling, and input/output (I/O) operations specified by the instructions in the program. This contrasts with external components such as main memory and I/O circuitry, and specialized processors such as graphics processing units (GPUs). </b></details> <details> <summary>What is RAM?</summary><br><b> RAM (Random Access Memory) is the hardware in a computing device where the operating system (OS), application programs and data in current use are kept so they can be quickly reached by the device's processor. RAM is the main memory in a computer. It is much faster to read from and write to than other kinds of storage, such as a hard disk drive (HDD), solid-state drive (SSD) or optical drive. </b></details> <details> <summary>What is an embedded system?</summary><br><b> An embedded system is a computer system - a combination of a computer processor, computer memory, and input/output peripheral devices—that has a dedicated function within a larger mechanical or electronic system. It is embedded as part of a complete device often including electrical or electronic hardware and mechanical parts. </b></details> <details> <summary>Can you give an example of an embedded system?</summary><br><b> Raspberry Pi </b></details> <details> <summary>What types of storage are there?</summary><br><b> </b></details> ## Big Data <details> <summary>Explain what is exactly Big Data</summary><br><b> As defined by Doug Laney: * Volume: Extremely large volumes of data * Velocity: Real time, batch, streams of data * Variety: Various forms of data, structured, semi-structured and unstructured * Veracity or Variability: Inconsistent, sometimes inaccurate, varying data </b></details> <details> <summary>What is DataOps? How is it related to DevOps?</summary><br><b> DataOps seeks to reduce the end-to-end cycle time of data analytics, from the origin of ideas to the literal creation of charts, graphs and models that create value. DataOps combines Agile development, DevOps and statistical process controls and applies them to data analytics. </b></details> <details> <summary>What is Data Architecture?</summary><br><b> An answer from [talend.com](https://www.talend.com/resources/what-is-data-architecture): "Data architecture is the process of standardizing how organizations collect, store, transform, distribute, and use data. The goal is to deliver relevant data to people who need it, when they need it, and help them make sense of it." </b></details> <details> <summary>Explain the different formats of data</summary><br><b> * Structured - data that has defined format and length (e.g. numbers, words) * Semi-structured - Doesn't conform to a specific format but is self-describing (e.g. XML, SWIFT) * Unstructured - does not follow a specific format (e.g. images, test messages) </b></details> <details> <summary>What is a Data Warehouse?</summary><br><b> [Wikipedia's explanation on Data Warehouse](https://en.wikipedia.org/wiki/Data_warehouse) [Amazon's explanation on Data Warehouse](https://aws.amazon.com/data-warehouse) </b></details> <details> <summary>What is Data Lake?</summary><br><b> [Data Lake - Wikipedia](https://en.wikipedia.org/wiki/Data_lake) </b></details> <details> <summary>Can you explain the difference between a data lake and a data warehouse?</summary><br><b> </b></details> <details> <summary>What is "Data Versioning"? What models of "Data Versioning" are there?</summary><br><b> </b></details> <details> <summary>What is ETL?</summary><br><b> </b></details> #### Apache Hadoop <details> <summary>Explain what is Hadoop</summary><br><b> [Apache Hadoop - Wikipedia](https://en.wikipedia.org/wiki/Apache_Hadoop) </b></details> <details> <summary>Explain Hadoop YARN</summary><br><b> Responsible for managing the compute resources in clusters and scheduling users' applications </b></details> <details> <summary>Explain Hadoop MapReduce</summary><br><b> A programming model for large-scale data processing </b></details> <details> <summary>Explain Hadoop Distributed File Systems (HDFS)</summary><br><b> * Distributed file system providing high aggregate bandwidth across the cluster. * For a user it looks like a regular file system structure but behind the scenes it's distributed across multiple machines in a cluster * Typical file size is TB and it can scale and supports millions of files * It's fault tolerant which means it provides automatic recovery from faults * It's best suited for running long batch operations rather than live analysis </b></details> <details> <summary>What do you know about HDFS architecture?</summary><br><b> [HDFS Architecture](http://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html) * Master-slave architecture * Namenode - master, Datanodes - slaves * Files split into blocks * Blocks stored on datanodes * Namenode controls all metadata </b></details> ## Ceph <details> <summary>Explain what is Ceph</summary><br><b> </b></details> <details> <summary>True or False? Ceph favor consistency and correctness over performances</summary><br><b> True </b></details> <details> <summary>Which services or types of storage Ceph supports?</summary><br><b> * Object (RGW) * Block (RBD) * File (CephFS) </b></details> <details> <summary>What is RADOS?</summary><br><b> * Reliable Autonomic Distributed Object Storage * Provides low-level data object storage service * Strong Consistency * Simplifies design and implementation of higher layers (block, file, object) </b></details> <details> <summary>Describe RADOS software components</summary><br><b> * Monitor * Central authority for authentication, data placement, policy * Coordination point for all other cluster components * Protect critical cluster state with Paxos * Manager * Aggregates real-time metrics (throughput, disk usage, etc.) * Host for pluggable management functions * 1 active, 1+ standby per cluster * OSD (Object Storage Daemon) * Stores data on an HDD or SSD * Services client IO requests </b></details> <details> <summary>What is the workflow of retrieving data from Ceph?</summary><br><b> </b></details> <details> <summary>What is the workflow of retrieving data from Ceph?</summary><br><b> </b></details> <details> <summary>What are "Placement Groups"?</summary><br><b> </b></details> <details> <summary>Describe in the detail the following: Objects -> Pool -> Placement Groups -> OSDs</summary><br><b> </b></details> <details> <summary>What is OMAP?</summary><br><b> </b></details> <details> <summary>What is a metadata server? How it works?</summary><br><b> </b></details> ## Packer <details> <summary>What is Packer? What is it used for?</summary><br><b> In general, Packer automates machine images creation. It allows you to focus on configuration prior to deployment while making the images. This allows you start the instances much faster in most cases. </b></details> <details> <summary>Packer follows a "configuration->deployment" model or "deployment->configuration"?</summary><br><b> A configuration->deployment which has some advantages like: 1. Deployment Speed - you configure once prior to deployment instead of configuring every time you deploy. This allows you to start instances/services much quicker. 2. More immutable infrastructure - with configuration->deployment it's not likely to have very different deployments since most of the configuration is done prior to the deployment. Issues like dependencies errors are handled/discovered prior to deployment in this model. </b></details> ## Release <details> <summary>Explain Semantic Versioning</summary><br><b> [This](https://semver.org/) page explains it perfectly: ``` Given a version number MAJOR.MINOR.PATCH, increment the: MAJOR version when you make incompatible API changes MINOR version when you add functionality in a backwards compatible manner PATCH version when you make backwards compatible bug fixes Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. ``` </b></details> ## Certificates If you are looking for a way to prepare for a certain exam this is the section for you. Here you'll find a list of certificates, each references to a separate file with focused questions that will help you to prepare to the exam. Good luck :) #### AWS * [Cloud Practitioner](certificates/aws-cloud-practitioner.md) (Latest update: 2020) * [Solutions Architect Associate](certificates/aws-solutions-architect-associate.md) (Latest update: 2021) * [Cloud SysOps Administration Associate](certificates/aws-cloud-sysops-associate.md) (Latest update: Oct 2022) #### Azure * [AZ-900](certificates/azure-fundamentals-az-900.md) (Latest update: 2021) #### Kubernetes * [Certified Kubernetes Administrator (CKA)](topics/kubernetes/CKA.md) (Latest update: 2022) ## Additional DevOps and SRE Projects <p align="center"><a href="https://github.com/bregman-arie/sre-checklist"><img width="500px" src="images/sre_checklist.png"/></a></p> <p align="center"><a href="https://github.com/bregman-arie/howtheydevops"><img src="images/how_they_devops.png"/></a></p> <p align="center"><a href="https://github.com/bregman-arie/devops-resources"><img src="images/devops_resources.png"/></a></p> <p align="center"><a href="https://github.com/bregman-arie/infraverse"><img src="images/infraverse.png"/></a></p> ## Credits Thanks to all of our amazing [contributors](https://github.com/bregman-arie/devops-exercises/graphs/contributors) who make it easy for everyone to learn new things :) Logos credits can be found [here](credits.md) ## License [](https://creativecommons.org/licenses/by-nc-nd/3.0/)

: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.

Themes based on the biggest StartUps (buttons, color palette, components, etc.) ready to use in your own projects.

<h3 align="center"> <img width="200" src="https://cdn.rawgit.com/sergioruizdavila/startups-themes/f14c6e27/www/assets/images/Steroidesign.png" alt="Steroidesign"> </h3> <h1 align="center" style="border:0;"> <b>Make your projects look as good 💎 as the big ones 💪🏻</b> </h1> <br> <h3 align="center"> 🚀 Join to the <a href="http://eepurl.com/cWWRrD">Steroidesign Weekly</a> newsletter! 🚀 <br> We'll submit a new theme every week (we know it's crazy, but it's not impossible 😵). </h3> <h3 align="center">Show us your interest by signing up, so we'll know that there are people interested in this.</h3> <br> <p align="center"> Made with ❤ & ☕ by <a href="https://www.twitter.com/rosa7082" target="_blank">@rosa7082</a> & <a href="https://www.twitter.com/seruda" target="_blank">@seruda</a> in <a href="https://www.google.com/maps/place/Portland,OR" target="_blank">Portland, OR</a> . </p> <br> ## Problem Whenever we start a new project, we spend a lot of time looking for inspiration on hundreds of websites, we take a little of each, and so we build our beloved Frankenstein 🤖. Our most important references are the most well-known Startups (Airbnb, Medium, Product Hunt, etc) as they have invested a lot of time in analyzing the best practices of design, validation of ideas, calls to action, hook, etc. And over time have been creating standards and trends. <br> ## Solution Since many are looking for these sites, we decided to create a skeleton of HTML styles and components based on these big companies, themes that are 100% editable and adaptable to your own palette color or styles, adding your own magic 🔮!. So that your product remains authentic and unique. **With this, we do not seek to copy the big companies, but to obtain inspiration and have its base for our own projects.** The themes include the basic elements in a website: buttons, labels, links, typography, form elements, box components, search bar, navbars, etc, etc, etc. Contributions are more than welcome. <br> ## Contents - [Base Methodology](#base-methodology) - [Installation and use](#installation-and-use) - [Themes](#themes) - [Airbnb](https://github.com/sergioruizdavila/startups-themes/blob/master/Airbnb.md) **(Done v.1.0.0)** - [Medium](#medium) (In Progress) - [Product Hunt](#product-hunt) (Coming soon) - [Asana](#asana) (Coming soon) - [Suggest us the next one](#suggest-us-the-next-one) - [License](#license) <br> ## Base methodology For our own components, follow the BEM (Block, Element, Modifier) method for writing & organising CSS. BEM helps keep our CSS logical and predictable. The naming convention follows this pattern: ```css .block {} .block__element {} .block__element--modifier {} ``` - ```.block``` represents the higher level of an abstraction or component. - ```.block__element``` represents a descendent of .block that helps form .block as a whole. - ```.block--modifier``` represents a different state or version of .block. ### more references: - [http://getbem.com/introduction/](http://getbem.com/introduction/) - [https://www.toptal.com/css/introduction-to-bem-methodology](https://www.toptal.com/css/introduction-to-bem-methodology) <br> --- <br> ## Installation and use <h3 align="center"> <img src="https://raw.githubusercontent.com/sergioruizdavila/startups-themes/develop/www/assets/images/compare%20themes.png" alt="compare"> </h3> <br> ### Install Really you don´t need an **'installation'**, you just could clone the project, take the 'theme' folder and you are able to start. The only tools that you need to use these themes are: - **Sass** - **Boostrap v3.3.7** *(to keep row and column structure, but you can feel free to use another library for that, the only issue is that you could see the components examples in index HTML a little bit wrong, because we use bootstrap to arrange each component inside row and column grids).* <br> #### If you want to run the demo page, you should follow this steps: **1:** Install NodeJS v6 or latest (Not sure if there is any problem with previous versions, but this is the one we use). **2:** On terminal (inside root directory) run the following commands: 1. Clone the project. ``` git clone https://github.com/sergioruizdavila/startups-themes.git projectname ``` 2. Install gulp, bower and express components: ```shell npm install ``` 3. Install basic components such as boostrap, jquery, animate.css: ```shell bower install ``` 4. Launch a local server in order to see styles guideline: ```shell gulp start ``` **3:** Open your favorite browser, and browse to: **http://localhost:8080/** There you can see whole styles guidelinein in a demo page. <br> ### How to use? It's very simple, you have to copy the **theme** folder into your own project, inside you will find all styles organized by **components**, and a folder named **core** which contains all global styles and variables (e.g. main palette, helper classes, font family, etc.). <h3 align="center"> <img src="https://cdn.rawgit.com/sergioruizdavila/startups-themes/56d23613/www/assets/images/structure_files.png" alt="structure files"> </h3> **The file structure is:** - ***components:*** A folder containing all styles of each component (buttons, links, forms, paragraphs, inputs, etc.) - ***core:*** Here are all the base styles of your project, here you find a file named **_global.scss** which contains all the global variables, helper classes, and base classes to reset the styles of some global elements such as the body, H tags, labels, etc. - ***app.scss:*** This is the parent file which contains a reference to all other styles: <h3 align="center"> <img src="https://cdn.rawgit.com/sergioruizdavila/startups-themes/d6b7a6e5/www/assets/images/app_file.png" alt="app file"> </h3> - **app.min.css:** It's the final result after running a small task in Gulp, compile it, concatenates and minifies every style in a single file. This is the file you should add in the **< head >** html section. ```html <! your vendors > <link rel="stylesheet" href="/build/css/vendor.min.css"> <! theme styles > <link rel="stylesheet" href="/theme/app.css"> ``` - **app.css**: If you don't use Sass or another preprocessor, don't worry you can take this file and include it into your own project, and you could use any of the components freely. <br> You can also see examples of all components on **index.html**. You will see all the components organized by groups, you can simply take the component you need, and take it to your own project. Any questions please write us: [@rosa7082](https://www.twitter.com/rosa7082) & [@seruda](https://www.twitter.com/seruda) **Enjoy it!** <br> ## Themes ### Airbnb Status: **[See components (v1.0.0)](https://github.com/sergioruizdavila/startups-themes/blob/master/Airbnb.md)** We used this theme in other own project: [http://www.waysily.com](http://www.waysily.com) <h3 align="center"> <img width="500" src="https://cdn.rawgit.com/sruda/steroidesign/967bcd2f/www/assets/images/waysily-example.png" alt="compare"> </h3> ### Medium Status: ***In Progress*** ### Product Hunt Status: ***Coming soon*** ### Asana Status: ***Coming soon*** <br> ## Suggest us the next one We started working on the themes that we believe would be the most beautiful and complete. But if you want us to start in a more great one, just let us know: [@rosa7082](https://www.twitter.com/rosa7082) & [@seruda](https://www.twitter.com/seruda), or by email: [Rosita](mailto:[email protected]) & [Sergio](mailto:[email protected]). You can write us if you'd like to talk to us. <br> ## License [](https://creativecommons.org/publicdomain/zero/1.0/) **Important:** Themes are not a copy, we write styles and structure from scratch, based on our own file structure and our own way of organizing styles (based n the [BEM methodology](https://en.bem.info/)), what we want with this is to create a 'skeleton' that can be used, edited, modified and replaced in any project. We are not responsible for misinterpretation or inappropriate use of this content and information. In the same way, we will not be responsible for the damages caused directly or indirectly by the using of this material. In no way are we liable for the consequences of the improper or negligent use of this material.

Advanced workflows and setup for building rock-solid Ionic apps

## We moved on! This project is not longer maintained from our side. It is still here for sake of completness. # Generator-M-Ionic [][npm-url] [][coveralls-url] [][travis-url] [][daviddm-url] [][npm-url] [npm-url]: https://npmjs.org/package/generator-m-ionic [coveralls-url]: https://coveralls.io/r/mwaylabs/generator-m-ionic?branch=master [travis-url]: https://travis-ci.org/mwaylabs/generator-m-ionic [daviddm-url]: https://david-dm.org/mwaylabs/generator-m-ionic Development: [][coveralls-url] [][travis-url] [](https://david-dm.org/mwaylabs/generator-m-ionic/dev) [](https://greenkeeper.io/) ## Why you need it #### Note on Angular 2 & Ionic 2: This Generator delivers **highly advanced workflows for Angular 1 & Ionic 1** with the latest Cordova. If you are looking for a version for Angular 2 & Ionic 2, we're working on one but progress is slow for [various reasons](https://github.com/mwaylabs/generator-m-ionic/issues/403#issuecomment-268562372). Meanwhile, we are still solidly committed to maintaining and rolling updates for the Angular 1 & Ionic 1 stack. Everybody looking to [get involved](https://github.com/mwaylabs/generator-m-ionic/issues/465) in either topic is very welcome! <p align="center"> <a href="https://github.com/mwaylabs/generator-m-ionic" alt="Generator-M-Ionic"> <img width="175" src="https://raw.githubusercontent.com/mwaylabs/generator-m-ionic/master/docs/resources/logo.png"> </a> </p> > **Advanced workflows for building rock-solid Ionic apps**: develop, prototype, test, build and deliver high quality apps with Yeoman, Gulp, Bower, Angular, Cordova and of course Ionic. All in one sexy generator. **[Read more ... ](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/intro/why_you_need_it.md)** ### What's in the box <br> <br> <p align="center" > <a href="http://yeoman.io/" target="_blank" alt="yeoman" title="yeoman"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041228/c1f91cac-ac7a-11e4-9c85-1a5298e29067.png"> </a> <a href="http://gulpjs.com/" target="_blank" alt="gulp" title="gulp"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/9409728/c5332474-481c-11e5-9a6e-74641a0f1782.png"> </a> <a href="http://bower.io/" target="_blank" alt="bower" title="bower"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041250/ef9a78b8-ac7a-11e4-9586-7e7e894e201e.png"> </a> <a href="https://www.browsersync.io/" target="_blank" alt="browsersync" title="browsersync"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/16412038/77028548-3d2a-11e6-88d0-2c0d66582f4c.png"> </a> <a href="https://angularjs.org/" target="_blank" alt="angular" title="angular"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041199/5978cb96-ac7a-11e4-9568-829e2ea4312f.png"> </a> <a href="http://ionicframework.com/" target="_blank" alt="ionic" title="ionic"> <img height="100" src="https://cloud.githubusercontent.com/assets/1134310/17360098/b5975f2e-5961-11e6-8a13-70d258d35ffe.png"> </a> <a href="http://cordova.apache.org/" target="_blank" alt="cordova" title="cordova"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041269/20ed1196-ac7b-11e4-8707-68fa331f1aeb.png"> </a> <br> <br> <a href="http://sass-lang.com/" target="_blank" alt="sass" title="sass"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/9410121/c330a3de-481e-11e5-8a69-ca0c56f6cabc.png"> </a> <a href="http://eslint.org/" target="_blank" alt="eslint" title="eslint"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/15893052/ada5651e-2d7d-11e6-9246-dc749c7afd63.png"> </a> <a href="http://karma-runner.github.io/" target="_blank" alt="karma" title="karma"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/9410216/44fef8fc-481f-11e5-8037-2f7f03678f4c.png"> </a> <a href="http://jasmine.github.io/" target="_blank" alt="jasmine" title="jasmine"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/9410153/ebd46a00-481e-11e5-9864-f00fa8427d17.png"> </a> <a href="https://angular.github.io/protractor/#/" target="_blank" alt="protractor" title="protractor"> <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/9410114/b99aaa9a-481e-11e5-8655-ebc1e324200d.png"> </a> </p> <br> <br> **[Read more ...](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/intro/whats_in_the_box.md)** **Latest releases** - **Component subgenerator**: [see here](https://github.com/mwaylabs/generator-m-ionic/blob/master/docs/guides/sub_generators.md#angularjs-components). - **Yarn** integration: [see here](https://github.com/mwaylabs/generator-m-ionic/blob/master/docs/guides/questions.md#npm-or-yarn). - Test setup improvements [#489](https://github.com/mwaylabs/generator-m-ionic/pull/489). - **Livereload** for the device! Wohoo! See [how it's done](https://github.com/mwaylabs/generator-m-ionic/blob/master/docs/guides/development_intro.md#run-on-device-or-emulator-with-livereload). - Integrations into [Ionic Cloud](https://github.com/mwaylabs/generator-m-ionic/blob/master/docs/ecosystems/ionic_platform.md), [Relution & Greenhouse](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/greenhouse.md). - [and many more ...](https://github.com/mwaylabs/generator-m-ionic/releases) ### What's new **Ionic Blog Series** - Great ride through everything Generator-M-Ionic has to offer: > Advanced workflows for building rock-solid Ionic Apps - [Part 1: Playground](http://blog.ionic.io/advanced-workflows-for-building-rock-solid-ionic-apps-part-1/) - [Part 2: Mountain](http://blog.ionic.io/advanced-workflows-for-building-rock-solid-ionic-apps-part-2/) - [Part 3: Orbit](http://blog.ionic.io/advanced-workflows-for-building-rock-solid-ionic-apps-part-3/) ## Guides ##### Quick Start - [Quick Start](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/intro/quick_start.md) for the experienced developer. - [Try the demo](https://github.com/mwaylabs/generator-m-ionic-demo). Get a quick impression by cloning the sample project generated with the latest version of Generator-M-Ionic. ##### Setup - [Installation and Prerequisites](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/installation_prerequisites.md) - [Questions](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/questions.md) the generator will ask and what they mean ##### Basics - [Development Introduction](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/development_intro.md) - [File structure](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/file_structure.md) - [Sub-generators](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/sub_generators.md) for adding new components. - [Git integration](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/git_integration.md), see how it's done. - [Sass integration](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/sass_integration.md) in our module concept. - [Bower component usage](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/bower_component_usage.md) in our module concept. - [Ionic style source](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/ionic_style_source.md), change it from CSS to Sass or vice versa. ##### Quality - [ESLint](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/eslint.md) code style checks and setting up your IDE/Editor. - [Testing](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/testing.md) with our testing setup. - [Husky hooks](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/testing_workflow.md), automatically run linting and tests before you commit. ##### Advanced - [CORS & Proxying](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/cors_proxy.md), how to cope with CORS issues. - [App Icons and splash screens](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/icons_splash_screens.md), a simple setup or different sets for different builds - all is possible. - [Use Environments](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/environments.md) manage different API Endpoints and much more with just a single parameter. - [Gulp defaults](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/gulp_defaults.md), spare yourself some tedious typing on the command line. ##### Building & Continuous Integration - [Build Vars](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/build_vars.md), inject vars into your app at build time. - [Programmatically change the `config.xml`](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/programmatically_change_configxml.md), with `gulp config` an essential part for a successful continuous integration setup. - [Full-blown Continuous Integration Guide](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/ci.md) - putting it all together: environments, build vars and `gulp config`! - [Greenhouse & Relution Integration Guide](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/guides/greenhouse.md) - build and distribute your apps using these powerful cloud services ##### Ecosystems - [Greenhouse & Relution](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/ecosystems/greenhouse.md) - build and distribute your apps using these powerful cloud services - [Ionic Cloud](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/ecosystems/ionic_platform.md) (beta) - a powerful suite of hybrid-focused mobile backend services and tools ## Generator Insights We've published 3 blog articles on our company blog delivering deep insights into the why and how of the generator: - September 2015: [Generator-M-Ionic and the search for the holy grail](http://blog.mwaysolutions.com/2015/09/21/generator-m-ionic-and-the-search-for-the-holy-grail/) - rather **technical comparison** between the generator and similar tools as well as technical insights to the **decisions and motivation** behind the generator - September 2015: [Generator-M-Ionic: HTML5 mobile app development evolved](http://blog.mwaysolutions.com/2015/09/10/generator-m-ionic-html5-mobile-app-development-evolved/) - provides insight to the **technology choices and ecosystem** and the **benefits of using the generator** - March 2015: [Generator-M: the state of HTML5 mobile app development at M-Way](http://blog.mwaysolutions.com/2015/03/26/generator-m-the-state-of-html5-mobile-app-development-at-m-way/) - the **origins** of the generator development and **company strategy** ## Questions, issues? Talk to us! Do the following: 1. check out our [Issue Guidelines](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/contribute/issue_guide.md) and [issues](https://github.com/mwaylabs/generator-m-ionic/issues) to see if there already is a solution or answer. 2. [](https://gitter.im/mwaylabs/generator-m-ionic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - Get in touch with other developers and our core team. 3. If all fails, make sure you have read the [Issue Guidelines](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/contribute/issue_guide.md) **first** and then [open a new issue](https://github.com/mwaylabs/generator-m-ionic/issues/new). ## Want to contribute ideas, code? Start by reading our: 1. [Mission Statement](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/contribute/mission_statement.md) 2. [Contribution Guide](https://github.com/mwaylabs/generator-m-ionic/tree/master/docs/contribute/contribution_guide.md) ## License Code licensed under MIT. Docs under Apache 2. PhoneGap is a trademark of Adobe.

Compiles Sass to CSS

<div align="center"> <img height="170" src="https://worldvectorlogo.com/logos/sass-1.svg"> <a href="https://github.com/webpack/webpack"> <img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg"> </a> </div> [![npm][npm]][npm-url] [![node][node]][node-url] [![tests][tests]][tests-url] [![coverage][cover]][cover-url] [![chat][chat]][chat-url] [![size][size]][size-url] # sass-loader Loads a Sass/SCSS file and compiles it to CSS. ## Getting Started To begin, you'll need to install `sass-loader`: ```console npm install sass-loader sass webpack --save-dev ``` or ```console yarn add -D sass-loader sass webpack ``` or ```console pnpm add -D sass-loader sass webpack ``` `sass-loader` requires you to install either [Dart Sass](https://github.com/sass/dart-sass), [Node Sass](https://github.com/sass/node-sass) on your own (more documentation can be found below) or [Sass Embedded](https://github.com/sass/embedded-host-node). This allows you to control the versions of all your dependencies, and to choose which Sass implementation to use. > **Note** > > We highly recommend using [Dart Sass](https://github.com/sass/dart-sass). > **Warning** > > [Node Sass](https://github.com/sass/node-sass) does not work with [Yarn PnP](https://classic.yarnpkg.com/en/docs/pnp/) feature and doesn't support [@use rule](https://sass-lang.com/documentation/at-rules/use). > **Warning** > > [Sass Embedded](https://github.com/sass/embedded-host-node) is experimental and in `beta`, therefore some features may not work Chain the `sass-loader` with the [css-loader](https://github.com/webpack-contrib/css-loader) and the [style-loader](https://github.com/webpack-contrib/style-loader) to immediately apply all styles to the DOM or the [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) to extract it into a separate file. Then add the loader to your Webpack configuration. For example: **app.js** ```js import "./style.scss"; ``` **style.scss** ```scss $body-color: red; body { color: $body-color; } ``` **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ // Creates `style` nodes from JS strings "style-loader", // Translates CSS into CommonJS "css-loader", // Compiles Sass to CSS "sass-loader", ], }, ], }, }; ``` Finally run `webpack` via your preferred method. ### Resolving `import` at-rules Webpack provides an [advanced mechanism to resolve files](https://webpack.js.org/concepts/module-resolution/). The `sass-loader` uses Sass's custom importer feature to pass all queries to the Webpack resolving engine. Thus you can import your Sass modules from `node_modules`. ```scss @import "bootstrap"; ``` Using `~` is deprecated and can be removed from your code (**we recommend it**), but we still support it for historical reasons. Why can you remove it? The loader will first try to resolve `@import` as a relative path. If it cannot be resolved, then the loader will try to resolve `@import` inside [`node_modules`](https://webpack.js.org/configuration/resolve/#resolvemodules). Prepending module paths with a `~` tells webpack to search through [`node_modules`](https://webpack.js.org/configuration/resolve/#resolvemodules). ```scss @import "~bootstrap"; ``` It's important to prepend it with only `~`, because `~/` resolves to the home directory. Webpack needs to distinguish between `bootstrap` and `~bootstrap` because CSS and Sass files have no special syntax for importing relative files. Writing `@import "style.scss"` is the same as `@import "./style.scss";` ### Problems with `url(...)` Since Sass implementations don't provide [url rewriting](https://github.com/sass/libsass/issues/532), all linked assets must be relative to the output. - If you pass the generated CSS on to the `css-loader`, all urls must be relative to the entry-file (e.g. `main.scss`). - If you're just generating CSS without passing it to the `css-loader`, it must be relative to your web root. You will be disrupted by this first issue. It is natural to expect relative references to be resolved against the `.sass`/`.scss` file in which they are specified (like in regular `.css` files). Thankfully there are a two solutions to this problem: - Add the missing url rewriting using the [resolve-url-loader](https://github.com/bholloway/resolve-url-loader). Place it before `sass-loader` in the loader chain. - Library authors usually provide a variable to modify the asset path. [bootstrap-sass](https://github.com/twbs/bootstrap-sass) for example has an `$icon-font-path`. ## Options - **[`implementation`](#implementation)** - **[`sassOptions`](#sassoptions)** - **[`sourceMap`](#sourcemap)** - **[`additionalData`](#additionaldata)** - **[`webpackImporter`](#webpackimporter)** - **[`warnRuleAsWarning`](#warnruleaswarning)** ### `implementation` Type: ```ts type implementation = object | string; ``` Default: `sass` The special `implementation` option determines which implementation of Sass to use. By default the loader resolve the implementation based on your dependencies. Just add required implementation to `package.json` (`sass` or `node-sass` package) and install dependencies. Example where the `sass-loader` loader uses the `sass` (`dart-sass`) implementation: **package.json** ```json { "devDependencies": { "sass-loader": "^7.2.0", "sass": "^1.22.10" } } ``` Example where the `sass-loader` loader uses the `node-sass` implementation: **package.json** ```json { "devDependencies": { "sass-loader": "^7.2.0", "node-sass": "^5.0.0" } } ``` Beware the situation when `node-sass` and `sass` were installed! By default the `sass-loader` prefers `sass`. In order to avoid this situation you can use the `implementation` option. The `implementation` options either accepts `sass` (`Dart Sass`) or `node-sass` as a module. #### `object` For example, to use Dart Sass, you'd pass: ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { // Prefer `dart-sass` implementation: require("sass"), }, }, ], }, ], }, }; ``` #### `string` For example, to use Dart Sass, you'd pass: ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { // Prefer `dart-sass` implementation: require.resolve("sass"), }, }, ], }, ], }, }; ``` Note that when using `sass` (`Dart Sass`), **synchronous compilation is twice as fast as asynchronous compilation** by default, due to the overhead of asynchronous callbacks. To avoid this overhead, you can use the [fibers](https://www.npmjs.com/package/fibers) package to call asynchronous importers from the synchronous code path. We automatically inject the [`fibers`](https://github.com/laverdet/node-fibers) package (setup `sassOptions.fiber`) for `Node.js` less v16.0.0 if is possible (i.e. you need install the [`fibers`](https://github.com/laverdet/node-fibers) package). > **Warning** > > Fibers is not compatible with `Node.js` v16.0.0 or later. Unfortunately, v8 commit [dacc2fee0f](https://github.com/v8/v8/commit/dacc2fee0f815823782a7e432c79c2a7767a4765) is a breaking change and workarounds are non-trivial. ([see introduction to readme](https://github.com/laverdet/node-fibers)). **package.json** ```json { "devDependencies": { "sass-loader": "^7.2.0", "sass": "^1.22.10", "fibers": "^4.0.1" } } ``` You can disable automatically injecting the [`fibers`](https://github.com/laverdet/node-fibers) package by passing a `false` value for the `sassOptions.fiber` option. **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { implementation: require("sass"), sassOptions: { fiber: false, }, }, }, ], }, ], }, }; ``` You can also pass the `fiber` value using this code: **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { implementation: require("sass"), sassOptions: { fiber: require("fibers"), }, }, }, ], }, ], }, }; ``` ### `sassOptions` Type: ```ts type sassOptions = | import("sass").LegacyOptions<"async"> | (( content: string | Buffer, loaderContext: LoaderContext, meta: any ) => import("sass").LegacyOptions<"async">); ``` Default: defaults values for Sass implementation Options for [Dart Sass](http://sass-lang.com/dart-sass) or [Node Sass](https://github.com/sass/node-sass) implementation. > **Note** > > The `charset` option has `true` value by default for `dart-sass`, we strongly discourage change value to `false`, because webpack doesn't support files other than `utf-8`. > **Note** > > The `indentedSyntax` option has `true` value for the `sass` extension. > **Note** > > Options such as `data` and `file` are unavailable and will be ignored. > ℹ We strongly discourage change `outFile`, `sourceMapContents`, `sourceMapEmbed`, `sourceMapRoot` options because `sass-loader` automatically sets these options when the `sourceMap` option is `true`. > **Note** > > Access to the [loader context](https://webpack.js.org/api/loaders/#the-loader-context) inside the custom importer can be done using the `this.webpackLoaderContext` property. There is a slight difference between the `sass` (`dart-sass`) and `node-sass` options. Please consult documentation before using them: - [Dart Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/Options) for all available `sass` options. - [Node Sass documentation](https://github.com/sass/node-sass/#options) for all available `node-sass` options. #### `object` Use an object for the Sass implementation setup. **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { sassOptions: { indentWidth: 4, includePaths: ["absolute/path/a", "absolute/path/b"], }, }, }, ], }, ], }, }; ``` #### `function` Allows to setup the Sass implementation by setting different options based on the loader context. ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { sassOptions: (loaderContext) => { // More information about available properties https://webpack.js.org/api/loaders/ const { resourcePath, rootContext } = loaderContext; const relativePath = path.relative(rootContext, resourcePath); if (relativePath === "styles/foo.scss") { return { includePaths: ["absolute/path/c", "absolute/path/d"], }; } return { includePaths: ["absolute/path/a", "absolute/path/b"], }; }, }, }, ], }, ], }, }; ``` ### `sourceMap` Type: ```ts type sourceMap = boolean; ``` Default: depends on the `compiler.devtool` value Enables/Disables generation of source maps. By default generation of source maps depends on the [`devtool`](https://webpack.js.org/configuration/devtool/) option. All values enable source map generation except `eval` and `false` value. > ℹ If a `true` the `sourceMap`, `sourceMapRoot`, `sourceMapEmbed`, `sourceMapContents` and `omitSourceMapUrl` from `sassOptions` will be ignored. **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", { loader: "css-loader", options: { sourceMap: true, }, }, { loader: "sass-loader", options: { sourceMap: true, }, }, ], }, ], }, }; ``` > ℹ In some rare cases `node-sass` can output invalid source maps (it is a `node-sass` bug). > > In order to avoid this, you can try to update `node-sass` to latest version or you can try to set within `sassOptions` the `outputStyle` option to `compressed`. **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { sourceMap: true, sassOptions: { outputStyle: "compressed", }, }, }, ], }, ], }, }; ``` ### `additionalData` Type: ```ts type additionalData = | string | ((content: string | Buffer, loaderContext: LoaderContext) => string); ``` Default: `undefined` Prepends `Sass`/`SCSS` code before the actual entry file. In this case, the `sass-loader` will not override the `data` option but just **prepend** the entry's content. This is especially useful when some of your Sass variables depend on the environment: #### `string` ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { additionalData: "$env: " + process.env.NODE_ENV + ";", }, }, ], }, ], }, }; ``` #### `function` ##### Sync ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { additionalData: (content, loaderContext) => { // More information about available properties https://webpack.js.org/api/loaders/ const { resourcePath, rootContext } = loaderContext; const relativePath = path.relative(rootContext, resourcePath); if (relativePath === "styles/foo.scss") { return "$value: 100px;" + content; } return "$value: 200px;" + content; }, }, }, ], }, ], }, }; ``` ##### Async ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { additionalData: async (content, loaderContext) => { // More information about available properties https://webpack.js.org/api/loaders/ const { resourcePath, rootContext } = loaderContext; const relativePath = path.relative(rootContext, resourcePath); if (relativePath === "styles/foo.scss") { return "$value: 100px;" + content; } return "$value: 200px;" + content; }, }, }, ], }, ], }, }; ``` ### `webpackImporter` Type: ```ts type webpackImporter = boolean; ``` Default: `true` Enables/Disables the default Webpack importer. This can improve performance in some cases. Use it with caution because aliases and `@import` at-rules starting with `~` will not work. You can pass own `importer` to solve this (see [`importer docs`](https://github.com/sass/node-sass#importer--v200---experimental)). **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { webpackImporter: false, }, }, ], }, ], }, }; ``` ### `warnRuleAsWarning` Type: ```ts type warnRuleAsWarning = boolean; ``` Default: `false` Treats the `@warn` rule as a webpack warning. > **Note** > > It will be `true` by default in the next major release. **style.scss** ```scss $known-prefixes: webkit, moz, ms, o; @mixin prefix($property, $value, $prefixes) { @each $prefix in $prefixes { @if not index($known-prefixes, $prefix) { @warn "Unknown prefix #{$prefix}."; } -#{$prefix}-#{$property}: $value; } #{$property}: $value; } .tilt { // Oops, we typo'd "webkit" as "wekbit"! @include prefix(transform, rotate(15deg), wekbit ms); } ``` The presented code will throw webpack warning instead logging. To ignore unnecessary warnings you can use the [ignoreWarnings](https://webpack.js.org/configuration/other-options/#ignorewarnings) option. **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { warnRuleAsWarning: true, }, }, ], }, ], }, }; ``` ### `api` Type: ```ts type api = "legacy" | "modern"; ``` Default: `"legacy"` Allows you to switch between `legacy` and `modern` API. You can find more information [here](https://sass-lang.com/documentation/js-api). > **Warning** > > "modern" API is experimental, so some features may not work (known: built-in `importer` is not working and files with errors is not watching on initial run), you can follow this [here](https://github.com/webpack-contrib/sass-loader/issues/774). > **Warning** > > The sass options are different for `modern` and `old` APIs. Please look at [docs](https://sass-lang.com/documentation/js-api) how to migrate on new options. **webpack.config.js** ```js module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", "css-loader", { loader: "sass-loader", options: { api: "modern", sassOptions: { // Your sass options }, }, }, ], }, ], }, }; ``` ## How to enable `@debug` output Defaults, the output of `@debug` messages is disabled. To enable it, add to **webpack.config.js** following: ```js module.exports = { stats: { loggingDebug: ["sass-loader"], }, // ... }; ``` ## Examples ### Extracts CSS into separate files For production builds it's recommended to extract the CSS from your bundle being able to use parallel loading of CSS/JS resources later on. There are four possibilities to extract a style sheet from the bundle: #### 1. [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) **webpack.config.js** ```js const MiniCssExtractPlugin = require("mini-css-extract-plugin"); module.exports = { module: { rules: [ { test: /\.s[ac]ss$/i, use: [ // fallback to style-loader in development process.env.NODE_ENV !== "production" ? "style-loader" : MiniCssExtractPlugin.loader, "css-loader", "sass-loader", ], }, ], }, plugins: [ new MiniCssExtractPlugin({ // Options similar to the same options in webpackOptions.output // both options are optional filename: "[name].css", chunkFilename: "[id].css", }), ], }; ``` #### 2. [Asset Modules](https://webpack.js.org/guides/asset-modules/) **webpack.config.js** ```js module.exports = { entry: [__dirname + "/src/scss/app.scss"], module: { rules: [ { test: /\.js$/, exclude: /node_modules/, use: [], }, { test: /\.scss$/, exclude: /node_modules/, type: "asset/resource", generator: { filename: "bundle.css", }, use: ["sass-loader"], }, ], }, }; ``` #### 3. [extract-loader](https://github.com/peerigon/extract-loader) (simpler, but specialized on the css-loader's output) #### 4. [file-loader](https://github.com/webpack-contrib/file-loader) (deprecated--should only be used in Webpack v4) **webpack.config.js** ```js module.exports = { entry: [__dirname + "/src/scss/app.scss"], module: { rules: [ { test: /\.js$/, exclude: /node_modules/, use: [], }, { test: /\.scss$/, exclude: /node_modules/, use: [ { loader: "file-loader", options: { outputPath: "css/", name: "[name].min.css" }, }, "sass-loader", ], }, ], }, }; ``` (source: https://stackoverflow.com/a/60029923/2969615) ### Source maps Enables/Disables generation of source maps. To enable CSS source maps, you'll need to pass the `sourceMap` option to the `sass-loader` _and_ the css-loader. **webpack.config.js** ```javascript module.exports = { devtool: "source-map", // any "source-map"-like devtool is possible module: { rules: [ { test: /\.s[ac]ss$/i, use: [ "style-loader", { loader: "css-loader", options: { sourceMap: true, }, }, { loader: "sass-loader", options: { sourceMap: true, }, }, ], }, ], }, }; ``` If you want to edit the original Sass files inside Chrome, [there's a good blog post](https://medium.com/@toolmantim/getting-started-with-css-sourcemaps-and-in-browser-sass-editing-b4daab987fb0). Checkout [test/sourceMap](https://github.com/webpack-contrib/sass-loader/tree/master/test) for a running example. ## Contributing Please take a moment to read our contributing guidelines if you haven't yet done so. [CONTRIBUTING](./.github/CONTRIBUTING.md) ## License [MIT](./LICENSE) [npm]: https://img.shields.io/npm/v/sass-loader.svg [npm-url]: https://npmjs.com/package/sass-loader [node]: https://img.shields.io/node/v/sass-loader.svg [node-url]: https://nodejs.org [tests]: https://github.com/webpack-contrib/sass-loader/workflows/sass-loader/badge.svg [tests-url]: https://github.com/webpack-contrib/sass-loader/actions [cover]: https://codecov.io/gh/webpack-contrib/sass-loader/branch/master/graph/badge.svg [cover-url]: https://codecov.io/gh/webpack-contrib/sass-loader [chat]: https://badges.gitter.im/webpack/webpack.svg [chat-url]: https://gitter.im/webpack/webpack [size]: https://packagephobia.now.sh/badge?p=sass-loader [size-url]: https://packagephobia.now.sh/result?p=sass-loader

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.

Get started with your own dotfiles.

<p align="center"><img src="art/banner-2x.png"></p> ## Introduction This repository serves as my way to help me setup and maintain my Mac. It takes the effort out of installing everything manually. Everything needed to install my preferred setup of macOS is detailed in this readme. Feel free to explore, learn and copy parts for your own dotfiles. Enjoy! 📖 - [Read the blog post](https://driesvints.com/blog/getting-started-with-dotfiles) 📺 - [Watch the screencast on Laracasts](https://laracasts.com/series/guest-spotlight/episodes/1) 💡 - [Learn how to build your own dotfiles](https://github.com/driesvints/dotfiles#your-own-dotfiles) If you find this repo useful, [consider sponsoring me](https://github.com/sponsors/driesvints) (a little bit)! ❤️ ## A Fresh macOS Setup These instructions are for setting up new Mac devices. Instead, if you want to get started building your own dotfiles, you can [find those instructions below](#your-own-dotfiles). ### Backup your data If you're migrating from an existing Mac, you should first make sure to backup all of your existing data. Go through the checklist below to make sure you didn't forget anything before you migrate. - Did you commit and push any changes/branches to your git repositories? - Did you remember to save all important documents from non-iCloud directories? - Did you save all of your work from apps which aren't synced through iCloud? - Did you remember to export important data from your local database? - Did you update [mackup](https://github.com/lra/mackup) to the latest version and ran `mackup backup`? ### Setting up your Mac After backing up your old Mac you may now follow these install instructions to setup a new one. 1. Update macOS to the latest version through system preferences 2. [Generate a new public and private SSH key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) by running: ```zsh curl https://raw.githubusercontent.com/driesvints/dotfiles/HEAD/ssh.sh | sh -s "<your-email-address>" ``` 3. Clone this repo to `~/.dotfiles` with: ```zsh git clone --recursive [email protected]:driesvints/dotfiles.git ~/.dotfiles ``` 4. Run the installation with: ```zsh ~/.dotfiles/fresh.sh ``` 5. After mackup is synced with your cloud storage, restore preferences by running `mackup restore` 6. Restart your computer to finalize the process Your Mac is now ready to use! > 💡 You can use a different location than `~/.dotfiles` if you want. Make sure you also update the reference in the [`.zshrc`](./.zshrc#L2) file. ### Cleaning your old Mac (optionally) After you've set up your new Mac you may want to wipe and clean install your old Mac. Follow [this article](https://support.apple.com/guide/mac-help/erase-and-reinstall-macos-mh27903/mac) to do that. Remember to [backup your data](#backup-your-data) first! ## Your Own Dotfiles **Please note that the instructions below assume you already have set up Oh My Zsh so make sure to first [install Oh My Zsh](https://github.com/robbyrussell/oh-my-zsh#getting-started) before you continue.** If you want to start with your own dotfiles from this setup, it's pretty easy to do so. First of all you'll need to fork this repo. After that you can tweak it the way you want. Go through the [`.macos`](./.macos) file and adjust the settings to your liking. You can find much more settings at [the original script by Mathias Bynens](https://github.com/mathiasbynens/dotfiles/blob/master/.macos) and [Kevin Suttle's macOS Defaults project](https://github.com/kevinSuttle/MacOS-Defaults). Check out the [`Brewfile`](./Brewfile) file and adjust the apps you want to install for your machine. Use [their search page](https://caskroom.github.io/search) to check if the app you want to install is available. Check out the [`aliases.zsh`](./aliases.zsh) file and add your own aliases. If you need to tweak your `$PATH` check out the [`path.zsh`](./path.zsh) file. These files get loaded in because the `$ZSH_CUSTOM` setting points to the `.dotfiles` directory. You can adjust the [`.zshrc`](./.zshrc) file to your liking to tweak your Oh My Zsh setup. More info about how to customize Oh My Zsh can be found [here](https://github.com/robbyrussell/oh-my-zsh/wiki/Customization). When installing these dotfiles for the first time you'll need to backup all of your settings with Mackup. Install Mackup and backup your settings with the commands below. Your settings will be synced to iCloud so you can use them to sync between computers and reinstall them when reinstalling your Mac. If you want to save your settings to a different directory or different storage than iCloud, [checkout the documentation](https://github.com/lra/mackup/blob/master/doc/README.md#storage). Also make sure your `.zshrc` file is symlinked from your dotfiles repo to your home directory. ```zsh brew install mackup mackup backup ``` You can tweak the shell theme, the Oh My Zsh settings and much more. Go through the files in this repo and tweak everything to your liking. Enjoy your own Dotfiles! ## Thanks To... I first got the idea for starting this project by visiting the [GitHub does dotfiles](https://dotfiles.github.io/) project. Both [Zach Holman](https://github.com/holman/dotfiles) and [Mathias Bynens](https://github.com/mathiasbynens/dotfiles) were great sources of inspiration. [Sourabh Bajaj](https://twitter.com/sb2nov/)'s [Mac OS X Setup Guide](http://sourabhbajaj.com/mac-setup/) proved to be invaluable. Thanks to [@subnixr](https://github.com/subnixr) for [his awesome Zsh theme](https://github.com/subnixr/minimal)! Thanks to [Caneco](https://twitter.com/caneco) for the header in this readme. And lastly, I'd like to thank [Emma Fabre](https://twitter.com/anahkiasen) for [her excellent presentation on Homebrew](https://speakerdeck.com/anahkiasen/a-storm-homebrewin) which made me migrate a lot to a [`Brewfile`](./Brewfile) and [Mackup](https://github.com/lra/mackup). In general, I'd like to thank every single one who open-sources their dotfiles for their effort to contribute something to the open-source community.

Sensible database change management

App/Sqitch version v1.3.1 ========================= | Release | Coverage | Database || |-------------------|-------------------|-------------------|--------------------| | [![CPAN]][📚] | [![OSes]][💿] | [![Exasol]][☀️] | [![Oracle]][🔮] | | [![Docker]][🐳] | [![Perl]][🧅] | [![Firebird]][🔥] | [![Snowflake]][❄️] | | [![Homebrew]][🍺] | [![Coverage]][📈] | [![MySQL]][🐬] | [![SQLite]][💡] | | [![Debian]][🍥] | | [![Postgres]][🐘] | [![Vertica]][🔺] | | | | [![Yugabyte]][💫] | [![Cockroach]][🪳] | [Sqitch] is a database change management application. It currently supports: * [PostgreSQL] 8.4+ * [YugabyteDB] 2.6+ * [CockroachDB] 21+ * [SQLite][lite] 3.7.11+ * [MySQL][my] 5.1+ * [MariaDB] 10.0+ * [Oracle][orcl] 10g+, * [Firebird][bird] 2.0+ * [Vertica][vert] 6.0+ * [Exasol][exa] 6.0+ * [Snowflake][flake] What makes it different from your typical migration approaches? A few things: * No opinions Sqitch is not tied to any framework, ORM, or platform. Rather, it is a standalone change management system with no opinions about your database engine, application framework, or development environment. * Native scripting Changes are implemented as scripts native to your selected database engine. Writing a [PostgreSQL] application? Write SQL scripts for [`psql`]. Writing an [Oracle][orcl]-backed app? Write SQL scripts for [SQL\*Plus]. * Dependency resolution Database changes may declare dependencies on other changes -- even on changes from other Sqitch projects. This ensures proper order of execution, even when you've committed changes to your VCS out-of-order. * Deployment integrity Sqitch manages changes and dependencies via a plan file, employing a [Merkle tree] pattern similar to [Git][gitmerkle] and [Blockchain] to ensure deployment integrity. As such, there is no need to number your changes, although you can if you want. Sqitch doesn't much care how you name your changes. * Iterative Development Up until you [tag] and [release] your project, you can modify your change deployment scripts as often as you like. They're not locked in just because they've been committed to your VCS. This allows you to take an iterative or test-driven approach to developing your database schema. Want to learn more? The best place to start is in the tutorials: * [Introduction to Sqitch on PostgreSQL, YugabyteDB, and CockroachDB](lib/sqitchtutorial.pod) * [Introduction to Sqitch on SQLite](lib/sqitchtutorial-sqlite.pod) * [Introduction to Sqitch on Oracle](lib/sqitchtutorial-oracle.pod) * [Introduction to Sqitch on MySQL](lib/sqitchtutorial-mysql.pod) * [Introduction to Sqitch on Firebird](lib/sqitchtutorial-firebird.pod) * [Introduction to Sqitch on Vertica](lib/sqitchtutorial-vertica.pod) * [Introduction to Sqitch on Exasol](lib/sqitchtutorial-exasol.pod) * [Introduction to Sqitch on Snowflake](lib/sqitchtutorial-snowflake.pod) There have also been a number of presentations on Sqitch: * [PDX.pm Presentation]: Slides from "Sane Database Management with Sqitch", presented to the Portland Perl Mongers in January, 2013. * [PDXPUG Presentation]: Movie of "Sane Database Management with Sqitch", presented to the Portland PostgreSQL Users Group in September, 2012. * [Agile Database Development]: Slides from a three-hour tutorial session on using [Git], test-driven development with [pgTAP], and change management with Sqitch, updated in January, 2014. Installation ------------ To install Sqitch from a distribution download, type the following: perl Build.PL ./Build installdeps ./Build ./Build test ./Build install To install Sqitch and all of its dependencies into a single directory named `sqitch_bundle`, install the Menlo CPAN client and build the bundle: cpanm Menlo::CLI::Compat ./Build bundle --install_base sqitch_bundle After which, Sqitch can be run from `./sqitch_bundle/bin/sqitch`. By default, no modules that are included in the core Perl distribution are included. To require that dual-life modules also be bundled, pass `--dual_life 1`: ./Build bundle --install_base sqitch_bundle --dual_life 1 To include support for a feature in the bundle, pass the `--with` option naming the feature: ./Build bundle --install_base sqitch_bundle --with postgres --with sqlite The feature names generally correspond to the supported engines. The currently supported features are: * `--with postgres`: Support for managing Postgres, Yugabyte, and Cockroach databases * `--with sqlite`: Support for managing SQLite databases * `--with mysql`: Support for managing MySQL databases * `--with firebird`: Support for managing Firebird databases * `--with oracle`: Support for managing Oracle databases * `--with vertica`: Support for managing Vertica databases * `--with exasol`: Support for managing Exasol databases * `--with snowflake`: Support for managing Snowflake databases * `--with odbc`: Include the ODBC driver To build from a Git clone, first install [Dist::Zilla], then use it to install Sqitch and all dependencies: cpanm Dist::Zilla dzil authordeps --missing | cpanm dzil listdeps --missing | cpanm dzil install To run Sqitch directly from the Git clone, execute `t/sqitch`. To install Sqitch on a specific platform, including Debian- and RedHat-derived Linux distributions and Windows, see the [Installation documentation]. License ------- Copyright (c) 2012-2022 iovation Inc., David E. Wheeler Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. [CPAN]: https://img.shields.io/cpan/v/App-Sqitch?label=%F0%9F%93%9A%20CPAN [📚]: https://metacpan.org/dist/App-Sqitch "Latest version on CPAN" [OSes]: https://github.com/sqitchers/sqitch/actions/workflows/os.yml/badge.svg [💿]: https://github.com/sqitchers/sqitch/actions/workflows/os.yml "Tested on Linux, macOS, and Windows" [Exasol]: https://github.com/sqitchers/sqitch/actions/workflows/exasol.yml/badge.svg [☀️]: https://github.com/sqitchers/sqitch/actions/workflows/exasol.yml "Tested with Exasol 7.0–7.1" [Oracle]: https://github.com/sqitchers/sqitch/actions/workflows/oracle.yml/badge.svg [🔮]: https://github.com/sqitchers/sqitch/actions/workflows/oracle.yml "Tested with Oracle 11, 18, and 21" [Docker]: https://img.shields.io/docker/v/sqitch/sqitch?label=%F0%9F%90%B3%20Docker&sort=semver [🐳]: https://hub.docker.com/r/sqitch/sqitch "Latest version on Docker Hub" [Perl]: https://github.com/sqitchers/sqitch/actions/workflows/perl.yml/badge.svg [🧅]: https://github.com/sqitchers/sqitch/actions/workflows/perl.yml "Tested with Perl 5.12–5.34" [Firebird]: https://github.com/sqitchers/sqitch/actions/workflows/firebird.yml/badge.svg [🔥]: https://github.com/sqitchers/sqitch/actions/workflows/firebird.yml "Tested with Firebird 2.5, 3, and 4" [Snowflake]: https://github.com/sqitchers/sqitch/actions/workflows/snowflake.yml/badge.svg [❄️]: https://github.com/sqitchers/sqitch/actions/workflows/snowflake.yml "Tested with Snowflake" [Homebrew]: https://img.shields.io/github/v/tag/sqitchers/homebrew-sqitch?label=%F0%9F%8D%BA%20Homebrew&sort=semver [🍺]: https://github.com/sqitchers/homebrew-sqitch#readme "Latest Homebrew Tap version" [Coverage]: https://img.shields.io/coveralls/github/sqitchers/sqitch?label=%F0%9F%93%88%20Coverage [📈]: https://coveralls.io/r/sqitchers/sqitch "Test Coverage" [MySQL]: https://github.com/sqitchers/sqitch/actions/workflows/mysql.yml/badge.svg [🐬]: https://github.com/sqitchers/sqitch/actions/workflows/mysql.yml "Tested with MySQL 5.5–8 and MariaDB 10.0–10.6" [SQLite]: https://github.com/sqitchers/sqitch/actions/workflows/sqlite.yml/badge.svg [💡]: https://github.com/sqitchers/sqitch/actions/workflows/sqlite.yml "Tested with SQLite 3.7–3.36" [Debian]: https://img.shields.io/debian/v/sqitch?label=%F0%9F%8D%A5%20Debian [🍥]: https://packages.debian.org/stable/sqitch "Latest version on Debian" [Postgres]: https://github.com/sqitchers/sqitch/actions/workflows/pg.yml/badge.svg [🐘]: https://github.com/sqitchers/sqitch/actions/workflows/pg.yml "Tested with PostgreSQL 9.3–14" [Yugabyte]: https://github.com/sqitchers/sqitch/actions/workflows/yugabyte.yml/badge.svg [💫]: https://github.com/sqitchers/sqitch/actions/workflows/yugabyte.yml "Tested with YugabyteDB 2.6–2.13" [Vertica]: https://github.com/sqitchers/sqitch/actions/workflows/vertica.yml/badge.svg [🔺]: https://github.com/sqitchers/sqitch/actions/workflows/vertica.yml "Tested with Vertica 7.1–11.0" [Cockroach]: https://github.com/sqitchers/sqitch/actions/workflows/cockroach.yml/badge.svg [🪳]: https://github.com/sqitchers/sqitch/actions/workflows/cockroach.yml "Tested with CockroachDB v21-22" [Sqitch]: https://sqitch.org/ [PostgreSQL]: https://postgresql.org/ [YugabyteDB]: https://www.yugabyte.com/yugabytedb/ [CockroachDB]: https://www.cockroachlabs.com/product/ [lite]: https://sqlite.org/ [my]: https://dev.mysql.com/ [MariaDB]: https://mariadb.org [`psql`]: https://www.postgresql.org/docs/current/static/app-psql.html [orcl]: https://www.oracle.com/database/ [bird]: https://www.firebirdsql.org/ [vert]: https://www.vertica.com/ [exa]: https://www.exasol.com/ [flake]: https://www.snowflake.net/ [SQL\*Plus]: https://www.orafaq.com/wiki/SQL*Plus [Merkle tree]: https://en.wikipedia.org/wiki/Merkle_tree "Wikipedia: “Merkle tree”" [gitmerkle]: https://stackoverflow.com/a/18589734/ "Stack Overflow: “What is the mathematical structure that represents a Git repo”" [Blockchain]: https://medium.com/byzantine-studio/blockchain-fundamentals-what-is-a-merkle-tree-d44c529391d7 "Medium: “Blockchain Fundamentals #1: What is a Merkle Tree?”" [tag]: https://sqitch.org/docs/manual/sqitch-tag/ [release]: https://sqitch.org/docs/manual/sqitch-tag/ [PDX.pm Presentation]: https://speakerdeck.com/theory/sane-database-change-management-with-sqitch [PDXPUG Presentation]: https://vimeo.com/50104469 [Agile Database Development]: https://speakerdeck.com/theory/agile-database-development-2ed [Git]: https://git-scm.org [pgTAP]: https://pgtap.org [Dist::Zilla]: https://metacpan.org/module/Dist::Zilla [Installation documentation]: https://sqitch.org/download/

Tsung is a high-performance benchmark framework for various protocols including HTTP, XMPP, LDAP, etc.

# Tsung README [](https://travis-ci.org/processone/tsung) ## Introduction This document gives pointers for information on this package which is distributed under the GNU General Public License version 2 (see file COPYING). ## What This Package Is Tsung is multi-protocol distributed load testing tool. It can be used to test the scalability and performances of IP based client/server applications (supported protocols: HTTP, WebDAV, SOAP, PostgreSQL, MySQL, LDAP, MQTT, AMQP and Jabber/XMPP) A User's manual is available : http://tsung.erlang-projects.org/user_manual/ ## Problems/Bugs Join the mailing-list: https://lists.process-one.net/mailman/listinfo/tsung-users or use the tracker https://github.com/processone/tsung/issues

📊 Cube — The Semantic Layer for Building Data Applications

<p align="center"> <a href="https://cube.dev?ref=github-readme"><img src="https://raw.githubusercontent.com/cube-js/cube.js/master/docs/content/cube-logo-with-bg.png" alt="Cube — Semantic Layer for Data Applications" width="300px"></a> </p> [Website](https://cube.dev?ref=github-readme) • [Getting Started](https://cube.dev/docs/getting-started?ref=github-readme) • [Docs](https://cube.dev/docs?ref=github-readme) • [Examples](https://cube.dev/docs/examples?ref=github-readme) • [Blog](https://cube.dev/blog?ref=github-readme) • [Slack](https://slack.cube.dev?ref=github-readme) • [Twitter](https://twitter.com/thecubejs) [](https://badge.fury.io/js/%40cubejs-backend%2Fserver) [](https://github.com/cube-js/cube.js/actions?query=workflow%3ABuild+branch%3Amaster) [](https://app.fossa.io/projects/git%2Bgithub.com%2Fcube-js%2Fcube.js?ref=badge_shield) __Cube is the semantic layer for building data applications.__ It helps data engineers and application developers access data from modern data stores, organize it into consistent definitions, and deliver it to every application. <img src="https://raw.githubusercontent.com/cube-js/cube.js/master/docs/content/cube-scheme-dark.png" style="border: none" width="100%" /> <p align="center"> <i>Learn more about connecting Cube to <a href="https://cube.dev/docs/config/databases?ref=github-readme" target="_blank">data sources</a> and <a href="https://cube.dev/docs/config/downstream?ref=github-readme" target="_blank">analytics & visualization tools</a>.</i> </p> Cube was designed to work with all SQL-enabled data sources, including cloud data warehouses like Snowflake or Google BigQuery, query engines like Presto or Amazon Athena, and application databases like Postgres. Cube has a built-in relational caching engine to provide sub-second latency and high concurrency for API requests. For more details, see the [introduction](https://cube.dev/docs/cubejs-introduction?ref=github-readme) page in our documentation. ## Why Cube? If you are building a data application—such as a business intelligence tool or a customer-facing analytics feature—you’ll probably face the following problems: 1. __SQL code organization.__ Sooner or later, modeling even a dozen metrics with a dozen dimensions using pure SQL queries becomes a maintenance nightmare, which leads to building a modeling framework. 2. __Performance.__ Most of the time and effort in modern analytics software development is spent providing adequate time to insight. In a world where every company’s data is big data, writing just SQL queries to get insight isn’t enough anymore. 3. __Access Control.__ It is important to secure and govern access to data for all downstream data consuming applications. Cube has the necessary infrastructure and features to implement efficient data modeling, access control, and performance optimizations so that every application—like embedded analytics, dashboarding and reporting tools, data notebooks, and other tools—can access consistent data via REST, SQL, and GraphQL APIs.  ## Getting Started 🚀 ### Cube Cloud [Cube Cloud](https://cube.dev/cloud?ref=github-readme) is the fastest way to get started with Cube. It provides managed infrastructure as well as an instant and free access for development projects and proofs of concept. <a href="https://cubecloud.dev/auth/signup?ref=github-readme"><img src="https://cubedev-blog-images.s3.us-east-2.amazonaws.com/f1f1eac0-0b44-4c47-936e-33b5c06eedf0.png" alt="Get started now" width="200px"></a> For a step-by-step guide on Cube Cloud, [see the docs](https://cube.dev/docs/cloud/getting-started/create?ref=github-readme). ### Docker Alternatively, you can get started with Cube locally or self-host it with [Docker](https://www.docker.com/). Once Docker is installed, in a new folder for your project, run the following command: ```bash docker run -p 4000:4000 \ -v ${PWD}:/cube/conf \ -e CUBEJS_DEV_MODE=true \ cubejs/cube ``` Then, open http://localhost:4000 in your browser to continue setup. For a step-by-step guide on Docker, [see the docs](https://cube.dev/docs/getting-started-docker?ref=github-readme). ## Resources - [Documentation](https://cube.dev/docs?ref=github-readme) - [Getting Started](https://cube.dev/docs/getting-started?ref=github-readme) - [Examples & Tutorials](https://cube.dev/docs/examples?ref=github-readme) - [Architecture](https://cube.dev/docs/cubejs-introduction?ref=github-readme#architecture) ## Community If you have any questions or need help - [please join our Slack community](https://slack.cube.dev?ref=github-readme) of amazing developers and data engineers. You are also welcome to join our **monthly community calls** where we discuss community news, Cube Dev team's plans, backlogs, use cases, etc. If you miss the call, the recordings will also be available after the meeting. * When: Second Wednesday of each month at [9am Pacific Time](https://www.thetimezoneconverter.com/?t=09:00&tz=PT%20%28Pacific%20Time%29). * Meeting link: https://us02web.zoom.us/j/86717042169?pwd=VlBEd2VVK01DNDVVbU1EUXd5ajhsdz09 * [Meeting page](https://cube.dev/community-call/). * Recordings will be posted on the [Community Call Playlist](https://www.youtube.com/playlist?list=PLtdXl_QTQjpb1dHZCM09qKTsgvgqjSvc9). ### Our quarterly roadmap We publish our open source roadmap every quarter and discuss them during our [monthly community calls](https://cube.dev/community-call/). You can find our roadmap under [projects in our Cube.js repository](https://github.com/cube-js/cube.js/projects?query=is%3Aopen+sort%3Aupdated-desc). ### Contributing There are many ways you can contribute to Cube! Here are a few possibilities: * Star this repo and follow us on [Twitter](https://twitter.com/thecubejs). * Add Cube to your stack on [Stackshare](https://stackshare.io/cube-js). * Upvote issues with 👍 reaction so we know what's the demand for particular issue to prioritize it within road map. * Create issues every time you feel something is missing or goes wrong. * Ask questions on [Stack Overflow with cube.js tag](https://stackoverflow.com/questions/tagged/cube.js) if others can have these questions as well. * Provide pull requests for all open issues and especially for those with [help wanted](https://github.com/cube-js/cube.js/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") and [good first issue](https://github.com/cube-js/cube.js/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") labels. All sort of contributions are **welcome and extremely helpful** 🙌 Please refer to [the contribution guide](https://github.com/cube-js/cube.js/blob/master/CONTRIBUTING.md) for more information. ## License Cube Client is [MIT licensed](./packages/cubejs-client-core/LICENSE). Cube Backend is [Apache 2.0 licensed](./packages/cubejs-server/LICENSE). [](https://app.fossa.io/projects/git%2Bgithub.com%2Fcube-js%2Fcube.js?ref=badge_large)

Database migration tool for .NET and .NET Core projects. Inspired by Flyway.

# Evolve [](https://ci.appveyor.com/project/lecaillon/evolve) [](https://lecaillon.visualstudio.com/Evolve-CI/_build/latest?definitionId=2&branchName=master) [](https://lecaillon.visualstudio.com/Evolve-CI/_build/latest?definitionId=2&branchName=master) [](https://www.nuget.org/packages/Evolve) [](https://twitter.com/intent/follow?screen_name=evolve_db) <img align="right" width="173px" height="173px" src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/logo.png"> Evolve is a personal, free-time project with no funding. If you use Evolve in your daily work and feel that it makes your life easier, consider supporting its development via [GitHub Sponsors](https://github.com/sponsors/lecaillon) :heart: and by adding a star to this repository :star: I’m very passionate about doing personal projects and very grateful that other people find them useful, too. I want to share as much as possible, but it doesn’t pay the bills. With your help, I can focus on open-source work more and make it sustainable. If your company uses any of my libraries, consider donating too as a sign of gratitude and for priority support! ## Beloved sponsors <table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://www.veepee.com"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve.Doc/master/static/images/Veepee.png" style="margin: 0rem auto"> </a> </td> <td align="center" valign="middle"> <a href="https://megaslice.uk"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve.Doc/master/static/images/Megaslice.png" style="margin: 0rem auto"> </a> </td> </tr> </tbody> </table> ## Introduction Evolve is a cross platform database migration tool inspired by [Flyway](https://flywaydb.org/), that uses plain SQL scripts. Its purpose is to automate your database changes, and help keep those changes synchronized through all your environments and development teams. This makes it an ideal tool for continuous integration / delivery. Overall Evolve embraces simplicity. Every time you run your project, it will automatically ensure that your database is up-to-date. Install it and forget it! ## Installation Evolve is available as a .NET library, a .NET tool and a standalone CLI. | | Evolve | Evolve Tool | Evolve CLI | |-|-|-|-| | Repository | [](https://www.nuget.org/packages/Evolve) | [](https://www.nuget.org/packages/Evolve.Tool) | [](https://github.com/lecaillon/Evolve/releases/latest) | ## Supported databases <table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://evolve-db.netlify.com/requirements/sqlserver" target="_blank"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/sqlserver.png"> </a> </td> <td align="center" valign="middle"> <a href="https://evolve-db.netlify.com/requirements/postgresql" target="_blank"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/postgresql.png"> </a> </td> <td align="center" valign="middle"> <a href="https://evolve-db.netlify.com/requirements/mysql" target="_blank"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/mysql.png"> </a> </td> <td align="center" valign="middle"> <a href="https://evolve-db.netlify.com/requirements/mariadb" target="_blank"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/mariadb.png"> </a> </td> <td align="center" valign="middle"> <a href="https://evolve-db.netlify.com/requirements/sqlite" target="_blank"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/sqlite.png"> </a> </td> <td align="center" valign="middle"> <a href="https://evolve-db.netlify.com/requirements/cassandra" target="_blank"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/cassandra.png"> </a> </td> <td align="center" valign="middle"> <a href="https://evolve-db.netlify.com/requirements/cockroachdb" target="_blank"> <img src="https://raw.githubusercontent.com/lecaillon/Evolve/master/images/cockroachdb.png"> </a> </td> </tr> </tbody> </table> ## Documentation You can read the latest documentation at [https://evolve-db.netlify.com](https://evolve-db.netlify.com) and find samples [here](https://github.com/lecaillon/Evolve/tree/master/samples). ## Changelog Detailed changes for each release are documented in the [release notes](https://github.com/lecaillon/Evolve/releases).

🧑‍🚀 Logto helps you build sign-in, auth, and user identity.

<p align="right"> <a href="https://www.producthunt.com/posts/logto?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-logto" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=352638&theme=neutral" alt="Logto | Product Hunt" width="200" /></a> </p> <p align="center"> <a href="https://logto.io" target="_blank" align="center" alt="Logto Logo"> <img src="./logo.png" height="100"> </a> </p> [](https://discord.gg/vRvwuwgpVX) [](https://github.com/logto-io/logto/actions?query=branch%3Amaster) [](https://github.com/logto-io/logto/releases) [](https://app.codecov.io/gh/logto-io/logto) [](https://gitpod.io/#https://github.com/logto-io/demo) [](https://render.com/deploy?repo=https://github.com/logto-io/logto) Logto[^info] helps you build sign-in, auth, and user identity. 🧑‍💻 **A frontend-to-backend identity solution** - A delightful sign-in experience for end-users and an OIDC-based identity service. - Web and native SDKs that can integrate your apps with Logto quickly. 📦 **Out-of-box technology and UI support for many things you needed to code before** - A centralized place to customize the user interface and then LIVE PREVIEW the changes you make. - Social sign-in for multiple platforms (GitHub, Google, WeChat, Alipay, etc.). - Dynamic passcode sign-in (via SMS or email). 💻 **Fully open-sourced, while no identity knowledge is required to use** - Super easy tryout (less than 1 min via GitPod, not joking), step-by-step tutorials and decent docs. - A full-function web admin console to manage the users, identities, and other things you need within a few clicks. Boringly, we call it "[customer identity access management](https://en.wikipedia.org/wiki/Customer_identity_access_management)" (CIAM) or "customer identity solution." [Subscribe to us](https://logto.io/subscribe) right away to receive up-to-date information about the Logto Cloud (SaaS) as well as in-time feature updates. ## Get started - Visit our 🎨 [website](https://logto.io) for a brief introduction if you are new to Logto. - A step-by-step guide is available on 📖 [docs.logto.io](https://docs.logto.io). ### Launch Logto #### Online demo (GitPod) [Click here](https://gitpod.io/#https://github.com/logto-io/demo) to launch Logto via GitPod. Once you see the message like `App is running at https://3001-...gitpod.io` in the terminal, press Cmd (or Ctrl) and click the URL to continue your Logto journey. #### Docker Compose Docker Compose CLI usually comes with [Docker Desktop](https://www.docker.com/products/docker-desktop). ```bash curl -fsSL https://raw.githubusercontent.com/logto-io/logto/HEAD/docker-compose.yml | \ TAG=prerelease docker compose -p logto -f - up ``` #### npm-init Requires [Node.js](https://nodejs.org/) `^18.12.0` + [PostgreSQL](https://postgresql.org/) `^14.0`. ```bash npm init @logto ``` ## Language support ```ts const languages = ['Deutsch', 'English', 'Français', 'Português', '简体中文', 'Türkçe', '한국어']; ``` ## Bug report, feature request, feedback - Our team takes security seriously, especially when it relates to identity. If you find any existing or potential security issues, please do not hesitate to email 🔒 [[email protected]](mailto:[email protected]). - About other bug reports, feature requests, and feedback, you can: - Directly 🙋 [open an issue](https://github.com/logto-io/logto/issues/new) on GitHub; - 💬 [join our Discord server](https://discord.gg/vRvwuwgpVX) to have a live chat; - Engage in our 🗓️ [public roadmap](https://silverhand.notion.site/Logto-Public-Roadmap-d6a1ad19039946b7b1139811aed82dcc). ## Contributing We have a [contributing guideline](https://github.com/logto-io/logto/blob/master/.github/CONTRIBUTING.md) available. Feel free to contact us before coding. ## Resources - [📖 Logto docs](https://docs.logto.io) - ✍️ Silverhand blog [Notion](https://silverhand.notion.site/Silverhand-Blog-68e122832cfb413ca8786e08152d00ac) [Substack](https://silverhand.substack.com/) <br/> [^info]: Licensed with MPL-2.0. Designed by Silverhand Inc.

PostgreSQL cloud native High Availability and more.

# stolon - PostgreSQL cloud native High Availability [](https://run.agola.io/org/stolon/projects/stolon.proj) [](https://talk.stolon.io) [](https://goreportcard.com/report/github.com/sorintlab/stolon) [](https://github.com/sorintlab/stolon/releases) [](https://github.com/sorintlab/stolon/releases)  stolon is a cloud native PostgreSQL manager for PostgreSQL high availability. It's cloud native because it'll let you keep an high available PostgreSQL inside your containers (kubernetes integration) but also on every other kind of infrastructure (cloud IaaS, old style infrastructures etc...) For an introduction to stolon you can also take a look at [this post](https://sgotti.dev/post/stolon-introduction/) ## Features * Leverages PostgreSQL streaming replication. * Resilient to any kind of partitioning. While trying to keep the maximum availability, it prefers consistency over availability. * [kubernetes integration](examples/kubernetes/README.md) letting you achieve postgreSQL high availability. * Uses a cluster store like [etcd](https://etcd.io), [consul](https://www.consul.io) or kubernetes API server as an high available data store and for leader election * Asynchronous (default) and [synchronous](doc/syncrepl.md) replication. * Full cluster setup in minutes. * Easy [cluster administration](doc/stolonctl.md) * Can do point in time recovery integrating with your preferred backup/restore tool. * [Standby cluster](doc/standbycluster.md) (for multi site replication and near zero downtime migration). * Automatic service discovery and dynamic reconfiguration (handles postgres and stolon processes changing their addresses). * Can use [pg_rewind](doc/pg_rewind.md) for fast instance resynchronization with current master. ## Architecture Stolon is composed of 3 main components * keeper: it manages a PostgreSQL instance converging to the clusterview computed by the leader sentinel. * sentinel: it discovers and monitors keepers and proxies and computes the optimal clusterview. * proxy: the client's access point. It enforce connections to the right PostgreSQL master and forcibly closes connections to old masters. For more details and requirements see [Stolon Architecture and Requirements](doc/architecture.md)  ## Documentation [Documentation Index](doc/README.md) ## Installation Stolon is available in [brew](https://brew.sh/). It is **unofficial and not supported** by the project. So check the version before installing using `brew`. [Step to install using brew](doc/unofficial_packages.md) ## Quick start and examples * [Simple cluster example](doc/simplecluster.md) * [Kubernetes example](examples/kubernetes/README.md) * [Two (or more) nodes setup](doc/twonodes.md) ## Project Status Stolon is under active development and used in different environments. Probably its on disk format (store hierarchy and key contents) will change in future to support new features. If a breaking change is needed it'll be documented in the release notes and an upgrade path will be provided. Anyway it's quite easy to reset a cluster from scratch keeping the current master instance working and without losing any data. ## Requirements * PostgreSQL 15, 14, 13, 12, 11, 10, 9.6 * etcd2 >= v2.0, etcd3 >= v3.0, consul >= v0.6 or kubernetes >= 1.8 (based on the store you're going to use) * OS: currently stolon is tested on GNU/Linux (with reports of people using it also on Solaris, *BSD and Darwin) ## build To build stolon we usually test and support the latest two major versions of Go like in the [Go release policy](https://golang.org/doc/devel/release.html#policy). ``` make ``` ## High availability Stolon tries to be resilient to any partitioning problem. The cluster view is computed by the leader sentinel and is useful to avoid data loss (one example over all avoid that old dead masters coming back are elected as the new master). There can be tons of different partitioning cases. The primary ones are covered (and in future more will be added) by various [integration tests](tests/integration) ## FAQ See [here](doc/faq.md) for a list of faq. If you have additional questions please ask. ## Contributing to stolon stolon is an open source project under the Apache 2.0 license, and contributions are gladly welcomed! To submit your changes please open a pull request. ## Contacts * For general discussion about using and developing stolon, join the [stolon forum](https://talk.stolon.io) * For bugs and feature requests file an [issue](https://github.com/sorintlab/stolon/issues/new/choose)

: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))

A chat server with OAuth2 authentication, persistent and searchable history, video and audio, markdown formatting, private and public rooms, stars, votes, embedded games, and many other features

 A chat server with authentication, persistent and searchable history, rich markdown formatting, video, private rooms, conversation highlighting, plugins, persisted notifications, code and table rendering, specialized link boxing, github hooks, bots, and many other features.  [](https://miaou.dystroy.org/1?Miaou) [](https://miaou.dystroy.org/3?Code_Croissants) **[Introduction/Gallery](http://miaou.dystroy.org/static/intro.html)** You can see it in action or use it on https://miaou.dystroy.org (anybody can create a room for public or private use on this server). # Installing a server If you want to install Miaou, the installation documentation is available [here](installation.md). Don't hesitate to come ask us some advices in one of the dedicated chat rooms [](https://miaou.dystroy.org/1?Miaou) and [](https://miaou.dystroy.org/3?Code_Croissants) (please note that they're currently more active between 8 and 19 GMT). And if you run your own server, please tell us, we're always happy to learn about installations. # Contributing As described in [the help](https://miaou.dystroy.org/help#Technical_Stack), Miaou is mostly coded in JavaScript. Stuff includes node, PostgreSQL, OAuth2, socket.io, WebRTC, express, Bluebird, Redis, Pug, Passport.js, hu.js, jQuery, sass/scss, Uglify-js, gulp, jest, travis-ci, and nginx. Many features are implemented as plugins, and that's where you should look first: [Plugin developpement](plugins/README.md). If you have the ability and will to contribute, come and discuss with us. The best landing place is usually the [Miaou room](http://miaou.dystroy.org/1?Miaou) where you can ping @dystroy or @Florian. Help is welcome but remember: 1. Come and discuss with us before to code 2. And, **always test yourself and run the test suite before doing a pull request**. ## License Most of Miaou follows the [MIT License](http://opensource.org/licenses/MIT). Exceptions are specified [here](license.md). Copyright (c) 2014 Denys Séguret <[https://www.dystroy.org/](https://www.dystroy.org/)>

An open-source time-series SQL database optimized for fast ingest and complex queries. Packaged as a PostgreSQL extension.

|Linux/macOS|Linux i386|Windows|Coverity|Code Coverage| |:---:|:---:|:---:|:---:|:---:| |[](https://github.com/timescale/timescaledb/actions?query=workflow%3ARegression+branch%3Amain)|[](https://github.com/timescale/timescaledb/actions?query=workflow%3A%22Regression+Linux+i386%22+branch%3Amain)|[](https://github.com/timescale/timescaledb/actions?query=workflow%3A%22Regression+Windows%22+branch%3Amain)|[](https://scan.coverity.com/projects/timescale-timescaledb)|[](https://codecov.io/gh/timescale/timescaledb) ## TimescaleDB TimescaleDB is an open-source database designed to make SQL scalable for time-series data. It is engineered up from PostgreSQL and packaged as a PostgreSQL extension, providing automatic partitioning across time and space (partitioning key), as well as full SQL support. If you prefer not to install or administer your instance of TimescaleDB, [hosted versions of TimescaleDB](https://tsdb.co/GitHubTimescaleCloud) are available in the cloud of your choice (pay-as-you-go, with a free trial to start). To determine which option is best for you, see [Timescale Products](https://tsdb.co/GitHubTimescaleProducts) for more information about our Apache-2 version, TimescaleDB Community (self-hosted), and Timescale Cloud (hosted), including: feature comparisons, FAQ, documentation, and support. Below is an introduction to TimescaleDB. For more information, please check out these other resources: - [Developer Documentation](https://tsdb.co/GitHubTimescaleDocs) - [Slack Channel](https://slack-login.timescale.com) - [Timescale Community Forum](https://www.timescale.com/forum/) - [Timescale Release Notes & Future Plans](https://tsdb.co/GitHubTimescaleReleaseNotes) For reference and clarity, all code files in this repository reference licensing in their header (either the Apache-2-open-source license or [Timescale License (TSL)](https://github.com/timescale/timescaledb/blob/main/tsl/LICENSE-TIMESCALE) ). Apache-2 licensed binaries can be built by passing `-DAPACHE_ONLY=1` to `bootstrap`. [Contributors welcome.](https://github.com/timescale/timescaledb/blob/main/CONTRIBUTING.md) (To build TimescaleDB from source, see instructions in [_Building from source_](https://github.com/timescale/timescaledb/blob/main/docs/BuildSource.md).) ### Using TimescaleDB TimescaleDB scales PostgreSQL for time-series data via automatic partitioning across time and space (partitioning key), yet retains the standard PostgreSQL interface. In other words, TimescaleDB exposes what look like regular tables, but are actually only an abstraction (or a virtual view) of many individual tables comprising the actual data. This single-table view, which we call a [hypertable](https://tsdb.co/GitHubTimescaleHypertable), is comprised of many chunks, which are created by partitioning the hypertable's data in either one or two dimensions: by a time interval, and by an (optional) "partition key" such as device id, location, user id, etc. ([Architecture discussion](https://docs.timescale.com/timescaledb/latest/overview/core-concepts/)) Virtually all user interactions with TimescaleDB are with hypertables. Creating tables and indexes, altering tables, inserting data, selecting data, etc., can (and should) all be executed on the hypertable. From the perspective of both use and management, TimescaleDB just looks and feels like PostgreSQL, and can be managed and queried as such. #### Before you start PostgreSQL's out-of-the-box settings are typically too conservative for modern servers and TimescaleDB. You should make sure your `postgresql.conf` settings are tuned, either by using [timescaledb-tune](https://github.com/timescale/timescaledb-tune) or doing it manually. #### Creating a hypertable ```sql -- Do not forget to create timescaledb extension CREATE EXTENSION timescaledb; -- We start by creating a regular SQL table CREATE TABLE conditions ( time TIMESTAMPTZ NOT NULL, location TEXT NOT NULL, temperature DOUBLE PRECISION NULL, humidity DOUBLE PRECISION NULL ); -- Then we convert it into a hypertable that is partitioned by time SELECT create_hypertable('conditions', 'time'); ``` - [Quick start: Creating hypertables](https://tsdb.co/GitHubTimescaleCreateHypertables) - [Reference examples](https://tsdb.co/GitHubTimescaleHypertableReference) #### Inserting and querying data Inserting data into the hypertable is done via normal SQL commands: ```sql INSERT INTO conditions(time, location, temperature, humidity) VALUES (NOW(), 'office', 70.0, 50.0); SELECT * FROM conditions ORDER BY time DESC LIMIT 100; SELECT time_bucket('15 minutes', time) AS fifteen_min, location, COUNT(*), MAX(temperature) AS max_temp, MAX(humidity) AS max_hum FROM conditions WHERE time > NOW() - interval '3 hours' GROUP BY fifteen_min, location ORDER BY fifteen_min DESC, max_temp DESC; ``` In addition, TimescaleDB includes additional functions for time-series analysis that are not present in vanilla PostgreSQL. (For example, the `time_bucket` function above.) - [Quick start: Basic operations](https://tsdb.co/GitHubTimescaleBasicOperations) - [Reference examples](https://tsdb.co/GitHubTimescaleWriteData) - [TimescaleDB API](https://tsdb.co/GitHubTimescaleAPI) ### Installation TimescaleDB is available pre-packaged for several platforms: - Linux: - [RedHat / CentOS](https://tsdb.co/GitHubTimescaleRedHatCentOS) - [Ubuntu](https://tsdb.co/GitHubTimescaleUbuntu) - [Debian](https://tsdb.co/GitHubTimescaleDebian) - [Docker](https://tsdb.co/GitHubTimescaleDocker) - [MacOS (Homebrew)](https://tsdb.co/GitHubTimescaleMacOS) - [Windows](https://tsdb.co/GitHubTimescaleWindows) [Timescale Cloud](https://tsdb.co/GitHubTimescaleCloud) (cloud-hosted and managed TimescaleDB) is available via free trial. You create database instances in the cloud of your choice and use TimescaleDB to power your queries, automating common operational tasks and reducing management overhead. We recommend following our detailed [installation instructions](https://tsdb.co/GitHubTimescaleInstall). To build from source, see instructions [here](https://github.com/timescale/timescaledb/blob/main/docs/BuildSource.md). ## Resources ### Architecture documents - [Basic TimescaleDB Features](tsl/README.md) - [Advanced TimescaleDB Features](tsl/README.md) - [Testing TimescaleDB](test/README.md) ### Useful tools - [timescaledb-tune](https://github.com/timescale/timescaledb-tune): Helps set your PostgreSQL configuration settings based on your system's resources. - [timescaledb-parallel-copy](https://github.com/timescale/timescaledb-parallel-copy): Parallelize your initial bulk loading by using PostgreSQL's `COPY` across multiple workers. ### Additional documentation - [Why use TimescaleDB?](https://tsdb.co/GitHubTimescaleIntro) - [Migrating from PostgreSQL](https://tsdb.co/GitHubTimescalePostgresMigrate) - [Writing data](https://tsdb.co/GitHubTimescaleWriteData) - [Querying and data analytics](https://tsdb.co/GitHubTimescaleReadData) - [Tutorials and sample data](https://tsdb.co/GitHubTimescaleTutorials) ### Community & help - [Slack Channel](https://slack.timescale.com) - [Github Issues](https://github.com/timescale/timescaledb/issues) - [Timescale Support](https://tsdb.co/GitHubTimescaleSupport): see support options (community & subscription) ### Releases & updates - [Timescale Release Notes & Future Plans](https://tsdb.co/GitHubTimescaleReleaseNotes): see planned and in-progress updates and detailed information about current and past releases. - [Subscribe to Timescale Release Notes](https://tsdb.co/GitHubTimescaleGetReleaseNotes) to get notified about new releases, fixes, and early access/beta programs. ### Contributing - [Contributor instructions](https://github.com/timescale/timescaledb/blob/main/CONTRIBUTING.md) - [Code style guide](https://github.com/timescale/timescaledb/blob/main/docs/StyleGuide.md)

RisingWave: A Distributed SQL Database for Stream Processing

 [](https://join.slack.com/t/risingwave-community/shared_invite/zt-120rft0mr-d8uGk3d~NZiZAQWPnElOfw) [](https://buildkite.com/risingwavelabs/main) [](https://codecov.io/gh/risingwavelabs/risingwave) **RisingWave is now ready for production! Curious about the use cases? More details coming soon!** RisingWave is a cloud-native streaming database that uses SQL as the interface language. It is designed to reduce the complexity and cost of building real-time applications. RisingWave consumes streaming data, performs continuous queries, and updates results dynamically. As a database system, RisingWave maintains results inside its own storage and allows users to access data efficiently. RisingWave ingests data from sources like Apache Kafka, Apache Pulsar, Amazon Kinesis, Redpanda, and materialized CDC sources. Learn more at [Introduction to RisingWave](https://www.risingwave.dev/docs/current/intro/). ## Quick Start ### Installation There are two ways to install RisingWave: use a pre-built package or compile from source. **Use a Pre-built Package (Linux)** ```shell # Download the pre-built binary wget https://github.com/risingwavelabs/risingwave/releases/download/v0.1.16/risingwave-v0.1.16-x86_64-unknown-linux.tar.gz # Unzip the binary tar xvf risingwave-v0.1.16-x86_64-unknown-linux.tar.gz # Start RisingWave in single-binary playground mode ./risingwave playground ``` **Use Docker (Linux, macOS)** ```shell # Start RisingWave in single-binary playground mode docker run -it --pull=always -p 4566:4566 -p 5691:5691 ghcr.io/risingwavelabs/risingwave:v0.1.16 playground ``` **Compile from Source with [RiseDev](docs/developer-guide.md#set-up-the-development-environment) (Linux and macOS)** ```shell # Install Rust toolchain curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Clone the repo git clone https://github.com/risingwavelabs/risingwave.git && cd risingwave # Compile and start the playground ./risedev playground ``` To build from source, you need to pre-install several tools in your system. You may use `./risedev configure` to configure compile settings. Please refer to the [developer guide](docs/developer-guide.md) for more information. You can launch a RisingWave cluster and process streaming data in a distributed manner, and enable other features like metrics collection and data persistence. Please refer to the [developer guide](docs/developer-guide.md) for more information. ### Your First Query To connect to the RisingWave server, you will need to [install PostgreSQL shell](docs/developer-guide.md#set-up-the-development-environment) (`psql`) in advance. ```shell # Use psql to connect RisingWave cluster psql -h localhost -p 4566 -d dev -U root ``` ```sql /* create a table */ create table t1(v1 int); /* create a materialized view based on the previous table */ create materialized view mv1 as select sum(v1) as sum_v1 from t1; /* insert some data into the source table */ insert into t1 values (1), (2), (3); /* (optional) ensure the materialized view has been updated */ flush; /* the materialized view should reflect the changes in source table */ select * from mv1; ``` If everything works correctly, you should see ``` sum_v1 -------- 6 (1 row) ``` in the terminal. ### Connecting to an External Source Please refer to [get started guide](https://www.risingwave.dev/docs/current/get-started/) for more information. ## Documentation To learn about how to use RisingWave, refer to [RisingWave docs](https://www.risingwave.dev/). To learn about the development process, see the [developer guide](docs/developer-guide.md). To understand the design and implementation of RisingWave, refer to the design docs listed in [readme.md](docs/README.md). ## License RisingWave is under the Apache License 2.0. Please refer to [LICENSE](LICENSE) for more information. ## Contributing Thanks for your interest in contributing to the project! Please refer to [contribution guidelines](CONTRIBUTING.md) for more information.

SQL builder and query library for golang

``` __ _ ___ __ _ _ _ / _` |/ _ \ / _` | | | | | (_| | (_) | (_| | |_| | \__, |\___/ \__, |\__,_| |___/ |_| ``` [](https://github.com/doug-martin/goqu/releases) [](https://github.com/doug-martin/goqu/actions?query=workflow%3ATest+and+branch%3Amaster+) [](https://pkg.go.dev/github.com/doug-martin/goqu/v9) [](https://codecov.io/gh/doug-martin/goqu) [](https://goreportcard.com/report/github.com/doug-martin/goqu/v9) `goqu` is an expressive SQL builder and executor If you are upgrading from an older version please read the [Migrating Between Versions](./docs/version_migration.md) docs. ## Installation If using go modules. ```sh go get -u github.com/doug-martin/goqu/v9 ``` If you are not using go modules... **NOTE** You should still be able to use this package if you are using go version `>v1.10` but, you will need to drop the version from the package. `import "github.com/doug-martin/goqu/v9` -> `import "github.com/doug-martin/goqu"` ```sh go get -u github.com/doug-martin/goqu ``` ### [Migrating Between Versions](./docs/version_migration.md) ## Features `goqu` comes with many features but here are a few of the more notable ones * Query Builder * Parameter interpolation (e.g `SELECT * FROM "items" WHERE "id" = ?` -> `SELECT * FROM "items" WHERE "id" = 1`) * Built from the ground up with multiple dialects in mind * Insert, Multi Insert, Update, and Delete support * Scanning of rows to struct[s] or primitive value[s] While goqu may support the scanning of rows into structs it is not intended to be used as an ORM if you are looking for common ORM features like associations, or hooks I would recommend looking at some of the great ORM libraries such as: * [gorm](https://github.com/jinzhu/gorm) * [hood](https://github.com/eaigner/hood) ## Why? We tried a few other sql builders but each was a thin wrapper around sql fragments that we found error prone. `goqu` was built with the following goals in mind: * Make the generation of SQL easy and enjoyable * Create an expressive DSL that would find common errors with SQL at compile time. * Provide a DSL that accounts for the common SQL expressions, NOT every nuance for each database. * Provide developers the ability to: * Use SQL when desired * Easily scan results into primitive values and structs * Use the native sql.Db methods when desired ## Docs * [Dialect](./docs/dialect.md) - Introduction to different dialects (`mysql`, `postgres`, `sqlite3`, `sqlserver` etc) * [Expressions](./docs/expressions.md) - Introduction to `goqu` expressions and common examples. * [Select Dataset](./docs/selecting.md) - Docs and examples about creating and executing SELECT sql statements. * [Insert Dataset](./docs/inserting.md) - Docs and examples about creating and executing INSERT sql statements. * [Update Dataset](./docs/updating.md) - Docs and examples about creating and executing UPDATE sql statements. * [Delete Dataset](./docs/deleting.md) - Docs and examples about creating and executing DELETE sql statements. * [Prepared Statements](./docs/interpolation.md) - Docs about interpolation and prepared statements in `goqu`. * [Database](./docs/database.md) - Docs and examples of using a Database to execute queries in `goqu` * [Working with time.Time](./docs/time.md) - Docs on how to use alternate time locations. ## Quick Examples ### Select See the [select dataset](./docs/selecting.md) docs for more in depth examples ```go sql, _, _ := goqu.From("test").ToSQL() fmt.Println(sql) ``` Output: ``` SELECT * FROM "test" ``` ```go sql, _, _ := goqu.From("test").Where(goqu.Ex{ "d": []string{"a", "b", "c"}, }).ToSQL() fmt.Println(sql) ``` Output: ``` SELECT * FROM "test" WHERE ("d" IN ('a', 'b', 'c')) ``` ### Insert See the [insert dataset](./docs/inserting.md) docs for more in depth examples ```go ds := goqu.Insert("user"). Cols("first_name", "last_name"). Vals( goqu.Vals{"Greg", "Farley"}, goqu.Vals{"Jimmy", "Stewart"}, goqu.Vals{"Jeff", "Jeffers"}, ) insertSQL, args, _ := ds.ToSQL() fmt.Println(insertSQL, args) ``` Output: ```sql INSERT INTO "user" ("first_name", "last_name") VALUES ('Greg', 'Farley'), ('Jimmy', 'Stewart'), ('Jeff', 'Jeffers') [] ``` ```go ds := goqu.Insert("user").Rows( goqu.Record{"first_name": "Greg", "last_name": "Farley"}, goqu.Record{"first_name": "Jimmy", "last_name": "Stewart"}, goqu.Record{"first_name": "Jeff", "last_name": "Jeffers"}, ) insertSQL, args, _ := ds.ToSQL() fmt.Println(insertSQL, args) ``` Output: ``` INSERT INTO "user" ("first_name", "last_name") VALUES ('Greg', 'Farley'), ('Jimmy', 'Stewart'), ('Jeff', 'Jeffers') [] ``` ```go type User struct { FirstName string `db:"first_name"` LastName string `db:"last_name"` } ds := goqu.Insert("user").Rows( User{FirstName: "Greg", LastName: "Farley"}, User{FirstName: "Jimmy", LastName: "Stewart"}, User{FirstName: "Jeff", LastName: "Jeffers"}, ) insertSQL, args, _ := ds.ToSQL() fmt.Println(insertSQL, args) ``` Output: ``` INSERT INTO "user" ("first_name", "last_name") VALUES ('Greg', 'Farley'), ('Jimmy', 'Stewart'), ('Jeff', 'Jeffers') [] ``` ```go ds := goqu.Insert("user").Prepared(true). FromQuery(goqu.From("other_table")) insertSQL, args, _ := ds.ToSQL() fmt.Println(insertSQL, args) ``` Output: ``` INSERT INTO "user" SELECT * FROM "other_table" [] ``` ```go ds := goqu.Insert("user").Prepared(true). Cols("first_name", "last_name"). FromQuery(goqu.From("other_table").Select("fn", "ln")) insertSQL, args, _ := ds.ToSQL() fmt.Println(insertSQL, args) ``` Output: ``` INSERT INTO "user" ("first_name", "last_name") SELECT "fn", "ln" FROM "other_table" [] ``` ### Update See the [update dataset](./docs/updating.md) docs for more in depth examples ```go sql, args, _ := goqu.Update("items").Set( goqu.Record{"name": "Test", "address": "111 Test Addr"}, ).ToSQL() fmt.Println(sql, args) ``` Output: ``` UPDATE "items" SET "address"='111 Test Addr',"name"='Test' [] ``` ```go type item struct { Address string `db:"address"` Name string `db:"name" goqu:"skipupdate"` } sql, args, _ := goqu.Update("items").Set( item{Name: "Test", Address: "111 Test Addr"}, ).ToSQL() fmt.Println(sql, args) ``` Output: ``` UPDATE "items" SET "address"='111 Test Addr' [] ``` ```go sql, _, _ := goqu.Update("test"). Set(goqu.Record{"foo": "bar"}). Where(goqu.Ex{ "a": goqu.Op{"gt": 10} }).ToSQL() fmt.Println(sql) ``` Output: ``` UPDATE "test" SET "foo"='bar' WHERE ("a" > 10) ``` ### Delete See the [delete dataset](./docs/deleting.md) docs for more in depth examples ```go ds := goqu.Delete("items") sql, args, _ := ds.ToSQL() fmt.Println(sql, args) ``` ```go sql, _, _ := goqu.Delete("test").Where(goqu.Ex{ "c": nil }).ToSQL() fmt.Println(sql) ``` Output: ``` DELETE FROM "test" WHERE ("c" IS NULL) ``` <a name="contributions"></a> ## Contributions I am always welcoming contributions of any type. Please open an issue or create a PR if you find an issue with any of the following. * An issue with Documentation * You found the documentation lacking in some way If you have an issue with the package please include the following * The dialect you are using * A description of the problem * A short example of how to reproduce (if applicable) Without those basics it can be difficult to reproduce your issue locally. You may be asked for more information but that is a good starting point. ### New Features New features and/or enhancements are great and I encourage you to either submit a PR or create an issue. In both cases include the following as the need/requirement may not be readily apparent. 1. The use case 2. A short example If you are issuing a PR also include the following 1. Tests - otherwise the PR will not be merged 2. Documentation - otherwise the PR will not be merged 3. Examples - [If applicable] see example_test.go for examples If you find an issue you want to work on please comment on it letting other people know you are looking at it and I will assign the issue to you. If want to work on an issue but dont know where to start just leave a comment and I'll be more than happy to point you in the right direction. ### Running tests The test suite requires a postgres, mysql and sqlserver databases. You can override the connection strings with the [`MYSQL_URI`, `PG_URI`, `SQLSERVER_URI` environment variables](https://github.com/doug-martin/goqu/blob/2fe3349/docker-compose.yml#L26)* ```sh go test -v -race ./... ``` You can also run the tests in a container using [docker-compose](https://docs.docker.com/compose/). ```sh MYSQL_VERSION=8 POSTGRES_VERSION=13.4 SQLSERVER_VERSION=2017-CU8-ubuntu GO_VERSION=latest docker-compose run goqu ``` ## License `goqu` is released under the [MIT License](http://www.opensource.org/licenses/MIT).

Baserow is an open source no-code database tool and Airtable alternative. This is a mirrored repository, the official one is hosted on https://gitlab.com/bramw/baserow.

## Baserow is an open source no-code database tool and Airtable alternative. Create your own online database without technical experience. Our user-friendly no-code tool gives you the powers of a developer without leaving your browser. * A spreadsheet database hybrid combining ease of use and powerful data organization. * Easily self-hosted with no storage restrictions or sign-up on https://baserow.io to get started immediately. * Alternative to Airtable. * Open-core with all non-premium and non-enterprise features under the [MIT License](https://choosealicense.com/licenses/mit/) allowing commercial and private use. * Headless and API first. * Uses popular frameworks and tools like [Django](https://www.djangoproject.com/), [Vue.js](https://vuejs.org/) and [PostgreSQL](https://www.postgresql.org/). [](https://heroku.com/deploy?template=https://github.com/bram2w/baserow/tree/master) ```bash docker run -v baserow_data:/baserow/data -p 80:80 -p 443:443 baserow/baserow:1.14.0 ```  ## Get Involved **We're hiring remotely**! More information at https://baserow.io/jobs. Join our forum on https://community.baserow.io/ or on Gitter via https://gitter.im/bramw-baserow/community. See [CONTRIBUTING.md](./CONTRIBUTING.md) on how to become a contributor. ## Installation * [**Docker**](docs/installation/install-with-docker.md) * [**Ubuntu**](docs/installation/install-on-ubuntu.md) * [**Docker Compose** ](docs/installation/install-with-docker-compose.md) * [** Heroku**: Easily install and scale up Baserow on Heroku.](docs/installation/install-on-heroku.md) * [** Render**: Easily install and scale up Baserow on Render.](docs/installation/install-on-render.md) * [** Cloudron**: Install and update Baserow on your own Cloudron server.](docs/installation/install-on-cloudron.md) ## Official documentation The official documentation can be found on the website at https://baserow.io/docs/index or [here](./docs/index.md) inside the repository. The API docs can be found here at https://api.baserow.io/api/redoc/ or if you are looking for the OpenAPI schema here https://api.baserow.io/api/schema.json. ## Become a sponsor If you would like to get new features faster, then you might want to consider becoming a sponsor. By becoming a sponsor we can spend more time on Baserow which means faster development. [Become a GitHub Sponsor](https://github.com/sponsors/bram2w) ## Development environment If you want to contribute to Baserow you can setup a development environment like so: ``` $ git clone https://gitlab.com/bramw/baserow.git $ cd baserow $ ./dev.sh --build ``` The Baserow development environment is now running. Visit [http://localhost:3000](http://localhost:3000) in your browser to see a working version in development mode with hot code reloading and other dev features enabled. More detailed instructions and more information about the development environment can be found at [https://baserow.io/docs/development/development-environment](./docs/development/development-environment.md) . ## Plugin development Because of the modular architecture of Baserow it is possible to create plugins. Make your own fields, views, applications, pages or endpoints. We also have a plugin boilerplate to get you started right away. More information can be found in the [plugin introduction](./docs/plugins/introduction.md) and in the [plugin boilerplate docs](./docs/plugins/boilerplate.md). ## Meta Created by Baserow B.V. - [email protected]. Distributes under the MIT license. See `LICENSE` for more information. Version: 1.14.0 The official repository can be found at https://gitlab.com/bramw/baserow. The changelog can be found [here](./changelog.md). Become a GitHub Sponsor [here](https://github.com/sponsors/bram2w). Community chat via https://gitter.im/bramw-baserow/community.

Next-generation ORM for Node.js & TypeScript | PostgreSQL, MySQL, MariaDB, SQL Server, SQLite, MongoDB and CockroachDB

 <div align="center"> <h1>Prisma</h1> <a href="https://www.npmjs.com/package/prisma"><img src="https://img.shields.io/npm/v/prisma.svg?style=flat" /></a> <a href="https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a> <a href="https://github.com/prisma/prisma/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-blue" /></a> <a href="https://slack.prisma.io/"><img src="https://img.shields.io/badge/chat-on%20slack-blue.svg" /></a> <br /> <br /> <a href="https://www.prisma.io/docs/getting-started/quickstart">Quickstart</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://www.prisma.io/">Website</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://www.prisma.io/docs/">Docs</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://github.com/prisma/prisma-examples/">Examples</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://www.prisma.io/blog">Blog</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://slack.prisma.io/">Slack</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://twitter.com/prisma">Twitter</a> <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> <a href="https://github.com/prisma/prisma1">Prisma 1</a> <br /> <hr /> </div> ## What is Prisma? Prisma is a **next-generation ORM** that consists of these tools: - [**Prisma Client**](https://www.prisma.io/docs/concepts/components/prisma-client): Auto-generated and type-safe query builder for Node.js & TypeScript - [**Prisma Migrate**](https://www.prisma.io/docs/concepts/components/prisma-migrate): Declarative data modeling & migration system - [**Prisma Studio**](https://github.com/prisma/studio): GUI to view and edit data in your database Prisma Client can be used in _any_ Node.js or TypeScript backend application (including serverless applications and microservices). This can be a [REST API](https://www.prisma.io/docs/understand-prisma/prisma-in-your-stack/rest), a [GraphQL API](https://www.prisma.io/docs/understand-prisma/prisma-in-your-stack/graphql), a gRPC API, or anything else that needs a database. > **Are you looking for Prisma 1? The Prisma 1 repository has been renamed to [`prisma/prisma1`](https://github.com/prisma/prisma1)**. ## Getting started The fastest way to get started with Prisma is by following the [**Quickstart (5 min)**](https://www.prisma.io/docs/getting-started/quickstart-typescript). The Quickstart is based on a preconfigured SQLite database. You can also get started with your own database (PostgreSQL and MySQL) by following one of these guides: - [Add Prisma to an existing project](https://www.prisma.io/docs/getting-started/setup-prisma/add-to-existing-project-typescript-postgres) - [Set up a new project with Prisma from scratch](https://www.prisma.io/docs/getting-started/setup-prisma/start-from-scratch-typescript-postgres) ## How does Prisma work This section provides a high-level overview of how Prisma works and its most important technical components. For a more thorough introduction, visit the [Prisma documentation](https://www.prisma.io/docs/). ### The Prisma schema Every project that uses a tool from the Prisma toolkit starts with a [Prisma schema file](https://www.prisma.io/docs/concepts/components/prisma-schema). The Prisma schema allows developers to define their _application models_ in an intuitive data modeling language. It also contains the connection to a database and defines a _generator_: ```prisma // Data source datasource db { provider = "postgresql" url = env("DATABASE_URL") } // Generator generator client { provider = "prisma-client-js" } // Data model model Post { id Int @id @default(autoincrement()) title String content String? published Boolean @default(false) author User? @relation(fields: [authorId], references: [id]) authorId Int? } model User { id Int @id @default(autoincrement()) email String @unique name String? posts Post[] } ``` In this schema, you configure three things: - **Data source**: Specifies your database connection (via an environment variable) - **Generator**: Indicates that you want to generate Prisma Client - **Data model**: Defines your application models --- ### The Prisma data model On this page, the focus is on the data model. You can learn more about [Data sources](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/data-sources) and [Generators](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/generators) on the respective docs pages. #### Functions of Prisma models The data model is a collection of [models](https://www.prisma.io/docs/concepts/components/prisma-schema/data-model#defining-models). A model has two major functions: - Represent a table in the underlying database - Provide the foundation for the queries in the Prisma Client API #### Getting a data model There are two major workflows for "getting" a data model into your Prisma schema: - Generate the data model from [introspecting](https://www.prisma.io/docs/concepts/components/introspection) a database - Manually writing the data model and mapping it to the database with [Prisma Migrate](https://www.prisma.io/docs/concepts/components/prisma-migrate) Once the data model is defined, you can [generate Prisma Client](https://www.prisma.io/docs/concepts/components/prisma-client/generating-prisma-client) which will expose CRUD and more queries for the defined models. If you're using TypeScript, you'll get full type-safety for all queries (even when only retrieving the subsets of a model's fields). --- ### Accessing your database with Prisma Client #### Generating Prisma Client The first step when using Prisma Client is installing its npm package: ``` npm install @prisma/client ``` Note that the installation of this package invokes the `prisma generate` command which reads your Prisma schema and _generates_ the Prisma Client code. The code will be located in `node_modules/.prisma/client`, which is exported by `node_modules/@prisma/client/index.d.ts`. After you change your data model, you'll need to manually re-generate Prisma Client to ensure the code inside `node_modules/.prisma/client` get updated: ``` npx prisma generate ``` Refer to the documentation for more information about ["generating the Prisma client"](https://www.prisma.io/docs/concepts/components/prisma-client/generating-prisma-client). #### Using Prisma Client to send queries to your database Once the Prisma Client is generated, you can import it in your code and send queries to your database. This is what the setup code looks like. ##### Import and instantiate Prisma Client You can import and instantiate Prisma Client as follows: ```ts import { PrismaClient } from '@prisma/client' const prisma = new PrismaClient() ``` or ```js const { PrismaClient } = require('@prisma/client') const prisma = new PrismaClient() ``` Now you can start sending queries via the generated Prisma Client API, here are few sample queries. Note that all Prisma Client queries return _plain old JavaScript objects_. Learn more about the available operations in the [Prisma Client docs](https://www.prisma.io/docs/concepts/components/prisma-client) or watch this [demo video](https://www.youtube.com/watch?v=LggrE5kJ75I&list=PLn2e1F9Rfr6k9PnR_figWOcSHgc_erDr5&index=4) (2 min). ##### Retrieve all `User` records from the database ```ts // Run inside `async` function const allUsers = await prisma.user.findMany() ``` ##### Include the `posts` relation on each returned `User` object ```ts // Run inside `async` function const allUsers = await prisma.user.findMany({ include: { posts: true }, }) ``` ##### Filter all `Post` records that contain `"prisma"` ```ts // Run inside `async` function const filteredPosts = await prisma.post.findMany({ where: { OR: [{ title: { contains: 'prisma' } }, { content: { contains: 'prisma' } }], }, }) ``` ##### Create a new `User` and a new `Post` record in the same query ```ts // Run inside `async` function const user = await prisma.user.create({ data: { name: 'Alice', email: '[email protected]', posts: { create: { title: 'Join us for Prisma Day 2021' }, }, }, }) ``` ##### Update an existing `Post` record ```ts // Run inside `async` function const post = await prisma.post.update({ where: { id: 42 }, data: { published: true }, }) ``` #### Usage with TypeScript Note that when using TypeScript, the result of this query will be _statically typed_ so that you can't accidentally access a property that doesn't exist (and any typos are caught at compile-time). Learn more about leveraging Prisma Client's generated types on the [Advanced usage of generated types](https://www.prisma.io/docs/concepts/components/prisma-client/advanced-usage-of-generated-types) page in the docs. ## Community Prisma has a large and supportive [community](https://www.prisma.io/community) of enthusiastic application developers. You can join us on [Slack](https://slack.prisma.io) and here on [GitHub](https://github.com/prisma/prisma/discussions). ## Security If you have a security issue to report, please contact us at [[email protected]](mailto:[email protected]?subject=[GitHub]%20Prisma%202%20Security%20Report%20). ## Support ### Ask a question about Prisma You can ask questions and initiate [discussions](https://github.com/prisma/prisma/discussions/) about Prisma-related topics in the `prisma` repository on GitHub. 👉 [**Ask a question**](https://github.com/prisma/prisma/discussions/new) ### Create a bug report for Prisma If you see an error message or run into an issue, please make sure to create a bug report! You can find [best practices for creating bug reports](https://www.prisma.io/docs/support/creating-bug-reports) (like including additional debugging output) in the docs. 👉 [**Create bug report**](https://github.com/prisma/prisma/issues/new?assignees=&labels=&template=bug_report.md&title=) ### Submit a feature request If Prisma currently doesn't have a certain feature, be sure to check out the [roadmap](https://www.prisma.io/docs/more/roadmap) to see if this is already planned for the future. If the feature on the roadmap is linked to a GitHub issue, please make sure to leave a +1 on the issue and ideally a comment with your thoughts about the feature! 👉 [**Submit feature request**](https://github.com/prisma/prisma/issues/new?assignees=&labels=&template=feature_request.md&title=) ## Contributing Refer to our [contribution guidelines](https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md) and [Code of Conduct for contributors](https://github.com/prisma/prisma/blob/main/CODE_OF_CONDUCT.md). ## Build Status - Prisma Tests Status: [](https://buildkite.com/prisma/prisma2-test) - Ecosystem Tests Status: [](https://github.com/prisma/ecosystem-tests/actions)

A cloud-native database based on PostgreSQL developed by Alibaba Cloud.

<div align="center"> [](https://developer.aliyun.com/topic/polardb-for-pg) # PolarDB for PostgreSQL **A cloud-native database service independently developed by Alibaba Cloud** [](https://developer.aliyun.com/topic/polardb-for-pg) [](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/actions/workflows/build-and-test.yml) [](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/actions/workflows/build-and-test.yml) [](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/actions/workflows/build-and-test.yml) [](doc/PolarDB-EN/LICENSE.txt) [](https://GitHub.com/ApsaraDB/PolarDB-for-PostgreSQL/issues) [](https://GitHub.com/ApsaraDB/PolarDB-for-PostgreSQL/pulls) [](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/network/members) [](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/stargazers) [](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/graphs/contributors) </div> # Overview  PolarDB PostgreSQL (hereafter simplified as PolarDB) is a cloud native database service independently developed by Alibaba Cloud. This service is 100% compatible with PostgreSQL and uses a shared-storage-based architecture in which computing is decoupled from storage. This service features flexible scalability, millisecond-level latency and hybrid transactional/analytical processing (HTAP) capabilities. 1. Flexible scalability: You can use the service to scale out a compute cluster or a storage cluster based on your business requirements. - If the computing power is insufficient, you can scale out only the compute cluster. - If the storage capacity or the storage I/O is insufficient, you can scale out a storage cluster without interrupting your service. 2. Millisecond-level latency: - Write-ahead logging (WAL) logs are stored in the shared storage. Only the metadata of WAL records is replicated from the read-write node to read-only nodes. - The *LogIndex* technology provided by PolarDB features two record replay modes: lazy replay and parallel replay. The technology can be used to minimize the record replication latency from the read-write node to read-only nodes. 3. HTAP: HTAP is implemented by using a shared-storage-based massively parallel processing (MPP) architecture. The architecture is used to accelerate online analytical processing (OLAP) queries in online transaction processing (OLTP) scenarios. PolarDB supports a complete suite of data types that are used in OLTP scenarios. PolarDB supports two computing engines that can process these types of data: - Standalone execution: processes OLTP queries that feature high concurrency. - Distributed execution: processes large OLAP queries. PolarDB provides a wide range of innovative multi-model database capabilities to help you process, analyze, and search for different types of data, such as spatio-temporal, geographic information system (GIS), image, vector, and graph data. Besides the **Shared-Storage** architecture mentioned above, PolarDB also supports depolyments in **Shared-Nothing** architecture. For more details, refer to [README](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/blob/distributed/README.md) in the **distributed** branch. # Architecture and Roadmap PolarDB uses a shared-storage-based architecture in which computing is decoupled from storage. The conventional shared-nothing architecture is changed to the shared-storage architecture. N copies of data in the compute cluster and N copies of data in the storage cluster are changed to N copies of data in the compute cluster and one copy of data in the storage cluster. The shared storage stores one copy of data, but the data states in memory are different. The WAL logs must be synchronized from the primary node to read-only nodes to ensure data consistency. In addition, when the primary node flushes dirty pages, it must be controlled to prevent the read-only nodes from reading future pages. Meanwhile, the read-only nodes must be prevented from reading the outdated pages that are not correctly replayed in memory. To resolve this issue, PolarDB provides the index structure *LogIndex* to maintain the page replay history. LogIndex can be used to synchronize data from the primary node to read-only nodes. After computing is decoupled from storage, the I/O latency and throughput increase. When a single read-only node is used to process analytical queries, the CPUs, memory, and I/O of other read-only nodes and the large storage I/O bandwidth cannot be fully utilized. To resolve this issue, PolarDB provides the shared-storage-based MPP engine. The engine can use CPUs to accelerate analytical queries at SQL level and support a mix of OLAP workloads and OLTP workloads for HTAP. For more information, see [Roadmap](doc/PolarDB-EN/Roadmap.md) and [Architecture](doc/PolarDB-EN/Architecture.md). # Branch Introduction 20210901: The default branch of PolarDB switched to **main** on 20210901, which supports compute-storage-separation architecture. The “POLARDB_11_STABLE” is the stable branch which is based on PostgreSQL 11.9. The original **master** branch in the past has been switched to **distributed** branch, which supports distributed architecture of PolarDB. # Documentation - [Architecture Design](doc/PolarDB-EN/Architecture.md) - [Roadmap](doc/PolarDB-EN/Roadmap.md) - Features of PolarDB PostgreSQL 1.0 - [Buffer Management](doc/PolarDB-EN/Buffer_Management.md) - [DDL Synchronization](doc/PolarDB-EN/DDL_Synchronization.md) - [LogIndex](doc/PolarDB-EN/LogIndex.md) - DB Monitoring - [PolarDB Stack](https://github.com/ApsaraDB/PolarDB-Stack-Operator/blob/master/README.md) - PolarDB File System # Quick Start with PolarDB Three approaches are offered to quickly try out PolarDB: Alibaba Cloud service, deployment of instance based on local storage, and deployment of instance based on PolarDB Stack. ## Alibaba Cloud Service Alibaba provides ApsaraDB for PolarDB PostgreSQL-Compatible Edition, which is a cloud-native relational database service compatible with PostgreSQL: [Official site](https://www.alibabacloud.com/product/polardb). ## Deploy Instance based on Local Storage We provide a script which uses default configuration to compile PolarDB. This section describes how to fast deploy a PolarDB instance with storage on your local disks by this script. **System Requirements**: CentOS 7.5 and above. The following setup steps are tested on CentOS 7.5. > **Note**: For the following steps, please use the same user. DO NOT use *root* user to create instances. 1. Download the stable branch "POLARDB_11_STABLE" of PolarDB from [here](https://github.com/ApsaraDB/PolarDB-for-PostgreSQL/tree/POLARDB_11_STABLE). 2. Install dependent packages: ```bash sudo yum install readline-devel zlib-devel perl-CPAN bison flex sudo cpan -fi Test::More IPC::Run ``` 3. Select the coommand according to your actual needs to start deployment. - Run the following commands to compile the source code only, without creating any instance: ```bash ./polardb_build.sh --noinit ``` - Run the following commands to compile the source code, and create an instance with one node (primary node). The port number is 5432. ```bash ./polardb_build.sh ``` - Run the following commands to compile the source code, and create an instance with two nodes. The nodes include: - One primary node and the port number is 5432. - One read-only node and the port number is 5433. ```bash ./polardb_build.sh --withrep --repnum=1 ``` - Run the following commands to compile the source code, and create an instance with three nodes. The nodes include: - One primary node and the port number is 5432. - One read-only node and the port number is 5433. - One standby node (for standby database) and the port number is 5434. ```bash ./polardb_build.sh --withrep --repnum=1 --withstandby ``` - Run the following commands to compile the source code, and create an instance with four nodes. The nodes include: - One primary node and the port number is 5432. - Two read-only nodes and the port numbers are 5433 and 5434. - One standby node (for standby database) and the port number is 5435. ```bash ./polardb_build.sh --withrep --repnum=2 --withstandby ``` 4. After the deployment, refer to the followng steps to check and test the created instance to make sure it is deployed correctly. - Run the following commands to check the instance: ```bash $HOME/tmp_basedir_polardb_pg_1100_bld/bin/psql -p 5432 -c 'select version();' $HOME/tmp_basedir_polardb_pg_1100_bld/bin/psql -p 5432 -c 'select * from pg_replication_slots;' ``` - Run the following commands to perform full regression test: ```bash ./polardb_build.sh --withrep --repnum=1 --withstandby -r-check-all -e -r-contrib -r-pl -r-external -r-installcheck-all ``` ## Deploy Instance based on PolarDB Stack PolarDB Stack is a PaaS software of PolarDB for PostgreSQL. It provides features of database lifecycle management. You can deploy a PolarDB instance (kernel) and PolarDB File System based on PolarDB Stack. The architecture of PolarDB Stack is as follows. For more details [refer to PolarDB Stack Documents](https://github.com/ApsaraDB/PolarDB-Stack-Operator/blob/master/README.md)  # Contributions You are welcome to make contributions to PolarDB. We appreciate all the contributions. For more information about how to start development and pull requests, see [contributing](doc/PolarDB-EN/contributing.md). # Software License PolarDB code is released under the Apache License (Version 2.0), developed based on the PostgreSQL which is released under the PostgreSQL License. This product contains various third-party components under other open source licenses. See the [LICENSE](./LICENSE.txt) and [NOTICE](./NOTICE.txt) file for more information. # Acknowledgments Some code and design ideas are based on other open source projects, such as PG-XC/XL (pgxc_ctl), TBase (Timestamp-based vacuum and MVCC), Greenplum and Citus (pg_cron). We thank the contributions of the preceding open source projects. # Contact us - PolarDB PostgreSQL at Slack: [https://app.slack.com/client/T023NM10KGE/C023VEMKS02](https://app.slack.com/client/T023NM10KGE/C023VEMKS02) - Use the DingTalk application to scan the following QR code and join the DingTalk group for PolarDB technology promotion.  --- Copyright © Alibaba Group, Inc.

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 👍

Expressive analytics in Python at any scale.

# Ibis [](http://ibis-project.org) [](https://anaconda.org/conda-forge/ibis-framework) [](https://pypi.org/project/ibis-framework) [](https://github.com/ibis-project/ibis/actions/workflows/ibis-main.yml?query=branch%3Amaster) [](https://github.com/ibis-project/ibis/actions/workflows/ibis-backends.yml?query=branch%3Amaster) [](https://codecov.io/gh/ibis-project/ibis) ## What is Ibis? Ibis is a Python library that provides a lightweight, universal interface for data wrangling. It helps Python users explore and transform data of any size, stored anywhere. Ibis has three primary components: 1. **A dataframe API for Python**. Python users can write Ibis code to manipulate tabular data. 2. **Interfaces to 10+ query engines.** Wherever data is stored, people can use Ibis as their API of choice to communicate with any of those query engines. 3. **Deferred execution**. Ibis uses deferred execution, so execution of code is pushed to the query engine. Users can execute at the speed of their backend, not their local computer. ## Why Use Ibis? Ibis aims to be a future-proof solution to interacting with data using Python and can accomplish this goal through its main features: - **Familiar API**: Ibis’s API design borrows from popular APIs like pandas and dplyr that most users already know and like to use. - **Consistent syntax**: Ibis aims to be a universal Python API for tabular data of any size, big or small. - **Deferred execution**: Ibis pushes code execution to the query engine and only moves required data into memory when necessary. Analytics workflows are faster and more efficient - **Interactive mode**: Ibis provides an interactive mode in which users can quickly diagnose problems, explore data, and mock up workflows and pipelines locally. - **10+ supported backends**: Ibis supports multiple query engines and DataFrame APIs. Use one interface to transform with your data wherever it lives: from DataFrames in pandas to Parquet files through DuckDB to tables in BigQuery. - **Minimize rewrites**: Teams can often keep their Ibis code the same regardless of backend changes, like increasing or decreasing computing power, changing the number or size of their databases, or switching backends entirely. - **Flexibility when you need it**: When Ibis doesn't support something, it provides a way to jump directly into SQL. ## Common Use Cases - **Speed up prototype to production.** Scale code written and tested locally to a distributed system or cloud SQL engine with minimal rewrites. - **Boost performance of existing Python or pandas code.** For example a general rule of thumb for pandas is "Have 5 to 10 times as much RAM as the size of your dataset". When a dataset exceeds this rule using in-memory frameworks like pandas can be slow. Instead, using Ibis will significantly speed up your workflows because of its deferred execution. Ibis also empowers you to switch to a faster database engine, without changing much of your code. - **Get rid of long, error-prone, `f`-strings.** Ibis provides one syntax for multiple query engines and dataframe APIs that lets you avoid learning new flavors of SQL or other framework-specific code. Learn the syntax once and use that syntax anywhere. ## Backends Ibis acts as a universal frontend to the following systems: - [Apache Impala](https://ibis-project.org/backends/Impala/) - [ClickHouse](https://ibis-project.org/backends/ClickHouse/) - [Dask](https://ibis-project.org/backends/Dask/) - [DuckDB](https://ibis-project.org/backends/DuckDB/) - [Google BigQuery](https://ibis-project.org/backends/BigQuery/) - [HeavyAI](https://github.com/heavyai/ibis-heavyai) - [MySQL](https://ibis-project.org/backends/MySQL/) - [Microsoft SQL Server](https://ibis-project.org/backends/MSSQL/) - [Pandas](https://ibis-project.org/backends/Pandas/) - [Polars](https://ibis-project.org/backends/Polars/) - [PostgreSQL](https://ibis-project.org/backends/PostgreSQL/) - [PySpark](https://ibis-project.org/backends/PySpark/) - [Snowflake](https://ibis-project.org/backends/Snowflake) (experimental) - [SQLite](https://ibis-project.org/backends/SQLite/) - [Trino](https://ibis-project.org/backends/Trino/) (experimental) The list of supported backends is continuously growing. Anyone can get involved in adding new ones! Learn more about contributing to ibis in our contributing documentation at https://github.com/ibis-project/ibis/blob/master/docs/CONTRIBUTING.md ## Installation Install Ibis from PyPI with: ```bash pip install 'ibis-framework[duckdb]' ``` Or from conda-forge with: ```bash conda install ibis-framework -c conda-forge ``` (It’s a common mistake to `pip install ibis`. If you try to use Ibis and get errors early on try uninstalling `ibis` and installing `ibis-framework`) To discover ibis, we suggest starting with the DuckDB backend (which is included by default in the conda-forge package). The DuckDB backend is performant and fully featured. To use ibis with other backends, include the backend name in brackets for PyPI: ```bash pip install 'ibis-framework[postgres]' ``` Or use `ibis-$BACKEND` where `$BACKEND` is the specific backend you want to use when installing from conda-forge: ```bash conda install ibis-postgres -c conda-forge ``` ## Getting Started with Ibis You can find a number of [helpful tutorials](https://ibis-project.org/tutorial/01-Introduction-to-Ibis/) on the Ibis website: - [Introduction to Ibis](https://ibis-project.org/tutorial/01-Introduction-to-Ibis/) - [Aggregating and Joining Data](https://ibis-project.org/tutorial/02-Aggregates-Joins/) - [Creating and Inserting Data](https://ibis-project.org/tutorial/05-IO-Create-Insert-External-Data/) You can also get started analyzing any dataset, anywhere with just a few lines of Ibis code. Here’s an example of how to use Ibis with an SQLite database. Download the SQLite database from the `ibis-tutorial-data` GCS (Google Cloud Storage) bucket, then connect to it using ibis. ```bash curl -LsS -o geography.db 'https://storage.googleapis.com/ibis-tutorial-data/geography.db' ``` Connect to the database and show the available tables ```python >>> import ibis >>> from ibis import _ >>> ibis.options.interactive = True >>> con = ibis.sqlite.connect("geography.db") >>> con.tables Tables ------ - countries - gdp - independence ``` Choose the `countries` table and preview its first few rows ```python >>> countries = con.tables.countries >>> countries.head() ┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━┓ ┃ iso_alpha2 ┃ iso_alpha3 ┃ iso_numeric ┃ fips ┃ name ┃ capital ┃ area_km2 ┃ population ┃ continent ┃ ┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━┩ │ string │ string │ int32 │ string │ string │ string │ float64 │ int32 │ string │ ├────────────┼────────────┼─────────────┼────────┼──────────────────────┼──────────────────┼──────────┼────────────┼───────────┤ │ AD │ AND │ 20 │ AN │ Andorra │ Andorra la Vella │ 468.0 │ 84000 │ EU │ │ AE │ ARE │ 784 │ AE │ United Arab Emirates │ Abu Dhabi │ 82880.0 │ 4975593 │ AS │ │ AF │ AFG │ 4 │ AF │ Afghanistan │ Kabul │ 647500.0 │ 29121286 │ AS │ │ AG │ ATG │ 28 │ AC │ Antigua and Barbuda │ St. Johns │ 443.0 │ 86754 │ NA │ │ AI │ AIA │ 660 │ AV │ Anguilla │ The Valley │ 102.0 │ 13254 │ NA │ └────────────┴────────────┴─────────────┴────────┴──────────────────────┴──────────────────┴──────────┴────────────┴───────────┘ ``` Show the 5 least populous countries in Asia ```python >>> ( ... countries.filter(_.continent == "AS") ... .select("name", "population") ... .order_by(_.population) ... .limit(5) ... ) ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ ┃ name ┃ population ┃ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ │ string │ int32 │ ├────────────────────────────────┼────────────┤ │ Cocos [Keeling] Islands │ 628 │ │ British Indian Ocean Territory │ 4000 │ │ Brunei │ 395027 │ │ Maldives │ 395650 │ │ Macao │ 449198 │ └────────────────────────────────┴────────────┘ ``` ## Community and Contributing Ibis is an open source project and welcomes contributions from anyone in the community. - Read [the contributing guide](https://github.com/ibis-project/ibis/blob/master/docs/CONTRIBUTING.md). - We care about keeping the community welcoming for all. Check out [the code of conduct](https://github.com/ibis-project/ibis/blob/master/docs/CODE_OF_CONDUCT.md). - The Ibis project is open sourced under the [Apache License](https://github.com/ibis-project/ibis/blob/master/LICENSE.txt). Join our community here: - Twitter: https://twitter.com/IbisData - Gitter: https://gitter.im/ibis-dev/Lobby - StackOverflow: https://stackoverflow.com/questions/tagged/ibis For more information visit https://ibis-project.org/.

SQL data analysis & visualization projects using MySQL, PostgreSQL, SQLite, Tableau, Apache Spark and pySpark.

Reliable PostgreSQL Backup & Restore

# pgBackRest <br/> Reliable PostgreSQL Backup & Restore ## Introduction pgBackRest aims to be a reliable, easy-to-use backup and restore solution that can seamlessly scale up to the largest databases and workloads by utilizing algorithms that are optimized for database-specific requirements. pgBackRest [v2.44](https://github.com/pgbackrest/pgbackrest/releases/tag/release/2.44) is the current stable release. Release notes are on the [Releases](http://www.pgbackrest.org/release.html) page. Please find us on [GitHub](https://github.com/pgbackrest/pgbackrest) and give us a star if you like pgBackRest! ## Features ### Parallel Backup & Restore Compression is usually the bottleneck during backup operations so pgBackRest solves this problem with parallel processing and more efficient compression algorithms such as lz4 and zstd. ### Local or Remote Operation A custom protocol allows pgBackRest to backup, restore, and archive locally or remotely via TLS/SSH with minimal configuration. An interface to query PostgreSQL is also provided via the protocol layer so that remote access to PostgreSQL is never required, which enhances security. ### Multiple Repositories Multiple repositories allow, for example, a local repository with minimal retention for fast restores and a remote repository with a longer retention for redundancy and access across the enterprise. ### Full, Incremental, & Differential Backups Full, differential, and incremental backups are supported. pgBackRest is not susceptible to the time resolution issues of rsync, making differential and incremental backups safe without the requirement to checksum each file. ### Backup Rotation & Archive Expiration Retention polices can be set for full and differential backups to create coverage for any time frame. The WAL archive can be maintained for all backups or strictly for the most recent backups. In the latter case WAL required to make older backups consistent will be maintained in the archive. ### Backup Integrity Checksums are calculated for every file in the backup and rechecked during a restore or verify. After a backup finishes copying files, it waits until every WAL segment required to make the backup consistent reaches the repository. Backups in the repository may be stored in the same format as a standard PostgreSQL cluster (including tablespaces). If compression is disabled and hard links are enabled it is possible to snapshot a backup in the repository and bring up a PostgreSQL cluster directly on the snapshot. This is advantageous for terabyte-scale databases that are time consuming to restore in the traditional way. All operations utilize file and directory level fsync to ensure durability. ### Page Checksums PostgreSQL has supported page-level checksums since 9.3. If page checksums are enabled pgBackRest will validate the checksums for every file that is copied during a backup. All page checksums are validated during a full backup and checksums in files that have changed are validated during differential and incremental backups. Validation failures do not stop the backup process, but warnings with details of exactly which pages have failed validation are output to the console and file log. This feature allows page-level corruption to be detected early, before backups that contain valid copies of the data have expired. ### Backup Resume An interrupted backup can be resumed from the point where it was stopped. Files that were already copied are compared with the checksums in the manifest to ensure integrity. Since this operation can take place entirely on the repository host, it reduces load on the PostgreSQL host and saves time since checksum calculation is faster than compressing and retransmitting data. ### Streaming Compression & Checksums Compression and checksum calculations are performed in stream while files are being copied to the repository, whether the repository is located locally or remotely. If the repository is on a repository host, compression is performed on the PostgreSQL host and files are transmitted in a compressed format and simply stored on the repository host. When compression is disabled a lower level of compression is utilized to make efficient use of available bandwidth while keeping CPU cost to a minimum. ### Delta Restore The manifest contains checksums for every file in the backup so that during a restore it is possible to use these checksums to speed processing enormously. On a delta restore any files not present in the backup are first removed and then checksums are generated for the remaining files. Files that match the backup are left in place and the rest of the files are restored as usual. Parallel processing can lead to a dramatic reduction in restore times. ### Parallel, Asynchronous WAL Push & Get Dedicated commands are included for pushing WAL to the archive and getting WAL from the archive. Both commands support parallelism to accelerate processing and run asynchronously to provide the fastest possible response time to PostgreSQL. WAL push automatically detects WAL segments that are pushed multiple times and de-duplicates when the segment is identical, otherwise an error is raised. Asynchronous WAL push allows transfer to be offloaded to another process which compresses WAL segments in parallel for maximum throughput. This can be a critical feature for databases with extremely high write volume. Asynchronous WAL get maintains a local queue of WAL segments that are decompressed and ready for replay. This reduces the time needed to provide WAL to PostgreSQL which maximizes replay speed. Higher-latency connections and storage (such as S3) benefit the most. The push and get commands both ensure that the database and repository match by comparing PostgreSQL versions and system identifiers. This virtually eliminates the possibility of misconfiguring the WAL archive location. ### Tablespace & Link Support Tablespaces are fully supported and on restore tablespaces can be remapped to any location. It is also possible to remap all tablespaces to one location with a single command which is useful for development restores. File and directory links are supported for any file or directory in the PostgreSQL cluster. When restoring it is possible to restore all links to their original locations, remap some or all links, or restore some or all links as normal files or directories within the cluster directory. ### S3, Azure, and GCS Compatible Object Store Support pgBackRest repositories can be located in S3, Azure, and GCS compatible object stores to allow for virtually unlimited capacity and retention. ### Encryption pgBackRest can encrypt the repository to secure backups wherever they are stored. ### Compatibility with ten versions of PostgreSQL pgBackRest includes support for ten versions of PostgreSQL, the five supported versions and the last five EOL versions. This allows ample time to upgrade to a supported version. ## Getting Started pgBackRest strives to be easy to configure and operate: - [User guides](http://www.pgbackrest.org/user-guide-index.html) for various operating systems and PostgreSQL versions. - [Command reference](http://www.pgbackrest.org/command.html) for command-line operations. - [Configuration reference](http://www.pgbackrest.org/configuration.html) for creating pgBackRest configurations. Documentation for v1 can be found [here](http://www.pgbackrest.org/1). No further releases are planned for v1 because v2 is backward-compatible with v1 options and repositories. ## Contributions Contributions to pgBackRest are always welcome! Please see our [Contributing Guidelines](https://github.com/pgbackrest/pgbackrest/blob/main/CONTRIBUTING.md) for details on how to contribute features, improvements or issues. ## Support pgBackRest is completely free and open source under the [MIT](https://github.com/pgbackrest/pgbackrest/blob/main/LICENSE) license. You may use it for personal or commercial purposes without any restrictions whatsoever. Bug reports are taken very seriously and will be addressed as quickly as possible. Creating a robust disaster recovery policy with proper replication and backup strategies can be a very complex and daunting task. You may find that you need help during the architecture phase and ongoing support to ensure that your enterprise continues running smoothly. [Crunchy Data](http://www.crunchydata.com) provides packaged versions of pgBackRest for major operating systems and expert full life-cycle commercial support for pgBackRest and all things PostgreSQL. [Crunchy Data](http://www.crunchydata.com) is committed to providing open source solutions with no vendor lock-in, ensuring that cross-compatibility with the community version of pgBackRest is always strictly maintained. Please visit [Crunchy Data](http://www.crunchydata.com) for more information. ## Recognition Primary recognition goes to Stephen Frost for all his valuable advice and criticism during the development of pgBackRest. [Crunchy Data](http://www.crunchydata.com) has contributed significant time and resources to pgBackRest and continues to actively support development. [Resonate](http://www.resonate.com) also contributed to the development of pgBackRest and allowed early (but well tested) versions to be installed as their primary PostgreSQL backup solution. [Armchair](https://thenounproject.com/search/?q=lounge+chair&i=129971) graphic by [Sandor Szabo](https://thenounproject.com/sandorsz).

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或请作者喝杯咖啡 

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.

🔥 The fastest way to build type safe web apps. IHP is a new batteries-included web framework optimized for longterm productivity and programmer happiness

<p align="center"> <a href="https://ihp.digitallyinduced.com/" target="_blank"> <img src="Guide/images/ihp-logo-readme.svg" /> </a> </p> <p align="center"> <img alt="MIT License" src="https://img.shields.io/github/license/digitallyinduced/ihp"> <a href="https://twitter.com/digitallyinduce" target="_blank"> <img src="https://img.shields.io/twitter/follow/digitallyinduce"/> </a> </p> <p align="center"> <a href="https://ihp.digitallyinduced.com/" target="_blank"> IHP Website </a> </p> # About IHP IHP is a modern batteries-included haskell web framework, built on top of Haskell and Nix. We believe that functional programing is the future of software development and want to make functional programing with haskell and nix available to anyone. We try to offer a solution which can be used by developers who have not worked with haskell yet. IHP comes with everything you need to build great web applications with haskell and nix. We have made a lot of pragmatic decisions to get you started faster. This way you can just pick up haskell along the way :-) IHP stands for Integrated Haskell Platform. ## What makes it different? **Type-safe and reliable:** With Haskell and Nix we use the most reliable technologies available, to make sure your application will never crash because of Null Pointer Exceptions. If you like TypeScript, you will love IHP. **Live Reload:** While haskell is a compiled language, the built-in dev server automatically reloads your code changes using the fastest way possible. Changes are reflected instantly. Just like good old PHP.  [Watch it in action!](https://youtu.be/nTjjDo57B8g) **Accessible:** Setup of the fully-managed dev environment takes just 5 minutes. All dependencies (even database and compiler) are managed using the nix package manager. This means dependency problems just cannot occur anymore. Also everything is guaranteed to be same for all developers in your team. **No Haskell Experience required:** Code Generators will help you to quickly build things even when you have no professional haskell experience yet. Pick up haskell by building real world applications. **Integrated Dev Tooling:** To speed up your development process, IHP comes with a full set of web based dev tools. Including: a database schema designer, a web-based code generator, a web-based repl, ... **Major Operating Systems Supported:** Windows (via Linux Subsystem), macOS, NixOS, Debian, Ubuntu **HSX:** Like React's JSX. Write html code in your haskell files. This will be transformed to actual type-checked haskell code at compile time. **Auto Refresh:** Re-render views in the background when the underlying data changes. This is useful when you want your views to always reflect the live database state. Auto Refresh can be an easy replacement for manually polling for changes using AJAX. Here's a view using Auto Refresh, there's no app specific JS code here. All view updates are triggered by the server:  Auto Refresh can be enabled for IHP views with a single line of code. [Watch it in action!](https://twitter.com/digitallyinduce/status/1312017800223956992) **Longterm Roadmap** Lots of frameworks are already gone a year after launch. Especially in the fast moving JS world. But don't worry about IHP. We have been using it at digitally induced since 2017. It's actively used by us and our friends and partners. Even without external contributors we will build new features and do periodic maintenance releases in the future. We have big plans for IHP and as a profitable and independent software company we have the ability to actually execute them over the longterm. ## Reviews Here's what other people are saying about IHP: <blockquote> IHP is the best web framework experience I have had. I think a lot of aspiring haskeller's will have worked their way through a text like Learn You a Haskell For Great Good or similar and then be looking to fool around with an actual project. IHP uses nix to cut out all the work of setting up ghc/stack/cabal which can be quite tricky for a beginner, it has just added haskell language server integration, it starts your postgres servers, it spares you from having to remember your SQL syntax, and means you can start writing haskell code instantly while getting immediate feedback on your hacking from GHCi and visually through the live reloading of the web app in your browser. I've found the [hsx||] quasiquotes quite fun to work with and type safety has sped up development by preventing bugs that can easily crop up when you're linking forms to databases. I like the design choices in IHP, and for me, at the moment, I like the focus on server side web app development, which encourages you to be more sparing/judicious in the use of javascript. With IHP being opinionated about the models or views and routing it means I can focus on integrating some of the other really cool haskell libraries that exist into web apps. (I'm also trying to keep a log of my experiences here on an https://ihpcafe.ihpapp.com if you want to read along with someone figuring out function type signatures ;) ) </blockquote> <a href="https://news.ycombinator.com/item?id=24817368">montmorency88 on HN</a> <blockquote> I have been learning Haskell through IHP. It's the best and actually simplest web framework I have ever tried. The developer experience is the best I ever had for a MVC-style framework. And I got to learn Haskell without banging my head too much against the wall. Really enjoyed it :) I really needed something like IHP to get started with Haskell. It's fun and easy and the documentation is very easy to follow. I see some argue that they wish to make more custom choices regarding the setup. That is precisely what I don't want and that's why IHP is a great fit for me. In terms of simplicity I think the choice of supporting only Nix and Postgres actually are strengths at this point. That lets them streamline the development of the framework without supporting the minor preferences of every individual. And these choices should work really well for most web developers. Some may disagree on this, and maybe IHP is not for them, but I don't think it shouldn't discourage those who considers trying it out and form their own opinion. I was prepared for great hardships learning Haskell as most of the resources are very academic and I'm mainly just a simple application builder. IHP was just what I needed to fill that gap, and it made it really fun :) I am tweeting about the whole thing, coding Haskell for 100 days: https://twitter.com/larsparsfromage </blockquote> <a href="https://news.ycombinator.com/item?id=24829215">kodefant on HN</a> <blockquote> IHP is supposed to become the Django/Rails/Phoenix of Haskell. I’ve been using Django professionally for since 2013, but have started using IHP a couple of weeks ago. It’s still quite early but with surprisingly few rough edges, i.e. the developer ergonomics are much better than I expected. It has great documentation that is improving rapidly (as opposed to many other Haskell libraries, which provide little more than API docs or even just the typed function definitions) and offers a refreshing take on database management and migrations. Some of its killer features: HSX, a JSX-like template language that looks like HTML while providing type safety Auto live reloading without the need to setup anything Documentation with examples: it lets you query the database without learning about monads it defines |> for you ;-) type-safe, composable SQL queries </blockquote> <a href="https://lobste.rs/s/8pieht/ihp_modern_batteries_included_web#c_6lroyn">hendi on Lobsters</a> There's more on the IHP website. ## Getting Started [First: Watch the introduction video to see how it generally works](https://youtu.be/UbDtS_mUMpI) **After that:** [If you like videos, check out IHP Casts!](https://www.youtube.com/watch?v=PLl9Sjq6Nzc&list=PLenFm8BWuKlS0IaE31DmKB_PbkMLmwWmG&index=1). [You can also follow the written Guide to build your first project!](https://ihp.digitallyinduced.com/Guide/) 🚀 [📧 To stay in the loop, subscribe to the IHP release emails.](https://ihp.digitallyinduced.com/MailingList) Or follow [](https://twitter.com/digitallyinduce) ## Install [See the documentation for installation instructions](https://ihp.digitallyinduced.com/Guide/installation.html) ## Community Questions, or need help with haskell type errors? [Join our Slack Community](https://ihp.digitallyinduced.com/Slack) [Also check out the IHP Forum!](https://forum.ihpapp.com/) ## Contributing We are happy to merge your pull requests!😄 See [CONTRIBUTING.md](CONTRIBUTING.md) for more info. ### Contributing Documentation If you just want to improve docs, [you can find the markdown files in the Guide directory](https://github.com/digitallyinduced/ihp/tree/master/Guide). ## Releases During beta, there is a new release every two weeks on Friday. You can find steps to update to the latest version [in the release notes](https://github.com/digitallyinduced/ihp/releases). [📧 Subscribe to the IHP release emails to stay in the loop.](https://ihp.digitallyinduced.com/MailingList) ### Apple M1 Builds Binaries for Apple M1 Builds are sponsored by [MacStadium](https://www.macstadium.com/). <img src="https://uploads-ssl.webflow.com/5ac3c046c82724970fc60918/5c019d917bba312af7553b49_MacStadium-developerlogo.png" width="300px"/>

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>

Synopse mORMot 1 ORM/SOA/MVC framework - Please upgrade to mORMot 2 !

RUM access method - inverted index with additional information in posting lists

[](https://travis-ci.com/postgrespro/rum) [](https://badge.fury.io/pg/rum) [](https://raw.githubusercontent.com/postgrespro/rum/master/LICENSE) [](https://postgrespro.com/) # RUM - RUM access method ## Introduction The **rum** module provides an access method to work with a `RUM` index. It is based on the `GIN` access method's code. A `GIN` index allows performing fast full-text search using `tsvector` and `tsquery` types. But full-text search with a GIN index has several problems: - Slow ranking. It needs positional information about lexemes to do ranking. A `GIN` index doesn't store positions of lexemes. So after index scanning, we need an additional heap scan to retrieve lexeme positions. - Slow phrase search with a `GIN` index. This problem relates to the previous problem. It needs positional information to perform phrase search. - Slow ordering by timestamp. A `GIN` index can't store some related information in the index with lexemes. So it is necessary to perform an additional heap scan. `RUM` solves these problems by storing additional information in a posting tree. For example, positional information of lexemes or timestamps. You can get an idea of `RUM` with the following diagram:  A drawback of `RUM` is that it has slower build and insert times than `GIN`. This is because we need to store additional information besides keys and because `RUM` uses generic Write-Ahead Log (WAL) records. ## License This module is available under the [license](LICENSE) similar to [PostgreSQL](http://www.postgresql.org/about/licence/). ## Installation Before building and installing **rum**, you should ensure following are installed: * PostgreSQL version is 9.6+. Typical installation procedure may look like this: ### Using GitHub repository $ git clone https://github.com/postgrespro/rum $ cd rum $ make USE_PGXS=1 $ make USE_PGXS=1 install $ make USE_PGXS=1 installcheck $ psql DB -c "CREATE EXTENSION rum;" ### Using PGXN $ USE_PGXS=1 pgxn install rum > **Important:** Don't forget to set the `PG_CONFIG` variable in case you want to test `RUM` on a custom build of PostgreSQL. Read more [here](https://wiki.postgresql.org/wiki/Building_and_Installing_PostgreSQL_Extension_Modules). ## Common operators and functions The **rum** module provides next operators. | Operator | Returns | Description | -------------------- | ------- | ---------------------------------------------- | tsvector &lt;=&gt; tsquery | float4 | Returns distance between tsvector and tsquery. | timestamp &lt;=&gt; timestamp | float8 | Returns distance between two timestamps. | timestamp &lt;=&#124; timestamp | float8 | Returns distance only for left timestamps. | timestamp &#124;=&gt; timestamp | float8 | Returns distance only for right timestamps. The last three operations also work for types timestamptz, int2, int4, int8, float4, float8, money and oid. ## Operator classes **rum** provides the following operator classes. ### rum_tsvector_ops For type: `tsvector` This operator class stores `tsvector` lexemes with positional information. It supports ordering by the `<=>` operator and prefix search. See the example below. Let us assume we have the table: ```sql CREATE TABLE test_rum(t text, a tsvector); CREATE TRIGGER tsvectorupdate BEFORE UPDATE OR INSERT ON test_rum FOR EACH ROW EXECUTE PROCEDURE tsvector_update_trigger('a', 'pg_catalog.english', 't'); INSERT INTO test_rum(t) VALUES ('The situation is most beautiful'); INSERT INTO test_rum(t) VALUES ('It is a beautiful'); INSERT INTO test_rum(t) VALUES ('It looks like a beautiful place'); ``` To create the **rum** index we need create an extension: ```sql CREATE EXTENSION rum; ``` Then we can create new index: ```sql CREATE INDEX rumidx ON test_rum USING rum (a rum_tsvector_ops); ``` And we can execute the following queries: ```sql SELECT t, a <=> to_tsquery('english', 'beautiful | place') AS rank FROM test_rum WHERE a @@ to_tsquery('english', 'beautiful | place') ORDER BY a <=> to_tsquery('english', 'beautiful | place'); t | rank ---------------------------------+--------- It looks like a beautiful place | 8.22467 The situation is most beautiful | 16.4493 It is a beautiful | 16.4493 (3 rows) SELECT t, a <=> to_tsquery('english', 'place | situation') AS rank FROM test_rum WHERE a @@ to_tsquery('english', 'place | situation') ORDER BY a <=> to_tsquery('english', 'place | situation'); t | rank ---------------------------------+--------- The situation is most beautiful | 16.4493 It looks like a beautiful place | 16.4493 (2 rows) ``` ### rum_tsvector_hash_ops For type: `tsvector` This operator class stores a hash of `tsvector` lexemes with positional information. It supports ordering by the `<=>` operator. It **doesn't** support prefix search. ### rum_TYPE_ops For types: int2, int4, int8, float4, float8, money, oid, time, timetz, date, interval, macaddr, inet, cidr, text, varchar, char, bytea, bit, varbit, numeric, timestamp, timestamptz Supported operations: `<`, `<=`, `=`, `>=`, `>` for all types and `<=>`, `<=|` and `|=>` for int2, int4, int8, float4, float8, money, oid, timestamp and timestamptz types. This operator supports ordering by the `<=>`, `<=|` and `|=>` operators. It can be used with `rum_tsvector_addon_ops`, `rum_tsvector_hash_addon_ops' and `rum_anyarray_addon_ops` operator classes. ### rum_tsvector_addon_ops For type: `tsvector` This operator class stores `tsvector` lexemes with any supported by module field. See the example below. Let us assume we have the table: ```sql CREATE TABLE tsts (id int, t tsvector, d timestamp); \copy tsts from 'rum/data/tsts.data' CREATE INDEX tsts_idx ON tsts USING rum (t rum_tsvector_addon_ops, d) WITH (attach = 'd', to = 't'); ``` Now we can execute the following queries: ```sql EXPLAIN (costs off) SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5; QUERY PLAN ----------------------------------------------------------------------------------- Limit -> Index Scan using tsts_idx on tsts Index Cond: (t @@ '''wr'' & ''qh'''::tsquery) Order By: (d <=> 'Mon May 16 14:21:25 2016'::timestamp without time zone) (4 rows) SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5; id | d | ?column? -----+---------------------------------+--------------- 355 | Mon May 16 14:21:22.326724 2016 | 2.673276 354 | Mon May 16 13:21:22.326724 2016 | 3602.673276 371 | Tue May 17 06:21:22.326724 2016 | 57597.326724 406 | Wed May 18 17:21:22.326724 2016 | 183597.326724 415 | Thu May 19 02:21:22.326724 2016 | 215997.326724 (5 rows) ``` > **Warning:** Currently RUM has bogus behaviour when one creates an index using ordering over pass-by-reference additional information. This is due to the fact that posting trees have fixed length right bound and fixed length non-leaf posting items. It isn't allowed to create such indexes. ### rum_tsvector_hash_addon_ops For type: `tsvector` This operator class stores a hash of `tsvector` lexemes with any supported by module field. It **doesn't** support prefix search. ### rum_tsquery_ops For type: `tsquery` It stores branches of query tree in additional information. For example, we have the table: ```sql CREATE TABLE query (q tsquery, tag text); INSERT INTO query VALUES ('supernova & star', 'sn'), ('black', 'color'), ('big & bang & black & hole', 'bang'), ('spiral & galaxy', 'shape'), ('black & hole', 'color'); CREATE INDEX query_idx ON query USING rum(q); ``` Now we can execute the following fast query: ```sql SELECT * FROM query WHERE to_tsvector('black holes never exists before we think about them') @@ q; q | tag ------------------+------- 'black' | color 'black' & 'hole' | color (2 rows) ``` ### rum_anyarray_ops For type: `anyarray` This operator class stores `anyarray` elements with length of the array. It supports operators `&&`, `@>`, `<@`, `=`, `%` operators. It also supports ordering by `<=>` operator. For example, we have the table: ```sql CREATE TABLE test_array (i int2[]); INSERT INTO test_array VALUES ('{}'), ('{0}'), ('{1,2,3,4}'), ('{1,2,3}'), ('{1,2}'), ('{1}'); CREATE INDEX idx_array ON test_array USING rum (i rum_anyarray_ops); ``` Now we can execute the query using index scan: ```sql SET enable_seqscan TO off; EXPLAIN (COSTS OFF) SELECT * FROM test_array WHERE i && '{1}' ORDER BY i <=> '{1}' ASC; QUERY PLAN ------------------------------------------ Index Scan using idx_array on test_array Index Cond: (i && '{1}'::smallint[]) Order By: (i <=> '{1}'::smallint[]) (3 rows SELECT * FROM test_array WHERE i && '{1}' ORDER BY i <=> '{1}' ASC; i ----------- {1} {1,2} {1,2,3} {1,2,3,4} (4 rows) ``` ### rum_anyarray_addon_ops For type: `anyarray` This operator class stores `anyarray` elements with any supported by module field. ## Todo - Allow multiple additional information (lexemes positions + timestamp). - Improve ranking function to support TF/IDF. - Improve insert time. - Improve GENERIC WAL to support shift (PostgreSQL core changes). ## Authors Alexander Korotkov <[email protected]> Postgres Professional Ltd., Russia Oleg Bartunov <[email protected]> Postgres Professional Ltd., Russia Teodor Sigaev <[email protected]> Postgres Professional Ltd., Russia Arthur Zakirov <[email protected]> Postgres Professional Ltd., Russia Pavel Borisov <[email protected]> Postgres Professional Ltd., Russia Maxim Orlov <[email protected]> Postgres Professional Ltd., Russia

Columnar storage extension for Postgres built as a foreign data wrapper. Check out https://github.com/citusdata/citus for a modernized columnar storage implementation built as a table access method.

## Important notice: Columnar storage is now part of Citus Columnar storage is now part of the [Citus extension](https://github.com/citusdata/citus), which uses the table access method API to give a much more native experience. It also supports streaming replication, archival, rollback, and simplifies pg_upgrade. You can use Citus just for columnar storage on a single PostgreSQL server, or combine it with distributed tables to parallelize queries locally or across a cluster of PostgreSQL servers. Migration is simple, and you'll typically see improved compression thanks to [zstd](https://github.com/facebook/zstd): ```sql -- After adding adding shared_preload_libraries = 'citus' -- to postgresql.conf and restarting: CREATE EXTENSION IF NOT EXISTS citus; -- Create a table using the columnar access method, with the same columns -- as an existing cstore_fdw table CREATE TABLE customer_reviews_am ( LIKE customer_reviews_fdw INCLUDING ALL ) USING columnar; -- Copy data from an old cstore_fdw table to an access method table INSERT INTO customer_reviews_am SELECT * FROM customer_reviews_fdw; -- cstore_fdw data size SELECT pg_size_pretty(cstore_table_size('customer_reviews_fdw')); ┌────────────────┐ │ pg_size_pretty │ ├────────────────┤ │ 100 MB │ └────────────────┘ -- Citus Columnar data size SELECT pg_size_pretty(pg_table_size('customer_reviews_am')); ┌────────────────┐ │ pg_size_pretty │ ├────────────────┤ │ 64 MB │ └────────────────┘ ``` Read more about it in the [Citus columnar blog post](https://www.citusdata.com/blog/2021/03/06/citus-10-columnar-compression-for-postgres/) by Jeff Davis. cstore_fdw ========== [][status] [][coverage] Cstore_fdw is an open source columnar store extension for PostgreSQL. Columnar stores provide notable benefits for analytics use cases where data is loaded in batches. Cstore_fdw’s columnar nature delivers performance by only reading relevant data from disk, and it may compress data 6x-10x to reduce space requirements for data archival. Cstore_fdw is developed by [Citus Data](https://www.citusdata.com) and can be used in combination with [Citus](https://github.com/citusdata/citus), a postgres extension that intelligently distributes your data and queries across many nodes so your database can scale and your queries are fast. If you have any questions about how Citus can help you scale or how to use Citus in combination with cstore_fdw, [please let us know](https://www.citusdata.com/about/contact_us/). Join the [Mailing List][mailing-list] to stay on top of the latest developments for Cstore_fdw. Introduction ------------ This extension uses a format for its data layout that is inspired by ORC, the Optimized Row Columnar format. Like ORC, the cstore format improves upon RCFile developed at Facebook, and brings the following benefits: * Compression: Reduces in-memory and on-disk data size by 2-4x. Can be extended to support different codecs. * Column projections: Only reads column data relevant to the query. Improves performance for I/O bound queries. * Skip indexes: Stores min/max statistics for row groups, and uses them to skip over unrelated rows. Further, we used the Postgres foreign data wrapper APIs and type representations with this extension. This brings: * Support for 40+ Postgres data types. The user can also create new types and use them. * Statistics collection. PostgreSQL's query optimizer uses these stats to evaluate different query plans and pick the best one. * Simple setup. Create foreign table and copy data. Run SQL. Building -------- cstore\_fdw depends on protobuf-c for serializing and deserializing table metadata. So we need to install these packages first: # Fedora 17+, CentOS, and Amazon Linux sudo yum install protobuf-c-devel # Ubuntu 10.4+ sudo apt-get install protobuf-c-compiler sudo apt-get install libprotobuf-c0-dev # Ubuntu 18.4+ sudo apt-get install protobuf-c-compiler sudo apt-get install libprotobuf-c-dev # Mac OS X brew install protobuf-c **Note.** In CentOS 5, 6, and 7, you may need to install or update EPEL 5, 6, or 7 repositories. See [this page](https://support.rackspace.com/how-to/install-epel-and-additional-repositories-on-centos-and-red-hat/) for instructions. **Note.** In Amazon Linux, the EPEL repository is installed by default, but not enabled. See [these instructions](http://aws.amazon.com/amazon-linux-ami/faqs/#epel) for how to enable it. Once you have protobuf-c installed on your machine, you are ready to build cstore\_fdw. For this, you need to include the pg\_config directory path in your make command. This path is typically the same as your PostgreSQL installation's bin/ directory path. For example: PATH=/usr/local/pgsql/bin/:$PATH make sudo PATH=/usr/local/pgsql/bin/:$PATH make install **Note.** cstore_fdw requires PostgreSQL version from 9.3 to 12. It doesn't support earlier versions of PostgreSQL. Usage ----- Before using cstore\_fdw, you need to add it to ```shared_preload_libraries``` in your ```postgresql.conf``` and restart Postgres: shared_preload_libraries = 'cstore_fdw' # (change requires restart) The following parameters can be set on a cstore foreign table object. * filename (optional): The absolute path to the location for storing table data. If you don't specify the filename option, cstore\_fdw will automatically choose the $PGDATA/cstore\_fdw directory to store the files. If specified the value of this parameter will be used as a prefix for all files created to store table data. For example, the value ```/cstore_fdw/my_table``` could result in the files ```/cstore_fdw/my_table``` and ```/cstore_fdw/my_table.footer``` being used to manage table data. * compression (optional): The compression used for compressing value streams. Valid options are ```none``` and ```pglz```. The default is ```none```. * stripe\_row\_count (optional): Number of rows per stripe. The default is ```150000```. Reducing this decreases the amount memory used for loading data and querying, but also decreases the performance. * block\_row\_count (optional): Number of rows per column block. The default is ```10000```. cstore\_fdw compresses, creates skip indexes, and reads from disk at the block granularity. Increasing this value helps with compression and results in fewer reads from disk. However, higher values also reduce the probability of skipping over unrelated row blocks. To load or append data into a cstore table, you have two options: * You can use the [```COPY``` command][copy-command] to load or append data from a file, a program, or STDIN. * You can use the ```INSERT INTO cstore_table SELECT ...``` syntax to load or append data from another table. You can use the [```ANALYZE``` command][analyze-command] to collect statistics about the table. These statistics help the query planner to help determine the most efficient execution plan for each query. **Note.** We currently don't support updating table using DELETE, and UPDATE commands. We also don't support single row inserts. Updating from earlier versions to 1.7 --------------------------------------- To update an existing cstore_fdw installation from versions earlier than 1.6 you can take the following steps: * Download and install cstore_fdw version 1.6 using instructions from the "Building" section, * Restart the PostgreSQL server, * Run ```ALTER EXTENSION cstore_fdw UPDATE;``` Example ------- As an example, we demonstrate loading and querying data to/from a column store table from scratch here. Let's start with downloading and decompressing the data files. wget http://examples.citusdata.com/customer_reviews_1998.csv.gz wget http://examples.citusdata.com/customer_reviews_1999.csv.gz gzip -d customer_reviews_1998.csv.gz gzip -d customer_reviews_1999.csv.gz Then, let's log into Postgres, and run the following commands to create a column store foreign table: ```SQL -- load extension first time after install CREATE EXTENSION cstore_fdw; -- create server object CREATE SERVER cstore_server FOREIGN DATA WRAPPER cstore_fdw; -- create foreign table CREATE FOREIGN TABLE customer_reviews ( customer_id TEXT, review_date DATE, review_rating INTEGER, review_votes INTEGER, review_helpful_votes INTEGER, product_id CHAR(10), product_title TEXT, product_sales_rank BIGINT, product_group TEXT, product_category TEXT, product_subcategory TEXT, similar_product_ids CHAR(10)[] ) SERVER cstore_server OPTIONS(compression 'pglz'); ``` Next, we load data into the table: ```SQL \COPY customer_reviews FROM 'customer_reviews_1998.csv' WITH CSV; \COPY customer_reviews FROM 'customer_reviews_1999.csv' WITH CSV; ``` **Note.** If you are getting ```ERROR: cannot copy to foreign table "customer_reviews"``` when trying to run the COPY commands, double check that you have added cstore\_fdw to ```shared_preload_libraries``` in ```postgresql.conf``` and restarted Postgres. Next, we collect data distribution statistics about the table. This is optional, but usually very helpful: ```SQL ANALYZE customer_reviews; ``` Finally, let's run some example SQL queries on the column store table. ```SQL -- Find all reviews a particular customer made on the Dune series in 1998. SELECT customer_id, review_date, review_rating, product_id, product_title FROM customer_reviews WHERE customer_id ='A27T7HVDXA3K2A' AND product_title LIKE '%Dune%' AND review_date >= '1998-01-01' AND review_date <= '1998-12-31'; -- Do we have a correlation between a book's title's length and its review ratings? SELECT width_bucket(length(product_title), 1, 50, 5) title_length_bucket, round(avg(review_rating), 2) AS review_average, count(*) FROM customer_reviews WHERE product_group = 'Book' GROUP BY title_length_bucket ORDER BY title_length_bucket; ``` Usage with Citus ---------------- The example above illustrated how to load data into a PostgreSQL database running on a single host. However, sometimes your data is too large to analyze effectively on a single host. Citus is a product built by Citus Data that allows you to run a distributed PostgreSQL database to analyze your data using the power of multiple hosts. You can easily install and run other PostgreSQL extensions and foreign data wrappers—including cstore_fdw—alongside Citus. You can create a cstore_fdw table and distribute it using the ```create_distributed_table()``` UDF just like any other table. You can load data using the ```copy``` command as you would do in single node PostgreSQL. Using Skip Indexes ------------------ cstore_fdw partitions each column into multiple blocks. Skip indexes store minimum and maximum values for each of these blocks. While scanning the table, if min/max values of the block contradict the WHERE clause, then the block is completely skipped. This way, the query processes less data and hence finishes faster. To use skip indexes more efficiently, you should load the data after sorting it on a column that is commonly used in the WHERE clause. This ensures that there is a minimum overlap between blocks and the chance of them being skipped is higher. In practice, the data generally has an inherent dimension (for example a time field) on which it is naturally sorted. Usually, the queries also have a filter clause on that column (for example you want to query only the last week's data), and hence you don't need to sort the data in such cases. Uninstalling cstore_fdw ----------------------- Before uninstalling the extension, first you need to drop all the cstore tables: postgres=# DROP FOREIGN TABLE cstore_table_1; ... postgres=# DROP FOREIGN TABLE cstore_table_n; Then, you should drop the cstore server and extension: postgres=# DROP SERVER cstore_server; postgres=# DROP EXTENSION cstore_fdw; cstore\_fdw automatically creates some directories inside the PostgreSQL's data directory to store its files. To remove them, you can run: $ rm -rf $PGDATA/cstore_fdw Then, you should remove cstore\_fdw from ```shared_preload_libraries``` in your ```postgresql.conf```: shared_preload_libraries = '' # (change requires restart) Finally, to uninstall the extension you can run the following command in the extension's source code directory. This will clean up all the files copied during the installation: $ sudo PATH=/usr/local/pgsql/bin/:$PATH make uninstall Changeset --------- ### Version 1.7.0 * (Fix) Add support for PostgreSQL 12 * (Fix) Support count(t.*) from t type queries * (Fix) Build failures for MacOS 10.14+ * (Fix) Make foreign scan parallel safe * (Fix) Add support for PostgreSQL 11 COPY ### Version 1.6.2 * (Fix) Add support for PostgreSQL 11 ### Version 1.6.1 * (Fix) Fix crash during truncate (Cstore crashing server when enabled, not used) * (Fix) No such file or directory warning when attempting to drop database ### Version 1.6 * (Feature) Added support for PostgreSQL 10. * (Fix) Removed table files when a schema, extension or database is dropped. * (Fix) Removed unused code fragments. * (Fix) Fixed incorrect initialization of stripe buffers. * (Fix) Checked user access rights when executing truncate. * (Fix) Made copy command cancellable. * (Fix) Fixed namespace issue regarding drop table. ### Version 1.5.1 * (Fix) Verify cstore_fdw server on CREATE FOREIGN TABLE command ### Version 1.5 * (Feature) Added support for PostgreSQL 9.6. * (Fix) Removed table data when cstore_fdw table is indirectly dropped. * (Fix) Removed unused code fragments. * (Fix) Fixed column selection logic to return columns used in expressions. * (Fix) Prevented alter table command from changinf column type to incompatible types. ### Version 1.4.1 * (Fix) Compatibility fix for Citus [copy command][copy-command]. ### Version 1.4 * (Feature) Added support for ```TRUNCATE TABLE``` * (Fix) Added support for PostgreSQL 9.5 ### Version 1.3 * (Feature) Added support for ```ALTER TABLE ADD COLUMN``` and ```ALTER TABLE DROP COLUMN```. * (Feature) Added column list support in ```COPY FROM```. * (Optimization) Improve row count estimation, which results in better plans. * (Fix) Fix the deadlock issue during concurrent inserts. * (Fix) Return correct result when using whole row references. ### Version 1.2 * (Feature) Added support for ```COPY TO```. * (Feature) Added support for ```INSERT INTO cstore_table SELECT ...```. * (Optimization) Improved memory usage. * (Fix) Dropping multiple cstore tables in a single command cleans-up files of all them. ### Version 1.1 * (Feature) Make filename option optional, and use a default directory inside $PGDATA to manage cstore tables. * (Feature) Automatically delete files on DROP FOREIGN TABLE. * (Fix) Return empty table if no data has been loaded. Previously, cstore_fdw errored out. * (Fix) Fix overestimating relation column counts when planning. * (Feature) Added cstore\_table\_size(tablename) for getting the size of a cstore table in bytes. Copyright --------- Copyright (c) Citus Data, Inc. This module is free software; you can redistribute it and/or modify it under the Apache v2.0 License. For all types of questions and comments about the wrapper, please contact us at engage @ citusdata.com. [status]: https://travis-ci.org/citusdata/cstore_fdw [mailing-list]: https://groups.google.com/forum/#!forum/cstore-users [coverage]: https://coveralls.io/r/citusdata/cstore_fdw [copy-command]: http://www.postgresql.org/docs/current/static/sql-copy.html [analyze-command]: http://www.postgresql.org/docs/current/static/sql-analyze.html

A type-safe typescript SQL query builder

[](https://stand-with-ukraine.pp.ua) [](https://discord.gg/xyBJ3GwvAm) [](https://github.com/koskimas/kysely) # [Kysely](https://koskimas.github.io/kysely/index.html) Kysely (pronounce “Key-Seh-Lee”) is a type-safe and autocompletion-friendly typescript SQL query builder. Inspired by [knex](http://knexjs.org/). Mainly developed for [node.js](https://nodejs.org/en/) but also runs on [deno](https://deno.land/) and in the browser.  Kysely makes sure you only refer to tables and columns that are visible to the part of the query you're writing. The result type only has the selected columns with correct types and aliases. As an added bonus you get autocompletion for all that stuff. As shown in the gif above, through the pure magic of modern typescript, Kysely is even able to parse the alias given to `pet.name` and add the `pet_name` column to the result row type. Kysely is able to infer column names, aliases and types from selected subqueries, joined subqueries, `with` statements and pretty much anything you can think of. Of course there are cases where things cannot be typed at compile time, and Kysely offers escape hatches for these situations. See the [sql template tag](https://koskimas.github.io/kysely/interfaces/Sql.html) and the [DynamicModule](https://koskimas.github.io/kysely/classes/DynamicModule.html#ref) for more info. All API documentation is written in the typing files and you can simply `cmd-click` on the module, class or method you're using to see it. The same documentation is also hosted [here](https://github.com/koskimas/kysely). If you start using Kysely and can't find something you'd want to use, please open an issue or join our [discord server](https://discord.gg/xyBJ3GwvAm). You can find a more thorough introduction [here](https://www.jakso.me/blog/kysely-a-type-safe-sql-query-builder-for-typescript). # Table of contents - [Installation](#installation) - [3rd party dialects](#3rd-party-dialects) - [Minimal example](#minimal-example) - [Playground](#playground) - [Generating types](#generating-types) - [Query examples](#query-examples) - [Select queries](#select-queries) - [Stream select query results](#stream-select-query-results) - [Update queries](#update-queries) - [Insert queries](#insert-queries) - [Delete queries](#delete-queries) - [Recipes](#recipes) - [Migrations](#migrations) - [PostgreSQL migration example](#postgresql-migration-example) - [MySQL migration example](#mysql-migration-example) - [Deno](#deno) - [Browser](#browser) - [Why not just contribute to knex](#why-not-just-contribute-to-knex) # Installation Kysely currently works on PostgreSQL, MySQL and SQLite. You can install it using: ``` # PostgreSQL npm install kysely pg # MySQL npm install kysely mysql2 # SQLite npm install kysely better-sqlite3 ``` More dialects will be added soon. Kysely also has a simple interface for [3rd party dialects](https://koskimas.github.io/kysely/interfaces/Dialect.html). ### 3rd party dialects - [AWS Data API](https://github.com/serverless-stack/kysely-data-api) - [PlanetScale Serverless Driver](https://github.com/depot/kysely-planetscale) - [SingleStore Data API](https://github.com/igalklebanov/kysely-singlestore) - [D1](https://github.com/aidenwallis/kysely-d1) - [SurrealDB](https://github.com/igalklebanov/kysely-surrealdb) # Minimal example All you need to do is define an interface for each table in the database and pass those interfaces to the `Kysely` constructor: ```ts import { Pool } from 'pg' import { Kysely, PostgresDialect, Generated, ColumnType, Selectable, Insertable, Updateable, } from 'kysely' interface PersonTable { // Columns that are generated by the database should be marked // using the `Generated` type. This way they are automatically // made optional in inserts and updates. id: Generated<number> first_name: string gender: 'male' | 'female' | 'other' // If the column is nullable in the database, make its type nullable. // Don't use optional properties. Optionality is always determined // automatically by Kysely. last_name: string | null // You can specify a different type for each operation (select, insert and // update) using the `ColumnType<SelectType, InsertType, UpdateType>` // wrapper. Here we define a column `modified_at` that is selected as // a `Date`, can optionally be provided as a `string` in inserts and // can never be updated: modified_at: ColumnType<Date, string | undefined, never> } interface PetTable { id: Generated<number> name: string owner_id: number species: 'dog' | 'cat' } interface MovieTable { id: Generated<string> stars: number } // Keys of this interface are table names. interface Database { person: PersonTable pet: PetTable movie: MovieTable } // You'd create one of these when you start your app. const db = new Kysely<Database>({ // Use MysqlDialect for MySQL and SqliteDialect for SQLite. dialect: new PostgresDialect({ pool: new Pool({ host: 'localhost', database: 'kysely_test' }) }) }) async function demo() { const { id } = await db .insertInto('person') .values({ first_name: 'Jennifer', gender: 'female' }) .returning('id') .executeTakeFirstOrThrow() await db .insertInto('pet') .values({ name: 'Catto', species: 'cat', owner_id: id }) .execute() const person = await db .selectFrom('person') .innerJoin('pet', 'pet.owner_id', 'person.id') .select(['first_name', 'pet.name as pet_name']) .where('person.id', '=', id) .executeTakeFirst() if (person) { person.pet_name } } ``` ```ts // You can extract the select, insert and update interfaces like this // if you want (you don't need to): type Person = Selectable<PersonTable> type InsertablePerson = Insertable<PersonTable> type UpdateablePerson = Updateable<PersonTable> ``` # Playground [@wirekang](https://github.com/wirekang) has created a [playground for Kysely](https://wirekang.github.io/kysely-playground/?p=f&i=-NLp3n_P5fyeQKMQda8n). You can use to quickly test stuff out and for creating code examples for your issues, PRs and discord messages. # Generating types If you want to generate the table types automatically from the database schema please check out [this awesome project](https://github.com/RobinBlomberg/kysely-codegen). # Query examples ## Select queries You can find examples of select queries in the documentation of the [select method](https://koskimas.github.io/kysely/classes/SelectQueryBuilder.html#select) and the [where method](https://koskimas.github.io/kysely/classes/SelectQueryBuilder.html#where) among other places. ### Stream select query results *Currently only supported by `postgres` and `mysql` dialects.* ```ts import { Pool } from 'pg' // or `import * as Cursor from 'pg-cursor'` depending on your tsconfig import Cursor from 'pg-cursor' import { Kysely, PostgresDialect } from 'kysely' const db = new Kysely<Database>({ // PostgresDialect requires the Cursor dependency dialect: new PostgresDialect({ pool: new Pool({ host: 'localhost', database: 'kysely_test' }), cursor: Cursor }), // MysqlDialect doesn't require any special configuration }) async function demo() { for await (const adult of db.selectFrom('person') .selectAll() .where('age', '>', 18) .stream() ) { console.log(`Hello ${adult.first_name}!`) if (adult.first_name === 'John') { // After this line the db connection is released and no more // rows are streamed from the database to the client break; } } } ``` ## Update queries See the [set method](https://koskimas.github.io/kysely/classes/UpdateQueryBuilder.html#set) and the [updateTable method](https://koskimas.github.io/kysely/classes/Kysely.html#updateTable) documentation. ## Insert queries See the [values method](https://koskimas.github.io/kysely/classes/InsertQueryBuilder.html#values) and the [insertInto method](https://koskimas.github.io/kysely/classes/Kysely.html#insertInto) documentation. ## Delete queries See the [deleteFrom method](https://koskimas.github.io/kysely/classes/Kysely.html#deleteFrom) documentation. # Recipes The [recipes](https://github.com/koskimas/kysely/tree/master/recipes) folder contains a bunch of small tutorials or "recipes" for common use cases. * [Conditional selects](https://github.com/koskimas/kysely/tree/master/recipes/conditional-selects.md) * [Deduplicate joins](https://github.com/koskimas/kysely/tree/master/recipes/deduplicate-joins.md) * [Extending kysely](https://github.com/koskimas/kysely/tree/master/recipes/extending-kysely.md) * [Raw SQL](https://github.com/koskimas/kysely/tree/master/recipes/raw-sql.md) * [Schemas](https://github.com/koskimas/kysely/tree/master/recipes/schemas.md) * [Dealing with the `Type instantiation is excessively deep and possibly infinite` error](https://github.com/koskimas/kysely/tree/master/recipes/excessively-deep-types.md) # Migrations Migration files should look like this: ```ts import { Kysely } from 'kysely' export async function up(db: Kysely<any>): Promise<void> { // Migration code } export async function down(db: Kysely<any>): Promise<void> { // Migration code } ``` The `up` function is called when you update your database schema to the next version and `down` when you go back to previous version. The only argument for the functions is an instance of `Kysely<any>`. It's important to use `Kysely<any>` and not `Kysely<YourDatabase>`. Migrations should never depend on the current code of your app because they need to work even when the app changes. Migrations need to be "frozen in time". The migrations can use the [Kysely.schema](https://koskimas.github.io/kysely/classes/SchemaModule.html) module to modify the schema. Migrations can also run normal queries to modify data. Execution order of the migrations is the alpabetical order of their names. An excellent way to name your migrations is to prefix them with an ISO 8601 date string. A date prefix works well in large teams where multiple team members may add migrations at the same time in parallel commits without knowing about the other migrations. You don't need to store your migrations as separate files if you don't want to. You can easily implement your own [MigrationProvider](https://koskimas.github.io/kysely/interfaces/MigrationProvider.html) and give it to the [Migrator](https://koskimas.github.io/kysely/classes/Migrator.html) class when you instantiate one. ### PostgreSQL migration example ```ts import { Kysely, sql } from 'kysely' export async function up(db: Kysely<any>): Promise<void> { await db.schema .createTable('person') .addColumn('id', 'serial', (col) => col.primaryKey()) .addColumn('first_name', 'varchar', (col) => col.notNull()) .addColumn('last_name', 'varchar') .addColumn('gender', 'varchar(50)', (col) => col.notNull()) .addColumn('created_at', 'timestamp', (col) => col.defaultTo(sql`now()`).notNull()) .execute() await db.schema .createTable('pet') .addColumn('id', 'serial', (col) => col.primaryKey()) .addColumn('name', 'varchar', (col) => col.notNull().unique()) .addColumn('owner_id', 'integer', (col) => col.references('person.id').onDelete('cascade').notNull() ) .addColumn('species', 'varchar', (col) => col.notNull()) .execute() await db.schema .createIndex('pet_owner_id_index') .on('pet') .column('owner_id') .execute() } export async function down(db: Kysely<any>): Promise<void> { await db.schema.dropTable('pet').execute() await db.schema.dropTable('person').execute() } ``` ### MySQL migration example ```ts import { Kysely } from 'kysely' export async function up(db: Kysely<any>): Promise<void> { await db.schema .createTable('person') .addColumn('id', 'integer', (col) => col.autoIncrement().primaryKey()) .addColumn('first_name', 'varchar(255)', (col) => col.notNull()) .addColumn('last_name', 'varchar(255)') .addColumn('gender', 'varchar(50)', (col) => col.notNull()) .execute() await db.schema .createTable('pet') .addColumn('id', 'integer', (col) => col.autoIncrement().primaryKey()) .addColumn('name', 'varchar(255)', (col) => col.notNull().unique()) .addColumn('owner_id', 'integer', (col) => col.notNull()) .addColumn('species', 'varchar(255)', (col) => col.notNull()) .addForeignKeyConstraint( 'pet_owner_id_fk', ['owner_id'], 'person', ['id'], (cb) => cb.onDelete('cascade') ) .execute() await db.schema .createIndex('pet_owner_id_index') .on('pet') .column('owner_id') .execute() } export async function down(db: Kysely<any>): Promise<void> { await db.schema.dropTable('pet').execute() await db.schema.dropTable('person').execute() } ``` You can then use ```ts const migrator = new Migrator(migratorConfig); await migrator.migrateToLatest(pathToMigrationsFolder) ``` to run all migrations that have not yet been run. See the [Migrator](https://koskimas.github.io/kysely/classes/Migrator.html) class's documentation for more info. Kysely doesn't have a CLI for running migrations and probably never will. This is because Kysely's migrations are also written in typescript. To run the migrations, you need to first build the typescript code into javascript. A CLI would cause confusion over which migrations are being run, the typescript ones or the javascript ones. If we added support for both, the CLI would need to depend on a typescript compiler, which most production environments don't (and shouldn't) have. You will probably want to add a simple migration script to your projects like this: ```ts import * as path from 'path' import { Pool } from 'pg' import { promises as fs } from 'fs' import { Kysely, Migrator, PostgresDialect, FileMigrationProvider } from 'kysely' async function migrateToLatest() { const db = new Kysely<Database>({ dialect: new PostgresDialect({ pool: new Pool({ host: 'localhost', database: 'kysely_test', }) }), }) const migrator = new Migrator({ db, provider: new FileMigrationProvider({ fs, path, migrationFolder: 'some/path/to/migrations', }) }) const { error, results } = await migrator.migrateToLatest() results?.forEach((it) => { if (it.status === 'Success') { console.log(`migration "${it.migrationName}" was executed successfully`) } else if (it.status === 'Error') { console.error(`failed to execute migration "${it.migrationName}"`) } }) if (error) { console.error('failed to migrate') console.error(error) process.exit(1) } await db.destroy() } migrateToLatest() ``` The migration methods use a lock on the database level and parallel calls are executed serially. This means that you can safely call `migrateToLatest` and other migration methods from multiple server instances simultaneously and the migrations are guaranteed to only be executed once. The locks are also automatically released if the migration process crashes or the connection to the database fails. # Deno Kysely doesn't include drivers for deno, but you can still use Kysely as a query builder or implement your own driver: ```ts // We use jsdeliver to get Kysely from npm. import { DummyDriver, Generated, Kysely, PostgresAdapter, PostgresIntrospector, PostgresQueryCompiler, } from 'https://cdn.jsdelivr.net/npm/kysely/dist/esm/index.js' interface Person { id: Generated<number> first_name: string last_name: string | null } interface Database { person: Person } const db = new Kysely<Database>({ dialect: { createAdapter() { return new PostgresAdapter() }, createDriver() { // You need a driver to be able to execute queries. In this example // we use the dummy driver that never does anything. return new DummyDriver() }, createIntrospector(db: Kysely<unknown>) { return new PostgresIntrospector(db) }, createQueryCompiler() { return new PostgresQueryCompiler() }, }, }) const query = db.selectFrom('person').select('id') const sql = query.compile() console.log(sql.sql) ``` # Browser Kysely also runs in the browser: ```ts import { Kysely, Generated, DummyDriver, SqliteAdapter, SqliteIntrospector, SqliteQueryCompiler, } from 'kysely' interface Person { id: Generated<number> first_name: string last_name: string | null } interface Database { person: Person } const db = new Kysely<Database>({ dialect: { createAdapter() { return new SqliteAdapter() }, createDriver() { return new DummyDriver() }, createIntrospector(db: Kysely<unknown>) { return new SqliteIntrospector(db) }, createQueryCompiler() { return new SqliteQueryCompiler() }, }, }) window.addEventListener('load', () => { const sql = db.selectFrom('person').select('id').compile() const result = document.createElement('span') result.id = 'result' result.innerHTML = sql.sql document.body.appendChild(result) }) ``` # Why not just contribute to knex Kysely is very similar to knex, but it also attempts to fix things that I personally find not-so-good in knex. Bringing the type system and the changes to knex would mean very significant breaking changes that aren't possible at this point of the project. Knex was also originally written for javascript and the typescript typings were added afterwards. That always leads to compromises in the types. Designing a library for typescript from the ground up produces much better and simpler types. # How to contribute to Kysely See [CONTRIBUTING.md](./CONTRIBUTING.md).

A modern Docker LAMP stack and MEAN stack for local development

<p align="center"> <h1 align="center">The Devilbox</h1> </p>  **[Quickstart](#-quickstart)** | **[Examples](#-examples)** | **[Features](#star-features)** | **[The Devilbox Stack](#-the-devilbox-stack)** | **[Community](#-community)** | **[Contributing](#-contributing)** | **[Logos](#-logos)** | **[License](#-license)**  [](https://github.com/cytopia/devilbox/releases) [](https://discord.gg/2wP3V6kBj4) [](https://devilbox.discourse.group) [](https://opensource.org/licenses/MIT) <!-- [](https://devilbox.readthedocs.io) [](https://github.com/cytopia/devilbox/actions?workflow=Lint) [](https://github.com/cytopia/devilbox/actions?workflow=Docs) [](https://github.com/cytopia/devilbox/actions/workflows/test-php.yml) [](https://github.com/cytopia/devilbox/actions/workflows/test-httpd.yml) [](https://github.com/cytopia/devilbox/actions/workflows/test-mysql.yml) [](https://github.com/cytopia/devilbox/actions/workflows/test-memcd.yml) [](https://github.com/cytopia/devilbox/actions/workflows/test-mongo.yml) [](https://github.com/cytopia/devilbox/actions/workflows/test-pgsql.yml) [](https://github.com/cytopia/devilbox/actions/workflows/test-redis.yml) --> <!-- <img width="200" style="width:200px;" src="docs/_includes/figures/https/https-ssl-address-bar.png" /><br/> <small>_{Support for <a href="https://devilbox.readthedocs.io/en/latest/intermediate/setup-valid-https.html">valid https</a> out of the box.}</small> --> The Devilbox is a versatile and highly customisable zero-conf PHP Docker stack supporting LEMP and MEAN as well as Websockets, Node, Python and Golang via automated Reverse Proxy integraton. <br/> <br/> The main goal is to provide a reproducible development environment that runs on all major platforms and is able to switch and combine any version you need. It supports an unlimited number of projects for which vhosts, SSL certificates and DNS records are created automatically. Email interception and popular development tools will be at your service as well. Configuration is not necessary, as everything is already pre-setup. <br/> <br/> All created projects (frontend or backend) will be able to communicate with one another to support the emulation of a complete microservice architecture or an API landscape. <br/> <br/> **Available Architectures:** `amd64`, `arm64`<br/> **Available PHP Versions:** `5.2`, `5.3`, `5.4`, `5.5`, `5.6`, `7.0`, `7.1`, `7.2`, `7.3`, `7.4`, `8.0`, `8.1`, `8.2` ## 🚀 Quickstart <details><summary>❗ System Requirements</summary> <br/> The Devilbox runs on all major operating systems and its only requirement is <code>Docker</code> and <code>Docker Compose</code>:<br/><br/>      <br/> * [Docker Engine 17.06.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-23) * [Docker Compose 1.16.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-23) </details> **Be up and running in 2 minutes.** <details style="margin-bottom:0px;"><summary>🚀 Install and Run: Linux</summary> <h3>Linux: Install</h3> 1. Download the Devilbox ```bash git clone https://github.com/cytopia/devilbox ``` 2. Enter the Devilbox git directory ```bash cd devilbox ``` 3. Copy the default environment file ```bash cp env-example .env ``` <h3>Linux: Run</h3> > <strong>:warning: Important: </strong> Ensure that nothing is listening on port <code>80</code> and <code>443</code> on your host system. These ports are required by the Devilbox webserver. <br/> 1. Start `httpd`, `php` and `mysql` container ```bash # This step may take a few minutes as required # Docker images have to be pulled initially. # Inside the Devilbox git directory docker-compose up httpd php mysql ``` 2. Visit http://localhost in your browser <br/> </details> <details style="margin-bottom:0px;"><summary>🚀 Install and Run: MacOS</summary> <h3>MacOS: Install</h3> 1. Download the Devilbox ```bash git clone https://github.com/cytopia/devilbox ``` 2. Enter the Devilbox git directory ```bash cd devilbox ``` 3. Copy the default environment file ```bash cp env-example .env ``` <h3>MacOS: Run</h3> > <strong>:warning: Important: </strong> Ensure that nothing is listening on port <code>80</code> and <code>443</code> on your host system. These ports are required by the Devilbox webserver. <br/> 1. Start `httpd`, `php` and `mysql` container ```bash # This step may take a few minutes as required # Docker images have to be pulled initially. # Inside the Devilbox git directory docker-compose up httpd php mysql ``` 2. Visit http://localhost in your browser <br/> </details> <details style="margin-bottom:0px;"><summary>🚀 Install and Run: Windows</summary> <br/> <strong>Note: </strong> If you are using <code>WSL2</code>, refer to the Linux guide instead. <br/> <h3>Windows: Install</h3> 1. Clone <code>https://github.com/cytopia/devilbox</code> to <code>C:\devilbox</code> with <a href="https://git-scm.com/downloads">Git for Windows</a> 2. Copy <code>C:\devilbox\env-example</code> to <code>C:\devilbox\.env</code> <h3>Windows: Run</h3> > <strong>:warning: Important: </strong> Ensure that nothing is listening on port <code>80</code> and <code>443</code> on your host system. These ports are required by the Devilbox webserver. <a href="https://devilbox.readthedocs.io/en/latest/howto/terminal/open-terminal-on-win.html">Open a terminal on Windows</a> and start `httpd`, `php` and `mysql` container: <br/> 1. Start `httpd`, `php` and `mysql` container ```bash # This step may take a few minutes as required # Docker images have to be pulled initially. # Inside the Devilbox git directory docker-compose up httpd php mysql ``` 2. Visit http://localhost in your browser <br/> </details> <details><summary>💻 Enter the work container</summary> <h3>Enter the work container</h3> The Devilbox allows you to work on your projects on the host system as well as inside the work container. Your project files will be available at both locations. The workflow ususally is: 1. Use your prefered IDE (e.g. PhpStorm) on your host system to add and alter files 2. Work inside the container to run common cli tools such as `node`, `composer`, `npm`, `phpcs`, `webpack` and many more. To enter the work container, simply run `./shell.sh` 1. On Linux, MacOS and Windows with WSL2 ```bash # Inside the Devilbox git directory ./shell.sh ``` 2. On Windows without WSL2 ```bash # Inside the Devilbox git directory ./shell.bat ``` </details> ## 💡 Examples **Create your first project:** <details><summary>Example: Dummy Project</summary> 1. Start the container you need: ```bash docker-compose up httpd php mysql ``` 2. Enter the work container: ```bash ./shell.sh ``` 3. Navigate to `/shared/httpd`: ```bash cd /shared/httpd ``` 4. Create your project directory ```bash mkdir dummy-project ``` 5. Visit http://localhost/vhosts.php<br/> You will notice that you need to create a `htdocs/` directory<br/> <img src="docs/img/example_01-vhost.png" /> 6. Create `htdocs/` directory ```bash # Navigate to your project directory cd /shared/httpd/dummy-project # Create htdocs dir mkdir htdocs ``` 7. Visit http://localhost/vhosts.php<br/> You will see that everything is now setup and your project is created and available<br/> <img src="docs/img/example_02-vhost.png" /> 8. Create an `index.php` file ```bash # Navigate to your project htdocs directory cd /shared/httpd/dummy-project/htdocs # Create a simple index.php file echo '<?php echo "it works";' > index.php ``` 9. View your project in the browser: http://dummy-project.dvl.to <br/> </details> <details><summary>Example: PHP Framework</summary> Find all the examples in the documentation: <a target="_blank" title="How to Setup CakePHP on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-cakephp.html"><img width="48" style="width:48px" src="docs/img/logo_fw/cake.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup CodeIgniter on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-codeigniter.html"><img width="48" style="width:48px" src="docs/img/logo_fw/codeigniter.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Contao on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-contao.html"><img width="48" style="width:48px" src="docs/img/logo_fw/contao.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup CraftCMS on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-craftcms.html"><img width="48" style="width:48px" src="docs/img/logo_fw/craftcms.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Drupal on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-drupal.html"><img width="48" style="width:48px" src="docs/img/logo_fw/drupal.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Joomla on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-joomla.html"><img width="48" style="width:48px" src="docs/img/logo_fw/joomla.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Laravel on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-laravel.html"><img width="48" style="width:48px" src="docs/img/logo_fw/laravel.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Magento 2 on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-magento2.html"><img width="48" style="width:48px" src="docs/img/logo_fw/magento.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup PhalconPHP on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-phalcon.html"><img width="48" style="width:48px" src="docs/img/logo_fw/phalcon.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup PhotonCMS on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-photon-cms.html"><img width="48" style="width:48px" src="docs/img/logo_fw/photoncms.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup PrestaShop on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-presta-shop.html"><img width="48" style="width:48px" src="docs/img/logo_fw/prestashop.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup ProcessWire on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-processwire.html"><img width="48" style="width:48px" src="docs/img/logo_fw/processwire.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Shopware on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-shopware.html"><img width="48" style="width:48px" src="docs/img/logo_fw/shopware.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Symfony on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-symfony.html"><img width="48" style="width:48px" src="docs/img/logo_fw/symfony.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Typo3 on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-typo3.html"><img width="48" style="width:48px" src="docs/img/logo_fw/typo3.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup WordPress on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-wordpress.html"><img width="48" style="width:48px" src="docs/img/logo_fw/wordpress.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Yii on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-yii.html"><img width="48" style="width:48px" src="docs/img/logo_fw/yii.png" alt="Devilbox" /></a> <a target="_blank" title="How to Setup Zend on the Devilbox" href="https://devilbox.readthedocs.io/en/latest/examples/setup-zend.html"><img width="48" style="width:48px" src="docs/img/logo_fw/zend.png" alt="Devilbox" /></a> </details> ## :star: Features The Devilbox tries to be a zero-configuration stack out of the box and has automated all the boring tasks. Additionally it provides common feature required for everyday work. <table> <tr valign="top" style="vertical-align:top"> <td> <strong>Automation</strong><br/> :star: <code>Automated Project creation</code><br/> :star: <code>Automated SSL</code><br/> :star: <code>Automated DNS</code><br/> :star: <code>Host permission sync</code><br/> </td> <td> <strong>Modes</strong><br/> :star: <code>Static files</code><br/> :star: <code>PHP files</code><br/> :star: <code>Reverse Proxy</code><br/> :star: <code>Websockets</code><br/> </td> <td> <strong>Backends</strong><br/> :star: <code>PHP-FPM</code><br/> :star: <code>NodeJS</code><br/> :star: <code>Python</code><br/> :star: <code>Golang</code><br/> :star: <code>...</code><br/> </td> <td> <strong>Profiling</strong><br/> :star: <code>Blackfire</code><br/> :star: <code>Xdebug</code><br/> :star: <code>XHProf</code><br/> </td> </tr> <tr valign="top" style="vertical-align:top"> <td> <strong>Projects</strong><br/> :star: <code>Unlimited Projects</code><br/> :star: <code>Inter-Project Communication</code><br/> :star: <code>Custom Project domains</code><br/> :star: <code>Valid browser HTTPS</code><br/> </td> <td> <strong>Intranet</strong><br/> :star: <code>Virtual Hosts</code><br/> :star: <code>C&C</code><br/> :star: <code>Email Reader</code><br/> :star: <code>OpCache Gui</code><br/> </td> <td> <strong>Batteries</strong><br/> :star: <code>Adminer</code><br/> :star: <code>phpMyAdmin</code><br/> :star: <code>phpPgAdmin</code><br/> :star: <code>phpRedMind</code><br/> </td> <td> <strong>Services</strong><br/> :star: <code>SQL</code><br/> :star: <code>NoSQL</code><br/> :star: <code>Cache</code><br/> :star: <code>...</code><br/> </td> </tr> </table> <h2><img id="the-devilbox-stack" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png" alt="The Devilbox Stack" /> The Devilbox Stack</h2> The Devilbox aims to be a swiss army knife for local development by providing you all the services you would ever need. To get an idea about the architecture behind it and to also see what's available have a look at its components and usage. <table width="100%" style="width:100%;display:table"> <tr> <td width="30%" valign="top" style="width:30%; vertical-align:top;"> <h4>Smallest stack</h4> <p>This is the smallest possible and fully functional stack you can run</p> </td> <td width="70%" valign="top" style="width:70%; vertical-align:top;"> <h4>Full stack</h4> <p>To better understand what is actually possible have a look at the full example</p> </td> </tr> <tr> <td> <img width="300" style="width:300px" title="Devilbox stack" src="https://raw.githubusercontent.com/devilbox/artwork/master/submissions_diagrams/cytopia/02/png/architecture-small.png" /> </td> <td> <img title="Devilbox stack" src="https://raw.githubusercontent.com/devilbox/artwork/master/submissions_diagrams/cytopia/01/png/architecture-full.png" /> </td> </tr> </table> <details style="margin-bottom: 0px;"><summary><strong>💻 Modes of operation</strong></summary> <h3>Modes of operation</h3> You can startup and operate the Devilbox in three different ways via `docker-compose`: 1. Selective startup 2. On Demand (add/remove container while running) 3. Full startup #### Selective startup If you already know what kind of container you need before starting the Devilbox, you can just specify them explicitly. ```bash # Inside the Devilbox git directory start httpd php mysql and redis docker-compose up httpd php mysql redis ``` The Intranet will show you what container you have currently running:  #### On Demand If the Devilbox is already started you can attach more container on-the-fly, ```bash # Inside the Devilbox git directory attach mongo and memcached docker-compose up mongo memcd ``` You can also shut down specific containers that you do not need ```bash # Inside the Devilbox git directory shutdown redis docker-compose stop redis ``` #### Full startup If you just want to start everything, run `docker-compose up` without any arguments ```bash # Inside the Devilbox git directory start them all docker-compose up ``` The Intranet will show you what container you have currently running:  If you prefer a visual guide, have a look at the two introduction videos on Youtube: <br/> <br/> <a target="_blank" title="Devilbox - Setup and Workflow" href="https://www.youtube.com/watch?v=reyZMyt2Zzo"><img title="Devilbox - Setup and Workflow" src="docs/img/devilbox_01-setup-and-workflow.png" /></a> <a target="_blank" title="Devilbox - Email Interception" href="https://www.youtube.com/watch?v=e-U-C5WhxGY"><img title="Devilbox - Email Interception" src="docs/img/devilbox_02-email-catch-all.png" /></a> > **Documentation:** > [Install the Devilbox](https://devilbox.readthedocs.io/en/latest/getting-started/install-the-devilbox.html) | > [Start the Devilbox](https://devilbox.readthedocs.io/en/latest/getting-started/start-the-devilbox.html) | > [.env file](https://devilbox.readthedocs.io/en/latest/configuration-files/env-file.html) <br/> </details> <details style="margin-bottom: 0px;"><summary><strong>🐋 Available Container</strong></summary> <h3>Available Container</h3> The following table lists all integrated and pre-configured Docker container shipped by the Devilbox. Only the webserver and PHP container are mandatory, all others are optional and don't need to be started. Each of them is also available in multiple different versions in order to reflect your exact desired environment. | Accel | Web | App | SQL | NoSQL | Queue / Search | ELK | Utils | |---------|------------|----------------|------------|-----------|----------------|---------------|-----------| | HAProxy | Apache | PHP | MariaDB | Memcached | RabbitMQ | ElasticSearch | Bind | | Varnish | Nginx | Python (Flask) | MySQL | MongoDB | Solr | Logstash | Blackfire | | | | | PerconaDB | Redis | | Kibana | MailHog | | | | | PostgreSQL | | | | Ngrok | <br/> > **Documentation:** > [Available Container](https://devilbox.readthedocs.io/en/latest/readings/available-container.html) <br/> </details> <details style="margin-bottom: 0px;"><summary><strong>📌 Version Matrix</strong></summary> <h3>Version Matrix</h3> Every single attachable container comes with many different versions. In order to select the desired version for a container, simply edit the `.env` file and uncomment the version of choice. Any combination is possible. #### Run different versions <table> <thead> <tr> <th>Apache</th> <th>Nginx</th> <th>PHP</th> <th>MySQL</th> <th>MariaDB</th> <th>Percona</th> <th>PgSQL</th> <th>Redis</th> <th>Memcached</th> <th>MongoDB</th> </tr> </thead> <tbody> <tr> <td><a target="_blank" title="Apache 2.2" href="https://github.com/devilbox/docker-apache-2.2">2.2</a></td> <td><a target="_blank" title="Nginx stable" href="https://github.com/devilbox/docker-nginx-stable">stable</a></td> <td><a target="_blank" title="PHP 5.2" href="https://github.com/devilbox/docker-php-fpm">5.2</a>^[1]</td> <td><a target="_blank" title="MySQL 5.5" href="https://github.com/devilbox/docker-mysql">5.5</a></td> <td><a target="_blank" title="MariaDB 5.5" href="https://github.com/devilbox/docker-mysql">5.5</a></td> <td><a target="_blank" title="PerconaDB 5.5" href="https://github.com/devilbox/docker-mysql">5.5</a></td> <td><a target="_blank" title="PgSQL 9.0" href="https://github.com/docker-library/postgres">9.0</a></td> <td><a target="_blank" title="Redis 2.8" href="https://github.com/docker-library/redis">2.8</a></td> <td><a target="_blank" title="Memcached 1.4" href="https://github.com/docker-library/memcached">1.4</a></td> <td><a target="_blank" title="MongoDB 2.8" href="https://github.com/docker-library/mongo">2.8</a></td> </tr> <tr> <td><a target="_blank" title="Apache 2.4" href="https://github.com/devilbox/docker-apache-2.4">2.4</a></td> <td><a target="_blank" title="Nginx mainline" href="https://github.com/devilbox/docker-nginx-mainline">mainline</a></td> <td><a target="_blank" title="PHP 5.3" href="https://github.com/devilbox/docker-php-fpm">5.3</a></td> <td><a target="_blank" title="MySQL 5.6" href="https://github.com/devilbox/docker-mysql">5.6</a></td> <td><a target="_blank" title="MariaDB 10.0" href="https://github.com/devilbox/docker-mysql">10.0</a></td> <td><a target="_blank" title="PerconaDB 5.6" href="https://github.com/devilbox/docker-mysql">5.6</a></td> <td><a target="_blank" title="PgSQL 9.1" href="https://github.com/docker-library/postgres">9.1</a></td> <td><a target="_blank" title="Redis 3.0" href="https://github.com/docker-library/redis">3.0</a></td> <td><a target="_blank" title="Memcached 1.5" href="https://github.com/docker-library/memcached">1.5</a></td> <td><a target="_blank" title="MongoDB 3.0" href="https://github.com/docker-library/mongo">3.0</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 5.4" href="https://github.com/devilbox/docker-php-fpm">5.4</a></td> <td><a target="_blank" title="MySQL 5.7" href="https://github.com/devilbox/docker-mysql">5.7</a></td> <td><a target="_blank" title="MariaDB 10.1" href="https://github.com/devilbox/docker-mysql">10.1</a></td> <td><a target="_blank" title="PerconaDB 5.7" href="https://github.com/devilbox/docker-mysql">5.7</a></td> <td><a target="_blank" title="PgSQL 9.2" href="https://github.com/docker-library/postgres">9.2</a></td> <td><a target="_blank" title="Redis 3.2" href="https://github.com/docker-library/redis">3.2</a></td> <td><a target="_blank" title="Memcached 1.6" href="https://github.com/docker-library/memcached">1.6</a></td> <td><a target="_blank" title="MongoDB 3.2" href="https://github.com/docker-library/mongo">3.2</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 5.5" href="https://github.com/devilbox/docker-php-fpm">5.5</a></td> <td><a target="_blank" title="MySQL 8.0" href="https://github.com/devilbox/docker-mysql">8.0</a></td> <td><a target="_blank" title="MariaDB 10.2" href="https://github.com/devilbox/docker-mysql">10.2</a></td> <td><a target="_blank" title="PerconaDB 8.0" href="https://github.com/devilbox/docker-mysql">8.0</a></td> <td><a target="_blank" title="PgSQL 9.3" href="https://github.com/docker-library/postgres">9.3</a></td> <td><a target="_blank" title="Redis 4.0" href="https://github.com/docker-library/redis">4.0</a></td> <td><a target="_blank" title="Memcached latest" href="https://github.com/docker-library/memcached">latest</a></td> <td><a target="_blank" title="MongoDB 3.4" href="https://github.com/docker-library/mongo">3.4</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 5.6" href="https://github.com/devilbox/docker-php-fpm">5.6</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.3" href="https://github.com/devilbox/docker-mysql">10.3</a></td> <td></td> <td><a target="_blank" title="PgSQL 9.4" href="https://github.com/docker-library/postgres">9.4</a></td> <td><a target="_blank" title="Redis 5.0" href="https://github.com/docker-library/redis">5.0</a></td> <td></td> <td><a target="_blank" title="MongoDB 3.6" href="https://github.com/docker-library/mongo">3.6</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 7.0" href="https://github.com/devilbox/docker-php-fpm">7.0</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.4" href="https://github.com/devilbox/docker-mysql">10.4</a></td> <td></td> <td><a target="_blank" title="PgSQL 9.5" href="https://github.com/docker-library/postgres">9.5</a></td> <td><a target="_blank" title="Redis 6.0" href="https://github.com/docker-library/redis">6.0</a></td> <td></td> <td><a target="_blank" title="MongoDB 4.0" href="https://github.com/docker-library/mongo">4.0</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 7.1" href="https://github.com/devilbox/docker-php-fpm">7.1</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.5" href="https://github.com/devilbox/docker-mysql">10.5</a></td> <td></td> <td><a target="_blank" title="PgSQL 9.6" href="https://github.com/docker-library/postgres">9.6</a></td> <td><a target="_blank" title="Redis 6.2" href="https://github.com/docker-library/redis">6.2</a></td> <td></td> <td><a target="_blank" title="MongoDB 4.2" href="https://github.com/docker-library/mongo">4.2</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 7.2" href="https://github.com/devilbox/docker-php-fpm">7.2</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.6" href="https://github.com/devilbox/docker-mysql">10.6</a></td> <td></td> <td><a target="_blank" title="PgSQL 10" href="https://github.com/docker-library/postgres">10</a></td> <td><a target="_blank" title="Redis 7.0" href="https://github.com/docker-library/redis">7.0</a></td> <td></td> <td><a target="_blank" title="MongoDB 4.4" href="https://github.com/docker-library/mongo">4.4</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 7.3" href="https://github.com/devilbox/docker-php-fpm">7.3</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.7" href="https://github.com/devilbox/docker-mysql">10.7</a></td> <td></td> <td><a target="_blank" title="PgSQL 11" href="https://github.com/docker-library/postgres">11</a></td> <td><a target="_blank" title="Redis latest" href="https://github.com/docker-library/redis">latest</a></td> <td></td> <td><a target="_blank" title="MongoDB 5.0" href="https://github.com/docker-library/mongo">5.0</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 7.4" href="https://github.com/devilbox/docker-php-fpm">7.4</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.8" href="https://github.com/devilbox/docker-mysql">10.8</a></td> <td></td> <td><a target="_blank" title="PgSQL 12" href="https://github.com/docker-library/postgres">12</a></td> <td></td> <td></td> <td><a target="_blank" title="MongoDB latest" href="https://github.com/docker-library/mongo">latest</a></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 8.0" href="https://github.com/devilbox/docker-php-fpm">8.0</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.9" href="https://github.com/devilbox/docker-mysql">10.9</a></td> <td></td> <td><a target="_blank" title="PgSQL ..." href="https://github.com/docker-library/postgres">...</a></td> <td></td> <td></td> <td></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 8.1" href="https://github.com/devilbox/docker-php-fpm">8.1</a></td> <td></td> <td><a target="_blank" title="MariaDB 10.10" href="https://github.com/devilbox/docker-mysql">10.10</a></td> <td></td> <td><a target="_blank" title="PgSQL 15" href="https://github.com/docker-library/postgres">15</a></td> <td></td> <td></td> <td></td> </tr> <tr> <td></td> <td></td> <td><a target="_blank" title="PHP 8.2" href="https://github.com/devilbox/docker-php-fpm">8.2</a><!-- ^[2] --></td> <td></td> <td></td> <td></td> <td><a target="_blank" title="PgSQL latest" href="https://github.com/docker-library/postgres">latest</a></td> <td></td> <td></td> <td></td> </tr> </tbody> </table> <br/> <small><strong>^[1]</strong> <strong>PHP 5.2</strong> is available to use, but it is not officially supported. The Devilbox intranet does not work with this version as PHP 5.2 does not support namespaces. Furthermore PHP 5.2 does only work with Apache 2.4, Nginx stable and Nginx mainline. It does not work with Apache 2.2. Use at your own risk.</small> <!-- <small><strong>^[2]</strong> <strong>PHP 8.2</strong> is an upcoming unreleased versions of PHP, which is directly built out of their [official git branches](https://github.com/php/php-src/) every night to assure you will leverage their latest features.</small> --> > **Documentation:** > [Change container versions](https://devilbox.readthedocs.io/en/latest/getting-started/change-container-versions.html) #### Additional services Additionally to the default stack, there are a variety of other services that can be easily enabled and started. <table> <thead> <tr> <th>Python (Flask)</th> <th>Blackfire</th> <th>ELK</th> <th>MailHog</th> <th>Ngrok</th> <th>RabbitMQ</th> <th>Solr</th> <th>HAProxy</th> <th>Varnish</th> </tr> </thead> <tbody> <tr> <td><a target="_blank" title="Python 2.7 " href="https://github.com/devilbox/docker-python-flask">2.7</a></td> <td><a target="_blank" title="Blackfire 1.8" href="https://github.com/blackfireio/docker">1.8</a></td> <td><a target="_blank" title="ELK stack" href="https://www.docker.elastic.co">5.x.y</a></td> <td><a target="_blank" title="MailHog v1.0.0" href="https://github.com/mailhog/MailHog">v1.0.0</a></td> <td><a target="_blank" title="Ngrok 2.x" href="https://github.com/devilbox/docker-ngrok">2.x</a></td> <td><a target="_blank" title="RabbitMQ 3.6" href="https://github.com/rabbitmq/rabbitmq-server">3.6</a></td> <td><a target="_blank" title="Solr 5" href="https://github.com/apache/lucene-solr">5</a></td> <td><a target="_blank" title="HAProxy 1.x" href="https://github.com/devilbox/docker-haproxy">1.x</a></td> <td><a target="_blank" title="Varnish 4" href="https://github.com/devilbox/docker-varnish">4</a></td> </tr> <tr> <td>...</td> <td>...</td> <td><a target="_blank" title="ELK stack" href="https://www.docker.elastic.co">6.x.y</a></td> <td><a target="_blank" title="MailHog latest" href="https://github.com/mailhog/MailHog">latest</a></td> <td></td> <td><a target="_blank" title="RabbitMQ 3.7" href="https://github.com/rabbitmq/rabbitmq-server">3.7</a></td> <td><a target="_blank" title="Solr 6" href="https://github.com/apache/lucene-solr">6</a></td> <td></td> <td><a target="_blank" title="Varnish 5" href="https://github.com/devilbox/docker-varnish">5</a></td> </tr> <tr> <td><a target="_blank" title="Python 3.7 " href="https://github.com/devilbox/docker-python-flask">3.7</a></td> <td><a target="_blank" title="Blackfire 1.18.0" href="https://github.com/blackfireio/docker">1.18.0</a></td> <td><a target="_blank" title="ELK stack" href="https://www.docker.elastic.co">7.x.y</a></td> <td></td> <td></td> <td><a target="_blank" title="RabbitMQ latest" href="https://github.com/rabbitmq/rabbitmq-server">latest</a></td> <td><a target="_blank" title="Solr 7" href="https://github.com/apache/lucene-solr">7</a></td> <td></td> <td><a target="_blank" title="Varnish 6" href="https://github.com/devilbox/docker-varnish">6</a></td> </tr> <tr> <td><a target="_blank" title="Python 3.8 " href="https://github.com/devilbox/docker-python-flask">3.8</a></td> <td><a target="_blank" title="Blackfire latest" href="https://github.com/blackfireio/docker">latest</a></td> <td></td> <td></td> <td></td> <td></td> <td><a target="_blank" title="Solr latest" href="https://github.com/apache/lucene-solr">latest</a></td> <td></td> <td><a target="_blank" title="Varnish latest" href="https://github.com/devilbox/docker-varnish">latest</a></td> </tr> </tbody> </table> <br/> > **Documentation:** > [Enable custom container](https://devilbox.readthedocs.io/en/latest/custom-container/enable-all-container.html) <br/> </details> <details><summary><strong>⚙️ Available PHP Extensions</strong></summary> <h3>Available PHP Extensions</h3> The Devilbox is a development stack, so it is made sure that a lot of PHP modules are available out of the box in order to work with many different frameworks. > * Core enabled (cannot be disabled): **✔** > * Enabled (can be disabled): 🗸 > * Available, but disabled (can be enabled): **d** <br/> <!-- modules --> | Modules | ^{PHP 5.2} | ^{PHP 5.3} | ^{PHP 5.4} | ^{PHP 5.5} | ^{PHP 5.6} | ^{PHP 7.0} | ^{PHP 7.1} | ^{PHP 7.2} | ^{PHP 7.3} | ^{PHP 7.4} | ^{PHP 8.0} | ^{PHP 8.1} | ^{PHP 8.2} | |-------------------------------|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:| | ^amqp | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^apc | | 🗸 | 🗸 | 🗸 | 🗸 | | | | | | | | | | ^apcu | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^bcmath | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^blackfire | | | | | d | d | d | d | d | d | d | | | | ^bz2 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^calendar | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^ctype | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^curl | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^date | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^dba | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^dom | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^enchant | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | 🗸 | 🗸 | 🗸 | | ^ereg | | ✔ | ✔ | ✔ | ✔ | | | | | | | | | | ^exif | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^FFI | | | | | | | | | | 🗸 | ✔ | ✔ | ✔ | | ^fileinfo | 🗸 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^filter | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^ftp | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^gd | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^gettext | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^gmp | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^hash | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^iconv | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^igbinary | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^imagick | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^imap | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^interbase | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | | | ^intl | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^ioncube | | | | d | d | d | d | d | d | d | | | | | ^json | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^ldap | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^libxml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^lz4 | | | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^lzf | | | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^mbstring | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^mcrypt | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | ^memcache | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^memcached | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^mhash | ✔ | ✔ | ✔ | ✔ | ✔ | | | | | | | | | | ^mongo | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | | | | | | | ^mongodb | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^msgpack | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^mysql | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | | | | | | | ^mysqli | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^mysqlnd | | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^OAuth | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^oci8 | | d | d | d | d | d | d | d | d | d | d | d | d | | ^OPcache | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^openssl | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^pcntl | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^pcre | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^PDO | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^pdo_dblib | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^PDO_Firebird | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^pdo_mysql | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^PDO_OCI | | | | | | d | d | d | d | d | d | d | d | | ^pdo_pgsql | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^pdo_sqlite | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^pdo_sqlsrv | | | | | | d | d | d | d | d | d | d | d | | ^pgsql | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^phalcon | | d | d | d | d | d | d | d | d | d | d | d | | | ^Phar | 🗸 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^posix | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^pspell | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^psr | | | d | d | d | d | d | d | d | d | d | d | d | | ^random | | | | | | | | | | | | | ✔ | | ^rdkafka | | d | d | d | d | d | d | d | d | d | d | d | d | | ^readline | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^recode | ✔ | ✔ | ✔ | ✔ | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | | | ^redis | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^Reflection | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^session | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^shmop | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^SimpleXML | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^snmp | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^soap | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^sockets | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^sodium | | | | | | | | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^solr | | | | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | ^SPL | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^sqlite | ✔ | ✔ | | | | | | | | | | | | | ^sqlite3 | | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^sqlsrv | | | | | | d | d | d | d | d | d | d | d | | ^ssh2 | | | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | | ^swoole | | d | d | d | d | d | d | d | d | d | d | d | | | ^sysvmsg | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^sysvsem | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^sysvshm | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^tidy | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^tokenizer | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^{uploadprogress} | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^uuid | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^vips | | | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | ^wddx | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | | | ^Xdebug | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^xhprof | | | | | | d | d | d | d | d | d | d | d | | ^xlswriter | | | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^xml | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^xmlreader | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^xmlrpc | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | | | | ^xmlwriter | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^xsl | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^yaml | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^zip | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | | ^zlib | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | | ^zstd | | | | | | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | 🗸 | <!-- /modules --> <br/> > * Core enabled (cannot be disabled): **✔** > * Enabled (can be disabled): 🗸 > * Available, but disabled (can be enabled): **d** <br/> PHP modules can be enabled or disabled on demand to reflect the state of your target environment. > **Documentation:** > [Enable/disable PHP modules](https://devilbox.readthedocs.io/en/latest/intermediate/enable-disable-php-modules.html) <br/> </details> <details><summary><strong>🛠️ Available CLI Tools</strong></summary> <h3>Available Tools</h3> Well-known and popular tools will be at your service: <a target="_blank" title="CodeCeption" href="https://codeception.com/"><img width="64" style="width:64px" src="docs/img/logo_tools/codeception.png" alt="Devilbox" /></a> <a target="_blank" title="Composer" href="https://getcomposer.org"><img width="64" style="width:64px" src="docs/img/logo_tools/composer.png" alt="Devilbox" /></a> <a target="_blank" title="Drupal Console" href="https://drupalconsole.com"><img width="64" style="width:64px" src="docs/img/logo_tools/drupal-console.png" alt="Devilbox" /></a> <a target="_blank" title="ESLint" href="https://eslint.org/"><img width="64" style="width:64px;" src="docs/img/logo_tools/eslint.png" alt="Devilbox" /></a> <a target="_blank" title="Git" href="https://git-scm.com"><img width="64" style="width:64px;" src="docs/img/logo_tools/git.png" alt="Devilbox" /></a> <a target="_blank" title="Gulp" href="https://gulpjs.com/"><img width="64" style="width:64px;" src="docs/img/logo_tools/gulp.png" alt="Devilbox" /></a> <a target="_blank" title="Grunt" href="https://gruntjs.com/"><img width="64" style="width:64px;" src="docs/img/logo_tools/grunt.png" alt="Devilbox" /></a> <a target="_blank" title="mysqldump-secure" href="https://mysqldump-secure.org"><img width="64" style="width:64px;" src="docs/img/logo_tools/mysqldump-secure.png" alt="Devilbox" /></a> <a target="_blank" title="NodeJS" href="https://nodejs.org"><img width="64" style="width:64px;" src="docs/img/logo_tools/nodejs.png" alt="Devilbox" /></a> <a target="_blank" title="NPM" href="https://www.npmjs.com"><img width="64" style="width:64px;" src="docs/img/logo_tools/npm.png" alt="Devilbox" /></a> <a target="_blank" title="PHPUnit" href="https://phpunit.de/"><img width="64" style="width:64px;" src="docs/img/logo_tools/phpunit.png" alt="Devilbox" /></a> <a target="_blank" title="Sass" href="https://sass-lang.com/"><img width="64" style="width:64px;" src="docs/img/logo_tools/sass.png" alt="Devilbox" /></a> <a target="_blank" title="Webpack" href="https://webpack.js.org/"><img width="64" style="width:64px;" src="docs/img/logo_tools/webpack.png" alt="Devilbox" /></a> <a target="_blank" title="Yarn" href="https://yarnpkg.com/en/"><img width="64" style="width:64px;" src="docs/img/logo_tools/yarn.png" alt="Devilbox" /></a> <!-- tools --> <!-- TOOLS_WORK_START --> | Tool | PHP 5.2 | PHP 5.3 | PHP 5.4 | PHP 5.5 | PHP 5.6 | PHP 7.0 | PHP 7.1 | PHP 7.2 | PHP 7.3 | PHP 7.4 | PHP 8.0 | PHP 8.1 | PHP 8.2 | |--------------------------------------------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------|---------| | [angular-cli][lnk_angular-cli] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [asgardcms][lnk_asgardcms] | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [awesome-ci][lnk_awesome-ci] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [codeception][lnk_codeception] | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**composer**][lnk_**composer**] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**corepack**][lnk_**corepack**] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [deployer][lnk_deployer] | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [eslint][lnk_eslint] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [git][lnk_git] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [git-flow][lnk_git-flow] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [grunt-cli][lnk_grunt-cli] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [gulp][lnk_gulp] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [jq][lnk_jq] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [jsonlint][lnk_jsonlint] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [laravel-installer][lnk_laravel-installer] | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [laravel-lumen][lnk_laravel-lumen] | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [linkcheck][lnk_linkcheck] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [mdl][lnk_mdl] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [mdlint][lnk_mdlint] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [mupdf-tools][lnk_mupdf-tools] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [net-tools][lnk_net-tools] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**node**][lnk_**node**] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**npm**][lnk_**npm**] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**nvm**][lnk_**nvm**] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [phalcon-devtools][lnk_phalcon-devtools] | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | | [php-cs-fixer][lnk_php-cs-fixer] | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | | [phpcbf][lnk_phpcbf] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [phpcs][lnk_phpcs] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [phpmd][lnk_phpmd] | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [phpunit][lnk_phpunit] | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**pip**][lnk_**pip**] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [pm2][lnk_pm2] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [pwncat][lnk_pwncat] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [rsync][lnk_rsync] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [sass][lnk_sass] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [shellcheck][lnk_shellcheck] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [ssh][lnk_ssh] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [stylelint][lnk_stylelint] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [svn][lnk_svn] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [symfony-cli][lnk_symfony-cli] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [taskfile][lnk_taskfile] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [tig][lnk_tig] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [vim][lnk_vim] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [vue-cli][lnk_vue-cli] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [webpack-cli][lnk_webpack-cli] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [wkhtmltopdf][lnk_wkhtmltopdf] | | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [wp-cli][lnk_wp-cli] | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [wscat][lnk_wscat] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [yamllint][lnk_yamllint] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [**yarn**][lnk_**yarn**] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [yq][lnk_yq] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | [zsh][lnk_zsh] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | [lnk_angular-cli]: ../php_tools/angular-cli [lnk_asgardcms]: ../php_tools/asgardcms [lnk_awesome-ci]: ../php_tools/awesome-ci [lnk_codeception]: ../php_tools/codeception [lnk_**composer**]: https://getcomposer.org/ [lnk_**corepack**]: https://nodejs.org/api/corepack.html [lnk_deployer]: ../php_tools/deployer [lnk_eslint]: ../php_tools/eslint [lnk_git]: ../php_tools/git [lnk_git-flow]: ../php_tools/git-flow [lnk_grunt-cli]: ../php_tools/grunt-cli [lnk_gulp]: ../php_tools/gulp [lnk_jq]: ../php_tools/jq [lnk_jsonlint]: ../php_tools/jsonlint [lnk_laravel-installer]: ../php_tools/laravel-installer [lnk_laravel-lumen]: ../php_tools/laravel-lumen [lnk_linkcheck]: ../php_tools/linkcheck [lnk_mdl]: ../php_tools/mdl [lnk_mdlint]: ../php_tools/mdlint [lnk_mupdf-tools]: ../php_tools/mupdf-tools [lnk_net-tools]: ../php_tools/net-tools [lnk_**node**]: https://nodejs.org/en/ [lnk_**npm**]: https://nodejs.org/en/knowledge/getting-started/npm/what-is-npm/ [lnk_**nvm**]: https://github.com/nvm-sh/nvm [lnk_phalcon-devtools]: ../php_tools/phalcon-devtools [lnk_php-cs-fixer]: ../php_tools/php-cs-fixer [lnk_phpcbf]: ../php_tools/phpcbf [lnk_phpcs]: ../php_tools/phpcs [lnk_phpmd]: ../php_tools/phpmd [lnk_phpunit]: ../php_tools/phpunit [lnk_**pip**]: https://pypi.org/ [lnk_pm2]: ../php_tools/pm2 [lnk_pwncat]: ../php_tools/pwncat [lnk_rsync]: ../php_tools/rsync [lnk_sass]: ../php_tools/sass [lnk_shellcheck]: ../php_tools/shellcheck [lnk_ssh]: ../php_tools/ssh [lnk_stylelint]: ../php_tools/stylelint [lnk_svn]: ../php_tools/svn [lnk_symfony-cli]: ../php_tools/symfony-cli [lnk_taskfile]: ../php_tools/taskfile [lnk_tig]: ../php_tools/tig [lnk_vim]: ../php_tools/vim [lnk_vue-cli]: ../php_tools/vue-cli [lnk_webpack-cli]: ../php_tools/webpack-cli [lnk_wkhtmltopdf]: ../php_tools/wkhtmltopdf [lnk_wp-cli]: ../php_tools/wp-cli [lnk_wscat]: ../php_tools/wscat [lnk_yamllint]: ../php_tools/yamllint [lnk_**yarn**]: https://yarnpkg.com/cli/install [lnk_yq]: ../php_tools/yq [lnk_zsh]: ../php_tools/zsh <!-- TOOLS_WORK_END --> <!-- /tools --> <br/> </details> <details><summary><strong>🔌 Supported Frameworks</strong></summary> <h3>Supported Frameworks</h3> #### PHP Frameworks As far as tested there are no limitations and you can use any Framework or CMS just as you would on your live environment. Below are a few examples of extensively tested Frameworks and CMS: <a target="_blank" title="CakePHP" href="https://cakephp.org"><img width="64" style="width:64px" src="docs/img/logo_fw/cake.png" alt="Devilbox" /></a> <a target="_blank" title="CodeIgniter" href="https://www.codeigniter.com"><img width="64" style="width:64px" src="docs/img/logo_fw/codeigniter.png" alt="Devilbox" /></a> <a target="_blank" title="Contao" href="https://contao.org/en/"><img width="64" style="width:64px" src="docs/img/logo_fw/contao.png" alt="Devilbox" /></a> <a target="_blank" title="CraftCMS" href="https://craftcms.com/"><img width="64" style="width:64px" src="docs/img/logo_fw/craftcms.png" alt="Devilbox" /></a> <a target="_blank" title="Drupal" href="https://www.drupal.org"><img width="64" style="width:64px" src="docs/img/logo_fw/drupal.png" alt="Devilbox" /></a> <a target="_blank" title="Joomla" href="https://www.joomla.org"><img width="64" style="width:64px" src="docs/img/logo_fw/joomla.png" alt="Devilbox" /></a> <a target="_blank" title="Laravel" href="https://laravel.com"><img width="64" style="width:64px" src="docs/img/logo_fw/laravel.png" alt="Devilbox" /></a> <a target="_blank" title="Magento 2" href="https://magento.com"><img width="64" style="width:64px" src="docs/img/logo_fw/magento.png" alt="Devilbox" /></a> <a target="_blank" title="PhalconPHP" href="https://phalconphp.com"><img width="64" style="width:64px" src="docs/img/logo_fw/phalcon.png" alt="Devilbox" /></a> <a target="_blank" title="PhotonCMS" href="https://photoncms.com"><img width="64" style="width:64px" src="docs/img/logo_fw/photoncms.png" alt="Devilbox" /></a> <a target="_blank" title="PrestaShop" href="https://www.prestashop.com/en"><img width="64" style="width:64px" src="docs/img/logo_fw/prestashop.png" alt="Devilbox" /></a> <a target="_blank" title="ProcessWire" href="https://processwire.com/"><img width="64" style="width:64px" src="docs/img/logo_fw/processwire.png" alt="Devilbox" /></a> <a target="_blank" title="Shopware" href="https://en.shopware.com"><img width="64" style="width:64px" src="docs/img/logo_fw/shopware.png" alt="Devilbox" /></a> <a target="_blank" title="Symfony" href="https://symfony.com"><img width="64" style="width:64px" src="docs/img/logo_fw/symfony.png" alt="Devilbox" /></a> <a target="_blank" title="Typo3" href="https://typo3.org"><img width="64" style="width:64px" src="docs/img/logo_fw/typo3.png" alt="Devilbox" /></a> <a target="_blank" title="WordPress" href="https://wordpress.org"><img width="64" style="width:64px" src="docs/img/logo_fw/wordpress.png" alt="Devilbox" /></a> <a target="_blank" title="Yii" href="http://www.yiiframework.com"><img width="64" style="width:64px" src="docs/img/logo_fw/yii.png" alt="Devilbox" /></a> <a target="_blank" title="Zend" href="https://framework.zend.com"><img width="64" style="width:64px" src="docs/img/logo_fw/zend.png" alt="Devilbox" /></a> > **Documentation:**<br/> > [Setup CakePHP](https://devilbox.readthedocs.io/en/latest/examples/setup-cakephp.html) | > [Setup CodeIgniter](https://devilbox.readthedocs.io/en/latest/examples/setup-codeigniter.html) | > [Setup Contao](https://devilbox.readthedocs.io/en/latest/examples/setup-contao.html) | > [Setup CraftCMS](https://devilbox.readthedocs.io/en/latest/examples/setup-craftcms.html) | > [Setup Drupal](https://devilbox.readthedocs.io/en/latest/examples/setup-drupal.html) | > [Setup Joomla](https://devilbox.readthedocs.io/en/latest/examples/setup-joomla.html) | > [Setup Laravel](https://devilbox.readthedocs.io/en/latest/examples/setup-laravel.html) | > [Setup Magento 2](https://devilbox.readthedocs.io/en/latest/examples/setup-magento2.html) | > [Setup PhalconPHP](https://devilbox.readthedocs.io/en/latest/examples/setup-phalcon.html) | > [Setup PhotonCMS](https://devilbox.readthedocs.io/en/latest/examples/setup-photon-cms.html) | > [Setup PrestaShop](https://devilbox.readthedocs.io/en/latest/examples/setup-presta-shop.html) | > [Setup ProcessWire](https://devilbox.readthedocs.io/en/latest/examples/setup-processwire.html) | > [Setup Shopware](https://devilbox.readthedocs.io/en/latest/examples/setup-shopware.html) | > [Setup Symfony](https://devilbox.readthedocs.io/en/latest/examples/setup-symfony.html) | > [Setup Typo3](https://devilbox.readthedocs.io/en/latest/examples/setup-typo3.html) | > [Setup WordPress](https://devilbox.readthedocs.io/en/latest/examples/setup-wordpress.html) | > [Setup Yii](https://devilbox.readthedocs.io/en/latest/examples/setup-yii.html) | > [Setup Zend](https://devilbox.readthedocs.io/en/latest/examples/setup-zend.html) #### Reverse Proxy Applications As far as tested there are no limitations and you can use any application that creates an open port. These ports will be reverse proxied by the web server and even allow you to use **valid HTTPS** for them. By the built-in **autostart feature** of the Devilbox you can ensure that your application automatically starts up as soon as you run `docker-compose up`. <a target="_blank" title="NodeJS" href="https://nodejs.org"><img width="64" style="width:64px;" src="docs/img/logo_tools/nodejs.png" alt="NodeJS" /></a> <a target="_blank" title="Python Flask" href="https://github.com/pallets/flask"><img width="64" style="width:64px;" src="docs/img/logo_tools/flask.png" alt="Python Flask" /></a> <a target="_blank" title="Sphinx" href="https://www.sphinx-doc.org/en/stable/"><img width="64" style="width:64px;" src="docs/img/logo_tools/sphinx.png" alt="Sphinx" /></a> > **Documentation:**<br/> > [Setup reverse proxy NodeJs](https://devilbox.readthedocs.io/en/latest/examples/setup-reverse-proxy-nodejs.html) | > [Setup reverse proxy Sphinx documentation](https://devilbox.readthedocs.io/en/latest/examples/setup-reverse-proxy-sphinx-docs.html) <br/> </details> <details><summary><strong>🌐 Devilbox Intranet</strong></summary> <h3>Devilbox Intranet</h3> The Devilbox comes with a pre-configured intranet on `http://localhost` and `https://localhost`. This can be explicitly disabled or password-protected. The intranet will not only show you, the chosen configuration, but also validate the status of the current configuration, such as if **DNS records** exists (on host and container), are directories properly set-up. Additionally it provides external tools to let you interact with databases and emails. * **Virtual Host overview** (validates directories and DNS) * **Command & Control** * **Email overview** * **Database overview** (MySQL, PgSQL, Redis, Memcache, ...) * **Info pages** (Httpd, MySQL, PgSQL, Redis, Memcache, ...) * And many more... <br/> The following batteries are available in the Devilbox intranet by default: <table width="100%" style="width:100%; display:table;"> <tbody style="text-align:center;"> <tr> <td><a href="https://www.adminer.org"><img width="64" style="width:64px;" src="https://raw.githubusercontent.com/cytopia/icons/master/128x128/adminer.png" alt="Adminer" /></a></td> <td><a href="https://www.phpmyadmin.net"><img width="64" style="width:64px;" src="https://raw.githubusercontent.com/cytopia/icons/master/128x128/phpmyadmin.png" alt="phpMyAdmin" /></a></td> <td><a href="http://phppgadmin.sourceforge.net"><img width="64" style="width:64px;" src="https://raw.githubusercontent.com/cytopia/icons/master/128x128/phppgadmin.png" alt="phpPgAdmin" /></a></td> <td><a href="https://github.com/sasanrose/phpredmin"><img width="64" style="width:64px;" src="https://raw.githubusercontent.com/cytopia/icons/master/128x128/phpredmin.png" alt="phpRedMin" /></a></td> <td><a href="https://github.com/elijaa/phpmemcachedadmin"><img width="64" style="width:64px;" src="https://raw.githubusercontent.com/cytopia/icons/master/128x128/phpmemcachedadmin.png" alt="PHPMemcachedAdmin" /></a></td> <td><a href="https://github.com/PeeHaa/OpCacheGUI"><img width="64" style="width:64px;" src="https://raw.githubusercontent.com/cytopia/icons/master/128x128/opcachegui.png" alt="OpCacheGUI" /></a></td> <td><img width="64" style="width:64px;" src="https://raw.githubusercontent.com/cytopia/icons/master/128x128/email.png" alt="Mail viewer" /></td> </tr> <tr> <td><a href="https://www.adminer.org">Adminer</a></td> <td><a href="https://www.phpmyadmin.net">phpMyAdmin</a></td> <td><a href="http://phppgadmin.sourceforge.net">phpPgAdmin</a></td> <td><a href="https://github.com/sasanrose/phpredmin">phpRedMin</a></td> <td><a href="https://github.com/elijaa/phpmemcachedadmin">PHP Memcached Admin</a></td> <td><a href="https://github.com/PeeHaa/OpCacheGUI">OpCache GUI</a></td> <td>Mail viewer</td> </tr> </tbody> </table> <br/> > **Documentation:** > [Devilbox Intranet](https://devilbox.readthedocs.io/en/latest/getting-started/devilbox-intranet.html) <br/> </details> <details><summary><strong>📸 Screenshots</strong></summary> <h3>Screenshots</h3> A few examples of how the built-in intranet looks like. <table> <tbody> <tr> <td rowspan="2"> <a href="docs/img/screenshots/01_intranet_home.png"><img style="width:250px;" alt="Intranet: Home" width="250" src="docs/img/screenshots/01_intranet_home.png" /></a> </td> <td> <a href="docs/img/screenshots/02_intranet_vhosts.png"><img style="width:250px" alt="Intranet: Vhost" width="250" src="docs/img/screenshots/02_intranet_vhosts.png" /></a> </td> <td> <a href="docs/img/screenshots/03_intranet_databases.png"><img style="width:250px;" alt="Intranet: Database" width="250" src="docs/img/screenshots/03_intranet_databases.png" /></a> </td> </tr> <tr> <td> <a href="docs/img/screenshots/04_intranet_emails.png"><img style="width:250px;" alt="Intranet: Emails" width="250" src="docs/img/screenshots/04_intranet_emails.png" /></a> </td> <td></td> </tr> </tbody> </table> <br/> </details> ## 👫 Community The Devilbox has a lot of features reaching from a simple single-user development environment that works out of the box up to a shared development infrastructure for a corporate network. In order to be aware about all that features, ensure to have skimmed over the **[documentation](https://devilbox.readthedocs.io)**, so you know what can be done and how that might simplify your every-day life. If you ever run into any unforseen issues, feel free to join the **[Discord chat](https://discord.gg/2wP3V6kBj4)** or visit the **[forums](https://devilbox.discourse.group)** and get community support quickly. <table width="100%" style="width:100%; display:table;"> <thead> <tr> <th width="25%" style="width:25%;"><h3><a target="_blank" href="https://devilbox.readthedocs.io">📘 Docs</a></h3></th> <th width="25%" style="width:25%;"><h3><a target="_blank" href="https://discord.gg/2wP3V6kBj4">🎮 Discord</a></h3></th> <th width="25%" style="width:25%;"><h3><a target="_blank" href="https://devilbox.discourse.group">🗪 Forum</a></h3></th> <th width="25%" style="width:25%;"><h3><a target="_blank" href="https://github.com/devilbox/flames">🔥 Flames</a></h3></th> </tr> </thead> <tbody style="vertical-align: middle; text-align: center;"> <tr> <td> <a target="_blank" href="https://devilbox.readthedocs.io"> <img title="Documentation" src="https://raw.githubusercontent.com/cytopia/icons/master/400x400/readthedocs.png" /> </a> </td> <td> <a target="_blank" href="https://discord.gg/2wP3V6kBj4"> <img title="Chat on Discord" src="https://raw.githubusercontent.com/cytopia/icons/master/400x400/discord.png" /> </a> </td> <td> <a target="_blank" href="https://devilbox.discourse.group"> <img title="Devilbox Forums" src="https://raw.githubusercontent.com/cytopia/icons/master/400x400/discourse.png" /> </a> </td> <td> <a target="_blank" href="https://github.com/devilbox/flames"> <img title="Devilbox Flames" src="https://raw.githubusercontent.com/cytopia/icons/master/400x400/flames2.png" /> </a> </td> </tr> <tr> <td><a target="_blank" href="https://devilbox.readthedocs.io">devilbox.readthedocs.io</a></td> <td><a target="_blank" href="https://discord.gg/2wP3V6kBj4">discord/devilbox</a></td> <td><a target="_blank" href="https://devilbox.discourse.group">devilbox.discourse.group</a></td> <td><a target="_blank" href="https://github.com/devilbox/flames">github.com/devilbox/flames</a></td> </tr> </tbody> </table> ## 🤝 Contributing The Devilbox is still a young project with a long roadmap ahead. Features are decided by you - **the community**, so any kind of contribution is welcome. * Star this project * Open up issues for bugs and feature requests * Clone this project and submit fixes or features ## 🧘 Maintainer I try to keep up with literally over 100 projects. If my work is making your life easier, consider sending coffee or beer. 🖤 * [GitHub Sponsorship](https://github.com/sponsors/cytopia) * [Patreon](https://www.patreon.com/devilbox) **Contributions:** PyPI: [cytopia](https://pypi.org/user/cytopia/) **·** Terraform: [cytopia](https://registry.terraform.io/namespaces/cytopia) **·** Ansible: [cytopia](https://galaxy.ansible.com/cytopia) ## 🌀 Logos Logos and banners can be found at **[devilbox/artwork](https://github.com/devilbox/artwork)**. Feel free to use or modify them by the terms of their license. <img style="width:64px; height:64px;" width="64" height="64" src="https://github.com/devilbox/artwork/blob/master/submissions_logo/cytopia/01/png/logo_128_trans.png?raw=true" /> <img style="width:64px; height:64px;" width="64" height="64" src="https://github.com/devilbox/artwork/blob/master/submissions_logo/cytopia/02/png/logo_128_trans.png?raw=true" /> <img style="height:64px;" height="64" src="https://github.com/devilbox/artwork/blob/master/submissions_banner/cytopia/01/png/banner_128_trans.png?raw=true" /> ## 🗎 License **[MIT License](LICENSE.md)** Copyright (c) 2016 **[cytopia](https://github.com/cytopia)** <a href="https://github.com/cytopia/devilbox/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cytopia/devilbox" /> </a>

Prisma Client Python is an auto-generated and fully type-safe database client designed for ease of use

<br /> <div align="center"> <h1>Prisma Client Python</h1> <p><h3 align="center">Type-safe database access for Python</h3></p> <div align="center"> <a href="https://discord.gg/HpFaJbepBH"> <img src="https://img.shields.io/discord/933860922039099444?color=blue&label=chat&logo=discord" alt="Chat on Discord"> </a> <a href="https://prisma.io"> <img src="https://img.shields.io/static/v1?label=prisma&message=4.10.0&color=blue&logo=prisma" alt="Supported Prisma version is 4.10.0"> </a> <a href="https://github.com/grantjenks/blue"> <img src="https://camo.githubusercontent.com/dbdbcf26db37abfa1f2ab7e6c28c8b3a199f2dad98e4ef53a50e9c45c7e4ace8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c75652d626c75652e737667" alt="Code style: blue"> </a> <a href="https://robertcraigie.github.io/prisma-client-py/htmlcov/index.html"> <img src="https://raw.githubusercontent.com/RobertCraigie/prisma-client-py/static/coverage/coverage.svg" alt="Code coverage report"> </a> <img src="https://img.shields.io/github/actions/workflow/status/RobertCraigie/prisma-client-py/test.yml?branch=main&label=tests" alt="GitHub Workflow Status (main)"> <img src="https://img.shields.io/pypi/pyversions/prisma" alt="Supported python versions"> <img src="https://img.shields.io/pypi/v/prisma" alt="Latest package version"> </div> </div> <hr> ## What is Prisma Client Python? Prisma Client Python is a next-generation ORM built on top of [Prisma](https://github.com/prisma/prisma) that has been designed from the ground up for ease of use and correctness. [Prisma](https://www.prisma.io/) is a TypeScript ORM with zero-cost type safety for your database, although don't worry, Prisma Client Python [interfaces](#how-does-prisma-python-interface-with-prisma) with Prisma using Rust, you don't need Node or TypeScript. Prisma Client Python can be used in _any_ Python backend application. This can be a REST API, a GraphQL API or _anything_ else that needs a database.  > _Note that the only language server that is known to support this form of autocompletion is Pylance / Pyright._ ## Why should you use Prisma Client Python? Unlike other Python ORMs, Prisma Client Python is **fully type safe** and offers native support for usage **with and without** `async`. All you have to do is [specify the type of client](https://prisma-client-py.readthedocs.io/en/stable/getting_started/setup/) you would like to use for your project in the [Prisma schema file](#the-prisma-schema). However, the arguably best feature that Prisma Client Python provides is [autocompletion support](#auto-completion-for-query-arguments) (see the GIF above). This makes writing database queries easier than ever! Core features: - [Prisma Migrate](https://www.prisma.io/docs/concepts/components/prisma-migrate) - [Full type safety](https://prisma-client-py.readthedocs.io/en/stable/getting_started/type-safety/) - [With / without async](https://prisma-client-py.readthedocs.io/en/stable/getting_started/setup/) - [Recursive and pseudo-recursive types](https://prisma-client-py.readthedocs.io/en/stable/reference/config/#recursive-type-depth) - [Atomic updates](https://prisma-client-py.readthedocs.io/en/stable/reference/operations/#updating-atomic-fields) - [Complex cross-relational queries](https://prisma-client-py.readthedocs.io/en/stable/reference/operations/#filtering-by-relational-fields) - [Partial type generation](https://prisma-client-py.readthedocs.io/en/stable/reference/partial-types/) - [Batching write queries](https://prisma-client-py.readthedocs.io/en/stable/reference/batching/) Supported database providers: - PostgreSQL - MySQL - SQLite - CockroachDB - MongoDB (experimental) - SQL Server (experimental) ## Support Have any questions or need help using Prisma? Join the [community discord](https://discord.gg/HpFaJbepBH)! If you don't want to join the discord you can also: - Create a new [discussion](https://github.com/RobertCraigie/prisma-client-py/discussions/new) - Ping me on the [Prisma Slack](https://slack.prisma.io/) `@Robert Craigie` ## How does Prisma work? This section provides a high-level overview of how Prisma works and its most important technical components. For a more thorough introduction, visit the [documentation](https://prisma-client-py.readthedocs.io). ### The Prisma schema Every project that uses a tool from the Prisma toolkit starts with a [Prisma schema file](https://www.prisma.io/docs/concepts/components/prisma-schema). The Prisma schema allows developers to define their _application models_ in an intuitive data modeling language. It also contains the connection to a database and defines a _generator_: ```prisma // database datasource db { provider = "sqlite" url = "file:database.db" } // generator generator client { provider = "prisma-client-py" recursive_type_depth = 5 } // data models model Post { id Int @id @default(autoincrement()) title String content String? views Int @default(0) published Boolean @default(false) author User? @relation(fields: [author_id], references: [id]) author_id Int? } model User { id Int @id @default(autoincrement()) email String @unique name String? posts Post[] } ``` In this schema, you configure three things: - **Data source**: Specifies your database connection. In this case we use a local SQLite database however you can also use an environment variable. - **Generator**: Indicates that you want to generate Prisma Client Python. - **Data models**: Defines your application models. --- On this page, the focus is on the generator as this is the only part of the schema that is specific to Prisma Client Python. You can learn more about [Data sources](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-schema/data-sources) and [Data models](https://www.prisma.io/docs/concepts/components/prisma-schema/data-model/) on their respective documentation pages. ### Prisma generator A prisma schema can define one or more generators, defined by the `generator` block. A generator determines what assets are created when you run the `prisma generate` command. The `provider` value defines which Prisma Client will be created. In this case, as we want to generate Prisma Client Python, we use the `prisma-client-py` value. You can also define where the client will be generated to with the `output` option. By default Prisma Client Python will be generated to the same location it was installed to, whether thats inside a virtual environment, the global python installation or anywhere else that python packages can be imported from. For more options see [configuring Prisma Client Python](https://prisma-client-py.readthedocs.io/en/stable/reference/config/). --- ### Accessing your database with Prisma Client Python Just want to play around with Prisma Client Python and not worry about any setup? You can try it out online on [gitpod](https://gitpod.io/#https://github.com/RobertCraigie/prisma-py-async-quickstart). #### Installing Prisma Client Python The first step with any python project should be to setup a virtual environment to isolate installed packages from your other python projects, however that is out of the scope for this page. In this example we'll use an asynchronous client, if you would like to use a synchronous client see [setting up a synchronous client](https://prisma-client-py.readthedocs.io/en/stable/getting_started/setup/#synchronous-client). ```sh pip install -U prisma ``` #### Generating Prisma Client Python Now that we have Prisma Client Python installed we need to actually generate the client to be able to access the database. Copy the Prisma schema file shown above to a `schema.prisma` file in the root directory of your project and run: ```sh prisma db push ``` This command will add the data models to your database and generate the client, you should see something like this: ``` Prisma schema loaded from schema.prisma Datasource "db": SQLite database "database.db" at "file:database.db" SQLite database database.db created at file:database.db 🚀 Your database is now in sync with your schema. Done in 26ms ✔ Generated Prisma Client Python to ./.venv/lib/python3.9/site-packages/prisma in 265ms ``` It should be noted that whenever you make changes to your `schema.prisma` file you will have to re-generate the client, you can do this automatically by running `prisma generate --watch`. The simplest asynchronous Prisma Client Python application will either look something like this: ```py import asyncio from prisma import Prisma async def main() -> None: prisma = Prisma() await prisma.connect() # write your queries here user = await prisma.user.create( data={ 'name': 'Robert', 'email': '[email protected]' }, ) await prisma.disconnect() if __name__ == '__main__': asyncio.run(main()) ``` or like this: ```py import asyncio from prisma import Prisma from prisma.models import User async def main() -> None: db = Prisma(auto_register=True) await db.connect() # write your queries here user = await User.prisma().create( data={ 'name': 'Robert', 'email': '[email protected]' }, ) await db.disconnect() if __name__ == '__main__': asyncio.run(main()) ``` #### Query examples For a more complete list of queries you can perform with Prisma Client Python see the [documentation](https://prisma-client-py.readthedocs.io/en/stable/reference/operations/). All query methods return [pydantic models](https://pydantic-docs.helpmanual.io/usage/models/). **Retrieve all `User` records from the database** ```py users = await db.user.find_many() ``` **Include the `posts` relation on each returned `User` object** ```py users = await db.user.find_many( include={ 'posts': True, }, ) ``` **Retrieve all `Post` records that contain `"prisma"`** ```py posts = await db.post.find_many( where={ 'OR': [ {'title': {'contains': 'prisma'}}, {'content': {'contains': 'prisma'}}, ] } ) ``` **Create a new `User` and a new `Post` record in the same query** ```py user = await db.user.create( data={ 'name': 'Robert', 'email': '[email protected]', 'posts': { 'create': { 'title': 'My first post from Prisma!', }, }, }, ) ``` **Update an existing `Post` record** ```py post = await db.post.update( where={ 'id': 42, }, data={ 'views': { 'increment': 1, }, }, ) ``` #### Usage with static type checkers All Prisma Client Python methods are fully statically typed, this means you can easily catch bugs in your code without having to run it! For more details see the [documentation](https://prisma-client-py.readthedocs.io/en/stable/getting_started/type-safety/). #### How does Prisma Client Python interface with Prisma? Prisma Client Python connects to the database and executes queries using Prisma's rust-based Query Engine, of which the source code can be found here: https://github.com/prisma/prisma-engines. Prisma Client Python exposes a CLI interface which wraps the [Prisma CLI](https://www.prisma.io/docs/reference/api-reference/command-reference). This works by downloading a Node binary, if you don't already have Node installed on your machine, installing the CLI with `npm` and running the CLI using Node. The CLI interface is the exact same as the standard [Prisma CLI](https://www.prisma.io/docs/reference/api-reference/command-reference) with [some additional commands](https://prisma-client-py.readthedocs.io/en/stable/reference/command-line/). ## Affiliation Prisma Client Python is _not_ an official Prisma product although it is very generously sponsored by Prisma. ## Room for improvement Prisma Client Python is a fairly new project and as such there are some features that are missing or incomplete. ### Auto completion for query arguments Prisma Client Python query arguments make use of `TypedDict` types. Support for completion of these types within the Python ecosystem is now fairly widespread. This section is only here for documenting support. Supported editors / extensions: - VSCode with [pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) v2021.9.4 or higher - Sublime Text with [LSP-Pyright](https://github.com/sublimelsp/LSP-pyright) v1.1.196 or higher - PyCharm [2022.1 EAP 3](<https://youtrack.jetbrains.com/articles/PY-A-233537928/PyCharm-2022.1-EAP-3-(221.4994.44-build)-Release-Notes>) added support for completing `TypedDict`s - This does not yet work for Prisma Client Python unfortunately, see [this issue](https://youtrack.jetbrains.com/issue/PY-54151/TypedDict-completion-at-callee-does-not-work-for-methods) - Any editor that supports the Language Server Protocol and has an extension supporting Pyright v1.1.196 or higher - vim and neovim with [coc.nvim](https://github.com/fannheyward/coc-pyright) - [emacs](https://github.com/emacs-lsp/lsp-pyright) ```py user = await db.user.find_first( where={ '|' } ) ``` Given the cursor is where the `|` is, an IDE should suggest the following completions: - id - email - name - posts ### Performance While there has currently not been any work done on improving the performance of Prisma Client Python queries, they should be reasonably fast as the core query building and connection handling is performed by Prisma. Performance is something that will be worked on in the future and there is room for massive improvements. ### Supported platforms Windows, MacOS and Linux are all officially supported. ## Version guarantees Prisma Client Python is _not_ stable. Breaking changes will be documented and released under a new **MINOR** version following this format. `MAJOR`.`MINOR`.`PATCH` New releases are scheduled bi-weekly, however as this is a solo project, no guarantees are made that this schedule will be stuck to. ## Contributing We use [conventional commits](https://www.conventionalcommits.org) (also known as semantic commits) to ensure consistent and descriptive commit messages. See the [contributing documentation](https://prisma-client-py.readthedocs.io/en/stable/contributing/contributing/) for more information. ## Attributions This project would not be possible without the work of the amazing folks over at [prisma](https://www.prisma.io). Massive h/t to [@steebchen](https://github.com/steebchen) for his work on [prisma-client-go](https://github.com/prisma/prisma-client-go) which was incredibly helpful in the creation of this project. This README is also heavily inspired by the README in the [prisma/prisma](https://github.com/prisma/prisma) repository.

URL shortening service written in Go and React

# Short [](https://ci.time4hacks.com/short-d/short) [](https://codecov.io/gh/short-d/short) [](https://codeclimate.com/github/short-d/short/maintainability) [](https://goreportcard.com/report/github.com/short-d/short) [](https://github.com/byliuyang/short) [](https://floobits.com/byliuyang/short/redirect)  ## Preview  ## Get `s/` Chrome extension Install it from [Chrome Web Store](https://short-d.com/r/ext) or build it from [source](https://short-d.com/r/ext-code) ## Dependent Projects - [app](https://github.com/short-d/app): Reusable framework for Go apps & command line tools. - [kgs](https://github.com/short-d/kgs): Offline unique key generation service. ## Table of Contents 1. [Getting Started](#getting-started) 1. [Accessing the source code](#accessing-the-source-code) 1. [Prerequisites](#prerequisites) 1. [Local environmental variables](#local-environmental-variables) 1. [Create reCAPTCHA account](#create-recaptcha-account) 1. [Configure Single Sign On](#configure-single-sign-on) 1. [Backend](#backend) 1. [Frontend](#frontend) 1. [System Design](#system-design) 1. [App Level Architecture](#app-level-architecture) 1. [Service Level Architecture](#service-level-architecture) 1. [Object Oriented Design](#object-oriented-design) 1. [Dependency Injection](#dependency-injection) 1. [Database Modeling](#database-modeling) 1. [Feature Toggle](#feature-toggle) 1. [Search Engine Optimization](#search-engine-optimization) 1. [Social Media Summary Card](#social-media-summary-card) 1. [Testing](#testing) 1. [The Importance Of Automation](#the-importance-of-automation) 1. [Testing Strategy](#testing-strategy) 1. [Unit Testing](#unit-testing) 1. [Integration Testing](#integration-testing) 1. [Component Testing](#component-testing) 1. [Contract Testing](#contract-testing) 1. [End To End Testing](#end-to-end-testing) 1. [The Test Pyramid](#the-test-pyramid) 1. [Deployment](#deployment) 1. [Continuous Delivery](#continuous-delivery) 1. [Kubernetes](#kubernetes) 1. [GitOps](#gitops) 1. [Tools We Use](#tools-we-use) 1. [Contributing](#contributing) 1. [Author](#author) 1. [License](#license) ## Getting Started ### Accessing the source code ```bash git clone https://github.com/short-d/short.git ``` ### Prerequisites - [Go](https://golang.org/doc/install) v1.13.1 - [Node.js](https://nodejs.org/en/download/) v12.12.0 - [Yarn](https://classic.yarnpkg.com/en/docs/install) v1.19.1 - [PostgreSQL](doc/tutorial/POSTGRES.md) v12.0 ### Local environmental variables 1. Copy `backend/.env.dist` file to `backend/.env`: ```bash cp backend/.env.dist backend/.env ``` 1. Copy `frontend/.env.development.dist` file to `frontend/.env.development`: ```bash cp frontend/.env.development.dist frontend/.env.development ``` ### Create reCAPTCHA account 1. Sign up at [ReCAPTCHA](https://short-d.com/r/recaptcha) with the following configurations: | Field | Value | |-----------------|----------------| | Label | `Short` | | reCAPTCHA type | `reCAPTCHAv3` | | Domains | `localhost` | 1. Open `settings`. Copy `SITE KEY` and `SECRET KEY`. 1. Replace the value of `RECAPTCHA_SECRET` in the `backend/.env` file with `SECRET KEY`. 1. Replace the value of `REACT_APP_RECAPTCHA_SITE_KEY` in `frontend/.env.development` file with `SITE KEY`. ### Configure Single Sign On #### Google Create a new Client ID at [Google API Credentials](https://console.developers.google.com/apis/credentials): 1. Click on `Create Credentials` and select `OAuth client ID`. 1. Select `Web application` for `Application type`. 1. Fill in `http://localhost/oauth/google/sign-in/callback` for `Authorized redirect URIs` and click on `Create`. 1. Replace the value of `GOOGLE_CLIENT_ID` in `backend/.env` file with `Your Client ID`. 1. Replace the value of `GOOGLE_CLIENT_SECRET` in `backend/.env` file with `Your Client Secret`. #### Facebook You can find the detailed instructions on setting up Facebook sign in [here](doc/sso/FACEBOOK.md) in case you are interested in. #### Github You can find the detailed instructions on setting up Github sign in [here](doc/sso/GITHUB.md) in case you are interested in. ### Backend 1. Update placeholder values with your own configurations. 1. Launch backend server ```bash cd backend ./scripts/dev ``` 1. Remember to install developers tools before start coding: ```bash ./scripts/tools ``` ### Frontend 1. Update `REACT_APP_RECAPTCHA_SITE_KEY` in `frontend/.env.development`. 1. Launch frontend server ```bash cd frontend ./scripts/dev ``` 1. Visit [http://localhost:3000](http://localhost:3000) ## System Design ### App Level Architecture Short backend is built on top of [Uncle Bob's Clean Architecture](https://api.short-d.com/r/ca), the central objective of which is separation of concerns.  It enables the developers to modify a single component of the system at a time while leaving the rest unchanged. This minimizes the amount of changes have to be made in order to support new requirements as the system grows. Clean Architecture also improves the testability of system, which in turn saves precious time when creating automated tests. ### Service Level Architecture Short adopts [Microservices Architecture](https://api.short-d.com/r/ms) to organize dependent services around business capabilities and to enable independent deployment of each service.  [SSR](https://docs.google.com/document/d/16iV91aESfnYU6rIEWGEzws3nbDX3hB-St9gAxrtCAa8), [Toggle](https://docs.google.com/document/d/1TuWexeKwhQh8JTytRAwST3XujBi0wTGExwJan-WfXWs), [Status Page](https://docs.google.com/document/d/1pgRNnD8yAlEmj-sucS_FZ89LdvBy5zpKQ9OvILoBqDM), Search, [Data Reporter](https://docs.google.com/document/d/1-BtxBuS4zIk8H1oXDe-qqEccWp4v6aT2GrWBfwIX5oI), [Feedback Widget](https://docs.google.com/document/d/1IoaTMHsOi5Tb0ZV4btxsvUnKplKi2lxaIYU600cwRuc), and Cloud API are still under active development. ### Object Oriented Design Short leverages class design, package cohesion, and package coupling principles to manage logical dependency between internal components. #### Class Design | Principal | Description | |------------------------------------------------------------------|------------------------------------------------------------------------| | [Single Responsibility Principle](https://api.short-d.com/r/srp) | A class should have one, and only one, reason to change. | | [Open Closed Principle](https://api.short-d.com/r/ocp) | You should be able to extend a classes behavior, without modifying it. | | [Liskov Substitution Principle](https://api.short-d.com/r/lsp) | Derived classes must be substitutable for their base classes. | | [Interface Segregation Principle](https://api.short-d.com/r/isp) | Make fine grained interfaces that are client specific. | | [Dependency Inversion Principle](https://api.short-d.com/r/dip) | Depend on abstractions, not on concretions. | #### Package Cohesion | Principal | Description | |----------------------------------------------------------------------|-------------------------------------------------------| | [Release Reuse Equivalency Principle](https://api.short-d.com/r/rep) | The granule of reuse is the granule of release. | | [The Common Closure Principle](https://api.short-d.com/r/ccp) | Classes that change together are packaged together. | | [The Common Reuse Principle](https://api.short-d.com/r/crp) | Classes that are used together are packaged together. | #### Package Coupling | Principal | Description | |-----------------------------------------------------------------|-------------------------------------------------------| | [Acyclic Dependencies Principle](https://api.short-d.com/r/adp) | The dependency graph of packages must have no cycles. | | [Stable Dependencies Principle](https://api.short-d.com/r/sdp) | Depend in the direction of stability. | | [Stable Abstractions Principle](https://api.short-d.com/r/sap) | Abstractness increases with stability. | ### Dependency Injection Short produces flexible and loosely coupled code, by explicitly providing components with all of the dependencies they need. ```go type Authenticator struct { tokenizer fw.CryptoTokenizer timer fw.Timer tokenValidDuration time.Duration } func NewAuthenticator( tokenizer fw.CryptoTokenizer, timer fw.Timer, tokenValidDuration time.Duration, ) Authenticator { return Authenticator{ tokenizer: tokenizer, timer: timer, tokenValidDuration: tokenValidDuration, } } ``` Short also simplifies the management of the big block of order-dependent initialization code with [Wire](https://api.short-d.com/r/wire), a compile time dependency injection framework by Google. ```go func InjectGraphQlService( name string, sqlDB *sql.DB, graphqlPath provider.GraphQlPath, secret provider.ReCaptchaSecret, jwtSecret provider.JwtSecret, bufferSize provider.KeyGenBufferSize, kgsRPCConfig provider.KgsRPCConfig, tokenValidDuration provider.TokenValidDuration, ) (mdservice.Service, error) { wire.Build( wire.Bind(new(fw.GraphQlAPI), new(graphql.Short)), wire.Bind(new(url.Retriever), new(url.RetrieverPersist)), wire.Bind(new(url.Creator), new(url.CreatorPersist)), wire.Bind(new(repo.UserURLRelation), new(db.UserURLRelationSQL)), wire.Bind(new(repo.URL), new(*db.URLSql)), wire.Bind(new(keygen.KeyGenerator), new(keygen.Remote)), wire.Bind(new(service.KeyFetcher), new(kgs.RPC)), observabilitySet, authSet, mdservice.New, provider.NewGraphGophers, mdhttp.NewClient, mdrequest.NewHTTP, mdtimer.NewTimer, db.NewURLSql, db.NewUserURLRelationSQL, provider.NewRemote, url.NewRetrieverPersist, url.NewCreatorPersist, provider.NewKgsRPC, provider.NewReCaptchaService, requester.NewVerifier, graphql.NewShort, ) return mdservice.Service{}, nil } ``` ### Database Modeling  ### Feature Toggle Short employs `feature toggles` to modify system behavior without changing code. UI components controlled by the feature toggles are created inside a centralized `UIFactory` in order to avoid having nested `if` `else` statement across the code base: ```typescript // UIFactory.tsx export class UIFactory { constructor( private featureDecisionService: IFeatureDecisionService ) {} public createGoogleSignInButton(): ReactElement { if (!this.featureDecisionService.includeGoogleSignButton()) { return <div />; } return ( <GoogleSignInButton googleSignInLink={this.authService.googleSignInLink()} /> ); } public createGithubSignInButton(): ReactElement { if (!this.featureDecisionService.includeGithubSignButton()) { return <div />; } return ( <GithubSignInButton githubSignInLink={this.authService.githubSignInLink()} /> ); } } ``` Short also provides `IFeatureDecisionService` interface, allowing the developers to switch to dynamic feature toggle backend in the future by simply swapping the dependency injected. ```typescript // FeatureDecision.service.ts export interface IFeatureDecisionService { includeGithubSignButton(): boolean; includeGoogleSignButton(): boolean; includeFacebookSignButton(): boolean; } ``` ```typescript // StaticConfigDecision.service.ts import { IFeatureDecisionService } from './FeatureDecision.service'; export class StaticConfigDecisionService implements IFeatureDecisionService { includeGithubSignButton(): boolean { return false; } includeGoogleSignButton(): boolean { return false; } includeFacebookSignButton(): boolean { return true; } } ``` ```typescript // dep.ts export function initUIFactory( ... ): UIFactory { ... const staticConfigDecision = new StaticConfigDecisionService(); ... return new UIFactory( ..., staticConfigDecision ); } ``` You can read about the detailed feature toggle design on [this article](https://martinfowler.com/articles/feature-toggles.html). ### Search Engine Optimization In order to improve the quality and quantity of the website's traffic, Short increases its visibility to web search engines through HTML meta tags. ```html <!-- ./frontend/public/index.html --> <title>Short: Free online link shortening service</title> <!-- Search Engine Optimization --> <meta name="description" content="Short enables people to type less for their favorite web sites"> <meta name="robots" content="index, follow"> <link href="https://short-d.com" rel="canonical"> ``` If you search `short-d.com` on Google, you should see Short shows up as the first result:  ### Social Media Summary Card #### Facebook & LinkedIn Short leverages `Open Graph` tags to control what content shows up in the summary card when the website is shared on Facebook or LinkedIn: ```html <!-- ./frontend/public/index.html --> <!-- Open Graph --> <meta property="og:title" content="Short: Free link shortening service"/> <meta property="og:description" content="Short enables people to type less for their favorite web sites"/> <meta property="og:image" content="https://short-d.com/promo/small-tile.png"/> <meta property="og:url" content="https://short-d.com"/> <meta property="og:type" content="website"/> ``` Shared on Facebook:  Shared on LinkedIn:  #### Twitter Twitter uses its own meta tags to determine what will show up when the website is mentioned in a Tweet: ```html <!-- Twitter --> <meta name="twitter:card" content="summary_large_image"/> <meta name="twitter:site" content="@byliuyang11"/> <meta name="twitter:title" content="Short: Free link shortening service"/> <meta name="twitter:description" content="Short enables people to type less for their favorite web sites"/> <meta name="twitter:image" content="https://short-d.com/promo/twitter-card.png"/> ```  ## Testing ### The Importance Of Automation Short is maintained by a small team of talented software engineers working at Google, Uber, and Vmware as a side project. The team wants to deliver new features faster without sacrificing its quality. Testing ever-increasing amount of features manually soon becomes impossible — unless we want to spend all our time with manual, repetitive work instead of delivering working features. Test automation is the only way forward. ### Testing Strategy  Please read [Testing Strategies in a Microservice Architecture](https://martinfowler.com/articles/microservice-testing) for a detailed introduction on test strategies. ### Unit Testing A unit test exercises the smallest piece of testable software in the application to determine whether it behaves as expected.  Run unit tests for backend: ```bash cd backend ./scripts/unit-test ``` #### Sociable And Solitary  #### The FIRST Principal - [F]ast: Unit tests should be fast otherwise they will slow down development & deployment. - [I]ndependent: Never ever write tests which depend on other test cases. - [R]epeatable: A repeatable test is one that produces the same results each time you run it. - [S]elf-validating: There must be no manual interpretation of the results. - [T]imely/[T]horoughly: Unit tests must be included for every pull request of a new feature and cover edge cases, errors, and bad inputs. #### Test Structure An automated test method should be composed of 3As: Arrange, Act, and Assert. - [A]rrange: All the data needed for a test should be arranged as part of the test. The data used in a test should not depend on the environment in which the test is running. - [A]ct: Invoke the actual method under test. - [A]ssert: A test method should test for a single logical outcome. ### Integration Testing An integration test verifies the communication paths and interactions between components to detect interface defects.  Run integration tests for backend: ```bash cd backend ./scripts/integration-test ``` ### Component Testing A component test limits the scope of the exercised software to a portion of the system under test, manipulating the system through internal code interfaces and using test doubles to isolate the code under test from other components. #### In Process  #### Out Of Process  ### Contract Testing An integration contract test is a test at the boundary of an external service verifying that it meets the contract expected by a consuming service. ### End To End Testing An end-to-end test verifies that a system meets external requirements and achieves its goals, testing the entire system, from end to end. ### The Test Pyramid  ## Deployment ### Continuous Delivery  Currently, we use continuous delivery to deploy code changes to staging & production environment. Merging pull request into master branch on Github will automatically deploy the changes to [staging](https://staging.short-d.com). Merging from `master` branch to `production` branch will automatically deploy the latest code to the production. In the future, when after we add enough automated tests, we may migrate to continuous deployment instead for faster releases. You can find the differences between continuous delivery & continuous deployment [here](doc/tutorial/CI-CD.md) ### Kubernetes Short leverages [Kubernetes](https://kubernetes.io) to automate deployment, scaling, and management of containerized microservices.  ### GitOps Short uses [GitOps](https://github.com/byliuyang/gitops) to configure Kubernetes cluster and span up new services.  ## Tools We Use - [Drone](https://short-d.com/r/ci): Continuous integration written in Go - [Code Climate](https://codeclimate.com/): Automated code review - [ElephantSQL](https://www.elephantsql.com): Managed PostgreSQL service. ## Contributing Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, the process for submitting pull requests to us, and our code review guideline. ## Author Harry Liu - *Initial work* - [byliuyang](https://short-d.com/r/ghharry) As the tech lead of Short, I am responsible for the overall planning, execution and success of complex software solutions to meet users' needs. I deeply believe in and am striving to achieve the right column of the following diagram:  ## License This project is maintained under MIT license

Pluggable Ruby translation framework

Mobility ======== [][gem] [][actions] [][codeclimate] [](https://gitter.im/mobility-ruby/mobility) [gem]: https://rubygems.org/gems/mobility [actions]: https://github.com/shioyama/mobility/actions [codeclimate]: https://codeclimate.com/github/shioyama/mobility [docs]: http://www.rubydoc.info/gems/mobility [wiki]: https://github.com/shioyama/mobility/wiki **This is the readme for version 1.x of Mobility. If you are using an earlier version (0.8.x or earlier), you probably want the readme on the [0-8 branch](https://github.com/shioyama/mobility/tree/0-8).** Mobility is a gem for storing and retrieving translations as attributes on a class. These translations could be the content of blog posts, captions on images, tags on bookmarks, or anything else you might want to store in different languages. For examples of what Mobility can do, see the <a href="#companies-using-mobility">Companies using Mobility</a> section below. Storage of translations is handled by customizable "backends" which encapsulate different storage strategies. The default way to store translations is to put them all in a set of two shared tables, but many alternatives are also supported, including [translatable columns](http://dejimata.com/2017/3/3/translating-with-mobility#strategy-1) and [model translation tables](http://dejimata.com/2017/3/3/translating-with-mobility#strategy-2), as well as database-specific storage solutions such as [json/jsonb](https://www.postgresql.org/docs/current/static/datatype-json.html) and [Hstore](https://www.postgresql.org/docs/current/static/hstore.html) (for PostgreSQL). Mobility is a cross-platform solution, currently supporting both [ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html) and [Sequel](http://sequel.jeremyevans.net/) ORM, with support for other platforms planned. For a detailed introduction to Mobility, see [Translating with Mobility](http://dejimata.com/2017/3/3/translating-with-mobility). See also my talk at RubyConf 2018, [Building Generic Software](https://www.youtube.com/watch?v=RZkemV_-__A), where I explain the thinking behind Mobility's design. If you're coming from Globalize, be sure to also read the [Migrating from Globalize](https://github.com/shioyama/mobility/wiki/Migrating-from-Globalize) section of the wiki. Installation ------------ Add this line to your application's Gemfile: ```ruby gem 'mobility', '~> 1.2.9' ``` ### ActiveRecord (Rails) Requirements: - ActiveRecord >= 5.0 (including 6.x) (Support for most backends and features is also supported with ActiveRecord/Rails 4.2, but there are some tests still failing. To see exactly what might not work, check pending specs in Rails 4.2 builds.) To translate attributes on a model, extend `Mobility`, then call `translates` passing in one or more attributes as well as a hash of options (see below). If using Mobility in a Rails project, you can run the generator to create an initializer and a migration to create shared translation tables for the default `KeyValue` backend: ``` rails generate mobility:install ``` (If you do not plan to use the default backend, you may want to use the `--without_tables` option here to skip the migration generation.) The generator will create an initializer file `config/initializers/mobility.rb` which looks something like this: ```ruby Mobility.configure do # PLUGINS plugins do backend :key_value active_record reader writer # ... end end ``` Each method call inside the block passed to `plugins` declares a plugin, along with an optional default. To use a different default backend, you can change the default passed to the `backend` plugin, like this: ```diff Mobility.configure do # PLUGINS plugins do - backend :key_value + backend :table ``` See other possible backends in the [backends section](#backends). You can also set defaults for backend-specific options. Below, we set the default `type` option for the KeyValue backend to `:string`. ```diff Mobility.configure do # PLUGINS plugins do - backend :key_value + backend :key_value, type: :string end end ``` We will assume the configuration above in the examples that follow. See [Getting Started](#quickstart) to get started translating your models. ### Sequel Requirements: - Sequel >= 4.0 When configuring Mobility, ensure that you include the `sequel` plugin: ```diff plugins do backend :key_value - active_record + sequel ``` You can extend `Mobility` just like in ActiveRecord, or you can use the `mobility` plugin, which does the same thing: ```ruby class Word < ::Sequel::Model plugin :mobility translates :name, :meaning end ``` Otherwise everything is (almost) identical to AR, with the exception that there is no equivalent to a Rails generator, so you will need to create the migration for any translation table(s) yourself, using Rails generators as a reference. The models in examples below all inherit from `ApplicationRecord`, but everything works exactly the same if the parent class is `Sequel::Model`. Usage ----- ### <a name="quickstart"></a>Getting Started Once the install generator has been run to generate translation tables, using Mobility is as easy as adding a few lines to any class you want to translate. Simply pass one or more attribute names to the `translates` method with a hash of options, like this: ```ruby class Word < ApplicationRecord extend Mobility translates :name, :meaning end ``` Note: When using the KeyValue backend, use the options hash to pass each attribute's type: ```ruby class Word < ApplicationRecord extend Mobility translates :name, type: :string translates :meaning, type: :text end ``` This is important because this is how Mobility knows to which of the [two translation tables](https://github.com/shioyama/mobility/wiki/KeyValue-Backend) it should save your translation. You now have translated attributes `name` and `meaning` on the model `Word`. You can set their values like you would any other attribute: ```ruby word = Word.new word.name = "mobility" word.meaning = "(noun): quality of being changeable, adaptable or versatile" word.name #=> "mobility" word.meaning #=> "(noun): quality of being changeable, adaptable or versatile" word.save word = Word.first word.name #=> "mobility" word.meaning #=> "(noun): quality of being changeable, adaptable or versatile" ``` Presence methods are also supported: ```ruby word.name? #=> true word.name = nil word.name? #=> false word.name = "" word.name? #=> false ``` What's different here is that the value of these attributes changes with the value of `I18n.locale`: ```ruby I18n.locale = :ja word.name #=> nil word.meaning #=> nil ``` The `name` and `meaning` of this word are not defined in any locale except English. Let's define them in Japanese and save the model: ```ruby word.name = "モビリティ" word.meaning = "(名詞):動きやすさ、可動性" word.name #=> "モビリティ" word.meaning #=> "(名詞):動きやすさ、可動性" word.save ``` Now our word has names and meanings in two different languages: ```ruby word = Word.first I18n.locale = :en word.name #=> "mobility" word.meaning #=> "(noun): quality of being changeable, adaptable or versatile" I18n.locale = :ja word.name #=> "モビリティ" word.meaning #=> "(名詞):動きやすさ、可動性" ``` Internally, Mobility is mapping the values in different locales to storage locations, usually database columns. By default these values are stored as keys (attribute names) and values (attribute translations) on a set of translation tables, one for strings and one for text columns, but this can be easily changed and/or customized (see the [Backends](#backends) section below). ### <a name="getset"></a> Getting and Setting Translations The easiest way to get or set a translation is to use the getter and setter methods described above (`word.name` and `word.name=`), enabled by including the `reader` and `writer` plugins. You may also want to access the value of an attribute in a specific locale, independent of the current value of `I18n.locale` (or `Mobility.locale`). There are a few ways to do this. The first way is to define locale-specific methods, one for each locale you want to access directly on a given attribute. These are called "locale accessors" in Mobility, and can be enabled by including the `locale_accessors` plugin, with a default set of accessors: ```diff plugins do # ... + locale_accessors [:en, :ja] ``` You can also override this default from `translates` in any model: ```ruby class Word < ApplicationRecord extend Mobility translates :name, locale_accessors: [:en, :ja] end ``` Since we have enabled locale accessors for English and Japanese, we can access translations for these locales with `name_en` and `name_ja`: ```ruby word.name_en #=> "mobility" word.name_ja #=> "モビリティ" word.name_en = "foo" word.name #=> "foo" ``` Other locales, however, will not work: ```ruby word.name_ru #=> NoMethodError: undefined method `name_ru' for #<Word id: ... > ``` With no plugin option (or a default of `true`), Mobility generates methods for all locales in `I18n.available_locales` at the time the model is first loaded. An alternative to using the `locale_accessors` plugin is to use the `fallthrough_accessors` plugin. This uses Ruby's [`method_missing`](http://apidock.com/ruby/BasicObject/method_missing) method to implicitly define the same methods as above, but supporting any locale without any method definitions. (Locale accessors and fallthrough locales can be used together without conflict, with locale accessors taking precedence if defined for a given locale.) Ensure the plugin is enabled: ```diff plugins do # ... + fallthrough_accessors ``` ... then we can access any locale we want, without specifying them upfront: ```ruby word = Word.new word.name_fr = "mobilité" word.name_fr #=> "mobilité" word.name_ja = "モビリティ" word.name_ja #=> "モビリティ" ``` (Note however that Mobility will complain if you have `I18n.enforce_available_locales` set to `true` and you try accessing a locale not present in `I18n.available_locales`; set it to `false` if you want to allow *any* locale.) Another way to fetch values in a locale is to pass the `locale` option to the getter method, like this: ```ruby word.name(locale: :en) #=> "mobility" word.name(locale: :fr) #=> "mobilité" ``` Note that setting the locale this way will pass an option `locale: true` to the backend and all plugins. Plugins may use this option to change their behavior (passing the locale explicitly this way, for example, disables [fallbacks](#fallbacks), see below for details). You can also *set* the value of an attribute this way; however, since the `word.name = <value>` syntax does not accept any options, the only way to do this is to use `send` (this is included mostly for consistency): ```ruby word.send(:name=, "mobiliteit", locale: :nl) word.name_nl #=> "mobiliteit" ``` Yet another way to get and set translated attributes is to call `read` and `write` on the storage backend, which can be accessed using the method `<attribute>_backend`. Without worrying too much about the details of how this works for now, the syntax for doing this is simple: ```ruby word.name_backend.read(:en) #=> "mobility" word.name_backend.read(:nl) #=> "mobiliteit" word.name_backend.write(:en, "foo") word.name_backend.read(:en) #=> "foo" ``` Internally, all methods for accessing translated attributes ultimately end up reading and writing from the backend instance this way. (The `write` methods do not call underlying backend's methods to persist the change. This is up to the user, so e.g. with ActiveRecord you should call `save` write the changes to the database). Note that accessor methods are defined in an included module, so you can wrap reads or writes in custom logic: ```ruby class Post < ApplicationRecord extend Mobility translates :title def title(*) super.reverse end end ``` ### Setting the Locale It may not always be desirable to use `I18n.locale` to set the locale for content translations. For example, a user whose interface is in English (`I18n.locale` is `:en`) may want to see content in Japanese. If you use `I18n.locale` exclusively for the locale, you will have a hard time showing stored translations in one language while showing the interface in another language. For these cases, Mobility also has its own locale, which defaults to `I18n.locale` but can be set independently: ```ruby I18n.locale = :en Mobility.locale #=> :en Mobility.locale = :fr Mobility.locale #=> :fr I18n.locale #=> :en ``` To set the Mobility locale in a block, you can use `Mobility.with_locale` (like `I18n.with_locale`): ```ruby Mobility.locale = :en Mobility.with_locale(:ja) do Mobility.locale #=> :ja end Mobility.locale #=> :en ``` Mobility uses [RequestStore](https://github.com/steveklabnik/request_store) to reset these global variables after every request, so you don't need to worry about thread safety. If you're not using Rails, consult RequestStore's [README](https://github.com/steveklabnik/request_store#no-rails-no-problem) for details on how to configure it for your use case. ### <a name="fallbacks"></a>Fallbacks Mobility offers basic support for translation fallbacks. First, enable the `fallbacks` plugin: ```diff plugins do # ... + fallbacks + locale_accessors ``` Fallbacks will require `fallthrough_accessors` to handle methods like `title_en`, which are used to track changes. For performance reasons it's generally best to also enable the `locale_accessors` plugin as shown above. Now pass a hash with fallbacks for each locale as an option when defining translated attributes on a class: ```ruby class Word < ApplicationRecord extend Mobility translates :name, fallbacks: { de: :ja, fr: :ja } translates :meaning, fallbacks: { de: :ja, fr: :ja } end ``` Internally, Mobility assigns the fallbacks hash to an instance of `I18n::Locale::Fallbacks.new`. By setting fallbacks for German and French to Japanese, values will fall through to the Japanese value if none is present for either of these locales, but not for other locales: ```ruby Mobility.locale = :ja word = Word.create(name: "モビリティ", meaning: "(名詞):動きやすさ、可動性") Mobility.locale = :de word.name #=> "モビリティ" word.meaning #=> "(名詞):動きやすさ、可動性" Mobility.locale = :fr word.name #=> "モビリティ" word.meaning #=> "(名詞):動きやすさ、可動性" Mobility.locale = :ru word.name #=> nil word.meaning #=> nil ``` You can optionally disable fallbacks to get the real value for a given locale (for example, to check if a value in a particular locale is set or not) by passing `fallback: false` (*singular*, not plural) to the getter method: ```ruby Mobility.locale = :de word.meaning(fallback: false) #=> nil Mobility.locale = :fr word.meaning(fallback: false) #=> nil Mobility.locale = :ja word.meaning(fallback: false) #=> "(名詞):動きやすさ、可動性" ``` You can also set the fallback locales for a single read by passing one or more locales: ```ruby Mobility.with_locale(:fr) do word.meaning = "(nf): aptitude à bouger, à se déplacer, à changer, à évoluer" end word.save Mobility.locale = :de word.meaning(fallback: false) #=> nil word.meaning(fallback: :fr) #=> "(nf): aptitude à bouger, à se déplacer, à changer, à évoluer" word.meaning(fallback: [:ja, :fr]) #=> "(名詞):動きやすさ、可動性" ``` Also note that passing a `locale` option into an attribute reader or writer, or using [locale accessors or fallthrough accessors](#getset) to get or set any attribute value, will disable fallbacks (just like `fallback: false`). (This will take precedence over any value of the `fallback` option.) Continuing from the last example: ```ruby word.meaning(locale: :de) #=> nil word.meaning_de #=> nil Mobility.with_locale(:de) { word.meaning } #=> "(名詞):動きやすさ、可動性" ``` For more details, see the [API documentation on fallbacks](http://www.rubydoc.info/gems/mobility/Mobility/Plugins/Fallbacks) and [this article on I18n fallbacks](https://github.com/svenfuchs/i18n/wiki/Fallbacks). ### <a name="default"></a>Default values Another option is to assign a default value, using the `default` plugin: ```diff plugins do # ... + default 'foo' ``` Here we've set a "default default" of `'foo'`, which will be returned if a fetch would otherwise return `nil`. This can be overridden from model classes: ```ruby class Word < ApplicationRecord extend Mobility translates :name, default: 'foo' end Mobility.locale = :ja word = Word.create(name: "モビリティ") word.name #=> "モビリティ" Mobility.locale = :de word.name #=> "foo" ``` You can override the default by passing a `default` option to the attribute reader: ```ruby word.name #=> 'foo' word.name(default: nil) #=> nil word.name(default: 'bar') #=> 'bar' ``` The default can also be a `Proc`, which will be called with the context as the model itself, and passed optional arguments (attribute, locale and options passed to accessor) which can be used to customize behaviour. See the [API docs][docs] for details. ### <a name="dirty"></a>Dirty Tracking Dirty tracking (tracking of changed attributes) can be enabled for models which support it. Currently this is models which include [ActiveModel::Dirty](http://api.rubyonrails.org/classes/ActiveModel/Dirty.html) (like `ActiveRecord::Base`) and Sequel models (through the [dirty](http://sequel.jeremyevans.net/rdoc-plugins/classes/Sequel/Plugins/Dirty.html) plugin). First, ensure the `dirty` plugin is enabled in your configuration, and that you have enabled an ORM plugin (either `active_record` or `sequel`), since the dirty plugin will depend on one of these being enabled. ```diff plugins do # ... active_record + dirty ``` (Once enabled globally, the dirty plugin can be selectively disabled on classes by passing `dirty: false` to `translates`.) Take this ActiveRecord class: ```ruby class Post < ApplicationRecord extend Mobility translates :title end ``` Let's assume we start with a post with a title in English and Japanese: ```ruby post = Post.create(title: "Introducing Mobility") Mobility.with_locale(:ja) { post.title = "モビリティの紹介" } post.save ``` Now let's change the title: ```ruby post = Post.first post.title #=> "Introducing Mobility" post.title = "a new title" Mobility.with_locale(:ja) do post.title #=> "モビリティの紹介" post.title = "新しいタイトル" post.title #=> "新しいタイトル" end ``` Now you can use dirty methods as you would any other (untranslated) attribute: ```ruby post.title_was #=> "Introducing Mobility" Mobility.locale = :ja post.title_was #=> "モビリティの紹介" post.changed ["title_en", "title_ja"] post.save ``` You can also access `previous_changes`: ```ruby post.previous_changes #=> { "title_en" => [ "Introducing Mobility", "a new title" ], "title_ja" => [ "モビリティの紹介", "新しいタイトル" ] } ``` Notice that Mobility uses locale suffixes to indicate which locale has changed; dirty tracking is implemented this way to ensure that it is clear what has changed in which locale, avoiding any possible ambiguity. For performance reasons, it is highly recommended that when using the Dirty plugin, you also enable [locale accessors](#getset) for all locales which will be used, so that methods like `title_en` above are defined; otherwise they will be caught by `method_missing` (using fallthrough accessors), which is much slower. For more details on dirty tracking, see the [API documentation](http://www.rubydoc.info/gems/mobility/Mobility/Plugins/Dirty). ### Cache The Mobility cache caches localized values that have been fetched once so they can be quickly retrieved again. The cache plugin is included in the default configuration created by the install generator: ```diff plugins do # ... + cache ``` It can be disabled selectively per model by passing `cache: false` when defining an attribute, like this: ```ruby class Word < ApplicationRecord extend Mobility translates :name, cache: false end ``` You can also turn off the cache for a single fetch by passing `cache: false` to the getter method, i.e. `post.title(cache: false)`. To remove the cache plugin entirely, remove the `cache` line from the global plugins configuration. The cache is normally just a hash with locale keys and string (translation) values, but some backends (e.g. KeyValue and Table backends) have slightly more complex implementations. ### <a name="querying"></a>Querying Mobility backends also support querying on translated attributes. To enable this feature, include the `query` plugin, and ensure you also have an ORM plugin enabled (`active_record` or `sequel`): ```diff plugins do # ... active_record + query ``` Querying defines a scope or dataset class method, whose default name is `i18n`. You can override this by passing a default in the configuration, like `query :t` to use a name `t`. Querying is supported in two different ways. The first is via query methods like `where` (and `not` and `find_by` in ActiveRecord, and `except` in Sequel). So for ActiveRecord, assuming a model using KeyValue as its default backend: ```ruby class Post < ApplicationRecord extend Mobility translates :title, type: :string translates :content, type: :text end ``` ... we can query for posts with title "foo" and content "bar" just as we would query on untranslated attributes, and Mobility will convert the queries to whatever the backend requires to actually return the correct results: ```ruby Post.i18n.find_by(title: "foo", content: "bar") ``` results in the SQL: ```sql SELECT "posts".* FROM "posts" INNER JOIN "mobility_string_translations" "Post_title_en_string_translations" ON "Post_title_en_string_translations"."key" = 'title' AND "Post_title_en_string_translations"."locale" = 'en' AND "Post_title_en_string_translations"."translatable_type" = 'Post' AND "Post_title_en_string_translations"."translatable_id" = "posts"."id" INNER JOIN "mobility_text_translations" "Post_content_en_text_translations" ON "Post_content_en_text_translations"."key" = 'content' AND "Post_content_en_text_translations"."locale" = 'en' AND "Post_content_en_text_translations"."translatable_type" = 'Post' AND "Post_content_en_text_translations"."translatable_id" = "posts"."id" WHERE "Post_title_en_string_translations"."value" = 'foo' AND "Post_content_en_text_translations"."value" = 'bar' ``` As can be seen in the query above, behind the scenes Mobility joins two tables, one with string translations and one with text translations, and aliases the joins for each attribute so as to match the particular model, attribute(s), locale(s) and value(s) passed in to the query. Details of how this is done can be found in the [Wiki page for the KeyValue backend](https://github.com/shioyama/mobility/wiki/KeyValue-Backend#querying). You can also use methods like `order`, `select`, `pluck` and `group` on translated attributes just as you would with normal attributes, and Mobility will handle generating the appropriate SQL: ```ruby Post.i18n.pluck(:title) #=> ["foo", "bar", ...] ``` If you would prefer to avoid the `i18n` scope everywhere, you can define it as a default scope on your model: ```ruby class Post < ApplicationRecord extend Mobility translates :title, type: :string translates :content, type: :text default_scope { i18n } end ``` Now translated attributes can be queried just like normal attributes: ```ruby Post.find_by(title: "Introducing Mobility") #=> finds post with English title "Introducing Mobility" ``` If you want more fine-grained control over your queries, you can alternatively pass a block to the query method and call attribute names from the block scope to build Arel predicates: ```ruby Post.i18n do title.matches("foo").and(content.matches("bar")) end ``` which generates the same SQL as above, except the `WHERE` clause becomes: ```sql SELECT "posts".* FROM "posts" ... WHERE "Post_title_en_string_translations"."value" ILIKE 'foo' AND "Post_content_en_text_translations"."value" ILIKE 'bar' ``` The block-format query format is very powerful and allows you to build complex backend-independent queries on translated and untranslated attributes without having to deal with the details of how these translations are stored. The same interface is supported with Sequel to build datasets. <a name="backends"></a>Backends -------- Mobility supports different storage strategies, called "backends". The default backend is the `KeyValue` backend, which stores translations in two tables, by default named `mobility_text_translations` and `mobility_string_translations`. You can set the default backend to a different value in the global configuration, or you can set it explicitly when defining a translated attribute, like this: ```ruby class Word < ApplicationRecord translates :name, backend: :table end ``` This would set the `name` attribute to use the `Table` backend (see below). The `type` option (`type: :string` or `type: :text`) is missing here because this is an option specific to the KeyValue backend (specifying which shared table to store translations on). Backends have their own specific options; see the [Wiki][wiki] and [API documentation][docs] for which options are available for each. Everything else described above (fallbacks, dirty tracking, locale accessors, caching, querying, etc) is the same regardless of which backend you use. ### Table Backend (like Globalize) The `Table` backend stores translations as columns on a model-specific table. If your model uses the table `posts`, then by default this backend will store an attribute `title` on a table `post_translations`, and join the table to retrieve the translated value. To use the table backend on a model, you will need to first create a translation table for the model, which (with Rails) you can do using the `mobility:translations` generator: ``` rails generate mobility:translations post title:string content:text ``` This will generate the `post_translations` table with columns `title` and `content`, and all other necessary columns and indices. For more details see the [Table Backend](https://github.com/shioyama/mobility/wiki/Table-Backend) page of the wiki and API documentation on the [`Mobility::Backend::Table` class](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Table). ### Column Backend (like Traco) The `Column` backend stores translations as columns with locale suffixes on the model table. For an attribute `title`, these would be of the form `title_en`, `title_fr`, etc. Use the `mobility:translations` generator to add columns for locales in `I18n.available_locales` to your model: ``` rails generate mobility:translations post title:string content:text ``` For more details, see the [Column Backend](https://github.com/shioyama/mobility/wiki/Column-Backend) page of the wiki and API documentation on the [`Mobility::Backend::Column` class](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Column). ### PostgreSQL-specific Backends Mobility also supports JSON and Hstore storage options, if you are using PostgreSQL as your database. To use this option, create column(s) on the model table for each translated attribute, and set your backend to `:json`, `:jsonb` or `:hstore`. If you are using Sequel, note that you will need to enable the [pg_json](http://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/pg_json_rb.html) or [pg_hstore](http://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/pg_hstore_rb.html) extensions with `DB.extension :pg_json` or `DB.extension :pg_hstore` (where `DB` is your database instance). Another option is to store all your translations on a single jsonb column (one per model). This is called the "container" backend. For details on these backends, see the [Postgres Backend](https://github.com/shioyama/mobility/wiki/Postgres-Backends-%28Column-Attribute%29) and [Container Backend](https://github.com/shioyama/mobility/wiki/Container-Backend) pages of the wiki and in the API documentation ([`Mobility::Backend::Jsonb`](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Jsonb) and [`Mobility::Backend::Hstore`](http://www.rubydoc.info/gems/mobility/Mobility/Backends/Hstore)). *Note: The Json backend (`:json`) may also work with recent versions of MySQL with JSON column support, although this backend/db combination is not tested. See [this issue](https://github.com/shioyama/mobility/issues/226) for details.* Development ----------- ### Custom Backends Although Mobility is primarily oriented toward storing ActiveRecord model translations, it can potentially be used to handle storing translations in other formats. In particular, the features mentioned above (locale accessors, caching, fallbacks, dirty tracking to some degree) are not specific to database storage. To use a custom backend, simply pass the name of a class which includes `Mobility::Backend` to `translates`: ```ruby class MyBackend include Mobility::Backend # ... end class MyClass extend Mobility translates :foo, backend: MyBackend end ``` For details on how to define a backend class, see the [Introduction to Mobility Backends](https://github.com/shioyama/mobility/wiki/Introduction-to-Mobility-Backends) page of the wiki and the [API documentation on the `Mobility::Backend` module](http://www.rubydoc.info/gems/mobility/Mobility/Backend). ### Testing Backends All included backends are tested against a suite of shared specs which ensure they conform to the same expected behaviour. These examples can be found in: - `spec/support/shared_examples/accessor_examples.rb` (minimal specs testing translation setting/getting) - `spec/support/shared_examples/querying_examples.rb` (specs for [querying](#querying)) - `spec/support/shared_examples/serialization_examples.rb` (specialized specs for backends which store translations as a Hash: `serialized`, `hstore`, `json` and `jsonb` backends) A minimal test can simply define a model class and use helpers defined in `spec/support/helpers.rb` to run these examples, by extending either `Helpers::ActiveRecord` or `Helpers::Sequel`: ```ruby describe MyBackend do extend Helpers::ActiveRecord before do stub_const 'MyPost', Class.new(ActiveRecord::Base) MyPost.extend Mobility MyPost.translates :title, :content, backend: MyBackend end include_accessor_examples 'MyPost' include_querying_examples 'MyPost' # ... end ``` Shared examples expect the model class to have translated attributes `title` and `content`, and an untranslated boolean column `published`. These defaults can be changed, see the shared examples for details. Backends are also each tested against specialized specs targeted at their particular implementations. Integrations ------------ * [friendly_id-mobility](https://github.com/shioyama/friendly_id-mobility): Use Mobility with [FriendlyId](https://github.com/norman/friendly_id). * [mobility-ransack](https://github.com/shioyama/mobility-ransack): Search attributes translated by Mobility with [Ransack](https://github.com/activerecord-hackery/ransack). * [mobility-actiontext](https://github.com/sedubois/mobility-actiontext): Translate Rails [Action Text](https://guides.rubyonrails.org/action_text_overview.html) rich text with Mobility. Tutorials --------- - [Polyglot content in a rails app](https://revs.runtime-revolution.com/polyglot-content-in-a-rails-app-aed823854955) - [Translating with Mobility](https://dejimata.com/2017/3/3/translating-with-mobility) - [JSONify your Ruby Translations](https://dejimata.com/2018/3/20/jsonify-your-ruby-translations) More Information ---------------- - [Github repository](https://www.github.com/shioyama/mobility) - [API documentation][docs] - [Wiki][wiki] <a name="#companies-using-mobility"></a>Companies using Mobility ------------------------ <img alt="Logos of companies using Mobility" src="./img/companies-using-mobility.png" style="width: 100%" /> - [Doorkeeper](https://www.doorkeeper.jp/) - [Oreegano](https://www.oreegano.com/) - [Venuu](https://venuu.fi) - ... ^&#10033; ^&#10033; <small>Post an issue or email me to add your company's name to this list.</small> License ------- The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

PostgreSQL Audit Extension

# pgAudit <br/> Open Source PostgreSQL Audit Logging ## Introduction The PostgreSQL Audit Extension (pgAudit) provides detailed session and/or object audit logging via the standard PostgreSQL logging facility. The goal of the pgAudit is to provide PostgreSQL users with capability to produce audit logs often required to comply with government, financial, or ISO certifications. An audit is an official inspection of an individual's or organization's accounts, typically by an independent body. The information gathered by pgAudit is properly called an audit trail or audit log. The term audit log is used in this documentation. ## Why pgAudit? Basic statement logging can be provided by the standard logging facility with `log_statement = all`. This is acceptable for monitoring and other usages but does not provide the level of detail generally required for an audit. It is not enough to have a list of all the operations performed against the database. It must also be possible to find particular statements that are of interest to an auditor. The standard logging facility shows what the user requested, while pgAudit focuses on the details of what happened while the database was satisfying the request. For example, an auditor may want to verify that a particular table was created inside a documented maintenance window. This might seem like a simple job for grep, but what if you are presented with something like this (intentionally obfuscated) example: ``` DO $$ BEGIN EXECUTE 'CREATE TABLE import' || 'ant_table (id INT)'; END $$; ``` Standard logging will give you this: ``` LOG: statement: DO $$ BEGIN EXECUTE 'CREATE TABLE import' || 'ant_table (id INT)'; END $$; ``` It appears that finding the table of interest may require some knowledge of the code in cases where tables are created dynamically. This is not ideal since it would be preferable to just search on the table name. This is where pgAudit comes in. For the same input, it will produce this output in the log: ``` AUDIT: SESSION,33,1,FUNCTION,DO,,,"DO $$ BEGIN EXECUTE 'CREATE TABLE import' || 'ant_table (id INT)'; END $$;" AUDIT: SESSION,33,2,DDL,CREATE TABLE,TABLE,public.important_table,CREATE TABLE important_table (id INT) ``` Not only is the `DO` block logged, but substatement 2 contains the full text of the `CREATE TABLE` with the statement type, object type, and full-qualified name to make searches easy. When logging `SELECT` and `DML` statements, pgAudit can be configured to log a separate entry for each relation referenced in a statement. No parsing is required to find all statements that touch a particular table. In fact, the goal is that the statement text is provided primarily for deep forensics and should not be required for an audit. ## Usage Considerations Depending on settings, it is possible for pgAudit to generate an enormous volume of logging. Be careful to determine exactly what needs to be audit logged in your environment to avoid logging too much. For example, when working in an OLAP environment it would probably not be wise to audit log inserts into a large fact table. The size of the log file will likely be many times the actual data size of the inserts because the log file is expressed as text. Since logs are generally stored with the OS this may lead to disk space being exhausted very quickly. In cases where it is not possible to limit audit logging to certain tables, be sure to assess the performance impact while testing and allocate plenty of space on the log volume. This may also be true for OLTP environments. Even if the insert volume is not as high, the performance impact of audit logging may still noticeably affect latency. To limit the number of relations audit logged for `SELECT` and `DML` statements, consider using object audit logging (see [Object Auditing](#object-audit-logging)). Object audit logging allows selection of the relations to be logged allowing for reduction of the overall log volume. However, when new relations are added they must be explicitly added to object audit logging. A programmatic solution where specified tables are excluded from logging and all others are included may be a good option in this case. ## PostgreSQL Version Compatibility pgAudit was developed to support PostgreSQL 9.5 or greater. In order to support new functionality introduced in each PostgreSQL release, pgAudit maintains a separate branch for each PostgreSQL major version (currently PostgreSQL 9.5 - 15) which will be maintained in a manner similar to the PostgreSQL project. Aside from bug fixes, no further development is planned for stable branches. New development, if any, will be strictly for next unreleased major version of PostgreSQL. pgAudit versions relate to PostgreSQL major versions as follows: - **pgAudit v1.7.X** is intended to support PostgreSQL 15. - **pgAudit v1.6.X** is intended to support PostgreSQL 14. - **pgAudit v1.5.X** is intended to support PostgreSQL 13. - **pgAudit v1.4.X** is intended to support PostgreSQL 12. - **pgAudit v1.3.X** is intended to support PostgreSQL 11. - **pgAudit v1.2.X** is intended to support PostgreSQL 10. - **pgAudit v1.1.X** is intended to support PostgreSQL 9.6. - **pgAudit v1.0.X** is intended to support PostgreSQL 9.5. ## Compile and Install pgAudit can be compiled against an installed copy of PostgreSQL with development packages using `PGXS`. The following instructions are for RHEL 7. Clone the pgAudit extension: ``` git clone https://github.com/pgaudit/pgaudit.git ``` Change to pgAudit directory: ``` cd pgaudit ``` Checkout `REL_15_STABLE` branch (note that the stable branch may not exist for unreleased versions of PostgreSQL): ``` git checkout REL_15_STABLE ``` Build and install pgAudit: ``` make install USE_PGXS=1 PG_CONFIG=/usr/pgsql-15/bin/pg_config ``` Instructions for testing and development may be found in `test`. ## Settings Settings may be modified only by a superuser. Allowing normal users to change their settings would defeat the point of an audit log. Settings can be specified globally (in `postgresql.conf` or using `ALTER SYSTEM ... SET`), at the database level (using `ALTER DATABASE ... SET`), or at the role level (using `ALTER ROLE ... SET`). Note that settings are not inherited through normal role inheritance and `SET ROLE` will not alter a user's pgAudit settings. This is a limitation of the roles system and not inherent to pgAudit. The pgAudit extension must be loaded in [shared_preload_libraries](http://www.postgresql.org/docs/15/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES). Otherwise, an error will be raised at load time and no audit logging will occur. In addition, `CREATE EXTENSION pgaudit` must be called before `pgaudit.log` is set to ensure proper pgaudit functionality. The extension installs event triggers which add additional auditing for DDL. pgAudit will work without the extension installed but DDL statements will not have information about the object type and name. If the `pgaudit` extension is dropped and needs to be recreated then `pgaudit.log` must be unset first otherwise an error will be raised. ### pgaudit.log Specifies which classes of statements will be logged by session audit logging. Possible values are: - **READ**: `SELECT` and `COPY` when the source is a relation or a query. - **WRITE**: `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY` when the destination is a relation. - **FUNCTION**: Function calls and `DO` blocks. - **ROLE**: Statements related to roles and privileges: `GRANT`, `REVOKE`, `CREATE/ALTER/DROP ROLE`. - **DDL**: All `DDL` that is not included in the `ROLE` class. - **MISC**: Miscellaneous commands, e.g. `DISCARD`, `FETCH`, `CHECKPOINT`, `VACUUM`, `SET`. - **MISC_SET**: Miscellaneous `SET` commands, e.g. `SET ROLE`. - **ALL**: Include all of the above. Multiple classes can be provided using a comma-separated list and classes can be subtracted by prefacing the class with a `-` sign (see [Session Audit Logging](#session-audit-logging)). The default is `none`. ### pgaudit.log_catalog Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog. Disabling this setting will reduce noise in the log from tools like psql and PgAdmin that query the catalog heavily. The default is `on`. ### pgaudit.log_client Specifies whether log messages will be visible to a client process such as psql. This setting should generally be left disabled but may be useful for debugging or other purposes. Note that `pgaudit.log_level` is only enabled when `pgaudit.log_client` is `on`. The default is `off`. ### pgaudit.log_level Specifies the log level that will be used for log entries (see [Message Severity Levels](http://www.postgresql.org/docs/15/runtime-config-logging.html#RUNTIME-CONFIG-SEVERITY-LEVELS) for valid levels) but note that `ERROR`, `FATAL`, and `PANIC` are not allowed). This setting is used for regression testing and may also be useful to end users for testing or other purposes. Note that `pgaudit.log_level` is only enabled when `pgaudit.log_client` is `on`; otherwise the default will be used. The default is `log`. ### pgaudit.log_parameter Specifies that audit logging should include the parameters that were passed with the statement. When parameters are present they will be included in `CSV` format after the statement text. The default is `off`. ### pgaudit.log_relation Specifies whether session audit logging should create a separate log entry for each relation (`TABLE`, `VIEW`, etc.) referenced in a `SELECT` or `DML` statement. This is a useful shortcut for exhaustive logging without using object audit logging. The default is `off`. ### pgaudit.log_rows Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field. The default is `off`. ### pgaudit.log_statement Specifies whether logging will include the statement text and parameters (if enabled). Depending on requirements, an audit log might not require this and it makes the logs less verbose. The default is `on`. ### pgaudit.log_statement_once Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry. Disabling this setting will result in less verbose logging but may make it more difficult to determine the statement that generated a log entry, though the statement/substatement pair along with the process id should suffice to identify the statement text logged with a previous entry. The default is `off`. ### pgaudit.role Specifies the master role to use for object audit logging. Multiple audit roles can be defined by granting them to the master role. This allows multiple groups to be in charge of different aspects of audit logging. There is no default. ## Session Audit Logging Session audit logging provides detailed logs of all statements executed by a user in the backend. ### Configuration Session logging is enabled with the [pgaudit.log](#pgauditlog) setting. Enable session logging for all `DML` and `DDL` and log all relations in `DML` statements: ``` set pgaudit.log = 'write, ddl'; set pgaudit.log_relation = on; ``` Enable session logging for all commands except `MISC` and raise audit log messages as `NOTICE`: ``` set pgaudit.log = 'all, -misc'; set pgaudit.log_level = notice; ``` ### Example In this example session audit logging is used for logging `DDL` and `SELECT` statements. Note that the insert statement is not logged since the `WRITE` class is not enabled _SQL_: ``` set pgaudit.log = 'read, ddl'; create table account ( id int, name text, password text, description text ); insert into account (id, name, password, description) values (1, 'user1', 'HASH1', 'blah, blah'); select * from account; ``` _Log Output_: ``` AUDIT: SESSION,1,1,DDL,CREATE TABLE,TABLE,public.account,create table account ( id int, name text, password text, description text );,<not logged> AUDIT: SESSION,2,1,READ,SELECT,,,select * from account,,<not logged> ``` ## Object Audit Logging Object audit logging logs statements that affect a particular relation. Only `SELECT`, `INSERT`, `UPDATE` and `DELETE` commands are supported. `TRUNCATE` is not included in object audit logging. Object audit logging is intended to be a finer-grained replacement for `pgaudit.log = 'read, write'`. As such, it may not make sense to use them in conjunction but one possible scenario would be to use session logging to capture each statement and then supplement that with object logging to get more detail about specific relations. ### Configuration Object-level audit logging is implemented via the roles system. The [pgaudit.role](#pgauditrole) setting defines the role that will be used for audit logging. A relation (`TABLE`, `VIEW`, etc.) will be audit logged when the audit role has permissions for the command executed or inherits the permissions from another role. This allows you to effectively have multiple audit roles even though there is a single master role in any context. Set [pgaudit.role](#pgauditrole) to `auditor` and grant `SELECT` and `DELETE` privileges on the `account` table. Any `SELECT` or `DELETE` statements on the `account` table will now be logged: ``` set pgaudit.role = 'auditor'; grant select, delete on public.account to auditor; ``` ### Example In this example object audit logging is used to illustrate how a granular approach may be taken towards logging of `SELECT` and `DML` statements. Note that logging on the `account` table is controlled by column-level permissions, while logging on the `account_role_map` table is table-level. _SQL_: ``` set pgaudit.role = 'auditor'; create table account ( id int, name text, password text, description text ); grant select (password) on public.account to auditor; select id, name from account; select password from account; grant update (name, password) on public.account to auditor; update account set description = 'yada, yada'; update account set password = 'HASH2'; create table account_role_map ( account_id int, role_id int ); grant select on public.account_role_map to auditor; select account.password, account_role_map.role_id from account inner join account_role_map on account.id = account_role_map.account_id ``` _Log Output_: ``` AUDIT: OBJECT,1,1,READ,SELECT,TABLE,public.account,select password from account,<not logged> AUDIT: OBJECT,2,1,WRITE,UPDATE,TABLE,public.account,update account set password = 'HASH2',<not logged> AUDIT: OBJECT,3,1,READ,SELECT,TABLE,public.account,select account.password, account_role_map.role_id from account inner join account_role_map on account.id = account_role_map.account_id,<not logged> AUDIT: OBJECT,3,1,READ,SELECT,TABLE,public.account_role_map,select account.password, account_role_map.role_id from account inner join account_role_map on account.id = account_role_map.account_id,<not logged> ``` ## Format Audit entries are written to the standard logging facility and contain the following columns in comma-separated format. Output is compliant CSV format only if the log line prefix portion of each log entry is removed. - **AUDIT_TYPE** - `SESSION` or `OBJECT`. - **STATEMENT_ID** - Unique statement ID for this session. Each statement ID represents a backend call. Statement IDs are sequential even if some statements are not logged. There may be multiple entries for a statement ID when more than one relation is logged. - **SUBSTATEMENT_ID** - Sequential ID for each sub-statement within the main statement. For example, calling a function from a query. Sub-statement IDs are continuous even if some sub-statements are not logged. There may be multiple entries for a sub-statement ID when more than one relation is logged. - **CLASS** - e.g. `READ`, `ROLE` (see [pgaudit.log](#pgauditlog)). - **COMMAND** - e.g. `ALTER TABLE`, `SELECT`. - **OBJECT_TYPE** - `TABLE`, `INDEX`, `VIEW`, etc. Available for `SELECT`, `DML` and most `DDL` statements. - **OBJECT_NAME** - The fully-qualified object name (e.g. public.account). Available for `SELECT`, `DML` and most `DDL` statements. - **STATEMENT** - Statement executed on the backend. - **PARAMETER** - If `pgaudit.log_parameter` is set then this field will contain the statement parameters as quoted CSV or `<none>` if there are no parameters. Otherwise, the field is `<not logged>`. Use [log_line_prefix](http://www.postgresql.org/docs/15/runtime-config-logging.html#GUC-LOG-LINE-PREFIX) to add any other fields that are needed to satisfy your audit log requirements. A typical log line prefix might be `'%m %u %d [%p]: '` which would provide the date/time, user name, database name, and process id for each audit log. ## Caveats Object renames are logged under the name they were renamed to. For example, renaming a table will produce the following result: ``` ALTER TABLE test RENAME TO test2; AUDIT: SESSION,36,1,DDL,ALTER TABLE,TABLE,public.test2,ALTER TABLE test RENAME TO test2,<not logged> ``` It is possible to have a command logged more than once. For example, when a table is created with a primary key specified at creation time the index for the primary key will be logged independently and another audit log will be made for the index under the create entry. The multiple entries will however be contained within one statement ID. Autovacuum and Autoanalyze are not logged. Statements that are executed after a transaction enters an aborted state will not be audit logged. However, the statement that caused the error and any subsequent statements executed in the aborted transaction will be logged as ERRORs by the standard logging facility. It is not possible to reliably audit superusers with pgAudit. One solution is to restrict access to superuser accounts and use the [set_user](https://github.com/pgaudit/set_user) extension to escalate permissions when required. ## Authors The PostgreSQL Audit Extension is based on the [2ndQuadrant](http://www.2ndquadrant.com) [pgaudit project](https://github.com/2ndQuadrant/pgaudit) authored by Simon Riggs, Abhijit Menon-Sen, and Ian Barwick and submitted as an extension to PostgreSQL core. Additional development has been done by David Steele of [Crunchy Data](http://www.crunchydata.com).

An easy-to-use, zero-downtime schema migration tool for Postgres

# Reshape [](https://github.com/fabianlindfors/reshape/actions/workflows/test.yaml) [](https://github.com/fabianlindfors/reshape/releases) Reshape is an easy-to-use, zero-downtime schema migration tool for Postgres. It automatically handles complex migrations that would normally require downtime or manual multi-step changes. During a migration, Reshape ensures both the old and new schema are available at the same time, allowing you to gradually roll out your application. It will also perform all changes without excessive locking, avoiding downtime caused by blocking other queries. For a more thorough introduction to Reshape, check out the [introductory blog post](https://fabianlindfors.se/blog/schema-migrations-in-postgres-using-reshape/). Designed for Postgres 12 and later. *Note: Reshape is **experimental** and should not be used in production. It can (and probably will) break your application.* - [How it works](#how-it-works) - [Getting started](#getting-started) - [Installation](#installation) - [Creating your first migration](#creating-your-first-migration) - [Preparing your application](#preparing-your-application) - [Running your migration](#running-your-migration) - [Using during development](#using-during-development) - [Writing migrations](#writing-migrations) - [Basics](#basics) - [Tables](#tables) - [Create table](#create-table) - [Rename table](#rename-table) - [Remove table](#remove-table) - [Add foreign key](#add-foreign-key) - [Remove foreign key](#remove-foreign-key) - [Columns](#columns) - [Add column](#add-column) - [Alter column](#alter-column) - [Remove column](#remove-column) - [Indices](#indices) - [Add index](#add-index) - [Remove index](#remove-index) - [Enums](#enums) - [Create enum](#create-enum) - [Remove enum](#remove-enum) - [Custom](#custom) - [Commands and options](#commands-and-options) - [`reshape migration start`](#reshape-migration-start) - [`reshape migration complete`](#reshape-migration-complete) - [`reshape migration abort`](#reshape-migration-abort) - [`reshape schema-query`](#reshape-schema-query) - [Connection options](#connection-options) - [License](#license) ## How it works Reshape works by creating views that encapsulate the underlying tables, which your application will interact with. During a migration, Reshape will automatically create a new set of views and set up triggers to translate inserts and updates between the old and new schema. This means that every deployment is a three-phase process: 1. **Start migration** (`reshape migration start`): Sets up views and triggers to ensure both the new and old schema are usable at the same time. 2. **Roll out application**: Your application can be gradually rolled out without downtime. The existing deployment will continue using the old schema whilst the new deployment uses the new schema. 3. **Complete migration** (`reshape migration complete`): Removes the old schema and any intermediate data and triggers. If the application deployment fails, you should run `reshape migration abort` which will roll back any changes made by `reshape migration start` without losing data. ## Getting started ### Installation #### Binaries Binaries are available for macOS and Linux under [Releases](https://github.com/fabianlindfors/reshape/releases). #### Cargo Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/) (requires Rust 1.58 or later): ```shell cargo install reshape ``` #### Docker Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape). ```shell docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migration start ``` ### Creating your first migration Each migration should be stored as a separate file in a `migrations/` directory. The files can be in either JSON or TOML format and the name of the file will become the name of your migration. We recommend prefixing every migration with an incrementing number as migrations are sorted by file name. Let's create a simple migration to set up a new table `users` with two fields, `id` and `name`. We'll create a file called `migrations/1_create_users_table.toml`: ```toml [[actions]] type = "create_table" name = "users" primary_key = ["id"] [[actions.columns]] name = "id" type = "INTEGER" generated = "ALWAYS AS IDENTITY" [[actions.columns]] name = "name" type = "TEXT" ``` This is the equivalent of running `CREATE TABLE users (id INTEGER GENERATED ALWAYS AS IDENTITY, name TEXT)`. ### Preparing your application Reshape relies on your application using a specific schema. When establishing the connection to Postgres in your application, you need to run a query to select the most recent schema. The simplest way to do this is to use one of the helper libraries: - [Rust](https://github.com/fabianlindfors/reshape-helper) - [Ruby (and Rails)](https://github.com/fabianlindfors/reshape-ruby) - [Python (and Django)](https://github.com/fabianlindfors/reshape-python) If your application is not using one of the languages with an available helper library, you can instead generate the query with the command: `reshape schema-query`. To pass it along to your application, you can for example use an environment variable in your run script: `RESHAPE_SCHEMA_QUERY=$(reshape schema-query)`. Then in your application: ```python # Example for Python reshape_schema_query = os.getenv("RESHAPE_SCHEMA_QUERY") db.execute(reshape_schema_query) ``` ### Running your migration To create your new `users` table, run: ```bash reshape migration start --complete ``` We use the `--complete` flag to automatically complete the migration. During a production deployment, you should first run `reshape migration start` followed by `reshape migration complete` once your application has been fully rolled out. If nothing else is specified, Reshape will try to connect to a Postgres database running on `localhost` using `postgres` as both username and password. See [Connection options](#connection-options) for details on how to change the connection settings. ### Using during development When adding new migrations during development, we recommend running `reshape migration start` but skipping `reshape migration complete`. This way, the new migrations can be iterated on by updating the migration file and running `reshape migration abort` followed by `reshape migration start`. ## Writing migrations ### Basics Every migration consists of one or more actions. The actions will be run sequentially. Here's an example of a migration with two actions to create two tables, `customers` and `products`: ```toml [[actions]] type = "create_table" name = "customers" primary_key = ["id"] [[actions.columns]] name = "id" type = "INTEGER" generated = "ALWAYS AS IDENTITY" [[actions]] type = "create_table" name = "products" primary_key = ["sku"] [[actions.columns]] name = "sku" type = "TEXT" ``` Every action has a `type`. The supported types are detailed below. ### Tables #### Create table The `create_table` action will create a new table with the specified columns, indices and constraints. *Example: create a `customers` table with a few columns and a primary key* ```toml [[actions]] type = "create_table" name = "customers" primary_key = ["id"] [[actions.columns]] name = "id" type = "INTEGER" generated = "ALWAYS AS IDENTITY" [[actions.columns]] name = "name" type = "TEXT" # Columns default to nullable nullable = false # default can be any valid SQL value, in this case a string literal default = "'PLACEHOLDER'" ``` *Example: create `users` and `items` tables with a foreign key between them* ```toml [[actions]] type = "create_table" name = "users" primary_key = ["id"] [[actions.columns]] name = "id" type = "INTEGER" generated = "ALWAYS AS IDENTITY" [[actions]] type = "create_table" name = "items" primary_key = ["id"] [[actions.columns]] name = "id" type = "INTEGER" generated = "ALWAYS AS IDENTITY" [[actions.columns]] name = "user_id" type = "INTEGER" [[actions.foreign_keys]] columns = ["user_id"] referenced_table = "users" referenced_columns = ["id"] ``` #### Rename table The `rename_table` action will change the name of an existing table. *Example: change name of `users` table to `customers`* ```toml [[actions]] type = "rename_table" table = "users" new_name = "customers" ``` #### Remove table The `remove_table` action will remove an existing table. *Example: remove `users` table* ```toml [[actions]] type = "remove_table" table = "users" ``` #### Add foreign key The `add_foreign_key` action will add a foreign key between two existing tables. The migration will fail if the existing column values aren't valid references. *Example: create foreign key from `items` to `users` table* ```toml [[actions]] type = "add_foreign_key" table = "items" [actions.foreign_key] columns = ["user_id"] referenced_table = "users" referenced_columns = ["id"] ``` #### Remove foreign key The `remove_foreign_key` action will remove an existing foreign key. The foreign key will only be removed once the migration is completed, which means that your new application must continue to adhere to the foreign key constraint. *Example: remove foreign key `items_user_id_fkey` from `users` table* ```toml [[actions]] type = "remove_foreign_key" table = "items" foreign_key = "items_user_id_fkey" ``` ### Columns #### Add column The `add_column` action will add a new column to an existing table. You can optionally provide an `up` setting. This should be an SQL expression which will be run for all existing rows to backfill the new column. *Example: add a new column `reference` to table `products`* ```toml [[actions]] type = "add_column" table = "products" [actions.column] name = "reference" type = "INTEGER" nullable = false default = "10" ``` *Example: replace an existing `name` column with two new columns, `first_name` and `last_name`* ```toml [[actions]] type = "add_column" table = "users" # Extract the first name from the existing name column up = "(STRING_TO_ARRAY(name, ' '))[1]" [actions.column] name = "first_name" type = "TEXT" [[actions]] type = "add_column" table = "users" # Extract the last name from the existing name column up = "(STRING_TO_ARRAY(name, ' '))[2]" [actions.column] name = "last_name" type = "TEXT" [[actions]] type = "remove_column" table = "users" column = "name" # Reconstruct name column by concatenating first and last name down = "first_name || ' ' || last_name" ``` *Example: extract nested value from unstructured JSON `data` column to new `name` column* ```toml [[actions]] type = "add_column" table = "users" # #>> '{}' converts the JSON string value to TEXT up = "data['path']['to']['value'] #>> '{}'" [actions.column] name = "name" type = "TEXT" ``` #### Alter column The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values. When performing more complex changes than a rename, `up` and `down` should be provided. These should be SQL expressions which determine how to transform between the new and old version of the column. Inside those expressions, you can reference the current column value by the column name. *Example: rename `last_name` column on `users` table to `family_name`* ```toml [[actions]] type = "alter_column" table = "users" column = "last_name" [actions.changes] name = "family_name" ``` *Example: change the type of `reference` column from `INTEGER` to `TEXT`* ```toml [[actions]] type = "alter_column" table = "users" column = "reference" up = "CAST(reference AS TEXT)" # Converts from integer value to text down = "CAST(reference AS INTEGER)" # Converts from text value to integer [actions.changes] type = "TEXT" # Previous type was 'INTEGER' ``` *Example: increment all values of an `index` column by one* ```toml [[actions]] type = "alter_column" table = "users" column = "index" up = "index + 1" # Increment for new schema down = "index - 1" # Decrement to revert for old schema [actions.changes] name = "index" ``` *Example: make `name` column not nullable* ```toml [[actions]] type = "alter_column" table = "users" column = "name" # Use "N/A" for any rows that currently have a NULL name up = "COALESCE(name, 'N/A')" [actions.changes] nullable = false ``` *Example: change default value of `created_at` column to current time* ```toml [[actions]] type = "alter_column" table = "users" column = "created_at" [actions.changes] default = "NOW()" ``` #### Remove column The `remove_column` action will remove an existing column from a table. You can optionally provide a `down` setting. This should be an SQL expression which will be used to determine values for the old schema when inserting or updating rows using the new schema. The `down` setting must be provided when the removed column is `NOT NULL` or doesn't have a default value. Any indices that cover the column will be removed. *Example: remove column `name` from table `users`* ```toml [[actions]] type = "remove_column" table = "users" column = "name" # Use a default value of "N/A" for the old schema when inserting/updating rows down = "'N/A'" ``` ### Indices #### Add index The `add_index` action will add a new index to an existing table. *Example: create a `users` table with a unique index on the `name` column* ```toml [[actions]] type = "create_table" name = "users" primary_key = "id" [[actions.columns]] name = "id" type = "INTEGER" generated = "ALWAYS AS IDENTITY" [[actions.columns]] name = "name" type = "TEXT" [[actions]] type = "add_index" table = "users" [actions.index] name = "name_idx" columns = ["name"] # Defaults to false unique = true ``` *Example: add GIN index to `data` column on `products` table* ```toml [[actions]] type = "add_index" table = "products" [actions.index] name = "data_idx" columns = ["data"] # One of: btree (default), hash, gist, spgist, gin, brin type = "gin" ``` #### Remove index The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed. *Example: remove the `name_idx` index* ```toml [[actions]] type = "remove_index" index = "name_idx" ``` ### Enums #### Create enum The `create_enum` action will create a new [enum type](https://www.postgresql.org/docs/current/datatype-enum.html) with the specified values. *Example: add a new `mood` enum type with three possible values* ```toml [[actions]] type = "create_enum" name = "mood" values = ["happy", "ok", "sad"] ``` #### Remove enum The `remove_enum` action will remove an existing [enum type](https://www.postgresql.org/docs/current/datatype-enum.html). Make sure all usages of the enum has been removed before running the migration. The enum will only be removed once the migration is completed. *Example: remove the `mood` enum type* ```toml [[actions]] type = "remove_enum" enum = "mood" ``` ### Custom The `custom` action lets you create a migration which runs custom SQL. It should be used with great care as it provides no guarantees of zero-downtime and will simply run whatever SQL is provided. Use other actions whenever possible as they are explicitly designed for zero downtime. There are three optional settings available which all accept SQL queries. All queries need to be idempotent, for example by using `IF NOT EXISTS` wherever available. - `start`: run when a migration is started using `reshape migration start` - `complete`: run when a migration is completed using `reshape migration complete` - `abort`: run when a migration is aborted using `reshape migration abort` *Example: enable PostGIS and pg_stat_statements extensions* ```toml [[actions]] type = "custom" start = """ CREATE EXTENSION IF NOT EXISTS postgis; CREATE EXTENSION IF NOT EXISTS pg_stat_statements; """ abort = """ DROP EXTENSION IF EXISTS postgis; DROP EXTENSION IF EXISTS pg_stat_statements; """ ``` ## Commands and options ### `reshape migration start` Starts a new migration, applying all migrations under `migrations/` that haven't yet been applied. After the command has completed, both the old and new schema will be usable at the same time. When you have rolled out the new version of your application which uses the new schema, you should run `reshape migration complete`. #### Options *See also [Connection options](#connection-options)* | Option | Default | Description | | ------ | ------- | ----------- | | `--complete`, `-c` | `false` | Automatically complete migration after applying it. | | `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. | ### `reshape migration complete` Completes migrations previously started with `reshape migration complete`. #### Options See [Connection options](#connection-options) ### `reshape migration abort` Aborts any migrations which haven't yet been completed. #### Options See [Connection options](#connection-options) ### `reshape schema-query` Generates the SQL query you need to run in your application before using the database. This command does not require a database connection. Instead it will generate the query based on the latest migration in the `migrations/` directory (or the directories specified by `--dirs`). If your application is written in Rust, we recommend using the [Rust helper library](https://github.com/fabianlindfors/reshape-helper/) instead. The query should look something like `SET search_path TO migration_1_initial_migration`. #### Options | Option | Default | Description | | ------ | ------- | ----------- | | `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. | ### Connection options The options below can be used with all commands that communicate with Postgres. Use either a [connection URL](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) or specify each connection option individually. All options can also be set using environment variables instead of flags. If a `.env` file exists, then variables will be automatically loaded from there. | Option | Default | Environment variable | Description | | ------ | ------- | -------------------- | ----------- | | `--url` | | `DB_URL` | URL to your Postgres database | | `--host` | `localhost` | `DB_HOST` | Hostname to use when connecting to Postgres | | `--port` | `5432` | `DB_PORT` | Port which Postgres is listening on | | `--database` | `postgres` | `DB_NAME` | Database name | | `--username` | `postgres` | `DB_USERNAME` | Postgres username | | `--password` | `postgres` | `DB_PASSWORD` | Postgres password | ## License Reshape is released under the [MIT license](https://choosealicense.com/licenses/mit/).

Object Relational Mapping

A modular Deno library for PostgreSQL, MySQL, MariaDB and SQLite migrations

<h1 align="center">Nessie</h1> <p align="center"> <a href="https://deno.land/x/nessie"> <img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/halvardssm/deno-nessie?label=Nessie%20stable&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEUAAABLCAYAAAAmh0pZAAAACXBIWXMAAAEjAAABIwFyQXfeAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAABltJREFUeJztnF2MHlUZx3+nXWlBWsJXaAWElI+iIBIhaAPcaDUEUrghApEQEhIMmKA1jTcmGkOUQPhKFC4gEFNpUuQC0l4YlK8CsUBLjBI+2m4pRdsldWuLLN3WbvfnxZk3u7zMO+/M+87szG75Jc3unnPmnOf5z5mZc55zTqFH1MvUP6ib1VF1p/qceot6VK/1TkvUE9WnzGZQvaxuW6cE9cvq1i6CtNivXl23zZWiHq1uyilIi1H1wrptrwz1kYKCtNikHlG3/aWjfkU91KMoqj+u24fSUR/qQxDVYfWLdfuRl1k5yy3rs53jgWv6rGPK6CqKuhA4pYS2Zo4owBkltbVUnVdSXZWSR5Sy3gVzgW+UVFel5BFloMT2Ti6xrsrI+6Iti7lT3F5P5BHl4xLb21RiXZXRjyjrC7a1A9hY8JpayCPKnJS0YeB7wLMF2vp5COFAgfLNRV2aMkJ9Pck7Qn3A7CnAfvX2uv0oFfWGFEdXt5X5mvqoOpTkHzQGn+5Xz6rL9l7J87lNG7xtm/xHCOFN4GYA9QtJ2sG+rauJXkV5r1Ph6SxGi16H+R1FmQnkEWVRStq2lLTDA3WeOt72kh1X0z7TM4ZuPeXrQGhL2z1jxhsd6CbKBSlpQ1UY0iTy9JR2dlZhSJP4vKek0FEUdTbw1ZSsw7qnLAbS1oR3VWRLY8gSJe3RAfhvFYY0iSxR0l6yAJ9UYUiT6KWnjFRhSJPopaeMqHPUu9UP1ffVFcmLeeaiLswIGl2krklJX1m33ZWiXp4hyr0ZedfWbXsZdHp8FndI/zPZ68oPOE1WAbPoJEpauGAtcDXZn+QFwC/6NaqRqGvbHoun1QH1GONmvyzG1Ovr9qF01LcnOfluIsbi5PdnuojS4mH16Lp9KQU1qPsSx0bUs9XT1B1J2uM5RVHdoM6v26eipL1TvgQcmfz+G+B9YE2SDlBkPHIR8NtejWsM6pLkLg8aB2m/bLv7u9SXC/QWnWY7JNN6ynHJz98RZ8kr2vJPJC6UFwlJ/rC4aQ1CvV49oJ6g/rTDnR9T7zL/jsnBuv0qQlpPmQ9sDCEMA1d1uG42cCtwHzCao50FvZlXD2miBGCjGoBvZVw7D/gJ8BjwRpd2uuU3ijRRxonRtRNI34YxmQHgR8R9cQ8CrwCH2soI/Ko/M6eWtLXkg8THo925LM5J/u0B/gS8TvyEnwusDSE836edU0qaKMPAUmAv0cljC9Q3C3gyhLBSPQ14ArhbvQP4ANhOXIfeCgwmP7eGEJoduDLGS3YY5zorC4xFnkmEQF2m7s553bjxUMMqdbl6qU1blnUiwHSrerq6t4tTf1cvT649SX3Mz64/F+UjdbV6nU2ZJhiPvn2kflM9T13XZvRe4xzou+os9UjjXe4mYC+MqPeoJ9UtytOT7tgKda6xF5xv8ogk5c5T7zP/o9IP+xJxKu857TsKWs4uJw7MWowArxFfjAALgSXEz/ZUsxNYHkL4Y1UNdBJlIfBPis2Ip5r1wJ0hhLVlV5wajgwhDAF/KbuxklkCrFFfNM7XSjtkldpTANRLgZeyyjSMA8AG4q7u94g9fQTYT775WYvtmQ6rTwDf79HI6cpQN1FOBf5GPO52uPBot007u4F/ECd1M5lPgHXEYNgtWe+UZcD9lHdcrimMA+8QJ62vEocab4UQxloFPiOKuhT4NXDxFBlZNbuIzrdE2BBCyNxjEyCexiCu/q1geotxCHgL+CtxHLM+hLClaCVBvRG4k4kljOnGGLAaeAp4IYSwp98KB4hR++m8KL6NibhM34IAoP7M3qb6Q8bj/v/qc6JXJuvU88sS5hL1SfXjHA1vNy6QzU+unaPeZFwibQKjaqdViFx86uujDhD3ui0GzmRi+XQfMZS4IYTwdoa45xD3sJzaj1Ft/IeJBbq8jAIXhBA2l2hH7xhjLHl6nMZe96DpYc8x9TtJnat66DGr6tbiU6hXJE51YzgpP0f9ICX/riR/vsUfz+F6VUhB/YH6vxzGn5KUP9sY3x2elPf7SfUdp75SQJQPa3M+C2OP2dPF+LParhlQv238747uaMubbQyPDuYQpbkLcOoi9dUM49P217WuzTpQsUi9MhHpcXXLpDr/bVNWATphjPjfZtzbMplD6jEltrPAeI76hrLqrBz1qEScl4xfqEZuSP4/aLLwWOQC9ScAAAAASUVORK5CYII=" /> </a> <a href="https://deno.land/x/nessie"> <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/halvardssm/deno-nessie?include_prereleases&label=Nessie%20Next&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEUAAABLCAYAAAAmh0pZAAAACXBIWXMAAAEjAAABIwFyQXfeAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAABltJREFUeJztnF2MHlUZx3+nXWlBWsJXaAWElI+iIBIhaAPcaDUEUrghApEQEhIMmKA1jTcmGkOUQPhKFC4gEFNpUuQC0l4YlK8CsUBLjBI+2m4pRdsldWuLLN3WbvfnxZk3u7zMO+/M+87szG75Jc3unnPmnOf5z5mZc55zTqFH1MvUP6ib1VF1p/qceot6VK/1TkvUE9WnzGZQvaxuW6cE9cvq1i6CtNivXl23zZWiHq1uyilIi1H1wrptrwz1kYKCtNikHlG3/aWjfkU91KMoqj+u24fSUR/qQxDVYfWLdfuRl1k5yy3rs53jgWv6rGPK6CqKuhA4pYS2Zo4owBkltbVUnVdSXZWSR5Sy3gVzgW+UVFel5BFloMT2Ti6xrsrI+6Iti7lT3F5P5BHl4xLb21RiXZXRjyjrC7a1A9hY8JpayCPKnJS0YeB7wLMF2vp5COFAgfLNRV2aMkJ9Pck7Qn3A7CnAfvX2uv0oFfWGFEdXt5X5mvqoOpTkHzQGn+5Xz6rL9l7J87lNG7xtm/xHCOFN4GYA9QtJ2sG+rauJXkV5r1Ph6SxGi16H+R1FmQnkEWVRStq2lLTDA3WeOt72kh1X0z7TM4ZuPeXrQGhL2z1jxhsd6CbKBSlpQ1UY0iTy9JR2dlZhSJP4vKek0FEUdTbw1ZSsw7qnLAbS1oR3VWRLY8gSJe3RAfhvFYY0iSxR0l6yAJ9UYUiT6KWnjFRhSJPopaeMqHPUu9UP1ffVFcmLeeaiLswIGl2krklJX1m33ZWiXp4hyr0ZedfWbXsZdHp8FndI/zPZ68oPOE1WAbPoJEpauGAtcDXZn+QFwC/6NaqRqGvbHoun1QH1GONmvyzG1Ovr9qF01LcnOfluIsbi5PdnuojS4mH16Lp9KQU1qPsSx0bUs9XT1B1J2uM5RVHdoM6v26eipL1TvgQcmfz+G+B9YE2SDlBkPHIR8NtejWsM6pLkLg8aB2m/bLv7u9SXC/QWnWY7JNN6ynHJz98RZ8kr2vJPJC6UFwlJ/rC4aQ1CvV49oJ6g/rTDnR9T7zL/jsnBuv0qQlpPmQ9sDCEMA1d1uG42cCtwHzCao50FvZlXD2miBGCjGoBvZVw7D/gJ8BjwRpd2uuU3ijRRxonRtRNI34YxmQHgR8R9cQ8CrwCH2soI/Ko/M6eWtLXkg8THo925LM5J/u0B/gS8TvyEnwusDSE836edU0qaKMPAUmAv0cljC9Q3C3gyhLBSPQ14ArhbvQP4ANhOXIfeCgwmP7eGEJoduDLGS3YY5zorC4xFnkmEQF2m7s553bjxUMMqdbl6qU1blnUiwHSrerq6t4tTf1cvT649SX3Mz64/F+UjdbV6nU2ZJhiPvn2kflM9T13XZvRe4xzou+os9UjjXe4mYC+MqPeoJ9UtytOT7tgKda6xF5xv8ogk5c5T7zP/o9IP+xJxKu857TsKWs4uJw7MWowArxFfjAALgSXEz/ZUsxNYHkL4Y1UNdBJlIfBPis2Ip5r1wJ0hhLVlV5wajgwhDAF/KbuxklkCrFFfNM7XSjtkldpTANRLgZeyyjSMA8AG4q7u94g9fQTYT775WYvtmQ6rTwDf79HI6cpQN1FOBf5GPO52uPBot007u4F/ECd1M5lPgHXEYNgtWe+UZcD9lHdcrimMA+8QJ62vEocab4UQxloFPiOKuhT4NXDxFBlZNbuIzrdE2BBCyNxjEyCexiCu/q1geotxCHgL+CtxHLM+hLClaCVBvRG4k4kljOnGGLAaeAp4IYSwp98KB4hR++m8KL6NibhM34IAoP7M3qb6Q8bj/v/qc6JXJuvU88sS5hL1SfXjHA1vNy6QzU+unaPeZFwibQKjaqdViFx86uujDhD3ui0GzmRi+XQfMZS4IYTwdoa45xD3sJzaj1Ft/IeJBbq8jAIXhBA2l2hH7xhjLHl6nMZe96DpYc8x9TtJnat66DGr6tbiU6hXJE51YzgpP0f9ICX/riR/vsUfz+F6VUhB/YH6vxzGn5KUP9sY3x2elPf7SfUdp75SQJQPa3M+C2OP2dPF+LParhlQv238747uaMubbQyPDuYQpbkLcOoi9dUM49P217WuzTpQsUi9MhHpcXXLpDr/bVNWATphjPjfZtzbMplD6jEltrPAeI76hrLqrBz1qEScl4xfqEZuSP4/aLLwWOQC9ScAAAAASUVORK5CYII=" /> </a> <a href="https://doc.deno.land/https/deno.land/x/nessie/mod.ts"> <img alt="Docs" src="https://img.shields.io/badge/Nessie-doc-informational.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEUAAABLCAYAAAAmh0pZAAAACXBIWXMAAAEjAAABIwFyQXfeAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAABltJREFUeJztnF2MHlUZx3+nXWlBWsJXaAWElI+iIBIhaAPcaDUEUrghApEQEhIMmKA1jTcmGkOUQPhKFC4gEFNpUuQC0l4YlK8CsUBLjBI+2m4pRdsldWuLLN3WbvfnxZk3u7zMO+/M+87szG75Jc3unnPmnOf5z5mZc55zTqFH1MvUP6ib1VF1p/qceot6VK/1TkvUE9WnzGZQvaxuW6cE9cvq1i6CtNivXl23zZWiHq1uyilIi1H1wrptrwz1kYKCtNikHlG3/aWjfkU91KMoqj+u24fSUR/qQxDVYfWLdfuRl1k5yy3rs53jgWv6rGPK6CqKuhA4pYS2Zo4owBkltbVUnVdSXZWSR5Sy3gVzgW+UVFel5BFloMT2Ti6xrsrI+6Iti7lT3F5P5BHl4xLb21RiXZXRjyjrC7a1A9hY8JpayCPKnJS0YeB7wLMF2vp5COFAgfLNRV2aMkJ9Pck7Qn3A7CnAfvX2uv0oFfWGFEdXt5X5mvqoOpTkHzQGn+5Xz6rL9l7J87lNG7xtm/xHCOFN4GYA9QtJ2sG+rauJXkV5r1Ph6SxGi16H+R1FmQnkEWVRStq2lLTDA3WeOt72kh1X0z7TM4ZuPeXrQGhL2z1jxhsd6CbKBSlpQ1UY0iTy9JR2dlZhSJP4vKek0FEUdTbw1ZSsw7qnLAbS1oR3VWRLY8gSJe3RAfhvFYY0iSxR0l6yAJ9UYUiT6KWnjFRhSJPopaeMqHPUu9UP1ffVFcmLeeaiLswIGl2krklJX1m33ZWiXp4hyr0ZedfWbXsZdHp8FndI/zPZ68oPOE1WAbPoJEpauGAtcDXZn+QFwC/6NaqRqGvbHoun1QH1GONmvyzG1Ovr9qF01LcnOfluIsbi5PdnuojS4mH16Lp9KQU1qPsSx0bUs9XT1B1J2uM5RVHdoM6v26eipL1TvgQcmfz+G+B9YE2SDlBkPHIR8NtejWsM6pLkLg8aB2m/bLv7u9SXC/QWnWY7JNN6ynHJz98RZ8kr2vJPJC6UFwlJ/rC4aQ1CvV49oJ6g/rTDnR9T7zL/jsnBuv0qQlpPmQ9sDCEMA1d1uG42cCtwHzCao50FvZlXD2miBGCjGoBvZVw7D/gJ8BjwRpd2uuU3ijRRxonRtRNI34YxmQHgR8R9cQ8CrwCH2soI/Ko/M6eWtLXkg8THo925LM5J/u0B/gS8TvyEnwusDSE836edU0qaKMPAUmAv0cljC9Q3C3gyhLBSPQ14ArhbvQP4ANhOXIfeCgwmP7eGEJoduDLGS3YY5zorC4xFnkmEQF2m7s553bjxUMMqdbl6qU1blnUiwHSrerq6t4tTf1cvT649SX3Mz64/F+UjdbV6nU2ZJhiPvn2kflM9T13XZvRe4xzou+os9UjjXe4mYC+MqPeoJ9UtytOT7tgKda6xF5xv8ogk5c5T7zP/o9IP+xJxKu857TsKWs4uJw7MWowArxFfjAALgSXEz/ZUsxNYHkL4Y1UNdBJlIfBPis2Ip5r1wJ0hhLVlV5wajgwhDAF/KbuxklkCrFFfNM7XSjtkldpTANRLgZeyyjSMA8AG4q7u94g9fQTYT775WYvtmQ6rTwDf79HI6cpQN1FOBf5GPO52uPBot007u4F/ECd1M5lPgHXEYNgtWe+UZcD9lHdcrimMA+8QJ62vEocab4UQxloFPiOKuhT4NXDxFBlZNbuIzrdE2BBCyNxjEyCexiCu/q1geotxCHgL+CtxHLM+hLClaCVBvRG4k4kljOnGGLAaeAp4IYSwp98KB4hR++m8KL6NibhM34IAoP7M3qb6Q8bj/v/qc6JXJuvU88sS5hL1SfXjHA1vNy6QzU+unaPeZFwibQKjaqdViFx86uujDhD3ui0GzmRi+XQfMZS4IYTwdoa45xD3sJzaj1Ft/IeJBbq8jAIXhBA2l2hH7xhjLHl6nMZe96DpYc8x9TtJnat66DGr6tbiU6hXJE51YzgpP0f9ICX/riR/vsUfz+F6VUhB/YH6vxzGn5KUP9sY3x2elPf7SfUdp75SQJQPa3M+C2OP2dPF+LParhlQv238747uaMubbQyPDuYQpbkLcOoi9dUM49P217WuzTpQsUi9MhHpcXXLpDr/bVNWATphjPjfZtzbMplD6jEltrPAeI76hrLqrBz1qEScl4xfqEZuSP4/aLLwWOQC9ScAAAAASUVORK5CYII=" /> </a> <a href="https://deno.land"> <img alt="Deno Version" src="https://img.shields.io/badge/deno-v1.27.0-green.svg?style=for-the-badge&logo=deno"/> </a> <a href="https://github.com/halvardssm/deno-nessie/actions?query=branch%3Amain+workflow%3ACI"> <img alt="GitHub Workflow Status (branch)" src="https://img.shields.io/github/workflow/status/halvardssm/deno-nessie/CI/main?style=for-the-badge&logo=github"> </a> <a href="https://app.codecov.io/gh/halvardssm/deno-nessie"> <img alt="Codecov" src="https://img.shields.io/codecov/c/gh/halvardssm/deno-nessie?logo=codecov&style=for-the-badge&token=O59WOJ5W00" /> </a> <a href="./LICENSE"> <img alt="License" src="https://img.shields.io/github/license/c4spar/deno-cliffy?logo=github&style=for-the-badge" /> </a> <a href="https://discord.gg/8WXfG2tvfr"> <img alt="Discord" src="https://img.shields.io/badge/chat-on%20discord-green.svg?style=for-the-badge&logo=discord" /> </a> <a href="https://hub.docker.com/repository/docker/halvardm/nessie"> <img alt="Docker Image Size (tag)" src="https://img.shields.io/docker/image-size/halvardm/nessie/latest?logo=docker&style=for-the-badge" /> </a> <br> <a href="https://deno.land/x/nessie"> <img alt="deno.land" src="https://img.shields.io/badge/Published%20on-deno.land-blue?logo=deno&labelColor=272727&color=272727&style=for-the-badge" /> </a> <a href="https://nest.land/package/Nessie"> <img alt="nest.land" src="https://nest.land/badge-large.svg"> </a> </p> <p align="center"> <b>A modular database migration tool for <a href="https://deno.land">Deno</a> inspired by <a href="https://github.com/laravel/laravel">Laravel</a> and <a href="https://github.com/cakephp/phinx">Phinx</a>.</b></br> _{Supports PostgreSQL, MySQL, MariaDB and SQLite.} </p> <p align="center"><img src="./.github/logo.png" alt="Nessie logo" width="200" height="200"></p> **Call for donations**: If you are using Nessie commercially, please consider supporting the future development. See [this issue](https://github.com/halvardssm/deno-nessie/issues/130) for more information. 🎉 **Version 2 is released**: To migrate from version 1 follow the steps in the [migration section](#migrate-from-version-1) bellow. > See documentation for the > [clients](https://doc.deno.land/https/deno.land/x/nessie/mod.ts). > Even though all examples in this readme applies unversioned usage, you should > always use a version when using Nessie. --- ## Contents - [Contents](#contents) - [Available Via](#available-via) - [CLI Usage](#cli-usage) - [Flags](#flags) - [Deno flags and Permissions](#deno-flags-and-permissions) - [Config file](#config-file) - [Remote Migration or Seed files](#remote-migration-or-seed-files) - [Custom Migration or Seed templates](#custom-migration-or-seed-templates) - [Docker usage](#docker-usage) - [Uses](#uses) - [Examples](#examples) - [Clients](#clients) - [How to make a client](#how-to-make-a-client) - [Migrate from version 1](#migrate-from-version-1) - [Contributing](#contributing) ## Available Via - https://deno.land/x/nessie - https://raw.githubusercontent.com/halvardssm/deno-nessie - https://nest.land/package/Nessie - https://hub.docker.com/repository/docker/halvardm/nessie ## CLI Usage > It is suggested you restrict the permissions Nessie has as much as possible, > to only the permissions its needs. An example of this is: > > ```shell > deno install --unstable --allow-net=<db hostname/ip>:<db port> --allow-read=. --allow-write=nessie.config.ts,db -f https://deno.land/x/nessie/cli.ts > ``` - `init`: Generates a `nessie.config.ts` file and also the `db` folder where migration and seed files will be placed. Two options are available: `--mode` and `--dialect`. - `--mode` can be one of `config` or `folders`. If mode is not set, it will create a `nessie.config.ts` file and the `db` folder structure, otherwise it will create the selected one. - `--dialect` is used for the config file and can be one of `pg`, `mysql` or `sqlite`. If not set, it will create a general config file including all three dialects, otherwise it will include only the selected one. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts init deno run -A --unstable https://deno.land/x/nessie/cli.ts init --mode folders deno run -A --unstable https://deno.land/x/nessie/cli.ts init --mode config --dialect pg deno run -A --unstable https://deno.land/x/nessie/cli.ts init --mode config --dialect sqlite deno run -A --unstable https://deno.land/x/nessie/cli.ts init --mode config --dialect mysql ``` - `make:migration [name]` & `make [name]`: Create migration, `name` has to be snake- and lowercase, it can also include numbers. You can also provide the flag `--migrationTemplate <template path or url>` or use the `migrationTemplate` property in the config file to tell Nessie which template to use when generating a new migration. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts make:migration create_users deno run -A --unstable https://deno.land/x/nessie/cli.ts make create_users deno run -A --unstable https://deno.land/x/nessie/cli.ts make --migrationTemplate some_custom_template create_users ``` - `make:seed [name]`: Create seed, `name` has to be snake- and lowercase, it can also include numbers. You can also provide the flag `--seedTemplate <template path or url>` or use the `seedTemplate` property in the config file to tell Nessie which template to use when generating a new migration. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts make:seed add_users deno run -A --unstable https://deno.land/x/nessie/cli.ts make:seed --seedTemplate some_custom_template add_users ``` - `migrate [amount?]`: Run migration - will migrate your migrations in your migration folder (sorted by timestamp) newer than the latest migration in your db. Amount defines how many migrations, defaults to all available if not set. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts migrate deno run -A --unstable https://deno.land/x/nessie/cli.ts migrate 1 deno run -A --unstable https://deno.land/x/nessie/cli.ts migrate -c ./nessie.config.ts ``` - `rollback [amount?]`: Rollback - will rollback your migrations. Amount defines how many migrations, defaults to 1 if not set. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts rollback deno run -A --unstable https://deno.land/x/nessie/cli.ts rollback 2 deno run -A --unstable https://deno.land/x/nessie/cli.ts rollback all ``` - `seed [matcher?]`: Seed - will seed your database. Optional matcher will match all files in your seed folder by string literal or RegExp. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts seed deno run -A --unstable https://deno.land/x/nessie/cli.ts seed seed_file.js deno run -A --unstable https://deno.land/x/nessie/cli.ts seed ".+.ts" ``` - `status`: Outputs the status of Nessie. Will output detailed information about current state of the migrations. Includes two flags: `--output` and `--file-names`. `--output` sets the output format and can be one of `log` or `json`. If not set, `log` is chosen by default. If result is used programatically, chose `json` as the format of `log` can change with every patch version, while the format of `json` will be considered more stable. `--file-names` adds the file names to each of the outputs. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts status totalAvailableMigrationFiles: 1 completedMigrations: 0 newAvailableMigrations: 1 deno run -A --unstable https://deno.land/x/nessie/cli.ts status --output json {"totalAvailableMigrationFiles":1,"completedMigrations":0,"newAvailableMigrations":1} deno run -A --unstable https://deno.land/x/nessie/cli.ts status --file-names totalAvailableMigrationFiles: 1 20210508115213_test1.ts completedMigrations: 0 newAvailableMigrations: 1 20210508115213_test1.ts deno run -A --unstable https://deno.land/x/nessie/cli.ts status --file-names --output json {"totalAvailableMigrationFiles":1,"completedMigrations":0,"newAvailableMigrations":1,"totalAvailableMigrationFileNames":["20210508115213_test1.ts"],"completedMigrationNames":[],"newAvailableMigrationNames":["20210508115213_test1.ts"]} ``` - `update_timestamps`: Update timestamps - will update timestamps to the new format. Will only update timestamps where the value is less than 1672531200000 (2023-01-01) so that the timestamps won't be updated multiple times. ```shell deno run -A --unstable https://deno.land/x/nessie/cli.ts update_timestamps ``` ### Flags - `-c, --config`: Path to config file, will default to `./nessie.config.ts` - `-d, --debug`: Enables verbose output. - `--migrationTemplate`: Path or URL to a custom migration template. Only used together with the `make` commands. - `--seedTemplate`: Path or URL to a custom seed template. Only used together with the `make` commands. ### Deno flags and Permissions While the examples simply show `-A` as the permission flag, you can also limit the permissions according to your needs. Bellow you will see what Nessie actually needs. - `--unstable`: Needed by [std/fs/copy](https://deno.land/[email protected]/fs/copy.ts) as it uses `Deno.utimeSync` and `Deno.utime` which are still unstable. - `--allow-read`: Nessie needs read access to be able to read the migration and seed folders, it also checks for the presence of the config file. - `--allow-write`: When initiating Nessie or creating a new migration or seed file, write access is required. - `--allow-net`: This is needed to import the nessie code in your config file. It is also needed if you use a remote config or migration files, this flag is needed to get access. ### Config file The config interface is exported from `mod.ts` as `NessieConfig`. ```ts export interface NessieConfig { /** Can be any class which extends `AbstractClient`. */ client: AbstractClient<any>; /** * The folders where migration files are located. * Can be a relative path or an absolute path. * Defaults to ['./db/migrations/'] if additionalMigrationFiles is not populated */ migrationFolders?: string[]; /** * The folders where seed files are located. * Can be a relative path or an absolute path. * Defaults to ['./db/seeds/'] if additionalSeedFiles is not populated */ seedFolders?: string[]; /** * Additional migration files which will be added to the * list to parse when running the migrate or rollback command. * Can be any format supported by `import()` e.g. url or path */ additionalMigrationFiles?: string[]; /** * Additional seed files which will be added to the list to * match against when running the seed command. * Can be any format supported by `import()` e.g. remote url or path */ additionalSeedFiles?: string[]; /** Custom migration template, can be path or url. When also using the CLI flag `--migrationTemplate`, it will have precidence. */ migrationTemplate?: string; /** Custom seed template, can be path or url. When also using the CLI flag `--seedTemplate`, it will have precidence. */ seedTemplate?: string; /** Enables verbose output for debugging */ debug?: boolean; } ``` ### Remote Migration or Seed files With the introduction of `additionalMigrationFiles` and `additionalSeedFiles`, you can now include remote migration and seed files which you can fetch for example via ftp or using api's like gihub or gitlab. Any input which can be given to the dynamic `import()` can be provided. ```ts // nessie.config.ts ... additionalMigrationFiles: ['https://example.com/some_migration_file.ts'], additionalSeedFiles: ['https://example.com/some_seed_file.ts'], ... ``` See the [example folder](./examples) for more examples. ### Custom Migration or Seed templates As your project grows, or you are starting to have multiple project but want the same logic across the migrations, you might find it tedious to change the seed and migration files after creating them. To get around this, you can provide the options `migrationTemplate` and `seedTemplate` in the config file, or use the corresponding flags from the command line. There are no restrictions to what the file has to contain, so you can even provide an empty file if that is your preferred starting point. A general usecase for providing custom templates is in the case that you use a custom `AbstractMigration` or `AbstractSeed` class, and want to use this for all your future migrations and seeds. See the [example folder](./examples) for more examples. ## Docker usage See the specific [Nessie image docs](./image/README.md) for using Nessie with a docker image. ## Uses - [Cliffy](https://deno.land/x/cliffy/) - [Deno Postgres](https://deno.land/x/postgres/) - [Deno MySQL](https://deno.land/x/mysql/) - [Deno SQLite](https://deno.land/x/sqlite/) ## Examples See [example repo](https://github.com/halvardssm/deno-rest-api) for a REST API which uses Oak and Nessie. See the [example folder](./examples) for more examples. Nessie uses the `AbstractMigration` class which you can extend to access the client and its properties. This enables better flexibility in migrations and seeds and allows a more complex workflow. `nessie.config.ts` with all default values ```ts import { ClientPostgreSQL, NessieConfig, } from "https://deno.land/x/nessie/mod.ts"; const clientPg = new ClientPostgreSQL({ database: "nessie", hostname: "localhost", port: 5432, user: "root", password: "pwd", }); const config: NessieConfig = { client: clientPg, migrationFolders: ["./db/migrations"], seedFolders: ["./db/seeds"], additionalMigrationFiles: [], additionalSeedFiles: [], migrationTemplate: undefined, seedTemplate: undefined, debug: false, }; export default config; ``` Minimal example of a migration file ```ts import { AbstractMigration, ClientPostgreSQL, Info, } from "https://deno.land/x/nessie/mod.ts"; export default class extends AbstractMigration<ClientPostgreSQL> { async up({ dialect }: Info): Promise<void> { await this.client.queryArray("CREATE TABLE table1 (id int)"); } async down({ dialect }: Info): Promise<void> { await this.client.queryArray("DROP TABLE table1"); } } ``` Seed file ```ts import { AbstractSeed, ClientPostgreSQL, Info, } from "https://deno.land/x/nessie/mod.ts"; export default class extends AbstractSeed<ClientPostgreSQL> { async run({ dialect }: Info): Promise<void> { await this.client.queryArray("INSERT INTO table1 VALUES (1234)"); } } ``` See the [example folder](./examples) for more ## Clients Provided clients are - [PostgreSQL](./clients/ClientPostgreSQL.ts) (also works for CockroachDB) - [MySQL](./clients/ClientMySQL.ts) & [MySQL 5.5](./clients/ClientMySQL55.ts) - Currently it works with password for 5.*, but for >=8 you have to send a blank password, see [issue 37](https://github.com/manyuanrong/deno_mysql/issues/37) - [SQLite](./clients/ClientSQLite.ts) > If you would like to see your DB flavor supported, take a look at how to make > a client plugin with examples in the [clients folder](./clients) or in the > next section . ### How to make a client A client needs to extend [AbstractClient](./clients/AbstractClient.ts). `query`: Takes a query string or array of query strings and sends them of to the database for execution. Should return whatever the database responds. `prepare`: Will be run when the migration or rollback commands are executed. This should create the connection, set up the `nessie_migrations` table and prepare the database for incoming migrations. `migrate`: Takes a number as an optional input, will default to all files if not set. Will run `Math.min(amount, numberOfFiles)` migration files. Only handles the `up` method. `rollback`: Takes a number as an optional input, will default to 1 if not set. Will run `Math.min(amount, numberOfFiles)` migration files. Only handles the `down` method. `seed`: Takes an optional matcher as input. Matcher can be regex or string. Will seed the database. Handles the `run` method in seed files. `close`: Will be the last method run before the program is finished. This should close the database connection. See the existing examples in the [clients](./clients) folder for reference. ## Migrate from version 1 If you are migrating from version 1, and starting from scratch is not an option, there are a couple of steps to perform. If you have any questions regarding the steps, please open a new discussion (not an issue). > ⚠️ The contributors of Nessie takes no responsibility for any dataloss which > might occur, so make sure to back up all existing data in your databases > before migrating and test it locally before executing any changes to your > production environment. 1. Back up existing data 2. Update the `nessie.config.ts` file to the new syntax (see the [examples](./examples) folder) 3. (Skip this step if you already updated the timestamps) Run the `update_timestamps` command from the CLI to update the migration file names and database entries (only the `nessie_migrations` table). Use the latest version of Nessie e.g. ```shell deno run -A --unstable https://deno.land/x/[email protected]/cli.ts update_timestamps ``` 4. Update all imports of Nessie to the latest version in your migration and seed files 5. Update the migration and seed files to use the new format (class based migration files) If you come across any issues, you can open a new discussion on GitHub. ## Contributing All contributions are welcome, make sure to read the [contribution guideline](./.github/CONTRIBUTING.md).

Docker 基本教學 - 從無到有 Docker-Beginners-Guide 教你用 Docker 建立 Django + PostgreSQL 📝

# docker-tutorial Docker 基本教學 - 從無到有 Docker-Beginners-Guide 教你用 [Docker](https://www.docker.com/) 建立 [Django](https://github.com/django/django) + [PostgreSQL](https://www.postgresql.org/) 📝 * [Youtube Tutorial PART 1 - Docker 基本教學 - 從無到有 Docker-Beginners-Guide](https://youtu.be/Wg5m0-Jyox8) * [目錄](https://github.com/twtrubiks/docker-tutorial#%E7%94%A8-docker-%E5%AF%A6%E6%88%B0-django-%E4%BB%A5%E5%8F%8A-postgre) - [Youtube Tutorial PART 2 - 用 Docker 實戰 Django 以及 Postgre](https://youtu.be/aZ6woJ7qekE) * [目錄](https://github.com/twtrubiks/docker-tutorial#%E5%85%B6%E4%BB%96%E7%AE%A1%E7%90%86-docker-gui-%E7%9A%84%E5%B7%A5%E5%85%B7) - [Youtube Tutorial PART 3 - Docker 基本教學 - 透過 portainer 管理 Docker](https://youtu.be/VZjHmBcEcew) * [目錄](https://github.com/twtrubiks/docker-tutorial#docker-registry) - [Youtube Tutorial PART 4 - Docker push image to Docker Hub 教學](https://youtu.be/dVBKwmqO5e4) 其他說明 * [Youtube Tutorial-Ubuntu(Linux) 如何安裝 docker](https://youtu.be/eS_HMBC_RaA) * [目錄](https://github.com/twtrubiks/docker-tutorial#docker-compose-networks) - [Youtube Tutorial-docker-compose networks 說明](https://youtu.be/wmV9WfkpyGk) * [目錄](https://github.com/twtrubiks/docker-tutorial#docker-container-%E5%85%A7%E5%A6%82%E4%BD%95%E9%80%A3%E6%8E%A5%E5%88%B0%E6%9C%AC%E6%A9%9F-localhost-%E6%9C%8D%E5%8B%99) - Docker container 內如何連接到本機 localhost 服務 * [目錄](https://github.com/twtrubiks/docker-tutorial#docker-compose-updown-%E5%92%8C-restart-%E7%9A%84%E5%B7%AE%E7%95%B0) - [Youtube Tutorial-docker-compose up/down 和 restart 的差異](https://youtu.be/nX-sbLPz-MU) * [目錄](https://github.com/twtrubiks/docker-tutorial/tree/master/docker-auto-run-linux) - [Youtube Tutorial-Linux 教學-開機自動啟動 docker / compose](https://youtu.be/c4YIQHCDLnQ) * [目錄](https://github.com/twtrubiks/docker-tutorial/tree/master/docker-env-tutorial) - [Youtube Tutorial - Docker 基本教學 - 在 docker compose 中善用 Environment variables](https://youtu.be/JwbI1aNKbtY) * [目錄](https://github.com/twtrubiks/docker-tutorial#%E5%A6%82%E4%BD%95%E6%B8%85%E9%99%A4-docker-container-log) - [Youtube Tutorial - 如何清除 Docker container log](https://youtu.be/SiG0tmwhqqg) * [目錄](https://github.com/twtrubiks/docker-tutorial#json-file-logging-driver) - [Youtube Tutorial - Docker 中的 JSON File logging driver(container log)](https://youtu.be/wb9bONgnFn4) ## 簡介 [Docker](https://www.docker.com/)  ***Containers as a Service ( CaaS ) - 容器如同服務*** 算是近幾年才開始紅的技術，蠻多公司都有使用 Docker，而且真的很方便，值得大家去了解一下 :smile: 如果你有環境上不統一的問題？ 請用 Docker :smile: 如果你有每次建立環境都快抓狂的問題？ 請用 Docker :blush: 如果你想要高效率、輕量、秒開的環境，請用 Docker :blush: 如果你不想搞死自己，請用 Docker :smile: 如果你想潮到出水，請一定要用 Docker :laughing: ### 什麼是 Docker [Docker](https://www.docker.com/) 是一個開源專案，出現於 2013 年初，最初是 Dotcloud 公司內部的 Side-Project。 它基於 Google 公司推出的 Go 語言實作。（ Dotcloud 公司後來改名為 Docker ） 技術原理我們這邊就不提了，簡單提一下他的好處。 我們先來看看官網的說明 Comparing Containers and Virtual Machines ( 傳統的虛擬化 )  從這張圖可以看出 Containers 並沒有 OS ，容量自然就小，而且啟動速度神快 詳細可參考 [https://www.docker.com/what-container](https://www.docker.com/what-container) Virtual Machines 是什麼？ 類似 [https://www.virtualbox.org/](https://www.virtualbox.org/)，我們可能用它裝裝看其他作業系統，例如說 我是 MAC，但我想玩 Windows，我就會在 MAC 中裝 VM 並且灌 Windows 系統。 一個表格了解 Docker 有多棒 :+1: Feauture  | Containers | Virtual Machines ( 傳統的虛擬化 ) -- | ---------- | ---------- 啟動   | 秒開 | 最快也要分鐘 容量 | MB | GB 效能 | 快 | 慢 支援數量 | 非常多 Containers | 10多個就很了不起了 複製相同環境 | 快 | 超慢 不理解:question::question::question: 我們來看一張圖，包準你懂  圖的來源 [https://blog.jayway.com/2015/03/21/a-not-very-short-introduction-to-docker/](https://blog.jayway.com/2015/03/21/a-not-very-short-introduction-to-docker/) ### 為什麼要使用 Docker 潮～ 不解釋 :satisfied: #### 更有效率的利用資源 比起像是 [https://www.virtualbox.org/](https://www.virtualbox.org/)，Docker 的利用率更高，我們可以設定更多 的 Containers ，而且啟動速度飛快！！:flushed: #### 統一環境 相信大家都有每次搞電腦的環境都搞的很煩的經驗 :angry: 假設今天公司來了個新同事，就又要幫他建立一次環境 :expressionless: 不然就是，我的電腦 run 起來正常阿～ 你的怎麼不行，是不是 xxx 版本的關係阿 :joy: 相信大家多多少少都遇過上面這些事情，我們可以透過 Docker 來解決這些問題， 保持大家環境一致，而且要建立的時候也很快 :smile: #### 對於 DevOps 的好處 對於 [DevOps](https://zh.wikipedia.org/wiki/DevOps) 來說，最希望的就是可以設定一次，將來在其他地方都可以快速建立環境且正常執行。 ### Docker 概念 建議大家先了解一下 Docker 中的幾個名詞，分別為 ***Image*** 映像檔，可以把它想成是以前我們在玩 VM 的 Guest OS（ 安裝在虛擬機上的作業系統 ）。 Image 是唯讀（ R\O ） ***Container*** 容器，利用映像檔（ Image ）所創造出來的，一個 Image 可以創造出多個不同的 Container， Container 也可以被啟動、開始、停止、刪除，並且互相分離。 Container 在啟動的時候會建立一層在最外（上）層並且是讀寫模式（ R\W ）。 這張圖解釋了 Image 是唯讀（ R\O ）以及 Container 是讀寫模式（ R\W ） 的關係  更多關係可參考 [https://docs.docker.com/engine/userguide/storagedriver/imagesandcontainers/#images-and-layers](https://docs.docker.com/engine/userguide/storagedriver/imagesandcontainers/#images-and-layers) ***Registry*** 可以把它想成類似 [GitHub](https://github.com/)，裡面存放了非常多的 Image ，可在 [Docker Hub](https://hub.docker.com/) 中查看。 更詳細的我這邊就不再解釋惹，留給大家做作功課:stuck_out_tongue: ## 安裝 Windows 請先到 Docker 官網 [https://www.docker.com/docker-windows](https://www.docker.com/docker-windows) 下載 stable 版本  接下來就是無腦安裝，安裝完後他會叫你登出電腦，點下去後就會幫你登出電腦  接著如果你的電腦沒有啟用 [Hyper-V](https://msdn.microsoft.com/zh-tw/library/hh831531(v=ws.11).aspx) ，他會叫你重啟電腦 (一樣，點下去就對惹) ( 更多可 Hyper-V 介紹請參考 [https://docs.microsoft.com/zh-tw/virtualization/hyper-v-on-windows/about/](https://docs.microsoft.com/zh-tw/virtualization/hyper-v-on-windows/about/) )  重新開機後，你就會發現可愛的 Docker 在右下角蹦出來惹  我們可以再用 cmd 確認一下是否有成功安裝 ```cmd docker --version docker-compose --version ```  記得再設定一個東西 Shared Drives  裝完了之後，建議大家再多裝一個 [Kitematic](https://kitematic.com/)，他是 GUI 介面的，方便你使用 Docker， ( 後面會再介紹一個更贊的 GUI 介面 [portainer](https://github.com/portainer/portainer) :grin: ) 我知道打指令很潮，但還是建議裝一下。 直接對著你的 Docker 圖示右鍵，就可以看到 [Kitematic](https://kitematic.com/)   下載回來直接解壓縮雙點擊即可使用  MAC MAC 我本身也有，但因為更早之前就裝了，步驟就沒記錄了，基本上大同小異 [https://www.docker.com/docker-mac](https://www.docker.com/docker-mac) Linux [Youtube Tutorial-Ubuntu(Linux) 如何安裝 docker](https://youtu.be/eS_HMBC_RaA) 這裡使用 Ubuntu 當作範例, 雖然在 ubuntu 中有 `snap` 可以非常快速的安裝 docker, 但在這邊我們不使用 `snap` 的方法安裝:smile: 請參考官方文件步驟安裝, Get Docker Engine - Community for Ubuntu [Get Docker Engine - Community for Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/) 安裝後步驟 (optional:exclamation:), 但建議參考一下 [Post-installation steps for Linux](https://docs.docker.com/install/linux/linux-postinstall/) docker-compose 的安裝 [docker-compose install](https://docs.docker.com/compose/install/) 系統資源分配問題, 假如你是使用 windows 或是 mac 的 docker, 你會有一個界面可以設定你要分多少的 cpu 以及 ram 給你的 docker, 通常會在 Preferences -> Advanced, 有 GUI 界面,  但如果是使用 linux, 就不會有這個界面, 因為在 Linux 中, 會自動依照系統的資源進行分配. ## 指令介紹 接著介紹一些 Docker 的指令， Docker 的指令真的很多，這裡就介紹我比較常用的或是實用的指令 查看目前 images ```cmd docker images ``` 建立 image ```cmd docker create [OPTIONS] IMAGE [COMMAND] [ARG...] ``` 詳細的參數可參考 [https://docs.docker.com/engine/reference/commandline/create/](https://docs.docker.com/engine/reference/commandline/create/) 範例 ( 建立一個名稱為 busybox 的 image ) ```cmd docker create -it --name busybox busybox ``` 刪除 Image ```cmd docker rmi [OPTIONS] IMAGE [IMAGE...] ``` 查看目前運行的 container ```cmd docker ps ``` 查看目前全部的 container（ 包含停止狀態的 container ） ```cmd docker ps -a ``` 新建並啟動 Container ```cmd docker run [OPTIONS] IMAGE[:TAG|@DIGEST] [COMMAND] [ARG...] ``` 舉個例子 ```cmd docker run -d -p 80:80 --name my_image nginx ``` `-d` 代表在 Detached（ 背景 ）執行，如不加 `-d`，預設會 foreground ( 前景 ) 執行 `-p` 代表將本機的 80 port 的所有流量轉發到 container 中的 80 port `--name` 設定 container 的名稱 在舉一個例子 ```cmd docker run -it --rm busybox ``` `--rm` 代表當 exit container 時，會自動移除 container。 ( incompatible with -d ) 更詳細的可參考 [https://docs.docker.com/engine/reference/run/](https://docs.docker.com/engine/reference/run/) 啟動 Container ```cmd docker start [OPTIONS] CONTAINER [CONTAINER...] ``` 如果想讓他在前景跑順便觀看輸出 , 可以使用以下指令 ```cmd docker start -a [OPTIONS] CONTAINER [CONTAINER...] ``` `--attach` 或 `-a` 代表 Attach STDOUT/STDERR and forward signals. 更詳細的可參考 [https://docs.docker.com/engine/reference/commandline/start/](https://docs.docker.com/engine/reference/commandline/start/) （ container ID 寫幾個就可以了，和 Git 的概念是一樣的 ， 不了解 Git 可以參考 [Git-Tutorials GIT基本使用教學](https://github.com/twtrubiks/Git-Tutorials) ） 停止 Container ```cmd docker stop [OPTIONS] CONTAINER [CONTAINER...] ``` 重新啟動 Container ```cmd docker restart [OPTIONS] CONTAINER [CONTAINER...] ``` 删除 Container ```cmd docker rm [OPTIONS] CONTAINER [CONTAINER...] ``` `--volumes , -v` 加上這個參數，會移除掉連接到這個 container 的 volume。 可參考 [https://docs.docker.com/engine/reference/commandline/rm/](https://docs.docker.com/engine/reference/commandline/rm/) 進入 Container ```cmd docker exec [OPTIONS] CONTAINER COMMAND [ARG...] docker exec -it <Container ID> bash ``` 使用 root 使用者進入　 ```cmd docker exec -u 0 -it <Container ID> bash docker exec -u root -it <Container ID> bash ``` 打指令比較潮，或是說你也可以透過 [Kitematic](https://kitematic.com/) 進入。 [](https://i.imgur.com/Yui1UZb.png) 當我們進入了 Container 之後，有時候想看一下裡面 Linux 的版本， 這時候可以使用以下指令查看 ```cmd cat /etc/os-release ``` 查看 Container 詳細資料 ```cmd docker inspect [OPTIONS] NAME|ID [NAME|ID...] ``` 查看 log ```cmd docker logs [OPTIONS] CONTAINER ``` `--follow` , `-f` , Follow log output 更詳細的可參考 [https://docs.docker.com/engine/reference/commandline/logs/](https://docs.docker.com/engine/reference/commandline/logs/) 從最後 100 行開始追蹤, ```cmd docker logs -f --tail 100 CONTAINER ``` 也可以把 log 寫進去檔案中, ```cmd docker logs CONTAINER >> access.log ``` 也可以先過濾 log 再寫進檔案中, ```cmd docker logs CONTAINER | grep "29/Mar/2022" >> access_tmp.log ``` 顯示容器資源 ( CPU , I/O ...... ) ```cmd docker stats [OPTIONS] [CONTAINER...] ``` 也可以加上 `--no-stream` ```cmd docker stats --no-stream ``` `--no-stream` Disable streaming stats and only pull the first result. 注意:exclamation::exclamation:這邊得到的 memory usage 會比實際上的還要小, 因為這邊的值是再減去 cache usage memory. 相關 issues 可參考 [https://github.com/moby/moby/issues/32253](https://github.com/moby/moby/issues/32253) ```txt On Linux, the Docker CLI reports memory usage by subtracting cache usage from the total memory usage. ``` 詳細說明可參考 [https://docs.docker.com/engine/reference/commandline/stats/](https://docs.docker.com/engine/reference/commandline/stats/) 也可參考 [https://docs.docker.com/config/containers/runmetrics/](https://docs.docker.com/config/containers/runmetrics/) 查看 container 中正在執行的 processes ```CMD docker top CONTAINER ``` 停止指定的 CONTAINER 中全部的 **processes** ```cmd docker pause CONTAINER [CONTAINER...] ``` 執行 `docker pause` 之後，可以試這用 `docker ps` 查看，會發現 還是有在執行，這裡拿 `docker stop` 比較一下，差異如下。 `docker stop` : process 級別。 `docker pause`: container 級別。 恢復指定暫停的 CONTAINER 中全部的 **processes** ```cmd docker unpause CONTAINER [CONTAINER...] ``` docker tag ```cmd docker tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] ``` 範例 ```cmd docker tag 0e5574283393 twtrubiks/nginx:version1.0 ``` 更多可參考 [https://docs.docker.com/engine/reference/commandline/tag/](https://docs.docker.com/engine/reference/commandline/tag/) 儲存 (備份) image 成 tar 檔案 ```cmd [OPTIONS] IMAGE [IMAGE...] ``` 範例 ```cmd docker save busybox > busybox.tar ``` 或 ```cmd docker save --output busybox.tar busybox ``` 或 ( 也可以一次備份多個 ) ```cmd docker save -o images.tar postgres:9.6 busybox ``` 更多可參考 [https://docs.docker.com/engine/reference/commandline/save/](https://docs.docker.com/engine/reference/commandline/save/) 載入 image ```cmd docker load [OPTIONS] ``` 範例 ```cmd docker load < busybox.tar ``` 或 ```cmd docker load -i busybox.tar ``` 更多可參考 [https://docs.docker.com/engine/reference/commandline/load/](https://docs.docker.com/engine/reference/commandline/load/) 顯示 image 的 history，查詢 image 的每一層 ```cmd docker history [OPTIONS] IMAGE ``` 在 docker 中，一層一層的概念很重要。  更多可參考 [https://docs.docker.com/engine/reference/commandline/history/](https://docs.docker.com/engine/reference/commandline/history/) 剛剛有教大家如何儲存 (備份) images， 載入 images， 還有另外一種是 export 和 import containers， docker export container 請參考 [https://docs.docker.com/engine/reference/commandline/export/](https://docs.docker.com/engine/reference/commandline/export/)。 docker import container 請參考 [https://docs.docker.com/engine/reference/commandline/import/](https://docs.docker.com/engine/reference/commandline/import/)。 其他指令 刪除所有 dangling images ```cmd docker image prune ``` 移除全部 unused images (不只 dangling images) ```cmd docker image prune -a ``` 更多資訊可參考 [image_prune](https://docs.docker.com/engine/reference/commandline/image_prune/) 停止所有正在運行的 Container ```cmd docker container stop $(docker ps -q) ``` 更多資訊可參考 [container_stop](https://docs.docker.com/engine/reference/commandline/container_stop/) 移除全部停止的 containers ```cmd docker container prune ``` 更多資訊可參考 [container_prune](https://docs.docker.com/engine/reference/commandline/container_prune/) ### ENTRYPOINT 教學說明請點選 [entrypoint-tutorial](https://github.com/twtrubiks/docker-tutorial/tree/master/entrypoint-tutorial) ### Volume 接下來要介紹 Volume，Volume 是 Docker 最推薦存放 persisting data（ 數據 ）的機制， 使用 Volume 有下列優點 * Volumes are easier to back up or migrate than bind mounts. * You can manage volumes using Docker CLI commands or the Docker API. * Volumes work on both Linux and Windows containers. * Volumes can be more safely shared among multiple containers. * Volume drivers allow you to store volumes on remote hosts or cloud providers, to encrypt the contents of volumes, or to add other functionality. * A new volume's contents can be pre-populated by a container. 在 container 的可寫層中，使用 volume 是一個比較好的選擇，因為他不會增加 container 的容量， volume 的內容存在於 container 之外。 也可參考下圖  更詳細的可參考 [https://docs.docker.com/engine/admin/volumes/volumes/](https://docs.docker.com/engine/admin/volumes/volumes/) 查看目前的 volume ```cmd docker volume ls [OPTIONS] ``` 創造一個 volume ```cmd docker volume create [OPTIONS] [VOLUME] ``` 刪除一個 volume ```cmd docker volume rm [OPTIONS] VOLUME [VOLUME...] ``` 查看 volume 詳細資料 ```cmd docker volume inspect [OPTIONS] VOLUME [VOLUME...] ``` 移除全部未使用的 volume ```cmd docker volume prune [OPTIONS] ``` 也可以建立 readonly 的 volumes (容器內 readonly) `docker-compose.yml` 方法如下, ```yml version: '3.5' services: nginx: image: nginx ports: - "80:80" volumes: - "nfs-data:/data:ro,z" volumes: nfs-data: ``` 如果要可讀寫, 就設定 `rw`. volumes 在容器內的確不能寫 (只能讀)  使用以下的指令查看 Mounts, 觀察它的 Mode ```cmd docker inspect <container ID> ```  也可以建立 NFS volumes, `docker-compose.yml` 方法如下, ```yml version: '3.5' services: nginx: image: nginx ports: - "80:80" volumes: - "nfs-data:/data" volumes: nfs-data: driver: local driver_opts: type: nfs o: nfsvers=4,addr=ip,rw device: ":/path/to/dir" ``` 可以用以下指令查看設定 ```cmd docker volume ls docker inspect <volume name> ```  NFS 相關文章可參考 [linux-nfs-server - 如何在 ubuntu 啟用 NFS Server](https://github.com/twtrubiks/linux-note/tree/master/linux-nfs-server) ### network 建議大家花點時間研究 docker 中的 network，會蠻有幫助的 :smiley: 查看目前 docker 的網路清單 ```cmd docker network ls [OPTIONS] ``` 詳細可參考 [https://docs.docker.com/engine/userguide/networking/](https://docs.docker.com/engine/userguide/networking/) docker 中的網路主要有三種 Bridge、Host、None，預設皆為 Bridge 模式。 指定 network 範例 ( 指定使用 `host` 網路 ) ```cmd docker run -it --name busybox --rm --network=host busybox ``` 建立 network ```cmd docker network create [OPTIONS] NETWORK ``` 移除 network ```cmd docker network rm NETWORK [NETWORK...] ``` 移除全部未使用的 network ```cmd docker network prune [OPTIONS] ``` 查看 network 詳細資料 ```cmd docker network inspect [OPTIONS] NETWORK [NETWORK...] ``` 將 container 連接 network ```cmd docker network connect [OPTIONS] NETWORK CONTAINER ``` 更多詳細資料可參考 [https://docs.docker.com/engine/reference/commandline/network_connect/](https://docs.docker.com/engine/reference/commandline/network_connect/) Disconnect container network ```cmd docker network disconnect [OPTIONS] NETWORK CONTAINER ``` 更多詳細資料可參考 [https://docs.docker.com/engine/reference/commandline/network_disconnect/](https://docs.docker.com/engine/reference/commandline/network_disconnect/) #### User-defined networks 這個方法是官方推薦的 :thumbsup: 透過內建的 DNS 伺服器，可以直接使用容器名稱，就可解析出 IP，不需要再使用 IP 讓容器互相 溝通，我們只需要知道容器的名稱就可以連接到容器。 更多詳細資料可參考 [https://docs.docker.com/engine/userguide/networking/#user-defined-networks](https://docs.docker.com/engine/userguide/networking/#user-defined-networks) ## docker-compose 再來要介紹 docker-compose，可參考官網 [https://docs.docker.com/compose/](https://docs.docker.com/compose/)  Compose 是定義和執行多 Container 管理的工具，不懂我在說什麼:question::question::question: 試著想想看，通常一個 Web 都還會有 DB，甚至可能還有 [Redis](https://redis.io/) 或 [Celery](http://www.celeryproject.org/)， 所以說我們需要有 Compose 來管理這些，透過 `docker-compose.yml` ( YML 格式 ) 文件。 `docker-compose.yml` 的寫法可參考 [https://docs.docker.com/compose/compose-file/](https://docs.docker.com/compose/compose-file/) 也可以直接參考官網範例 [https://docs.docker.com/compose/compose-file/#compose-file-structure-and-examples](https://docs.docker.com/compose/compose-file/#compose-file-structure-and-examples) Compose 的 Command-line 很多和 Docker 都是類似的， 可參考 [https://docs.docker.com/glossary/?term=compose](https://docs.docker.com/glossary/?term=compose) 查看目前 Container ```cmd docker-compose ps ``` 加上 `-q` 的話，只顯示 id ```cmd docker-compose ps -q ``` 啟動 Service 的 Container ```cmd docker-compose start [SERVICE...] ``` 停止 Service 的 Container ( 不會刪除 Container ) ```cmd docker-compose stop [options] [SERVICE...] ``` 重啟 Service 的 Container ```cmd docker-compose restart [options] [SERVICE...] ``` Builds, (re)creates, starts, and attaches to containers for a service ```cmd docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...] ``` 加個 `-d`，會在背景啟動，一般建議正式環境下使用。 ```cmd docker-compose up -d ``` 然後如果你有很多個 `docker-compose.yml` `docker-compose-dev.yml`, 你可以透過 `-f` 決定你要執行哪一個, 範例如下, ```cmd docker-compose -f ./docker-compose-dev.yml up -d ``` `-f` `--file FILE` Specify an alternate compose file (default: `docker-compose.yml`) `up` 這個功能很強大，建議可以參考 [https://docs.docker.com/compose/reference/up/](https://docs.docker.com/compose/reference/up/) 如果你希望每次都重新 build image，可以加上 `--build` ( Build images before starting containers. ) ```cmd docker-compose up -d --build ``` docker-compose down ```cmd docker-compose down [options] ``` `down` 這個功能也建議可以參考 [https://docs.docker.com/compose/reference/down/](https://docs.docker.com/compose/reference/down/) 舉個例子 ```cmd docker-compose down -v ``` 加個 `-v` 就會順便幫你把 volume 移除（ 移除你在 `docker-compose.yml` 裡面設定的 volume ） 在指定的 Service 中執行一個指令 ```cmd docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...] [ARGS...] ``` 舉個例子 ```cmd docker-compose run web bash ``` 在 web Service 中執行 `bash` 指令 可參考 [https://docs.docker.com/compose/reference/run/](https://docs.docker.com/compose/reference/run/) 觀看 Service logs ```cmd docker-compose logs [options] [SERVICE...] ``` 檢查 `docker-compose.yml` 格式是否正確 ```cmd docker-compose config ``` 如下指令，和 `docker exec` 一樣 ```cmd docker-compose exec ``` 範例 ( 進入 web 這個 service 的 bash ) ```cmd docker-compose exec web bash ``` 顯示被使用到的 container 中的 images 清單 ```cmd docker-compose images ``` 移除 service containers ```cmd docker-compose rm ``` Pushes images 到 docker hub ```cmd docker-compose push ``` 目前這個指令其實我也搞不太懂，可參考 [https://github.com/docker/compose/issues/4283](https://github.com/docker/compose/issues/4283) 官網也解釋的沒有很清楚 [https://docs.docker.com/compose/reference/push/](https://docs.docker.com/compose/reference/push/) ### docker-compose up/down 和 restart 的差異 * [Youtube Tutorial- docker-compose up/down 和 restart 的差異](https://youtu.be/nX-sbLPz-MU) 先來談 `docker-compose up/down`, 假如今天你修改了 `docker-compose.yml` 又或是更新了 image, 當你要重建 docker , 有幾種方法, 方法一. 先停止 container, 執行 `docker-compose down` 再執行 `docker-compose up`. 方法二. 不需要停止 container, 直接執行 `docker-compose up -d`. (他會自動幫你重建, 很方便, 不需要多一步先關閉 container ) 結論, 只要你的 `docker-compose.yml` 有任何變動, 一定要執行 `docker-compose up` 才會生效. 再來談 `docker-compose restart`, 請看官方文件 [docker-compose restart](https://docs.docker.com/compose/reference/restart/), 如果你對 `docker-compose.yml` 修改, 然後使用這個指令, 是**不會**生效的, 但是, 如果你是改 code (可能是 python code), 那這個指令是有效的. ### docker-compose networks * [Youtube Tutorial - docker-compose networks 說明](https://youtu.be/wmV9WfkpyGk) 這邊多補充 docker-compose networks 的觀念，因為剛好最近有用到:smile: ```yml version: '3.5' services: db: container_name: 'postgres' image: postgres environment: POSTGRES_PASSWORD: password123 ports: - "5432:5432" # (HOST:CONTAINER) volumes: - pgdata:/var/lib/postgresql/data/ networks: - proxy web: build: ./api command: python manage.py runserver 0.0.0.0:8000 restart: always volumes: - api_data:/docker_api # (HOST:CONTAINER) ports: - "8000:8000" # (HOST:CONTAINER) depends_on: - db networks: - proxy volumes: api_data: pgdata: networks: proxy: # external: name: my_network ``` 先把 version 改成 3.5，因為這版本才開始有 networks name 的概念，在 db 以及 web 中都加了 networks ( 自己定義的 )，定義的地方在最後面， proxy 是名稱 ( 類似 volumes 的概念 )，`external` option 的意思代表 是不是要參考外部別人已經定義好的 network ( 所以如果找不到就會報錯 )， 但如果不加上 `external` option，也就代表是自己定義的，會幫你自動建立 你所定義的 network，名稱為 my_network。 如果你都完全沒有定義 networks，預設就是資料夾的名稱_default 。 ### docker-compose ports 和 expose 差異 在 docker-compose 中有兩種方法可以暴露容器 ports， 分別是 ports 和 expose， #### ports ```yml ... ports: - "5000:5000" # 绑定 container 中的 5000 port 到 本機(HOST) 的 5000 port # (HOST:CONTAINER) - "5001:5000" # 绑定 container 中的 5000 port 到 本機(HOST) 的 5001 port - "5000" # 绑定 container 中的 5000 port 到本機的任意 port (本機會隨機被分配到一個 port) ... ``` 隨機 port 範例， 這邊使用 dpage/pgadmin4 這個 images 來示範， ```cmd docker run -p 80 \ -e "[email protected]" \ -e "PGADMIN_DEFAULT_PASSWORD=SuperSecret" \ -d dpage/pgadmin4 ``` 如果我們執行兩次以上指令，你會發現本機被分配到兩個隨機的 ports (如下圖)，  本機被隨機分配到 32768 以及 32769 port， 這邊不管我們怎麼設定 ports，這些 ports 都會暴露給本機 (HOST) 以及其他 containers，這點很重要:exclamation::exclamation: 也就是說，如果本機 5001 ports 被使用了，其他的 containers 就無法使用 5001 ports， 可能要改成5002 ports 之類的。 #### expoese ```yml ... expose: - "4000" - "6000" ... ``` expose 是將 port 暴露給其他容器。 expose 和 ports 最大的差別就是在 expose 不會暴露 port 給本機(HOST)， 所以 本機(HOST)絕對無法被訪問，但 containers 內可以被訪問， 所以說如果今天你的容器想要在 本機(HOST) 被訪問，一定要使用 ports 方式。 ***ports 和 expose 差異*** 簡單說，就是 ports 可以被 本機(HOST) 和 containers 訪問 ; 而 expose 是本機(HOST) 無法被訪問，只有在 containers 中可以被訪問。 ## Docker container 內如何連接到本機 localhost 服務  假設今天在本機上有一個 A 服務, 他是使用 docker run 起來的, 而本機上還有一個 B 服務, 是用 vscode run 起來的 (非 docker), 這時候我有一個需求, 我想要將我的 A 服務連線到我的 B 服務, 也就是從 docker 內的服務連接到本機 localhost. 比較簡單的方法, 就是透過 docker 內的這個參數, `host.docker.internal:host-gateway`. 在你的 yml 裡面加上, ```yml version: '3.5' services: web: ...... extra_hosts: - "host.docker.internal:host-gateway" ...... ``` 這樣當你在容器內, 就可以順利訪問本機:smile: ```cmd curl http://host.docker.internal:8069 ``` ## Docker Registry  可以把它想成是一個類似 github 的地方，只不過裡面變成是存 docker 的東西，當然， 也可以自己架，但會有一些額外的成本，像是網路，維護等等，這部分就要自己衡量了:grinning: 接下來教大家如何將 image push 到 Docker Registry :smiley: * [Youtube Tutorial PART 4 - Docker push image to Docker Hub 教學](https://youtu.be/dVBKwmqO5e4) 首先，先登入 [Docker Registry](https://hub.docker.com/) ( 註冊流程很簡單，我就跳過了 ) ```cmd docker login ```  舉個例子，先 run 一個 busybox 的容器 ```cmd docker run -it busybox ``` 接著在裡面新增一筆資料 ```cmd echo 'text' > data.txt ```  然後打開另一個 terminal ，使用 `docker ps` 查看目前容器的 id  再來使用像 git 一樣的方式 commit docker commit ```cmd docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]] ``` 可參考 [https://docs.docker.com/engine/reference/commandline/commit/](https://docs.docker.com/engine/reference/commandline/commit/) ```cmd docker commit -m "test" 4fb4ef51e917 twtrubiks/my_busybox ``` `-m` commit message ，和 git 一樣。 twtrubiks/my_busybox 則為我們定義的 REPOSITORY。 如果需要 tag , 也可以增加 ```cmd docker commit -m "test" 4fb4ef51e917 twtrubiks/my_busybox:v1 ``` （ 如果沒定義 tag , 則會顯示 latest ） 這時候可以用 `docker images` 查看  最後 push ```cmd docker push twtrubiks/my_busybox ```  docker 是一層一層的概念，他只會 push 自己新增的幾層上去而已， 所以不用擔心整個 image 很大，要上傳很久 :relaxed: 最後可以到 [https://hub.docker.com/](https://hub.docker.com/) 確認是否有成功 :smile:  ## 用 Docker 實戰 Django 以及 Postgre * [Youtube Tutorial PART 2 - 用 Docker 實戰 Django 以及 Postgre](https://youtu.be/aZ6woJ7qekE) 上面介紹了那麼多，來實戰一下是必須的 :satisfied: 我們使用 [Django-REST-framework 基本教學 - 從無到有 DRF-Beginners-Guide](https://github.com/twtrubiks/django-rest-framework-tutorial) 來當範例 有幾個地方必須修改一下， 將 `settings.py` 裡面的 db 連線改成 [PostgreSQL](https://www.postgresql.org/) ```pyhon DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': 'postgres', 'USER': 'postgres', 'PASSWORD': 'password123', 'HOST': 'db', 'PORT': 5432, } } ``` 建議也將 `ALLOWED_HOSTS = []` 改為 `ALLOWED_HOSTS = ['*']` （ 這只是方便，實務上不會這樣使用 ） 再來是兩個很重要的檔案，分別為 `Dockerfile` 和 `docker-compose.yml` `Dockerfile` ```text FROM python:3.8.12 LABEL maintainer twtrubiks ENV PYTHONUNBUFFERED 1 RUN mkdir /docker_api WORKDIR /docker_api COPY . /docker_api/ RUN pip install -r requirements.txt ``` 詳細可參考 [https://docs.docker.com/engine/reference/builder/](https://docs.docker.com/engine/reference/builder/) `docker-compose.yml` ```yml version: '3' services: db: container_name: 'postgres' image: postgres environment: POSTGRES_PASSWORD: password123 ports: - "5432:5432" # (HOST:CONTAINER) volumes: - pgdata:/var/lib/postgresql/data/ web: build: ./api command: python manage.py runserver 0.0.0.0:8000 restart: always volumes: - api_data:/docker_api # (HOST:CONTAINER) ports: - "8000:8000" # (HOST:CONTAINER) depends_on: - db volumes: api_data: pgdata: ``` 詳細可參考 [https://docs.docker.com/compose/compose-file/#compose-file-structure-and-examples](https://docs.docker.com/compose/compose-file/#compose-file-structure-and-examples) 溫馨小提醒 1 :heart: 可能有人會問為什麼我是使用 `0.0.0.0`，而不是使用 `127.0.0.1`:question::question: ```cmd python manage.py runserver 0.0.0.0:8000 ``` `127.0.0.1`，並不代表真正的 **本機**，我們經常認為他是本機是因為我們電腦的 `host` 預設都幫你設定好了:smirk: 詳細的 `host` 設定教學可參考 [hosts-設定檔 以及 查詢內網 ip](https://github.com/twtrubiks/docker-django-nginx-uswgi-postgres-tutorial#hosts-設定檔-以及-查詢內網-ip)， `0.0.0.0` 才是真正的代表，**當下 ( 本 ) 網路中的本機** :pencil2: 如果大家想更深入的了解，可 google 再進一步的了解 `127.0.0.1` 以及 `0.0.0.0` 的差異 :smile: 溫馨小提醒 2 :heart: 這邊要特別提一下 `depends_on` 這個參數， 詳細可參考 [https://docs.docker.com/compose/compose-file/#depends_on](https://docs.docker.com/compose/compose-file/#depends_on)， 上面連結中有一段說明很值得看 ****depends_on does not wait for db and redis to be 「ready」 before starting web - only until they have been started. If you need to wait for a service to be ready, see Controlling startup order for more on this problem and strategies for solving it.**** 以我的 [docker-compose.yml](https://github.com/twtrubiks/docker-tutorial/blob/master/docker-compose.yml) 為例，啟動順序雖然為 db -> web，**但他不會等待 db 啟動完成後才啟動 web**， 也就是說，還是有可能 **web 比 db 先啟動完成**，這樣就需要重啟 web service，否則會無法連上 db :sob: 如果真的要控制啟動順序，請參考 [Controlling startup order](https://docs.docker.com/compose/startup-order/)。 溫馨小提醒 3 :heart: `docker-compose.yml` 其實使用 `docker run` 也是可以完成的，例如這個範例中，如果使用 `docker run` 來寫，會變成這樣。 首先，為了讓容器彼此可以溝通，我們先建立一個網路 ( User-defined networks )， ```cmd docker network create my_network ``` db 容器 ```cmd docker run --name db -v pgdata:/var/lib/postgresql/data/ -p 5432:5432 --network=my_network -e POSTGRES_PASSWORD=password123 postgres ``` 接下來先去 api 資料夾中 build 出 image ```cmd docker build --tag web_image . ``` `--tag , -t` , tag 這個 image 名稱為 web_image 也可以是 ```cmd docker build -t user/repo:tag . ``` web 容器 ```cmd docker run --name web -v api_data:/docker_api -p 8000:8000 --network=my_network --restart always web_image python manage.py runserver 0.0.0.0:8000 ``` 以上這樣，和 `docker-compose.yml` 其實是一樣的:open_mouth: 設定完了之後，接下來我們就可以啟動他了 ```cmd docker-compose up ``` 接下來你會看到類似的畫面   假如你出現了類似的畫面  代表 database 還在建立的時候，你的 web ( Django ) 就去連接他， 所以導致連接不上，這時候我們可以先終止他 ( 按 Ctrl+C ) 接著在重新 `docker-compose up` 我們成功啟動了 ( db 連線也正常 )  :exclamation: [commit](https://github.com/twtrubiks/docker-tutorial/commit/398cb2fc375af8926cfe1eeabda33da018437897) 已經更新為自動 migrate:exclamation: 但你仔細看上圖，你會發現他說你還沒 migrate 接下來我們開啟另一個 cmd 進入 web 的 service， 透過剛剛介紹的指令進入 service ```cmd docker ps docker exec -it <Container ID> bash ``` 或是說也可以從 [Kitematic](https://kitematic.com/) 進入， 進入後我們可以開始 migrate ```cmd python manage.py makemigrations musics python manage.py migrate ```  順便在建立一個 superuser ```cmd python manage.py createsuperuser ``` :exclamation: [commit](https://github.com/twtrubiks/docker-tutorial/commit/398cb2fc375af8926cfe1eeabda33da018437897) 已經更新為自動建立 superuser:exclamation: 請參考 [docker-compose.yml](https://github.com/twtrubiks/docker-tutorial/blob/master/docker-compose.yml) 中的 environment ( 如下 ), `DJANGO_SUPERUSER_USERNAME` `DJANGO_SUPERUSER_PASSWORD` `DJANGO_SUPERUSER_EMAIL` 接著我們可以試著使用 GUI 介紹連接 db， 因為我們是用 [PostgreSQL](https://www.postgresql.org/) ，可以透過 [pgadmin](https://www.pgadmin.org/) 連線  我們剛剛 migrate 的東西確實有存在  我們不需要再重新啟動 直接可以開開心心的去瀏覽 [http://127.0.0.1:8000/api/music/](http://127.0.0.1:8000/api/music/) 大家一定會看到很熟悉的畫面  接著依照自己剛剛設定的帳密登入進去即可   以上整個環境，都是在 Docker 中 :open_mouth: 如果我們再 Ctrl+C 退出，重新啟動一次 `docker-compose up` 這次就不會再和你說你沒有 migrate 了  ## 其他管理 Docker GUI 的工具 * [Youtube Tutorial PART 3 - Docker 基本教學 - 透過 portainer 管理 Docker](https://youtu.be/VZjHmBcEcew) 除了 [Kitematic](https://kitematic.com/) 之外，還有其他不錯的推薦給大家， 這次要介紹的就是 [portainer](https://github.com/portainer/portainer) 功能強大又好用 :fire: 其實如果去看看 [Kitematic](https://github.com/docker/kitematic) 以及 [portainer](https://github.com/portainer/portainer) 的 github， 你會發現 [portainer](https://github.com/portainer/portainer) 感覺比較有在 maintenance :smile: 而且我使用了 [portainer](https://github.com/portainer/portainer) 之後，真心大推 :smiley: 安裝方法可參考 [https://portainer.io/install.html](https://portainer.io/install.html) ```cmd docker volume create portainer_data docker run --name=portainer -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer ``` `-d` `-p` 在前面的 `docker run` 有介紹過代表的含意，`--name` 只是命名而已。 `Note 1`: The -v /var/run/docker.sock:/var/run/docker.sock option is available on Linux environments only. `Note 2`: The -v portainer_data:/data portainer/portainer option will persist Portainer data in portainer_data on the host where Portainer is running. You can specify another location on your filesystem. （ 建立起來之後，就依照 container 的操作即可 ） 之後查看 [http://localhost:9000/](http://localhost:9000/) 就會看到下圖 然後設定帳號、密碼  選 Local or Remote  畫面真的不錯看，而且資訊也很豐富 :heart_eyes:  相信我，你使用完他之後，你會默默的邊緣化 [Kitematic](https://kitematic.com/) :smirk: ## 查看 port 佔用狀況 這個推薦給大家，有時候會遇到 port 被佔用，用指令查比較方便 Linux 安裝 net-tools ```cmd sudo apt install net-tools ``` 查看誰佔用 80 port ```cmd sudo netstat -lnp | grep -w ':80' ``` `-l`, `--listening` display listening server sockets. `-n`, `--numeric` don't resolve names. `-p`, `--programs` display PID/Program name for sockets. 也可以使用 `lsof` ```cmd sudo lsof -i :80 ``` `-i` select IPv[46] files. Windows 查看所有 port 的佔用狀況 ```cmd netstat -ano ``` 查看指定 port 的佔用狀況，例如現在想要查看 port 5432 佔用的狀況 ```cmd netstat -aon|findstr "5432" ``` 查看 PID 對應的 process ```cmd tasklist|findstr "2016" ``` 停止 PID 為 6093 的 process ```cmd taskkill /f /PID 6093 ``` 停止 vscode.exe process ```cmd taskkill /f /t /im vscode.exe ``` MAC 將 port 為 8000 的 process 全部停止 ```cmd sudo lsof -t -i tcp:8000 | xargs kill -9 ``` 查看指定 port 的佔用狀況，例如現在想要查看 port 5432 佔用的狀況 ```cmd lsof -i tcp:5432 ``` ## 在 Linux 中自動啟動 docker [在 Linux 中自動啟動 docker](https://github.com/twtrubiks/docker-tutorial/tree/master/docker-auto-run-linux) ## 如何清除 Docker container log [Youtube Tutorial - 如何清除 Docker container log](https://youtu.be/SiG0tmwhqqg) docker 的 container log 都會在 `/var/lib/docker/containers` 裡面 ( 前提是你使用官方的安裝方法, [Youtube Tutorial-Ubuntu(Linux) 如何安裝 docker](https://youtu.be/eS_HMBC_RaA)) 如果你是使用 `snap` 安裝 docker, 路徑則會在 `/var/snap/docker/common/var-lib-docker/containers`.  log 是一個 json 的檔案  如果你一直不去管他, log 就會越來越大:scream: 以下狀況這個 log 會被清除, 就是修改了 `docker-compose.yml` 或是 你執行了 `docker-compose down`, 這些 logs 都會被清除 (因為 containers 重新建立). (`docker-compose stop` 不受影響, 因為只是暫停而已) 建立大家可參考 [docker-compose up/down 和 restart 的差異](https://github.com/twtrubiks/docker-tutorial#docker-compose-updown-%E5%92%8C-restart-%E7%9A%84%E5%B7%AE%E7%95%B0) 那你可能會問我, 如果我很長一段時間都不會修改 `docker-compose.yml` 以及執行 `docker-compose down` 該怎麼辦:sob: (因為 log 可能會長很快) 這邊提供大家一個方法, 使用 linux 中的 truncate 指令(可參考 [ Linux 指令教學 - truncate](https://github.com/twtrubiks/linux-note#truncate)) 刪除全部 container 的 logs ```cmd truncate -s 0 /var/lib/docker/containers/*/*-json.log ``` 但是有時候只希望針對(清除)某個 container 的 logs, 這時候就可以使用以下的指令 ```cmd truncate -s 0 $(docker inspect --format='{{.LogPath}}' <container_name_or_id>) ``` (`container_name_or_id` 請換上自己 container 的 id 或 name) 其中的 `docker inspect --format='{{.LogPath}}' <container_name_or_id>` 只是顯示路徑而已.  但還有一個更好的方法, 直接透過 docker 內的 JSON File logging driver. ## JSON File logging driver [Youtube Tutorial - Docker 中的 JSON File logging driver(container log)](https://youtu.be/wb9bONgnFn4) 在 docker 中 json-file driver 是默認的 default logging driver, 詳細可參考 [json-file](https://docs.docker.com/config/containers/logging/json-file/) 所以我們可以透過這個設定限制 log 的大小, ```yaml logging: driver: "json-file" options: max-file: "1" # default 是 1 max-size: "200m" # default 是 -1, 也就是沒有限制 ``` 設定完之後重新啟動 docker-compose, 可以使用以下的指令查看是否生效 ```cmd docker inspect --format '{{.HostConfig.LogConfig}}' CONTAINER ```  這樣設定完之後, 就不用再擔心 container log 吃掉大量的容量了:smile: ## 後記： Docker 算是我最近才開始接觸的，所以也算是新手，如果我有任何講錯的，歡迎和我說，我會再修改 :grinning: Docker 可以玩的真的很多，延伸參考 * [實戰 Docker + Jenkins + Django + Postgres 📝](https://github.com/twtrubiks/docker-jenkins-django-tutorial) - 結合 Jenkins * [Docker + Django + Nginx + uWSGI + Postgres 基本教學 - 從無到有](https://github.com/twtrubiks/docker-django-nginx-uwsgi-postgres-tutorial) * [實戰 Docker + Django + Nginx + uWSGI + Postgres - Load Balance 📝](https://github.com/twtrubiks/docker-django-nginx-uwsgi-postgres-load-balance-tutorial) 也可以再玩玩 **Docker Swarm** ( 分散式系統 ) :satisfied: * [Docker Swarm 基本教學 - 從無到有 Docker-Swarm-Beginners-Guide📝](https://github.com/twtrubiks/docker-swarm-tutorial) 最後，希望大家在學習 Docker 的過程中，遇到不懂的，可以去找資料並且了解他， 順便補足一些之前不足的知識。 ## 執行環境 * Mac * Python 3.8.12 * windows 10 ## Reference * [https://docs.docker.com/](https://docs.docker.com/) * [portainer](https://github.com/portainer/portainer) ## Donation 文章都是我自己研究內化後原創，如果有幫助到您，也想鼓勵我的話，歡迎請我喝一杯咖啡:laughing: 綠界科技ECPAY ( 不需註冊會員 )  [贊助者付款](http://bit.ly/2F7Jrha) 歐付寶 ( 需註冊會員 )  [贊助者付款](https://payment.opay.tw/Broadcaster/Donate/9E47FDEF85ABE383A0F5FC6A218606F8) ## 贊助名單 [贊助名單](https://github.com/twtrubiks/Thank-you-for-donate) ## License MIT license

Documentation for the PureScript language, compiler, and tools.

 Welcome to the PureScript documentation repository! PureScript is a small, strongly typed programming language that compiles to JavaScript. To get a better overview of PureScript, visit [The PureScript Website](http://purescript.org). This repository is a collaborative effort, so please feel free to make a pull request to add/edit content or create an issue to discuss it. PureScript is a big project used by people coming from a variety of backgrounds. Making documentation useful to a wide variety of people is really hard to do well, requiring readers like you to point out and add documentation you feel is missing. Thanks for helping! ## Directory ### Getting Started - [Getting Started](guides/Getting-Started.md): Download PureScript and build your first project - [Try PureScript](http://try.purescript.org): Try PureScript in your browser ### Community - [Discourse](https://discourse.purescript.org/): Discuss PureScript in a forum setting - [Discord](https://purescript.org/chat): Chat about PureScript and attend video / audio meetups ### Learning - The [PureScript Book](https://book.purescript.org) is the recommended approach to learning the language, since it covers more material in greater depth. - The [Functional Programming Made Easier](https://leanpub.com/fp-made-easier) will start you at the very beginning with the basics. The book assumes that you know nothing about Functional Programming, and teaches you functional concept with Purescript and in the final few chapters it will build a Full-Stack web server and browser-based front end written in PureScript. - [Language Reference](language/README.md) - [PureScript: Jordan's Reference](https://github.com/JordanMartinez/purescript-jordans-reference): An up-to-date project covering Getting Started, Build Tools, PureScript's syntax with examples, FP design patterns, and PureScript's ecosystem. - [PureScript Cookbook](https://github.com/JordanMartinez/purescript-cookbook): An unofficial cookbook for PureScript. - [A guide to the PureScript numeric hierarchy](https://a-guide-to-the-purescript-numeric-hierarchy.readthedocs.io/en/latest/index.html): An introduction to the mathematics behind the numeric hierarchy of type classes in PureScript’s Prelude. (See also [PureScript numeric hierarchy overview](https://harry.garrood.me/numeric-hierarchy-overview/).) - [PureScript Resources](https://purescript-resources.readthedocs.io/): A collection of notes and links to resources to learn and use PureScript. ### Guides - [Common Operators](guides/Common-Operators.md) - [The Foreign Function Interface (FFI)](guides/FFI.md) - [FFI Tips](guides/FFI-Tips.md) - [Custom Type Errors](guides/Custom-Type-Errors.md) - [PureScript Without Node](guides/PureScript-Without-Node.md) - [Contrib Library Guidelines](guides/Contrib-Guidelines.md) - [Error Suggestions](guides/Error-Suggestions.md) - [psc-ide FAQ](guides/psc-ide-FAQ.md) - [Try PureScript Help](https://github.com/purescript/trypurescript/blob/gh-pages/README.md) ### Tools - [Editor and tool support](ecosystem/Editor-and-tool-support.md): Editor plugins, build tools, and other development tools - [`easy-purescript-nix`](https://github.com/justinwoo/easy-purescript-nix): Set up PureScript and development environment with [Nix](https://nixos.org/) - [PSCi](guides/PSCi.md): An interactive development tool for PureScript ### Ecosystem - [Maintained Packages](ecosystem/Maintained-Packages.md) - [Style Guide](guides/Style-Guide.md) - [Alternate Backends](https://github.com/purescript/documentation/blob/master/ecosystem/Alternate-backends.md): PureScript can compile to other languages as well! - [Recommended tooling for PureScript in 2020](https://discourse.purescript.org/t/recommended-tooling-for-purescript-in-2020/1615) ### Articles - [24 Days of PureScript 2016](https://github.com/paf31/24-days-of-purescript-2016) ### Talks/Meetups - [PureScript Presentations](ecosystem/PureScript-Presentations.md) - [PureScript Meetups](ecosystem/PureScript-Meetups.md) ### Related Languages - [Related Projects](Related-Projects.md) - [Differences from Haskell](language/Differences-from-Haskell.md) ## Project Scope Topics currently in this repository's scope: - PureScript language reference documentation - Its compiler errors - Core concepts on which the language is based - Comparison with similar languages - An introduction to other sources of documentation Topics currently *not* in scope: - Using PureScript libraries (those docs belong with the corresponding libraries) - A PureScript language teaching course (use the [PureScript by Example](https://book.purescript.org) book or other resources) - Introduction to package managers and dependency management Feel free to make an issue to discuss amending the scope. ## License <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/3.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License</a>.

A component toolkit for creating live-running code editing experiences, using the power of CodeSandbox.

<img style="width:100%" src="https://user-images.githubusercontent.com/4838076/163777661-a44ec0a9-ee7c-483a-bdbb-7898ba665f68.gif" alt="Component toolkit for live running code editing experiences" /> # Sandpack Sandpack is a component toolkit for creating your own live running code editing experience powered by CodeSandbox. [Learn more about Sandpack](https://sandpack.codesandbox.io/) [](https://codesandbox.io/p/github/codesandbox/sandpack) ## Sandpack Client This is a small foundation package that sits on top of the bundler. It is framework agnostic and facilitates the handshake between your context and the bundler iframe. [Read more](https://sandpack.codesandbox.io/docs/advanced-usage/client) ## Sandpack React React components that give you the power of editable sandboxes that run in the browser. ```jsx import { Sandpack } from "@codesandbox/sandpack-react"; <Sandpack template="react" />; ``` [Read more](https://sandpack.codesandbox.io/docs/advanced-usage/components) ## Sandpack Themes A list of themes to customize your Sandpack components. ```jsx import { githubLight } from "@codesandbox/sandpack-themes"; <Sandpack theme={githubLight} />; ``` [Read more](https://sandpack.codesandbox.io/docs/getting-started/themes) ## Documentation You can find the Sandpack documentation on [https://sandpack.codesandbox.io/docs/](https://sandpack.codesandbox.io/docs). Start with the [Sandpack introduction](https://sandpack.codesandbox.io/docs) page for a quick overview and you can kick the tyres as well. The documentation is divided into following sections: - [Getting Started](https://sandpack.codesandbox.io/docs/getting-started/install) - [Advanced Guides](https://sandpack.codesandbox.io/docs/advanced-usage/provider) - [API reference](https://sandpack.codesandbox.io/docs/api/client) - [Migration guide from v0.x to v1.x](https://sandpack.codesandbox.io/docs/releases/v1)

Easy to maintain open source documentation websites.

<h1 align="center"> <p align="center">Docusaurus</p> <a href="https://docusaurus.io"><img src="https://docusaurus.io/img/slash-introducing.svg" alt="Docusaurus"></a> </h1> <p align="center"> <a href="https://twitter.com/docusaurus"><img src="https://img.shields.io/twitter/follow/docusaurus.svg?style=social" align="right" alt="Twitter Follow" /></a> <a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/Docusaurus/sponsors/badge.svg" /></a> <a href="https://www.npmjs.com/package/@docusaurus/core"><img src="https://img.shields.io/npm/v/@docusaurus/core.svg?style=flat" alt="npm version"></a> <a href="https://github.com/facebook/docusaurus/actions/workflows/tests.yml"><img src="https://github.com/facebook/docusaurus/actions/workflows/tests.yml/badge.svg" alt="GitHub Actions status"></a> <a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a> <a href="https://discord.gg/docusaurus"><img src="https://img.shields.io/discord/102860784329052160.svg" align="right" alt="Discord Chat" /></a> <a href= "https://github.com/prettier/prettier"><img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"></a> <a href="#license"><img src="https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?colorB=ff0000"></a> <a href="https://github.com/facebook/jest"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Tested with Jest"></a> <a href="https://gitpod.io/#https://github.com/facebook/docusaurus"><img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"/></a> <a href="https://app.netlify.com/sites/docusaurus-2/deploys"><img src="https://api.netlify.com/api/v1/badges/9e1ff559-4405-4ebe-8718-5e21c0774bc8/deploy-status" alt="Netlify Status"></a> <a href="https://meercode.io/facebook/docusaurus"><img src="https://meercode.io/badge/facebook/docusaurus?type=ci-score" alt="CI Score"></a> <a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffacebook%2Fdocusaurus%2Ftree%2Fmain%2Fexamples%2Fclassic&project-name=my-docusaurus-site&repo-name=my-docusaurus-site"><img src="https://vercel.com/button" alt="Deploy with Vercel"/></a> <a href="https://app.netlify.com/start/deploy?repository=https://github.com/slorber/docusaurus-starter"><img src="https://www.netlify.com/img/deploy/button.svg" alt="Deploy to Netlify"></a> </p> > **We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the [Docusaurus v2 website](https://docusaurus.io/) for more details.** > Docusaurus v1 doc is available at [v1.docusaurus.io](https://v1.docusaurus.io) and code is available on branch [docusaurus-v1](https://github.com/facebook/docusaurus/tree/docusaurus-v1) ## Introduction Docusaurus is a project for building, deploying, and maintaining open source project websites easily. Short on time? Check out our [5-minute tutorial ⏱️](https://tutorial.docusaurus.io)! **Tip**: use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately in a playground. - **Simple to Start** > Docusaurus is built in a way so that it can [get running](https://docusaurus.io/docs/installation) in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project. - **Localizable** > Docusaurus ships with [localization support](https://docusaurus.io/docs/i18n/introduction) via CrowdIn. Empower and grow your international community by translating your documentation. - **Customizable** > While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/blog), and additional support pages, it is also [customizable](https://docusaurus.io/docs/creating-pages) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/styling-layout). ## Installation Use the initialization CLI to create your site: ```bash npm init docusaurus@latest ``` [Read the docs](https://docusaurus.io/docs/installation) for any further information. ## Contributing We've released Docusaurus because it helps us better scale and supports the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community. ### [Code of Conduct](https://code.fb.com/codeofconduct) Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.fb.com/codeofconduct) so that you can understand what actions will and will not be tolerated. ### Contributing guide Read our [contributing guide](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus. ### Beginner-friendly bugs To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner-friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that might contain smaller issues to tackle first. This is a great place to get started. ## Contact We have a few channels for contact: - [Discord](https://discord.gg/docusaurus): - `#general` for those using Docusaurus. - `#contributors` for those wanting to contribute to the Docusaurus core. - [@docusaurus](https://twitter.com/docusaurus) on Twitter - [GitHub Issues](https://github.com/facebook/docusaurus/issues) ## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. <a href="https://github.com/facebook/docusaurus/graphs/contributors"><img src="https://opencollective.com/Docusaurus/contributors.svg?width=890&button=false" /></a> ## Backers Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/Docusaurus#backer) <a href="https://opencollective.com/Docusaurus#backers" target="_blank"><img src="https://opencollective.com/Docusaurus/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/Docusaurus#sponsor) <a href="https://opencollective.com/Docusaurus/sponsor/0/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/0/avatar.svg"></a> <a href="https://opencollective.com/Docusaurus/sponsor/1/website" target="_blank"><img src="https://opencollective.com/Docusaurus/sponsor/1/avatar.svg"></a> ## License Docusaurus is [MIT licensed](./LICENSE). The Docusaurus documentation (e.g., `.md` files in the `/docs` folder) is [Creative Commons licensed](./LICENSE-docs). ## Special thanks [](http://www.browserstack.com/) [BrowserStack](http://www.browserstack.com/) supports us with [free access for open source](https://www.browserstack.com/open-source). [](https://rocketvalidator.com/) [Rocket Validator](https://rocketvalidator.com/) helps us find HTML markup or accessibility issues.

Reference and documentation for Perfect (Server-side Swift). Perfect (支持服务器端Swift语言的软件函数库）使用文档和参考手册.

# Perfect Documentation Library [简体中文](README.zh_CN.md) <p align="center"> <a href="http://perfect.org/get-involved.html" target="_blank"> <img src="http://perfect.org/assets/github/perfect_github_2_0_0.jpg" alt="Get Involved with Perfect!" width="854" /> </a> </p> <p align="center"> <a href="https://github.com/PerfectlySoft/Perfect" target="_blank"> <img src="http://www.perfect.org/github/Perfect_GH_button_1_Star.jpg" alt="Star Perfect On Github" /> </a> <a href="http://stackoverflow.com/questions/tagged/perfect" target="_blank"> <img src="http://www.perfect.org/github/perfect_gh_button_2_SO.jpg" alt="Stack Overflow" /> </a> <a href="https://twitter.com/perfectlysoft" target="_blank"> <img src="http://www.perfect.org/github/Perfect_GH_button_3_twit.jpg" alt="Follow Perfect on Twitter" /> </a> <a href="http://perfect.ly" target="_blank"> <img src="http://www.perfect.org/github/Perfect_GH_button_4_slack.jpg" alt="Join the Perfect Slack" /> </a> </p> <p align="center"> <a href="https://developer.apple.com/swift/" target="_blank"> <img src="https://img.shields.io/badge/Swift-4.1-orange.svg?style=flat" alt="Swift 4.1"> </a> <a href="https://developer.apple.com/swift/" target="_blank"> <img src="https://img.shields.io/badge/Platforms-OS%20X%20%7C%20Linux%20-lightgray.svg?style=flat" alt="Platforms OS X | Linux"> </a> <a href="http://perfect.org/licensing.html" target="_blank"> <img src="https://img.shields.io/badge/License-Apache-lightgrey.svg?style=flat" alt="License Apache"> </a> <a href="http://twitter.com/PerfectlySoft" target="_blank"> <img src="https://img.shields.io/badge/[email protected]?style=flat" alt="PerfectlySoft Twitter"> </a> <a href="http://perfect.ly" target="_blank"> <img src="http://perfect.ly/badge.svg" alt="Slack Status"> </a> </p> This library contains all the reference documentation and API reference-related material you need to run and use Perfect. ## Table of Contents * [Introduction](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/introduction.md) * [Getting Started](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/gettingStarted.md) * [Getting Started From Scratch](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/gettingStartedFromScratch.md) * [An HTTP and Web Services Primer](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/WebServicesPrimer.md) * [Repository Layout](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/repositoryLayout.md) * [Building with Swift Package Manager](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/buildingWithSPM.md) * [Configuring and Launching HTTPServer](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HTTPServer.md) * [Handling Requests](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/handlingRequests.md) * [Routing](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/routing.md) * [HTTPRequest](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HTTPRequest.md) * [Using Form Data](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/formData.md) * [File Uploads](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/fileUploads.md) * [HTTPResponse](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HTTPResponse.md) * [Request &amp; Response Filters](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/filters.md) * [Web Redirect Filters](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/webRedirects.md) * [Sessions](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/sessions.md) * [CSRF Security](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/csrf.md) * [CORS Security](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/cors.md) * [Local Authentication modules](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/authentication.md) * [GSS-SPNEGO Security Feature](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/SPNEGO.md) * [JSON](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/JSON.md) * [Static File Content](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/staticFileContent.md) * [Mustache](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/mustache.md) * [Markdown](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Markdown.md) * [HTTP Request Logging](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HTTPRequestLogging.md) * [CRUD](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/crud.md) * [WebSockets](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/webSockets.md) * [Utilities](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/utilities.md) * [Bytes](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/bytes.md) * [File](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/file.md) * [Dir](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/dir.md) * [Environmental Variables](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/env.md) * [Threading](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/thread.md) * [Networking](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/net.md) @kjessup * [OAuth2 and Providers](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/OAuth2.md) * [UUID](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/UUID.md) * [SysProcess](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/sysProcess.md) * [Log](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/log.md) * [Log Files](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/logFiles.md) * [Remote Logging](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/logRemote.md) * [CURL](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/cURL.md) * [XML](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/xml.md) * [INI](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/ini.md) * [Zip](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/zip.md) * [Crypto](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/crypto.md) * [SMTP](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/SMTP.md) * [Google Analytics Measurement Protocol](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/GoogleAnalytics.md) * [Repeater](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/repeater.md) * [Database Connectors](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/databaseConnectors.md) * [SQLite](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/SQLite.md) * [MySQL](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MySQL.md) * [MariaDB](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MariaDB.md) * [PostgreSQL](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/PostgreSQL.md) * [MongoDB](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MongoDB.md) * [MongoDB Databases](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MongoDB-Database.md) * [MongoDB Collections](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MongoDB-Collections.md) * [MongoDB Client](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MongoDB-Client.md) * [Working with BSON](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MongoDB-BSON.md) * [GridFS](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/MongoDB-GridFS.md) * [CouchDB](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/CouchDB.md) * [LDAP](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/LDAP.md) * [Redis](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Redis.md) @kjessup * [FileMaker](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/filemaker.md) * [iOS Notifications](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/iOSNotifications.md) @kjessup * [Deployment](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/deployment.md) * [Ubuntu](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/deployment-Ubuntu.md) * Docker * [Heroku](https://github.com/PerfectlySoft/Perfect/wiki/Deploying-with-Heroku) * Azure * AWS * Linode * [Digital Ocean](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/deployment-DigitalOcean.md) * Performance Profiling & Remote Monitoring * [SysInfo](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/SYSINFO.md) * [New Relic](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/NEWRELIC.md) * Message Queue & Cluster Control * [Kafka](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Kafka.md) * [Mosquitto](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/mosquitto.md) * [ZooKeeper (Linux Only)](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/ZooKeeper.md) * Big Data / Artificial Intelligence & Machine Learning * [TensorFlow](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/tensorflow.md) * [Hadoop](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Hadoop.md) * [HDFS](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HadoopWebHDFS.md) * [MapReduce Master](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HadoopMapReduceMaster.md) * [MapReduce History](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HadoopMapReduceHistory.md) * [YARN Node Manager](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HadoopYARNNodeManager.md) * [YARN Resource Manager](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/HadoopYARNResourceManager.md) * Platform specific Notes * [Ubuntu 16.04: Starting Services at System Boot](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/starting-services.md) * Language Extensions: * [Python](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/python.md) ## StORM, a Swift ORM StORM is not distributed as a Perfect.org project; however, the Perfect libraries are integral to its operation, and some authors are common. * [StORM, a Swift ORM](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM.md) * [Introduction to StORM](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM.md) * [Setting up a class](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-Setting-up-a-class.md) * [Saving, Retrieving and Deleting Rows](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-Saving-Retrieving-and-Deleting-Rows.md) * [StORMCursor](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-Cursor.md) * [Inserting rows](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-Insert.md) * [Updating rows](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-Update.md) * [StORM Lifecycle Events](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORMLifecycleEvents.md) * Database Specific Implementations * [PostgresStORM](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-PostgreSQL.md) * [SQLiteStORM](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-SQLite.md) * [MySQLStORM](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-MySQL.md) * [Apache CouchDB](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-CouchDB.md) * [MongoDBStoRM](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/StORM-MongoDB.md) ## Perfect Turnstile – an authentication layer for Perfect [Turnstile](https://github.com/stormpath/Turnstile) is an Open Source project from [Stormpath](https://github.com/stormpath) focussing on standardizing authentication across platforms and frameworks. Thanks to work done by [Edward Jiang](https://github.com/edjiang) on Turnstile and a foundation linking Turnstile with Perfect, an authentication layer is available for Perfect. **⚠️NOTE⚠️** Turnstile is out of service as declared by its author, please check [Storm API Migration FAQ](https://stormpath.com/oktaplusstormpath?utm_source=github&utm_medium=readme&utm-campaign=okta-announcement) for more information. * [Perfect-Turnstile](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Turnstile.md) * [Perfect Turnstile with SQLite Integration](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Turnstile.md) * [Perfect Turnstile with PostgreSQL Integration](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Turnstile.md) * [Perfect Turnstile with MySQL Integration](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Turnstile.md) * [Perfect Turnstile with CouchDB Integration](https://github.com/PerfectlySoft/PerfectDocs/blob/master/guide/Turnstile.md)

:books: A curated list of awesome resources : articles, books, videos, tools, podcasts about technical writing

# Awesome Technical Writing [](https://github.com/sindresorhus/awesome) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> [](#contributors-) <!-- ALL-CONTRIBUTORS-BADGE:END -->  > Technical writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, engineering, chemistry, aeronautics, robotics, finance, medical, consumer electronics, biotechnology, and forestry. ~ [Wikipedia](https://en.wikipedia.org/wiki/Technical_writing) *List inspired by the [awesome](https://github.com/sindresorhus/awesome) list and [awesome-jamstack](https://github.com/bolajiayodeji/awesome-jamstack) list* ## Table of Contents - [Community](#community) - [Courses](#courses) - [Resources](#resources) - [Videos](#videos) - [Useful Tools](#useful-tools) - [Conferences](#conferences) - [Speaker Decks](#speaker-decks) - [Books](#books) - [Podcasts](#podcasts) - [Style Guides](#style-guides) - [Technical Writers to Follow](#technical-writers-to-follow) ## Community * [Hashnode](https://hashnode.com/) * [r/technicalwriting](https://www.reddit.com/r/technicalwriting/) * [Google's Season of Docs](https://developers.google.com/season-of-docs/) * [freeCodeCamp News](https://www.freecodecamp.org/news/) * [ycombinator News](https://news.ycombinator.com/) * [DEV](https://dev.to/) * [Hackernoon](https://hackernoon.com/) * [Write the Docs ](https://www.writethedocs.org/) * [The Good Docs Project](https://thegooddocsproject.dev/) * [LinkedIn Technical Writing Community](https://www.linkedin.com/groups/13705342/) * [Society for Technical Communication](https://www.stc.org/) * [LogRocket Blog](https://blog.logrocket.com/) * [Scotch](https://scotch.io/) * [The Manuscript Academy](https://manuscriptacademy.com/) ## Courses * [Study Technical Writing](https://developers.google.com/tech-writing/overview) * [Technical Writing: Documentation on Software Projects](https://www.pluralsight.com/courses/technical-writing-software-documentation) * [Coding for Writers: Basic Programming](https://www.udemy.com/course/coding-for-writers-1-basic-programming/) * [Class Central Technical Writing](https://www.classcentral.com/course/technical-writing-7117) * [Professional Technical Writing: Advance Your Writing Skills](https://www.udemy.com/technical-writing-and-editing/) * [Technical Writing: Master Your Writing Career](https://www.udemy.com/technical-writing/) * [English 305: Advanced Technical Writing](https://study.com/academy/course/technical-writing-course.html) * [Technical Communication Techniques and Principles for Project Managers](https://ce.uwec.edu/programs/technical-communication-techniques-and-principles-project-managers/) * [Learn DITA](https://learningdita.com/) * [Documenting APIs: A Guide for Technical Writers](https://idratherbewriting.com/learnapidoc) ## Resources * [The Ultimate Guide to Content Creation](https://blog.hubspot.com/marketing/content-creation) * [How to Create Great Content: A Step-by-Step Guide to Content Marketing That Delivers Real Results](https://www.inc.com/jeff-haden/how-to-create-great-content-a-step-by-step-guide-to-content-marketing-that-delivers-real-results.html) * [9 Tips to Become the Best Content Creator in Your Industry](https://www.weidert.com/blog/tips-to-make-you-the-best-content-creator-in-your-industry) * [Advice for Technical Writing](https://css-tricks.com/advice-for-technical-writing/) * [Becoming a Technical Writer at Google](https://developers.google.com/tech-writing/becoming) * [15 Tips to Improve Your Technical Writing](https://thebestschools.org/magazine/technical-writing-tips/) * [How to Become a Technical Writer: A Beginner’s Guide](https://www.instructionalsolutions.com/blog/become-a-technical-writer) * [How to Create Cover Images for Your Devblog Posts](https://townhall.hashnode.com/how-to-create-cover-images-for-your-devblog-posts-cjyo53edo000heys1p7iuylpw) * [Introducing Google Season of Docs](https://developers.google.com/season-of-docs/docs) * [How to Start a Software YouTube Channel](https://www.freecodecamp.org/news/how-to-start-a-software-youtube-channel/) * [Starting a YouTube Channel as a Software Developer](https://www.claudiobernasconi.ch/2019/03/20/starting-a-youtube-channel-as-a-software-developer/0) * [How to Create a Programming YouTube Channel - Lessons From 5 Years and 1 Million Subscribers](https://www.freecodecamp.org/news/how-to-start-a-software-youtube-channel-video-course/) * [Developers: The Why and How to Writing Technical Articles](https://www.freecodecamp.org/news/developers-the-why-and-how-to-writing-technical-articles-54e824789ef6/) * [How to Improve the SEO of Your Devblog Articles](https://townhall.hashnode.com/how-to-improve-the-seo-of-your-devblog-articles-cjz3u8lk3003gavs1l071dzoz) * [How to Improve the SEO of Your Devblog](https://townhall.hashnode.com/how-to-improve-the-seo-of-your-devblog-cjz191c0e00380ks1nbtpwh8f) * [Technical Writing: Why and How?](https://medium.com/the-andela-way/technical-writing-why-and-how-599f18477cef) * [Minimalist Approach to Technical Documentation](https://www.utwente.nl/en/bms/ist/minimalism/) * [A beginner’s guide to writing documentation](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/) * [Crash Course in APIs for Technical Writers](https://medium.com/@patford12/crash-course-in-apis-for-technical-writers-694b274a2ad8) * [Technical Writing: What and How?](https://edidiongasikpo.com/technical-writing-what-and-how-ckastwm2705xq4us1l0cbvv2h) * [Write For Us: A List of Companies Who Pay Freelancers for Writing Tutorials](https://github.com/sixhobbits/technical-writing/blob/master/write-for-us.md) * [Technical Writing Books: A Curated Collection of Books to Help You Be a Better Technical Writer](https://github.com/sixhobbits/technical-writing/blob/master/resources.md) * [Everything Technical Writing: Tips and Techniques that'll Help You Thrive as a Technical Writer in the Software Industry](https://www.everythingtechnicalwriting.com/) ## Videos * [Content Creation Strategies: How To Create Content Online](https://www.youtube.com/watch?v=APQoWEqezFc) * [How to start a Coding YouTube channel (with tips from a bunch of successful creators!)](https://www.youtube.com/watch?v=AsTagX5tG4E) * [How To Start A Programming YouTube Channel With Coding Tutorials 360](https://www.youtube.com/watch?v=aeCRHv4XUPU) * [15 Technical Writing Tips](https://www.youtube.com/watch?v=Lw4TKCsIumQ) * [What is Technical Writing? | Writing Genre Fundamentals](https://www.youtube.com/watch?v=9SB4tfD0hxM) * [Meet Technical Writers at Google](https://www.youtube.com/watch?v=qnnkAWP55Ww) * [Technical Writing 101: Introduction to Technical Writing](https://www.youtube.com/watch?v=LTDsgd0ytbE&list=PL9RLbEIB-lv-bRTz14iEK4YSxRzxLQfdx) * [What do Technical Writers do? (Also, what is Technical Writing?)](https://www.youtube.com/watch?v=biocrCx5T_k) * [How to become a Technical Writer | Skills & Career Growth](https://www.youtube.com/watch?v=8l2KJXIBpB0) * [Writing technical documentation](https://www.youtube.com/watch?v=a4L9GhldTHo) * [Write The Docs Podcast & Meetups](https://www.youtube.com/channel/UCUI--N-VWjK93292AaaArCg) * [Write the Readable README](https://www.youtube.com/watch?v=2dAK42B7qtw) * [GitHub as a Landing Page](https://www.youtube.com/watch?v=fXMN4X9B8Rg&feature=youtu.be) * [Lessons Learned From Rebuilding a Developer Documentation Website](https://www.youtube.com/watch?v=s4kS-crtnlQ) * [A Balanced Diet of Documentation](https://www.youtube.com/watch?v=K-ACxb_Iy5k) * [Write your Docs like Nobody Reads Them](https://www.youtube.com/watch?v=ye-hCiJ5_Dg) * [The Developer's Guide to Technical Writing](https://drive.google.com/file/d/1a01iOLh_EYSTdukw_--mFJk-PD_IZXYh/view?fbclid=IwAR0D11PeXf_x4n8KlQJ2XCeY294QHyfnktrfk3cCW2VcSrTsh6zaYisLTqY) * [How to write technical blog posts](https://www.youtube.com/watch?v=YODPgBadj80) * [Technical Writing Portfolio](https://www.youtube.com/watch?v=68ddwfpXHrE) * [How to Document APIs Using Postman](https://youtu.be/d2WAKIKpKlE) ## Podcasts * [The Manuscript Podcast](https://brenobarreto.co/the-manuscript-podcast/) - The intersection of writing and the development of technology products. * [The Manuscript Academy Podcast](https://manuscriptacademy.com/podcast) - Interviews with agents and editors, how-to tips, and behind-the-scenes looks at the creation of the Academy. * [Write the Docs Podcast](https://podcast.writethedocs.org/) - The Write the Docs Podcast publishes discussion-style podcasts focusing on topics related to the Write the Docs community. * [The Not-Boring Tech Writer](https://www.thenotboringtechwriter.com/) - The Not-Boring Tech Writer podcast introduces technical writers skills used in the open data movement. ## Useful Tools * [technical-writing-template](https://github.com/BolajiAyodeji/technical-writing-template) - A sample template for writing a technical article. * [HackMD](https://hackmd.io/) - Real-time collaborate on technical documentation in markdown. * [Dropbox Paper](https://www.dropbox.com/paper) - A flexible workspace for collaborative document-editing. * [Google Docs](https://docs.google.com/) - Smart editing and styling tools to help you easily format text and paragraphs. * [Notion](https://notion.so) - The all-in-one workspace for your notes, tasks, wikis and databases. * [Grammarly](https://www.grammarly.com/) - a writing assistant that goes deeper than grammar to offer you comprehensive writing feedback. * [Canva](https://www.canva.com/) - A graphic design platform that allows you to create social media graphics, and other visual content. * [TinyPNG](https://tinypng.com/) - Smart PNG and JPEG image compression. * [Full Page Screen Capture](https://chrome.google.com/webstore/detail/full-page-screen-capture/fdpohaocaechififmbbbbbknoalclacl?hl=en) - The simplest way to take a full page screenshot of your current browser window. * [Awesome Screenshot: Screen Video Recorder](https://chrome.google.com/webstore/detail/awesome-screenshot-screen/nlipoenfbbikpbjkfpfillcgkoblgpmj?hl=en) - Screen Capture full page screenshot and recorder for screencast. * [Readme Markdown Generator](https://github.com/kefranabg/readme-md-generator) - CLI that generates beautiful README.md files. * [Capture to a Gif](https://chrome.google.com/webstore/detail/capture-to-a-gif/eapecadlmfblmnfnojebefkbginhggeh) - Record content of pages to an animated gif picture from browser. * [Microsoft Word](https://www.microsoft.com/en/microsoft-365/word) - Goes beyond checking spelling and grammar, intelligent suggestions is also included to assist you across documents, email, and on the web. * [Log4brains](https://github.com/thomvaill/log4brains) - Docs-as-code knowledge base to manage Architecture Decision Records (ADR) for your project and publish them automatically as a static website. * [Antidote](https://www.antidote.info/en) - The corrector analyzes your text and flags any detections. * [LanguageTool](https://languagetool.org/) - Open-source writing assistant, an alternative to Grammarly. * [HemingwayApp](https://hemingwayapp.com/) - Hemingway App makes your writing bold and clear. Helps fix long & complex sentences ## Conferences * [Write the Docs Conferences](https://www.writethedocs.org/conf/) * [The LavaCon Content Strategy Conference ](https://lavacon.org/) * [API the Docs](https://apithedocs.org/) * [Technical Communication UK Metro Conference](http://technicalcommunicationuk.com/) * [MadWorld](https://www.madcapsoftware.com/madworld-conferences/) * [WritersUA West Content Pro Conference](http://west.writersua.com/) ## Speaker Decks * [Effective Documentation: The Key to Open Source Growth](https://slides.com/bolajiayodeji/effective-oss-docs) * [Technical Writing for Non-Writers](https://speakerdeck.com/taroth21/technical-writing-for-non-writers) * [Beyond The Editor: Automating Your Writing Process](https://slides.com/bolajiayodeji/beyond-the-editor) ## Books * [The Developer's Guide to Content Creation](https://www.developersguidetocontent.com/) - by Stephanie Morillo * [The Developer's Guide to Creating a Successful Blog](https://gumroad.com/l/successfulblog) - by Flavio Copes * [Everybody Writes](https://www.goodreads.com/book/show/23001125-everybody-writes) - by Ann Handley * [Technical Writing for Dummies](http://www.amazon.co.uk/Technical-Writing-Dummies-Sheryl-Lindsell-Roberts/dp/0764553089/ref=sr_1_1?ie=UTF8&s=books&qid=1283958591&sr=8-1) - by Sheryl Lindsell-Roberts * [The Handbook of Technical Writing](https://www.amazon.com/gp/aw/d/1457675528/ref=cm_cr_arp_mb_bdcrb_top?ie=UTF8) - by Gerald J. Alre * [How To Write Usable User Documentation, 2nd Edition](https://www.amazon.com/How-Write-Usable-User-Documentation/dp/0897746392/ref=sr_1_1) - by Edmond H. Weiss * [Letting Go of the Words](https://www.goodreads.com/book/show/1135441.Letting_Go_of_the_Words) by Janice Redish * [Docs Like Code](https://www.amazon.com/Docs-Like-Code-Anne-Gentle/dp/1365816079) by Anne Gentle * [The Product is Docs](https://www.goodreads.com/book/show/37563319-the-product-is-docs) by Christopher Gales * [Every Page is Page One](https://www.amazon.com/Every-Page-One-Topic-Based-Communication/dp/1937434281) by Mark Baker * [Modern Technical Writing: An Introduction to Software ](https://www.amazon.com/Modern-Technical-Writing-Introduction-Documentation-ebook/dp/B01A2QL9SS/ref=sr_1_1?crid=Y7S35M7LVXWE&dchild=1&keywords=modern+technical+writing&qid=1595414707&sprefix=modern+technical+%2Caps%2C346&sr=8-1)- by Andrew Etter ## Style Guides * [Microsoft Manual of Style](https://ptgmedia.pearsoncmg.com/images/9780735648715/samplepages/9780735648715.pdf) * [IBM Editorial Style Guide](http://ptgmedia.pearsoncmg.com/images/9780132101301/samplepages/0132101300.pdf) * [The Red Hat Style Guide](https://stylepedia.net/style/) * [Google Developer Documentation Style Guide](https://developers.google.com/style/) <details> <summary> ## Technical Writers to follow </summary> | Name | Link to Blog | Blog Niche | Link to Twitter | |-------------------|--------------------------------------------------------------------------|----------------------------------|-------------------------------------------------------| | Bolaji Ayodeji | https://blog.bolajiayodeji.com | Web Development, JAMstack, A11y | [@iambolajiayo](https://twitter.com/iambolajiayo) | | Angie Jones | https://angiejones.tech | Test Automation, Java | [@techgirl1908](https://twitter.com/techgirl1908) | | Sarah Drasner | https://sarah.dev/writing | Web Development, Vuejs, SVGs | [@sarah_edo](https://twitter.com/sarah_edo) | | Prosper Otemuyiwa | https://medium.com/@unicodeveloper | All things Technical & Magical | [@unicodeveloper](https://twitter.com/unicodeveloper) | | Ire Aderinokun | https://bitsofco.de | Frontend Development, JavaScript | [@ireaderinokun](https://twitter.com/ireaderinokun) | | Tom Johnson | https://idratherbewriting.com | Technical Writing and API lessons| [@tomjohnson](https://twitter.com/tomjohnson) | | Anne Gentle | https://justwriteclick.com | Doc as Code | [@annegentle](https://twitter.com/annegentle) | | Kayce Basques | https://kayce.basqu.es/blog | Dev tools and Documentation | [@kaycebasques](https://twitter.com/kaycebasques) | | Tania Rascia | https://taniarascia.com | Modern JavaScript, Node.js, and development | [@taniarascia](https://twitter.com/taniarascia) | | SWYX | https://swyx.io/writing | Web Development, React and Tech | [@swyx](https://twitter.com/swyx) | | Sean C Davis | https://cobwwweb.com/ | Web Development, JamStack | [@seancdavis29](https://twitter.com/seancdavis29) | | Alvaro Montoro | https://dev.to/alvaromontoro | css, html | [@alvaro_montoro](https://twitter.com/alvaro_montoro) | | Linda Ikechukwu | https://www.everythingtechnicalwriting.com/ | Technical Writing and Developer Documentation | [@_mslinda](https://twitter.com/_MsLinda)| | Amruta Ranade | https://www.youtube.com/c/AmrutaRanade | Technical Writing and Developer Documentation | [@AmrutaRanade](https://twitter.com/AmrutaRanade) | </details> ## Contributing Found an awesome technical writer, resource, article, blog, tool, video, speaker deck etc.? Please send me a pull request and follow the [contributors guidelines](/CONTRIBUTING.md). ## Contributors ✨ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://www.patreon.com/bolajiayodeji"><img src="https://avatars2.githubusercontent.com/u/30334776?v=4?s=100" width="100px;" alt="Bolaji Ayodeji"/><br />_{<b>Bolaji Ayodeji</b>}</a><br /><a href="#content-BolajiAyodeji" title="Content">🖋</a> <a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=BolajiAyodeji" title="Documentation">📖</a> <a href="#design-BolajiAyodeji" title="Design">🎨</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/prachford"><img src="https://avatars2.githubusercontent.com/u/59001653?v=4?s=100" width="100px;" alt="prachford"/><br />_{<b>prachford</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=prachford" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://iamjude.xyz"><img src="https://avatars3.githubusercontent.com/u/44995419?v=4?s=100" width="100px;" alt="Jude J Obiejesi"/><br />_{<b>Jude J Obiejesi</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=JaybeeClassical" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://medium.com/@patford12"><img src="https://avatars0.githubusercontent.com/u/64233065?v=4?s=100" width="100px;" alt="Patrick Rachford"/><br />_{<b>Patrick Rachford</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=rachfop" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="http://edidiongasikpo.com/"><img src="https://avatars1.githubusercontent.com/u/28895379?v=4?s=100" width="100px;" alt="Didicodes"/><br />_{<b>Didicodes</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=edyasikpo" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/browncrussell"><img src="https://avatars3.githubusercontent.com/u/70669410?v=4?s=100" width="100px;" alt="browncrussell"/><br />_{<b>browncrussell</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=browncrussell" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://dwyer.co.za"><img src="https://avatars2.githubusercontent.com/u/2641205?v=4?s=100" width="100px;" alt="Gareth Dwyer"/><br />_{<b>Gareth Dwyer</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=sixhobbits" title="Documentation">📖</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://peterthaleikis.com"><img src="https://avatars0.githubusercontent.com/u/8433587?v=4?s=100" width="100px;" alt="Peter Thaleikis"/><br />_{<b>Peter Thaleikis</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=spekulatius" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://genesisgabiola.now.sh/"><img src="https://avatars0.githubusercontent.com/u/8042418?v=4?s=100" width="100px;" alt="Genesis Gabiola"/><br />_{<b>Genesis Gabiola</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=genesisgabiola" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://bluebricks.dev"><img src="https://avatars2.githubusercontent.com/u/8985674?v=4?s=100" width="100px;" alt="Thomas Vaillant"/><br />_{<b>Thomas Vaillant</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=thomvaill" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.sipakov.com"><img src="https://avatars.githubusercontent.com/u/34224178?v=4?s=100" width="100px;" alt="Rostyslav Sipakov"/><br />_{<b>Rostyslav Sipakov</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=rsipakov" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://codewithlinda.com"><img src="https://avatars.githubusercontent.com/u/32891838?v=4?s=100" width="100px;" alt="Linda Ikechukwu"/><br />_{<b>Linda Ikechukwu</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=Linda-Ikechukwu" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="http://linkedin.com/in/sojin-samuel/"><img src="https://avatars.githubusercontent.com/u/77185816?v=4?s=100" width="100px;" alt="Sojin"/><br />_<b>Sojin</b></a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=SojinSamuel" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://ezefizzy.herokuapp.com"><img src="https://avatars.githubusercontent.com/u/57665815?v=4?s=100" width="100px;" alt="Ezefizzy"/><br />_{<b>Ezefizzy</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/pulls?q=is%3Apr+reviewed-by%3AEzekiel8807" title="Reviewed Pull Requests">👀</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/aucolins"><img src="https://avatars.githubusercontent.com/u/25918652?v=4?s=100" width="100px;" alt="Colin Sheppard"/><br />_{<b>Colin Sheppard</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/issues?q=author%3Aaucolins" title="Bug reports">🐛</a></td> <td align="center" valign="top" width="14.28%"><a href="http://bhupesh.me"><img src="https://avatars.githubusercontent.com/u/34342551?v=4?s=100" width="100px;" alt="Bhupesh Varshney"/><br />_{<b>Bhupesh Varshney</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=Bhupesh-V" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/duskmushroom"><img src="https://avatars.githubusercontent.com/u/106955770?v=4?s=100" width="100px;" alt="DMoosh"/><br />_{<b>DMoosh</b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=duskmushroom" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://birdboybolu.github.io/BoluwatifeVictor/"><img src="https://avatars.githubusercontent.com/u/95125924?v=4?s=100" width="100px;" alt="Boluwatife Victor "/><br />_{<b>Boluwatife Victor </b>}</a><br /><a href="https://github.com/BolajiAyodeji/awesome-technical-writing/commits?author=BirdboyBolu" title="Documentation">📖</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END --> --- **Check out my [blog](https://blog.bolajiayodeji.com), [newsletter](https://bawd.bolajiayodeji.com), or say *hi* on [Twitter](https://twitter.com/iambolajiayo).** ## License <a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

The book documenting the curl project, the curl tool, libcurl and more. Simply put: everything curl.

# Introduction *Everything curl* is an extensive guide for all things curl. The project, the command-line tool, the library, how everything started and how it came to be the useful tool it is today. It explains how we work on developing it further, what it takes to use it, how you can contribute with code or bug reports and why millions of existing users use it. This book is meant to be interesting and useful to both casual readers and somewhat more experienced developers. It offers something for everyone to pick and choose from. Do not try to read it from front to back. Read the chapters or content you are curious about and flip back and forth as you see fit. I hope to run this book project as I do all other projects I work on: in the open, completely free to download and read. I want it to be free for anyone to comment on, and available for everyone to contribute to and help out with. Send your bug reports, pull requests or critiques to me and I will improve this book accordingly. This book will never be finished. I intend to keep working on it. While I may at some point consider it fairly complete, covering most aspects of the project (even if only that seems like an insurmountable goal), the curl project will continue to move so there will always be things to update in the book as well. This book project started at the end of September 2015. ## Site [https://everything.curl.dev](https://everything.curl.dev) is the home of this book. It features accessible links to read the book online in a web version, or download a PDF version for offline reading. Unfortunately, the previously provided ebook formats are no longer provided by gitbook.com that we use to produce the book. (The "export PDF" option menu is only visible if the used web browser is wide enough.) ## Content All book content is hosted on GitHub in the [https://github.com/bagder/everything-curl](https://github.com/bagder/everything-curl) repository. ## Author With the hope of becoming just a co-author of this material, I am Daniel Stenberg. I founded the curl project and I am a developer at heart—for fun and profit. I live and work in Stockholm, Sweden. All there is to know about Daniel can be found on [daniel.haxx.se](https://daniel.haxx.se/). ## Contribute If you find mistakes, omissions, errors or blatant lies in this document, please send us a refreshed version of the affected paragraph and we will amend and update. We give credits to and recognize everyone who helps out! Preferably, you could submit [errors](https://github.com/bagder/everything-curl/issues) or [pull requests](https://github.com/bagder/everything-curl/pulls) on the book's GitHub page. ## Contributors Lots of people have reported bugs, improved sections or otherwise helped making this book the success it is. These friends include the following: AaronChen0 on github, alawvt on github, Amin Khoshnood, amnkh on github, Anders Roxell, Angad Gill, Aris (Karim) Merchant, auktis on github, Ben Bodenmiller Ben Peachey, bookofportals on github, Bruno Baguette, Carlton Gibson, Chris DeLuca, Citizen Esosa, Dan Fandrich, Daniel Brown, Daniel Sabsay, David Piano, DrDoom74 at GitHub, Emil Hessman, enachos71 on github, ethomag on github, Fabian Keil, faterer on github, Frank Dana, Frank Hassanabad, Gautham B A, Geir Hauge, Harry Wright, Helena Udd, Hubert Lin, i-ky on github, infinnovation-dev on GitHub, Jay Ottinger, Jay Satiro, Jeroen Ooms, Johan Wigert, John Simpson, JohnCoconut on github, Jonas Forsberg, Josh Vanderhook, JoyIfBam5, KJM on github, knorr3 on github, lowttl on github, Luca Niccoli, Manuel on github, Marius Žilėnas, Mark Koester, Martin van den Nieuwelaar, mehandes on github, Michael Kaufmann, Ms2ger, Nick Travers, Nicolas Brassard, Oscar on github, Oskar Köök, Patrik Lundin, RekGRpth on github, Ryan McQuen, Saravanan Musuwathi Kesavan, Senthil Kumaran, Shusen Liu, Sonia Hamilton, Spiros Georgaras, Stephen, Steve Holme, Stian Hvatum, strupo on github, Viktor Szakats, Vitaliy T, Wayne Lai, Wieland Hoffmann, 谭九鼎 ## License This document is licensed under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/).

A curated list of Game Boy development resources such as tools, docs, emulators, related projects and open-source ROMs.

#  Awesome Game Boy Development #### [Join us on Discord](https://discord.gg/tKGMPNr) [](https://discord.gg/tKGMPNr) A curated list of awesome Game Boy (Color) Development resources, tools, docs, related projects and open-source ROMs. Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing. You can find a (way cooler) web version of this list [here](https://gbdev.github.io/resources). ## Contents - [Introduction](#introduction) - [Disambiguation](#disambiguation) - [Community](#community) - [Documentation](#documentation) - [Misc](#misc) - [Opcodes](#opcodes) - [Game Boy Color](#game-boy-color) - [Hardware](#hardware) - [Peripherals](#peripherals) - [Cartridges](#cartridges) - [Emulator Development](#emulator-development) - [Testing](#testing) - [Software Development](#software-development) - [Assemblers](#assemblers) - [Compilers](#compilers) - [Experimental/Proof of Concepts](#experimentalproof-of-concepts) - [Emulators](#emulators) - [Tools](#tools) - [Engines](#engines) - [Development tools](#development-tools) - [Graphics utilities](#graphics-utilities) - [Hardware and ROM utilities](#hardware-and-rom-utilities) - [Music drivers and trackers](#music-drivers-and-trackers) - [Programming](#programming) - [ASM](#asm) - [Sources](#sources) - [Timings](#timings) - [Boilerplates](#boilerplates) - [Syntax highlighting packages](#syntax-highlighting-packages) - [C](#c) - [Homebrews](#homebrews) - [ASM](#asm-1) - [C](#c-1) - [GB Studio](#gb-studio) - [Demos](#demos) - [Reverse Engineering](#reverse-engineering) - [Game Disassemblies](#game-disassemblies) - [Game Boy Camera](#game-boy-camera) - [Retrieving Images](#retrieving-images) - [Changing the camera's behavior](#changing-the-cameras-behavior) - [Post-processing](#post-processing) - [Related projects](#related-projects) - [Directories](#directories) - [Websites](#websites) - [About](#about) - [Contribute](#contribute) - [License](#license) - [Acknowledgements](#acknowledgements) - [Sponsors](#sponsors) ## Introduction - [The Game Boy, a hardware autopsy](https://www.youtube.com/playlist?list=PLu3xpmdUP-GRDp8tknpXC_Y4RUQtMMqEu) - [The Ultimate Game Boy Talk](https://media.ccc.de/v/33c3-8029-the_ultimate_game_boy_talk) > ### Disambiguation > > #### Game Boy Advance > > Game Boy Advance development is covered by another project, the [awesome-gbadev](https://github.com/gbdev/awesome-gbadev) list. > GBA, however, *can run* GB/GBC games. It does so in a slightly different way compared to native hardware: this is covered in the Emulator Development section of this list. > > #### Game Boy Color and Super Game Boy > > This list is focused on the original *Game Boy* (GB or DMG, 1989), the *Game Boy Color* (GBC or CGB) and the *Super Game Boy* (SGB) are very similar systems, with a few important distinctions, such as: > >- Different hardware specifications; >- Specific hardware and software features; >- Specific registers; >- Specific bugs, quirks and exploitable behaviours. > >If you aim to develop your software for SGB or GBC, or you want to know how it runs on the other systems, you may want to take advantage and adapt to these differences, check the [Game Boy Color](#game-boy-color) category and look for specific references to GBC/CGB and SGB. ## Community - [Chat channels](https://gbdev.io/chat) - [Forum](https://gbdev.gg8.se/forums/) ## Documentation - [**Pan Docs**](https://gbdev.github.io/pandocs/) - The single, most comprehensive technical reference to Game Boy available to the public. Corrected, updated and maintained by the community. - [The Cycle-Accurate Game Boy Docs](https://github.com/AntonioND/giibiiadvance/blob/master/docs/TCAGBD.pdf) - A precise documentation by AntonioND to make a cycle-accurate Game Boy emulator. - [Complete Technical Reference](https://gekkio.fi/files/gb-docs/gbctr.pdf) - by Gekkio. - [Game Boy Architecture: A Practical Analysis](https://www.copetti.org/writings/consoles/game-boy/) - by Rodrigo Copetti. - [Game Boy Project Report](http://www.cs.columbia.edu/~sedwards/classes/2019/4840-spring/reports/GameBoy.pdf) - Report of an hardware [emulator](https://github.com/kitsuneh/SVGameBoy) (on a Terasic DE1-SoC Board) developed as final project for the CSEE4840 Embedded Systems Design course at Columbia University. #### Opcodes - [gb-opcodes](https://gbdev.github.io/gb-opcodes/optables/) - Opcodes table - [RGBDS opcodes reference](https://rgbds.gbdev.io/docs/gbz80.7) - A reference of all instructions, including short descriptions, cycle and byte counts, and explanations of flag modifications. ### Game Boy Color - [Bootstrap ROM](https://tcrf.net/Game_Boy_Color_Bootstrap_ROM) - [Unused Palettes](https://tcrf.net/Notes:Game_Boy_Color_Bootstrap_ROM) - [Colorization palettes in the BIOS](https://forums.nesdev.com/viewtopic.php?p=114388&sid=c3d4ce08cfd9d9c834958d4f148750c3#p114388) - [Boot ROM Disassembly](https://gist.github.com/drhelius/6063265) - [GBC Hicolour notes](https://romhack.github.io/doc/gbcHiColour/) - A technical note regarding Hicolour mode trick for Game Boy Color and its realization in the GBC game “Crystalis”. ### Hardware - [DMG Schematics](http://gbdev.gg8.se/wiki/articles/DMG_Schematics) - Hardware schematics. - [The Game Boy Project](http://marc.rawer.de/Gameboy/Docs/GBProject.pdf) - Provides a study on the hardware and detailed constructional information for the implementation of three 8-bit bidirectional parallel ports. - [Related custom hardware](https://github.com/Gekkio/gb-hardware) - by Gekkio. - [ESP8266 GB Dev Board](https://github.com/applefreak/esp8266-gameboy-dev-board) - Dev board for Game Boy accessories development, powered by ESP8266. - [ESP8266 GB Printer](https://github.com/applefreak/esp8266-gameboy-printer) - A device that emulates the GB Printer and lets you retrieve images using WiFi. - [fruttenboel](http://verhoeven272.nl/fruttenboel/Gameboy/index.html) - Page with loads of information on the hardware, custom boards to interface with the console and other related projects. - [Game Boy hardware database](https://gbhwdb.gekkio.fi/) - Data and photos of various types of Game Boy consoles. - [dmg-schematics](https://github.com/msinger/dmg-schematics) - Schematics and annotated overlay for the DMG-CPU B chip, extracted from die photos, made with KiCad. Also contains Electric VLSI library with layouts for some of the cells and memories. ### Peripherals - [Dan Docs](https://shonumi.github.io/dandocs.html) - Obscure Game Boy hardware documentation. - [Edge of Emulation](https://shonumi.github.io/articles.html), a series of articles about emulating and investigating Game Boy accessories. Also available as [technical documents](https://github.com/shonumi/gbe-plus/tree/master/src/docs/technical) in the GBE- emulator documentation. - [Mobile Adapter GB](https://shonumi.github.io/articles/art14.html) - Internet connectivity and DLC on the Game Boy Color. - [The Game Boy Printer](https://shonumi.github.io/articles/art2.html) - [Pocket Sonar](https://shonumi.github.io/articles/art13.html) - A blue cart with built-in sonar hardware. - [Zok Zok Heroes](https://shonumi.github.io/articles/art8.html) - Zok Zok Heroes' Full Changer, a motion-activated accessory. - [Infrared Madness](https://shonumi.github.io/articles/art11.html) - Infrared communication on the Game Boy Color. - [Game Boy 4-Player Adapter](https://shonumi.github.io/articles/art9.html) - DMG-07. - [Barcode Boy](https://shonumi.github.io/articles/art7.html) - The first Game Boy card-scanner. - [Barcode Taisen Bardigun](https://shonumi.github.io/articles/art6.html) - A late 90s DMG-GBC barcode reader. - [DMG-07 Technical Documentation](https://raw.githubusercontent.com/shonumi/gbe-plus/master/src/docs/technical/DMG_07.txt) - [Game Boy Camera RE](https://github.com/AntonioND/gbcam-rev-engineer) - Documentation about GB Camera and tools used to reverse engineer it by using Arduino. - [Creating photo realistic images with neural networks and a Gameboy Camera](http://www.pinchofintelligence.com/photorealistic-neural-network-gameboy/) - [The Game Boy Printer](https://shonumi.github.io/articles/art2.html) - An in-depth technical document about the printer hardware, the communication protocol and the usual routine that games used for implementing the print feature. - [Ben Heck Reverse Engineers Game Boy Printer](https://www.youtube.com/watch?v=43FfJvd-YP4) (Errata: the used thermal paper is expired, 4 colors are actually printable). - [Arduino Game Boy Printer Emulator](https://github.com/mofosyne/arduino-gameboy-printer-emulator) - Emulating a Game Boy Printer via the Game Boy Link cable with an Arduino. - [Mobile Game Boy Adapter](https://bulbapedia.bulbagarden.net/wiki/Mobile_Game_Boy_Adapter) - [GB KISS LINK MODEM](http://nectaris.tg-16.com/GB-KISS-LINK-FAQ-hudson-gameboy-nectaris.html) ### Cartridges - [GB Flash Cartridges for Sale](https://bbbbbr.github.io/GameBoy-Flash-Carts/) - A List of available, ready-made Game Boy Flash Cartridges. - [AntonioND's docs](https://github.com/AntonioND/giibiiadvance/tree/master/docs) - Corrected schematics and infos on cartridge header data. - [Gekkio's Game Boy cartridge types](http://gekkio.fi/blog/2015-02-14-mooneye-gb-gameboy-cartridge-types.html) - An overview on existing cartridge types. - Gekkio's cartridge analysis: - [DMG-BEAN-02](http://gekkio.fi/blog/2015-05-18-mooneye-gb-cartridge-analysis-dmg-bean-02.html); - [MBC1](http://gekkio.fi/blog/2015-05-17-mooneye-gb-cartridge-analysis-fortress-of-fear.html); - [no MBC](http://gekkio.fi/blog/2015-02-28-mooneye-gb-cartridge-analysis-tetris.html). - Pinout, registers descriptions and VHDL code of some cartridge types on Tauwasser's wiki: - [MBC1](https://wiki.tauwasser.eu/view/MBC1) - [MBC2](https://wiki.tauwasser.eu/view/MBC2) - [MMM01](https://wiki.tauwasser.eu/view/MMM01) - [Game Boy Cartridges Schematics](http://www.devrs.com/gb/files/gb.html) - Schematics for MBC2 and MBC3 types. - [Cartridges PCB photos](https://imgur.com/a/D5bpC) - [MBC1+RAM+Battery cartridge Schematic](http://www.devrs.com/gb/files/mbc1.gif) - First schematics by Jeff Frohwein. - [MBC1 and MBC2 cartridges circuits](http://fms.komkon.org/GameBoy/Tech/Carts.html) - and explanation on how these MBC bank switch and control RAM. - [GB Rom List](CartridgeList.csv) - Navigable table of every game released with details on their cartridges. - [Game Boy cartridge PCB photos](http://gekkio.fi/blog/2016-03-19-game-boy-cartridge-pcb-photos.html) #### Custom cartridges - [Emulating a GameBoy Cartridge](https://dhole.github.io/post/gameboy_cartridge_emu_1/) - Emulating the functionality of a Game Boy cartridge with the development board STM32F4. - [Wolf](http://www.happydaze.se/wolf/) - Game Boy cartridge with co-processor. - [Homebrew-Gameboy-Cartridge](https://github.com/dwaq/Homebrew-Gameboy-Cartridge) - Eagle library, schematic, and board files for a cartridge PCB using an Atmel AT49F040 as ROM. - [Homebrew Gameboy Color Cartridge](https://github.com/Xyl2k/Gameboy-Color-Cartridge) - Board layout for an EEPROM powered cartridge. - [Nekocart](https://github.com/zephray/NekoCart-GB) - Open-source flash cartridge using an Xilinx CPLD as MBC5 ([Post](https://hackaday.io/project/41160-nekocart-cpld-gameboy-cartridge)). - [Reiner Ziegler's Game Boy page](http://reinerziegler.de.mirrors.gg8.se/) - Commercial and homemade programmable cartridges and programming systems. Tutorials, wiring and schematics provided. - [Gameboy-MBC5-MBC1-Hybrid](https://github.com/insidegadgets/Gameboy-MBC5-MBC1-Hybrid) - CPLD implementation of a MBC5/MBC1 Hybrid cartridge. #### Misc - [Introduction to Game Boy Hacking](http://pepijndevos.nl/sha2017/workshop.pdf) - Workshop introducing basic assembly, debugging and reverse engineering. - [GBSOUND.txt](https://github.com/bwhitman/pushpin/blob/master/src/gbsound.txt) - A document detailing the Game Boy sound engine. - [gbdev FAQs](http://www.devrs.com/gb/files/faqs.html) - Must read by Jeff Frohwein. - [Game Boy Bootrom](http://www.neviksti.com/DMG/DMG_ROM.asm) - Commented dump of the DMG bootrom. - [Differences between the Z80 and the gameboy's processor](http://www.z80.info/z80gboy.txt) - [Gameboy 2BPP Graphics Format](http://www.huderlem.com/demos/gameboy2bpp.html) - Information on how the Game Boy interprets VRAM tile data to color pixels. ## Emulator Development - [Reverse Engineering fine details of Game Boy hardware](https://www.youtube.com/watch?v=GBYwjch6oEE) - 43 minutes talk by Gekkio given at Disobey 2018 ([errata](https://gekkio.fi/blog/2018-02-05-errata-for-reverse-engineering-fine-details-of-game-boy-hardware.html)). - [Emulation of Nintendo Game Boy](https://github.com/Baekalfen/PyBoy/blob/master/PyBoy.pdf) - Overview of the Game Boy hardware with the perspective of building an emulator. - [DMG-01](https://rylev.github.io/DMG-01/public/book/) - An educational Gameboy Emulator in Rust and a companion book explaining its development. *[Oh Boy! Creating a Game Boy Emulator in Rust](https://media.ccc.de/v/rustfest-rome-3-gameboy-emulator)- is a talk given at Rust Fest 18 about this. - [Building a Game Boy emulator in JavaScript](http://imrannazar.com/gameboy-Emulation-in-JavaScript) - Step by step tutorial. - [Writing a Game Boy emulator, Cinoop](https://cturt.github.io/cinoop.html) - [0dmg](https://jeremybanks.github.io/0dmg/2018/05/23/getting-started.html) - Learning Rust by building a partial Game Boy emulator. - [RealBoy Emulator](https://realboyemulator.wordpress.com/posts/) - A series of posts about the design and implementation of the RealBoy Emulator. - [Codeslinger](http://www.codeslinger.co.uk/pages/projects/gameboy.html) - Another series of posts documenting the building of an emulator. - [Why did I spend 1.5 months creating a Gameboy emulator?](http://blog.rekawek.eu/2017/02/09/coffee-gb/) - Blog post. - [binjgb rewind](https://binji.github.io/2017/12/31/binjgb-rewind.html) - Implementing a *rewind- feature. - [binjgb on the web](https://binji.github.io/2017/02/26/binjgb-on-the-web-part-1.html) - Porting of the binjgb emulator to Web Assembly. [(Part 2)](https://binji.github.io/2017/02/27/binjgb-on-the-web-part-2.html) - [binjgb debugging hangs](https://binji.github.io/2017/05/03/debugging-hangs.html) - Investigations on emulations quirks. - [Decoding Gameboy Z80 opcodes](https://gb-archive.github.io/salvage/decoding_gbz80_opcodes/Decoding%20Gamboy%20Z80%20Opcodes.html) - How to algorithmically decode Game Boy instructions (as opposed to writing one huge switch-case statement). - [Porting a GO Game Boy emulator to WebAssembly](https://djhworld.github.io/post/2018/09/21/i-ported-my-gameboy-color-emulator-to-webassembly/) - [About swotGB](https://mitxela.com/projects/swotgb/about) - Notes about the development of a Game Boy emulator in JavaScript. - [List of open source emulators](EMULATORS.md) - [Game Boy Doctor](https://github.com/robert/gameboy-doctor) - A command line tool for comparing logs from your emulator to those from a known-correct one. Useful for line-by-line debugging of Blargg's test ROMs. ### Testing - [Blargg's test roms](http://gbdev.gg8.se/files/roms/blargg-gb-tests/) - [Gekkio's test roms](https://gekkio.fi/files/mooneye-gb/latest/) - [SameSuite](https://github.com/LIJI32/SameSuite) - [Mealybug Tearoom Tests](https://github.com/mattcurrie/mealybug-tearoom-tests) - [GB Accuracy Tests](http://tasvideos.org/EmulatorResources/GBAccuracyTests.html) - [144p Test Suite](https://github.com/pinobatch/240p-test-mini/tree/master/gameboy) - Port of Artemio Urbina's 240p Test Suite to the Game Boy. - [MBC3 RTC test ROM](https://github.com/aaaaaa123456789/rtc3test) - [dmg-acid2](https://github.com/mattcurrie/dmg-acid2) and [cgb-acid2](https://github.com/mattcurrie/cgb-acid2) - Basic PPU rendering tests. ## Software Development The [Choosing tools for Game Boy development](https://gbdev.io/guides/tools.html) essay provides an overview of the available development tools for Game Boy. ### Assemblers - [RGBDS](https://github.com/gbdev/rgbds) - Assembler and linker package. [Documentation](https://rgbds.gbdev.io/docs/). - [ASMotor](https://github.com/csoren/asmotor) - Assembler engine and development system targeting Game Boy, among other CPUs. Written by the original RGBDS author. [Documentation](https://github.com/asmotor/asmotor/tree/develop#further-reading). - [wla-dx](https://github.com/vhelin/wla-dx) - Yet Another GB-Z80/Z80/... Multi Platform Cross Assembler Package. [Documentation](http://www.villehelin.com/wla.txt). ### Compilers - [GBDK](https://github.com/gbdk-2020/gbdk-2020/) - Maintained and modernized GBDK (Game Boy Development Kit) powered by an updated version of the SDCC toolchain. Provides a C compiler, assembler, linker and a set of libraries. - [API docs: Getting Started](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_getting_started.html) - [Examples](https://github.com/mrombout/gbdk_playground) - [Documentation, links and tools](https://gbdk-2020.github.io/gbdk-2020/docs/api/docs_links_and_tools.html) - [Turbo Rascal Syntax Error](https://lemonspawn.com/turbo-rascal-syntax-error-expected-but-begin/) - Complete suite (IDE, compiler, programming language, resource editor) intended for developing games/demos for 8 / 16-bit line of computers, including the Game Boy and Game Boy Color. #### Experimental/Proof of Concepts - [RGBDS-Live](https://daid.github.io/rgbds-live/) - In-browser coding environment to try out RGBDS. - [Wiz](https://github.com/wiz-lang/wiz) - A high-level assembly language for writing homebrew on retro console platforms (Game Boy, NES, Atari 2600, and more). - [gbforth](https://github.com/ams-hackers/gbforth) - A Forth-based Game Boy development kit. - [gbasm-rs](https://gitlab.com/BonsaiDen/gbasm-rs) - An opinionated Rust based compiler for Game Boy z80 assembly code. - [gbasm](https://github.com/BonsaiDen/gbasm) - A JavaScript based compiler for Game Boy z80 assembly code. - [tniASM](http://www.tni.nl/products/tniasm.html) - Macro Assembler. - [Assembler](https://github.com/ulrikdamm/Assembler) - Assembler written in Swift. - [llvm-gbz80](https://github.com/Bevinsky/llvm-gbz80) / [clang-gbz80](https://github.com/Bevinsky/clang-gbz80) - Clang/LLVM port to the GBZ80 CPU (similar to the deprecated [euclio/llvm-gbz80](https://github.com/euclio/llvm-gbz80)). - [gbdk-go](https://github.com/pokemium/gbdk-go) - A compiler translates Go programs to C code. The output C code is built into GB ROM by GBDK. ### Emulators - [BGB](https://bgb.bircd.org/) - Powerful emulator and debugger. Provides an accurate hardware emulation. - [SameBoy](https://github.com/LIJI32/SameBoy) - Accurate emulator with a wide range of powerful debugging features. - [Mooneye GB](https://github.com/Gekkio/mooneye-gb) - Research project and emulator in Rust. - [mGBA](https://github.com/mgba-emu/mgba) - Modern cross platform GBA emulator which also runs GB/GBC games. - [Binjgb](https://github.com/binji/binjgb) - 5Kloc emulator that passes most of the tests. *Rewind- feature. Runs in the browser using WebAssembly. - [Gambatte](https://github.com/gb-archive/gambatte) - Cross-platform and accurate emulator. - [MetroBoy](https://github.com/aappleby/MetroBoy) - A playable, circuit-level simulation of an entire Game Boy. - [gbe-plus](https://github.com/shonumi/gbe-plus) - A recently rewritten emulator that has a large effort in preserving the functions of obscure accessories (such as IR link, Mobile Network GB, Barcode Boy, GB Printer, local and online GB Serial Link Cable, ... ) - [Emulicious](https://emulicious.net/) - Provides accurate emulation and includes powerful tools such as a profiler and source-level debugging for ASM and C via a [VS Code debug adapter](https://marketplace.visualstudio.com/items?itemName=emulicious.emulicious-debugger). [Complete list of open source emulators](EMULATORS.md) ### Tools #### Engines - [ZGB](https://github.com/Zal0/ZGB) - A little engine for creating games for the original Game Boy (expands gbdk, more info [here](http://zalods.blogspot.com/2017/01/zgb-little-engine-for-game-boy.html)). - [Retr0 GB](https://bitbucket.org/HellSuffering/retr0-gb/) - An engine for creating games (expands GBDK). #### Development tools - [GBExtended](http://www.tensi.eu/thomas/programming/gameboy/gbextended.html) - C library extending gbdk. - [gbdk-lib-extension](https://github.com/ProGM/gbdk-lib-extension) - A small set of sources and tools for the Game Boy Development Kit by Michael Hope. - [Dot Matrix Game Editor](http://www.dotmatrixgame.com/) - An IDE for Game Boy programming in a C-like language called GBL, with many other features like tile and map extraction, WLA-DX assembly, and more. - [mgbdis](https://github.com/mattcurrie/mgbdis) - Game Boy ROM disassembler with RGBDS compatible output. - [ROM Header Utility](http://catskull.net/GB-Logo-Generator/) - An online tool to inspect and modify a ROM's header data, including the logo. - [romusage](https://github.com/bbbbbr/romusage) - Command line tool for estimating usage (free space) of Game Boy ROMs from a .map, .noi or ihx file. Works with GBDK-2020 and RGBDS. - [awake](https://github.com/devdri/awake) - Game Boy decompiler. - [Game Boy Text Tools](https://github.com/raphaklaus/gameboy-text-tools) - Set of tools for text manipulation and translation of Game Boy ROMs written in Node.js. - [evscript](https://github.com/eievui5/evscript) - A scripting language for the Game Boy, useful for enemy AI, dialogue, animations, and coroutines. - [evunit](https://github.com/eievui5/evunit) - A unit testing program for assembly code. #### Graphics utilities - [Game Boy Tile Data Generator](https://github.com/chrisantonellis/gbtdg) - HTML5 / JS web application that will convert bitmap images to hexadecimal data appropriate for use in tile based graphical applications, specifically GB. - [Harry Mulder's GB Development](http://www.devrs.com/gb/hmgd/intro.html) - Some sources and home of Game Boy Tile Designer (GBTD) and Game Boy Map Builder (GBMB) tools. - [GBTiles](https://github.com/bashaus/gbtiles) - Converts .GBR files created with Harry Mulder's Tile Designer (GBTD) and .GBM files created with Harry Mulder's Map Builder (GBMB) to different formats for use with the Game Boy and GBDK. - [bmp2cgb](https://github.com/gitendo/bmp2cgb) - Graphics converter for Game Boy Color development providing real time palette adjustments. - [png2gb](https://github.com/LuckyLights/png2gb) - CLI tool to convert image file to game boy .c array. - [GB-convert](https://github.com/exezin/gb-convert) - Game Boy tile conversion and map editor tool (converts to assembly). - [brewtool](http://make.vg/brewtool/) - A collection of primitive editor/converter tools for making assets used with homebrew ROM development. - [vtGBte](https://github.com/paul-arutyunov/vtGBte) - A minimalistic ncurses tile editor. - [tpp1](https://github.com/TwitchPlaysPokemon/tpp1) - Definition and specification of a custom GB/GBC memory/hardware mapper, as a functional superset of MBC. - [libstdgb](https://github.com/delwink/libstdgb) - A C library of useful Game Boy operations (SDCC). - [Tilemap GB](https://github.com/bbbbbr/gimp-tilemap-gb) - GIMP image editor plug-in for importing & exporting GBMB and GBTD tilemaps and tilesets (as bitmap images or .GBM/.GBR files). - [Tilemap Helper](https://github.com/bbbbbr/gimp-tilemap-helper) - GIMP image editor plug-in for optimizing tile maps and tile sets. - [Tilemap Studio](https://github.com/Rangi42/tilemap-studio) - A tilemap editor for Game Boy, Color, Advance, and SNES projects. Written in C++ with FLTK. - [Superfamiconv](https://github.com/Optiroc/SuperFamiconv) - Flexible and composable tile graphics converter supporting Super Nintendo, Game Boy, Game Boy Color, Game Boy Advance, Mega Drive and PC Engine formats. #### Hardware and ROM utilities - [cart-dumper](https://github.com/Palmr/cart-dumper) - Game Boy Cartridge Dumper ROM. - [gbcamextract](https://github.com/jkbenaim/gbcamextract) - Extracts photos from Game Boy Camera saves. - [Game Boy LCD sniffing](https://github.com/svendahlstrand/game-boy-lcd-sniffing) - Sniff your Game Boy's LCD using a logic analyzer. - [swapdump](https://github.com/sanqui/swapdump) - Diagnostic utility for Game Boy flashcarts. - [Gameboy-LinkUp](https://github.com/JustinLloyd/Gameboy-LinkUp) - Game Boy LinkUp serial cable networking project. #### Music drivers and trackers - [DevSound](https://github.com/DevEd2/DevSound) - Sound driver embeddable in homebrews which supports pulse width manipulation, arpeggios, and multiple waveforms. - [Carillon Player](http://gbdev.gg8.se/files/musictools/Aleksi%20Eeben/Carillon%20Editor.zip) - Music Engine. - [GBT PLAYER](https://github.com/AntonioND/gbt-player) - A music player library and converter kit. - [mmlgb](https://github.com/SimonLarsen/mmlgb) - A MML parser and GBDK sound driver for the Nintendo Game Boy. - [XPMCK](https://github.com/bazzinotti/XPMCK) - An MML based music compiler with support for Game Boy & Game Boy Color. - [GBSoundSystem](https://github.com/gbdev/GBSoundSystem) - A modernized audio driver for GameBoy Tracker (aka the Paragon 5 music player). - [hUGETracker](https://github.com/SuperDisk/hUGETracker) - A music tracker based on OpenMPT, focused on ease of use, compact output, and embeddability in homebrew games. - [CBT-FX](https://github.com/datguywitha3ds/CBT-FX) - A GBDK-2020 sound effect driver compatible with FX-Hammer sound effects. ## Programming Guides, tutorials and tools to develop software for Game Boy using the development toolchains described in the [Software Development](#software-development) chapter. ### ASM - **[gb asm tutorial](https://eldred.fr/gb-asm-tutorial)** - Step by step tutorial, building several ROMs to accompany its explanations. - [ASMSchool](http://gameboy.mongenel.com/asmschool.html) - A set of lessons by Duo about coding in Assembly for GB/GBC and disassembling. - [hardware.inc](https://github.com/tobiasvl/hardware.inc) - Standard include file containing Game Boy hardware definitions for use in RGBDS projects. - [Assembly tutorial by David Pello](https://gb-archive.github.io/salvage/tutorial_de_ensamblador/tutorial_de_ensamblador_la_decadence.html) - Good document to learn to produce working asm code for gb. Brief explanations of many important topics. Many examples with commented source code. - [assemblydigest](https://github.com/assemblydigest/gameboy) - Exploring Game Boy programming techniques: - [Making an Empty Game Boy ROM (in Wiz)](http://assemblydigest.tumblr.com/post/77203696711/tutorial-making-an-empty-game-boy-rom-in-wiz) - [Making Art for the Game Boy](http://assemblydigest.tumblr.com/post/77404621743/tutorial-making-art-for-the-game-boy) - [Beginner's Guide to Reverse Engineering GB](http://web.archive.org/web/20150511145100/http://www.bennvenn.com/Beginners_Guide_To_Reverse_Engineering.htm) - Some starting tips on disassembling and reverse engineering. - [FlappyBoy: Making a simple Game Boy Game](http://voidptr.io/blog/2017/01/21/GameBoy.html) - [Super Game Boy development](https://imanoleasgames.blogspot.no/2016/12/games-aside-1-super-game-boy.html) - Step by step tutorial to implement Super Game Boy features (frame and palettes). - [GameBoy programming tutorial: Hello World!](https://peterwynroberts.wordpress.com/2014/05/11/gameboy-programming-tutorial-hello-world/) - Step by step tutorial. - [DMGreport](https://github.com/lancekindle/DMGreport) - Game programming tutorials in assembly. - [OAM DMA tutorial](https://gbdev.gg8.se/wiki/articles/OAM_DMA_tutorial) - Example of how to use OAM DMA in assembly. - [Game Boy Assembly Programming for the Modern Game Developer](https://github.com/ahrnbom/gbapfomgd) - An e-book about making Game Boy games in Assembly. #### Sources Fragments of code, effects, proof of concepts and generally non complete games. - [dev'rs ASM section](http://www.devrs.com/gb/asmcode.php) - A lot of working demos and sources. - [EmmaEwert's experiments](https://github.com/EmmaEwert/gameboy) - A collection of prototype programs, mostly just toying around. Among others, a daylight effect, transparency and a weather effect. - [DeadCScroll](https://github.com/gb-archive/DeadCScroll) - A detailed tutorial on how to make the screen wobble, among other "raster effects" #### Timings - [Nitty Gritty Gameboy Cycle Timing](http://blog.kevtris.org/blogfiles/Nitty%20Gritty%20Gameboy%20VRAM%20Timing.txt) - [Mode3 Sprite Timing](https://www.reddit.com/r/EmuDev/comments/59pawp/gb_mode3_sprite_timing/) - [GameBoy Color DMA-Transfers v0.0.1](http://gameboy.mongenel.com/dmg/gbc_dma_transfers.txt) - [STAT interrupt timings](http://gameboy.mongenel.com/dmg/istat98.txt) - [Video Timing](https://github.com/jdeblese/gbcpu/wiki/Video-Timing) #### Boilerplates and libraries - [rgbds-template](https://github.com/nezticle/rgbds-template) - Basic hello-world example for Game Boy using RGBDS. - [Game Boy Assembly Language Primer](http://www.devrs.com/gb/files/galp.zip) - Simple template code with memory defines, copy routines and IBM font tilemap. - [bootstrap.gb](https://github.com/yenatch/bootstrap.gb) - An example Game Boy project. - [Gameboy Boilerplate](https://github.com/junebug12851/GameboyBoilerplateProj) - Boilerplate project to move quicker into the actual assembly code for your game. - [GingerBread](https://github.com/ahrnbom/gingerbread) - A software library for making your own Game Boy games. It is made to be used alongside the book [Game Boy Assembly Programming for the Modern Game Developer](https://github.com/ahrnbom/gbapfomgd) which also doubles as documentation. - [gb-vwf](https://github.com/ISSOtm/gb-vwf) - Library to print variable-width text, comes with a demo. - [gb-boilerplate](https://github.com/ISSOtm/gb-boilerplate) - A template for starting Game Boy projects, providing a Makefile for infrastructure. - [gb-starter-kit](https://github.com/ISSOtm/gb-starter-kit) - An expansion on the above, including base library code as well to get started faster. - [gb-template](https://github.com/gb-archive/gb-template) - A template with basic functions such as joypad input, DMA transfers, and map/tile data loading. #### Syntax highlighting packages - [gbz80-highlight](https://github.com/ISSOtm/gbz80-highlight) - Notepad+- and gedit syntax highlighting files for RGBDS assembly. - [Vim syntax file for the Game Boy assembler RGBASM](http://www.vim.org/scripts/script.php?script_id=819) - Vim syntax highlighting for RGBDS assembly. - [Vim syntax file for RGBDS](https://github.com/Leandros/dotfiles/blob/master/.vim/syntax/rgbds.vim) - Another Vim syntax highlighting file for RGBDS assembly. - [sublime-rgbds](https://packagecontrol.io/packages/RGBDS) - A Sublime Text 3 package for RGBDS, including syntax highlighting and some completion snippets. - [Z80 Assembly support for Visual Studio Code](https://github.com/Imanolea/z80asm-vscode) - [rgbds-vscode](https://github.com/DonaldHays/rgbds-vscode) - Visual Studio Code language extension for RGBDS GBZ80 Assembly. - [rgbds-mode](https://github.com/japanoise/rgbds-mode) - Emacs major mode for RGBDS assembly. ### C - [8-Bit Wonderland](https://github.com/gb-archive/salvage/blob/master/misc/8bit_wonderland.pdf) - Well-written introductory document about how the Game Boy works and how to start developing working code for it. - [Grooves Game Boy Programming](https://github.com/gbdk-salvage/grooves-game-boy-programming) - A complete set of lessons about implementing various game mechanics in a Game Boy game. - [How to Write a Simple Side Scrolling Game](http://pastebin.com/F3tHLj68) - Old (but still relevant) tutorial. - [Just another simple tutorial](http://pastebin.com/gzT47MPJ) - [GBDK Tutorial](https://refreshgames.co.uk/2016/04/18/gameboy-tutorial-rom/) - Fairly minimal game demo for getting started with GBDK. - [GBDK Sprite](http://gbdev.gg8.se/wiki/articles/GBDK_Sprite_Tutorial) - Presents a workflow for getting multiple sprites to display and animate. - [GBDK Color](http://gbdev.gg8.se/wiki/articles/GBDK_Color_Tutorial) - Extends your knowledge of basic spriting on the Game Boy by adding colors to sprites, backgrounds and the window layer. - [GBDK Joypad](http://gbdev.gg8.se/wiki/articles/GBDK_Joypad_Tutorial) - Details the use of the joypad with GBDK. - [Game Boy home of Flavor](https://web.archive.org/web/20210427064949/www.personal.triticom.com/~erm/GameBoy/) - Some full games and sources. - [GBDK Configuring and Programming Tutorial](https://videlais.com/2016/07/03/programming-game-boy-games-using-gbdk-part-1-configuring-programming-and-compiling/) - Configuring GBDK, Using Tiles, Colliding Sprites, GBTD, GBMB, Memory Management and ROM Banking. - [Simplified GBDK examples](https://github.com/mrombout/gbdk_playground) - [GBDK Programming Video Tutorials](https://www.youtube.com/playlist?list=PLeEj4c2zF7PaFv5MPYhNAkBGrkx4iPGJo) - A series of video tutorials introducing beginners to programming with GBDK. - [Larold's Jubilant Junkyard](https://laroldsjubilantjunkyard.com/tutorials/) - A collection of detailed GBDK-2020 based tutorials. ## Homebrews Complete and open source games. - [Homebrew Hub](https://hh.gbdev.io) - A community-led attempt to collect, archive and preserve every unlicensed and homebrew game released for Game Boy. Entries are playable online. ### ASM - [Tuff](https://github.com/BonsaiDen/Tuff.gb) - [2048-gb](https://github.com/Sanqui/2048-gb) - [Snake](https://bitbucket.org/Sanqui/snake/src/?at=master) - [Lazerpong](https://github.com/huderlem/lazerpong) - [Geometrix](https://github.com/AntonioND/geometrix) - [µCity](https://github.com/AntonioND/ucity) - [Carazu](https://github.com/mholtkamp/carazu) - [Snake-gb](https://github.com/DonaldHays/snake-gb) - [GB303](https://github.com/furrtek/GB303) - GB303 wavetable-based TB-303 style synthesizer for the Nintendo Game Boy. - [Sushi](https://github.com/JustSid/Sushi) - [Flappy-boy-asm](https://github.com/bitnenfer/flappy-boy-asm) - [kupman](https://github.com/dubvulture/gbdev) and some other projects. - [Adjustris](https://github.com/tbsp/Adjustris) - [exeman](https://github.com/exezin/exeman/) - [Aevilia](https://github.com/ISSOtm/Aevilia-GB) - [GBSlides](https://github.com/Kartones/gameboy) - A simple Game Boy Powerpoint-like slides viewer. - [Pokered-gbc](https://github.com/dannye/pokered-gbc) - Pokémon Red remade with full GBC support. - [ToyToy](https://github.com/tslanina/Retro-GameBoyColor-ToyToy) - [StefaN](https://github.com/tslanina/Retro-GameBoyColor-StefaN) - Fourway Breakout clone. - [Galaxia](https://github.com/tslanina/Retro-GameBoyColor-Galaxia) - [desgb](https://github.com/sanqui/desgb) - DES encryption. - [superhappyfunbubbletime](https://github.com/l0k1/superhappyfunbubbletime) - [minesweepGB](https://github.com/lancekindle/minesweepGB) - [Libbet and the Magic Floor](https://github.com/pinobatch/libbet) - [waveform-gb](https://github.com/dannye/waveform-gb) - Program visualizing the wave form used by the wave channel. The wave form can be edited freely and playback of the wave is updated immediately. - [vectroid.gb](https://gitlab.com/BonsaiDen/vectroid.gb) - Developed with gbasm. - [PlantBoy](https://github.com/gb-archive/plantboy) - [Death Planet](https://makrill.itch.io/death-planet) - [Quartet](https://makrill.itch.io/quartet) - Puzzle game for the Game Boy (Color) and Super Game Boy. - [Dangan](https://snorpung.itch.io/dangan-gb) ### C - [FlappyBoy](https://github.com/bitnenfer/FlappyBoy) - [flappybird-gameboy](https://github.com/pashutk/flappybird-gameboy) - [fbgb](https://github.com/gb-archive/fbgb) - [Novascape](https://web.archive.org/web/20171002042716/http://ludumdare.com/compo/ludum-dare-34/?action=preview&uid=6823) - [Squishy the Turtle](https://github.com/cppchriscpp/SquishyTheTurtle) - [Quadratino](https://github.com/avivace/quadratino) - [Doctor How](https://github.com/elfgames/doctorhow) - [Super Princess' 2092 Exodus](https://github.com/Zal0/gbjam2016) - ([ZGB engine](https://github.com/Zal0/ZGB/)). - [GBsnake](https://github.com/brovador/GBsnake) - [gb-mines](https://github.com/andreasjhkarlsson/gb-mines) - [oranges](http://www.atari2600land.com/gameboy/oranges.html) - [red hot princess carnage](https://github.com/Imanolea/bitbitjam3_red_hot_princess_carnage) - [loderunner](http://www.tensi.eu/thomas/programming/gameboy/loderunner.html) - [Hives](https://refreshgames.co.uk/2017/04/24/ludum-dare-38-entry-hives/) - [Bubble Factory](https://github.com/DonaldHays/bubblefactory) - *Vanilla- SDCC (no gbdk). - [GBC Atari Boxing](https://github.com/rubfi/gbc-atari-boxing) - Atari 2600 Boxing clone for the Game Boy (Color). - [GB raycaster, Vision-8](https://github.com/haroldo-ok/really-old-stuff/tree/master/gameboy) - and some other projects. - [Tobu Tobu Girl Deluxe](https://github.com/SimonLarsen/tobutobugirl-dx) - An arcade platformer for the Game Boy (Color). - [Burly Bear vs. The Mean Foxes](http://sebastianmihai.com/gameboy-burly-bear.html) ([GBC](http://sebastianmihai.com/gameboy-color-burly-bear.html) port) - [PostBot](https://github.com/MasterIV/PostBot) - [Guns & Riders](https://github.com/kanfor/gunsridersgameboy) - [Dino's Offline Adventure](https://github.com/gingemonster/DinosOfflineAdventure) - A clone of the Google Chrome offline game. - [dino-gb](https://github.com/rnegron/dino-gb) - Another clone of the Chrome game. - [Evoland.gb](https://github.com/flozz/evoland.gb) - A port of the first level of Evoland. - [Petris](https://github.com/bbbbbr/Petris) - A puzzle game of shapely pets for the Game Boy Color ([itch.io](https://bbbbbr.itch.io/petris)). - [Infinity](https://github.com/gb-archive/infinity-gbc) - RPG developed by Affinix Software primarily between the years 1999 and 2001. The game never found a publisher and was eventually canceled. Got recently released with the full source, development tools and workflows. - [Black Castle](https://gbdev.gg8.se/forums/viewtopic.php?id=743) - Side scrolling platformer for the Game Boy ([itch.io](https://user0x7f.itch.io/black-castle)). - [Genesis](https://gbdev.gg8.se/forums/viewtopic.php?id=674) - Shmup for the Game Boy ([itch.io](https://user0x7f.itch.io/genesis)). - [Indestructo Tank!](https://antonylavelle.itch.io/indestructotank-gb) - [Super JetPak DX](https://pocketpixel.design/super-jetpak-dx-game-boy-rom.html) - [Powa!](https://aiguanachein.itch.io/powa) - Side scrolling platformer for the Game Boy (Color) ([ZGB engine](https://github.com/Zal0/ZGB/)). - [Cavern](https://thegreatgallus.itch.io/cavern-mvm-9) - ([ZGB engine](https://github.com/Zal0/ZGB/)). - [Mona and the Witch's Hat Deluxe](https://ctneptune.itch.io/mona-and-the-witchs-hat-dx) - ([ZGB engine](https://github.com/Zal0/ZGB/)). - [The Bouncing Ball](https://gamejolt.com/games/the-bouncing-ball-gb/86699) - [DMG Deals Damage](https://drludos.itch.io/dmg-deals-damage) ### GB Studio - [Soul Void](https://kadabura.itch.io/soul-void) - Interactive horror fiction. - [Deadeus](https://izma.itch.io/deadeus) - [SUPER IMPOSTOR BROS.](https://lumpytouch.itch.io/super-impostor-bros) ### Demos - [Back to Color](https://github.com/AntonioND/back-to-color) - [beach-gbc](https://github.com/vegard/beach-gbc) - [CUTE DEMO](https://github.com/mills32/CUTE_DEMO) - [`10 PRINT` Game Boy](https://github.com/svendahlstrand/10-print-game-boy) - [Roboto Demo](https://github.com/naavis/roboto-demo) - [matrix-rain-gb](https://github.com/wtjones/matrix-rain-gb) - A Matrix digital rain effect in assembler. - [GBVideoPlayer](https://github.com/LIJI32/GBVideoPlayer) - A technical demo demonstrating how the Game Boy LCD controller can be hacked to make a Game Boy Color play a full motion video in color, together with music. - [GBVideoPlayer2](https://github.com/LIJI32/GBVideoPlayer2) - The second iteration of the above demo, which increases the resolution, adds *stereo- PCM audio, and introduces video compression*. ## Reverse Engineering - [Reverse engineering Kirby's Dreamland 2](http://ecc-comp.blogspot.it/2016/03/reverse-engineering-kirbys-dreamland-2.html) - [pokemontools](https://github.com/pret/pokemon-reverse-engineering-tools) - a python module that provides various reverse engineering components for various Pokémon games. - [Reverse Engineering a Gameboy ROM with radare2](https://www.megabeets.net/reverse-engineering-a-gameboy-rom-with-radare2) - A walkthrough to reverse engineer a Game Boy ROM challenge using radare2. - [Disassembling Link's Awakening](http://kemenaran.winosx.com/posts/category-disassembling-links-awakening/) - A series of blog posts about disassembling Link's Awakening DX. - [Reverse Engineering the GameBoy Tetris](https://github.com/h3nnn4n/Reverse-Engineering-the-GameBoy-Tetris) - [DMA hijacking](https://gbdev.io/guides/dma_hijacking) - A simple technique that allows you to run custom code in most GB/SGB/CGB games, provided you have an ACE exploit. ### Game Disassemblies - [Pokémon Red/Blue](https://github.com/pret/pokered) - [Pokémon Crystal](https://github.com/pret/pokecrystal) - [Pokémon Yellow](https://github.com/pret/pokeyellow) - [Pokémon Gold and Silver](https://github.com/pret/pokegold) - [Pokémon Pinball](https://github.com/pret/pokepinball) - [Pokémon TCG](https://github.com/pret/poketcg) - [pokegold-spaceworld](https://github.com/pret/pokegold-spaceworld) - Pokémon Gold and Silver 1997 Space World demo. - [Link's Awakening DX](https://github.com/mojobojo/LADX-Disassembly) - [Oracle of Ages](https://github.com/drenn1/ages-disasm) - [Tetris](https://github.com/vinheim3/tetris-gb-disasm) - Complete Tetris disassembly. - [FX Hammer](https://github.com/DevEd2/FXHammer-Disasm) - [Harvest Moon 3](https://github.com/sanqui/hm3) - [Final Fantasy Adventure](https://github.com/daid/FFA-disassembly) ## Game Boy Camera ### Retrieving images Game Boy Printer emulation (e.g. to retrieve images from the camera): - [Arduino Gameboy Printer Emulator](https://github.com/mofosyne/arduino-gameboy-printer-emulator) - Emulate a gameboy printer via the gameboy link cable. - [ESP8266 Game Boy Printer](https://github.com/applefreak/esp8266-gameboy-printer) - A device that emulates the Gameboy Printer and lets you retrieve images using WiFi powered by an ESP8266. - [WiFi GBP Emulator](https://github.com/HerrZatacke/wifi-gbp-emulator) - A GameBoy printer emulator which provides the received data over a WiFi connection. - [Game Boy WiFi Printer - D1 Mini Shield](https://github.com/cristofercruz/gbp-esp-shield-pcb) - Game Boy Printer interface shield for D1 mini/mini Pro ESP8266 boards. - [Game Boy Printer Sniffer](https://github.com/mofosyne/GameboyPrinterSniffer) - Sniff packet communications between a Game Boy and the Printer. ### Changing the camera's behavior Methods to improve and/or manipulate the camera's quality and behavior: - [Game Boy Camera Canon EF Lens Mount](http://ekeler.com/game-boy-camera-canon-ef-mount) - [Game Boy Camera to Canon Lens mount](https://www.thingiverse.com/thing:4337362) - based on the above. - [game-boy-camera-frame-replacer](https://github.com/cristofercruz/game-boy-camera-frame-replacer) - Manipulate the ROM of a camera to include custom frames ### Post processing - [Game Boy Printer Paper Simulation](https://github.com/mofosyne/GameboyPrinterPaperSimulation) - Generate as-if-printed images of digital printed images. - [Game Boy Printer Web](https://github.com/HerrZatacke/gb-printer-web) - Gallery app for to the Game Boy camera: import pictures from exports or cartridge dumps and choose color palettes. ## Related projects - [GB Studio](https://www.gbstudio.dev/) - Drag and drop game creator with simple, no knowledge required, visual scripting. - [Resources to get started](https://gbstudiocentral.com/resources/) - [Dedicated Discord](https://discord.gg/knRryZWGcm) - [ArduinoBoy](https://github.com/trash80/Arduinoboy) - Serial communication (MIDI) from an Arduino to the Game Boy for music applications such as LittleSoundDJ, Nanoloop, and mGB. - [papiGB](https://github.com/diegovalverde/papiGB) - Game Boy Classic fully functional FPGA implementation from scratch. - [fpgaboy](https://github.com/trun/fpgaboy) - Implementation Nintendo's Game Boy console on an FPGA. - [Piglet](https://github.com/danShumway/Piglet) - A LUA-driven AI that plays classic Game Boy color games using experimentation. In active development. - [Ostrich](https://github.com/PumpMagic/ostrich) - A Game Boy Sound System player written in Swift. - [mGB](https://github.com/trash80/mGB) - A Game Boy cartridge program that enables the Game Boy to act as a full MIDI supported sound module. - [GBVisualizer](https://github.com/LIJI32/GBVisualizer) - Demonstrating the use of two undocumented Game Boy Color registers, nicknamed PCM12 (FF76) and PCM34 (FF77), which can be used to read the current PCM amplitude of the 4 APU channels. - [ArduinoGameBoy](https://github.com/drhelius/arduinogameboy) - Arduino based Game Boy cartridge reader and writer. - [gameboy-brainfuck](https://github.com/bitnenfer/gameboy-brainfuck) - Brainf*ck interpreter. - [gbfk](https://github.com/elseyf/gbfk) - Brainf*ck interpreter, with input. - [gb-save-states](https://github.com/mattcurrie/gb-save-states) - Patches to add save state support to Game Boy games when playing on the original hardware. - [gbcpu](https://github.com/jdeblese/gbcpu) - A CPU and peripherals implementing the Game Boy instruction set and functionality. - [Digitized Speech in Game Boy Games](https://youtube.com/watch?v=1lzHfLYzyRM) - [Sniffing Game Boy serial traffic with an STM32F4](https://dhole.github.io/post/gameboy_serial_1/) - [Virtual Game Boy Printer with an STM32F4](https://dhole.github.io/post/gameboy_serial_2/) - [Printing on the Game Boy Printer using an STM32F4](https://dhole.github.io/post/gameboy_serial_3/) - [Programming Game Boy Chinese cartridges with an STM32F4](https://dhole.github.io/post/gameboy_cartridge_rw_1/) - [Pokemon Pocket Computer:](https://tilde.town/~minerobber/techwriteups/pokemonpc.html) - What is it and how to use it to make cheat codes. - [Booting the Game Boy with a custom logo](https://dhole.github.io/post/gameboy_custom_logo/) - Bypassing the Nintendo logo check. - Making a Game Boy game in 2017: A "Sheep It Up!" Post-Mortem ([part 1](https://www.gamasutra.com/blogs/DoctorLudos/20171207/311143/), [part 2](https://www.gamasutra.com/blogs/DoctorLudos/20180213/314554/)) - [Nintendo's fake logos](http://fuji.drillspirits.net/?post=87) - Every cartridge has to show the authentic logo to be considered valid and be run, but obviously some companies managed to exploit the check system. - [liblsdj](https://github.com/stijnfrishert/liblsdj) - Utility library for interacting with the LSDj save format (.sav), song files (.lsdsng) and more. - [lsdpatch](https://github.com/jkotlinski/lsdpatch) - Tool for modifying samples, fonts and palettes on LSDj ROM images. - [Game Boy video effects](https://github.com/ChaosCabbage/crazy-gameboy-video-experiments) - Some little experiments using the STAT interrupt to do funny video manipulations. - [gbos](https://github.com/ekimekim/gbos) - A basic operating system for the Game Boy. - [Work Master OS](https://translate.google.com/translate?hl=&sl=ru&tl=en&u=https%3A%2F%2Fweb.archive.org%2Fweb%2F20081226145726%2Fhttp%3A%2F%2Fworkmaster.ru%2Findex.php%3Fp%3D8&sandbox=1) - Russian multi tasking operating system. - [Game Boy Link Cable Breakout Board](https://github.com/Palmr/gb-link-cable) - [GBCartFlasher firmware](https://github.com/Tauwasser/GBCartFlasher) - [VerilogBoy](https://github.com/zephray/VerilogBoy/) - Game Boy compatible console Verilog RTL implementation. - [GBCamcorder](https://github.com/furrtek/GBCamcorder) - Lo-Fi portable video recorder using a GameBoy Camera cartridge. - [GBCartRead](https://github.com/insidegadgets/GBCartRead) - Read ROM, Read RAM or Write RAM from/to a GameBoy Cartridge. - [GBxCart-RW](https://github.com/insidegadgets/GBxCart-RW) - A device for reading game ROMs, save games and restoring saves for GB, GBC and GBA carts from your PC via USB. - [Dumping the Super Game Boy Boot ROM](http://www.its.caltech.edu/~costis/sgb_hack/) ### Directories - [Archive of related files](http://gbdev.gg8.se/files/) - [The Game Boy Archive](https://github.com/gb-archive) - A library of Game Boy related software, hardware and literature. Aimed to mirror and preserve old and fragmented contributions from the last three decades. - [The Game Boy Archive - Salvage](https://github.com/gb-archive/salvage) - Historical archive of software, old articles, FAQs and various documents. ### Websites - [devrs.com/gb](http://devrs.com/gb) - Old home of the scene: examples, sources, complete documentation, guides, tutorials and various tools. - [pdroms.de](http://pdroms.de/news/gameboy/) - Game Boy releases. - [Handheld Underground](http://hhug.me) - Unlicensed games, blog posts about Game Boy, home of the hhugboy emulator. ## About ### Contribute Take a look at [Contribution Guidelines](CONTRIBUTING.md). ### License Licensed under **GPLv3**. See [LICENSE](LICENSE) for more information. ### Acknowledgements Thanks to [every](https://github.com/avivace/awesome-gbdev/graphs/contributors) contributor of this project, Jeff Frohwein, Pascal Felber, KOOPa, Pan of Anthrox, GABY, Marat Fayzullin, Paul Robson, BOWSER, neviksti, Martin "nocash" Korth, Nitro2k01, Duo, Chris Antonellis, Michael Hope, Beware, Jonathan “Lord Nightmare” Gevaryahu, Carsten Sorense, Sindre Aamås, Otaku No Zoku, GeeBee. ### Sponsors Special thanks to our friends at [DigitalOcean](https://www.digitalocean.com/), sponsoring the open source activites of our Game Boy Development community ([announcement](https://twitter.com/avivace4/status/992188011990409216)).

OpenAPI 3.0 (and Swagger v2) implementation for Go (parsing, converting, validation, and more)

[](https://github.com/getkin/kin-openapi/actions) [](https://goreportcard.com/report/github.com/getkin/kin-openapi) [](https://godoc.org/github.com/getkin/kin-openapi) [](https://gitter.im/getkin/kin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) # Introduction A [Go](https://golang.org) project for handling [OpenAPI](https://www.openapis.org/) files. We target: * [OpenAPI `v2.0`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) (formerly known as Swagger) * [OpenAPI `v3.0`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) * [OpenAPI `v3.1`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) Soon! [Tracking issue here.](https://github.com/getkin/kin-openapi/issues/230) Licensed under the [MIT License](./LICENSE). ## Contributors, users and sponsors The project has received pull requests [from many people](https://github.com/getkin/kin-openapi/graphs/contributors). Thanks to everyone! Be sure to [give back to this project](https://github.com/sponsors/fenollp) like our sponsors: <p align="center"> <a href="//www.speakeasyapi.dev"><img src=".github/sponsors/speakeasy.png" alt="Speakeasy" height="100px"/></a> </p> Here's some projects that depend on _kin-openapi_: * [github.com/Tufin/oasdiff](https://github.com/Tufin/oasdiff) - "A diff tool for OpenAPI Specification 3" * [github.com/danielgtaylor/apisprout](https://github.com/danielgtaylor/apisprout) - "Lightweight, blazing fast, cross-platform OpenAPI 3 mock server with validation" * [github.com/deepmap/oapi-codegen](https://github.com/deepmap/oapi-codegen) - "Generate Go client and server boilerplate from OpenAPI 3 specifications" * [github.com/dunglas/vulcain](https://github.com/dunglas/vulcain) - "Use HTTP/2 Server Push to create fast and idiomatic client-driven REST APIs" * [github.com/danielgtaylor/restish](https://github.com/danielgtaylor/restish) - "...a CLI for interacting with REST-ish HTTP APIs with some nice features built-in" * [github.com/goadesign/goa](https://github.com/goadesign/goa) - "Design-based APIs and microservices in Go" * [github.com/hashicorp/nomad-openapi](https://github.com/hashicorp/nomad-openapi) - "Nomad is an easy-to-use, flexible, and performant workload orchestrator that can deploy a mix of microservice, batch, containerized, and non-containerized applications. Nomad is easy to operate and scale and has native Consul and Vault integrations." * [gitlab.com/jamietanna/httptest-openapi](https://gitlab.com/jamietanna/httptest-openapi) ([*blog post*](https://www.jvt.me/posts/2022/05/22/go-openapi-contract-test/)) - "Go OpenAPI Contract Verification for use with `net/http`" * [github.com/SIMITGROUP/openapigenerator](https://github.com/SIMITGROUP/openapigenerator) - "Openapi v3 microservices generator" * (Feel free to add your project by [creating an issue](https://github.com/getkin/kin-openapi/issues/new) or a pull request) ## Alternatives * [go-swagger](https://github.com/go-swagger/go-swagger) stated [*OpenAPIv3 won't be supported*](https://github.com/go-swagger/go-swagger/issues/1122#issuecomment-575968499) * [swaggo](https://github.com/swaggo/swag) has an [open issue on OpenAPIv3](https://github.com/swaggo/swag/issues/386) * [go-openapi](https://github.com/go-openapi)'s [spec3](https://github.com/go-openapi/spec3) * an iteration on [spec](https://github.com/go-openapi/spec) (for OpenAPIv2) * see [README](https://github.com/go-openapi/spec3/tree/3fab9faa9094e06ebd19ded7ea96d156c2283dca#oai-object-model---) for the missing parts Be sure to check [OpenAPI Initiative](https://github.com/OAI)'s [great tooling list](https://github.com/OAI/OpenAPI-Specification/blob/master/IMPLEMENTATIONS.md) as well as [OpenAPI.Tools](https://openapi.tools/). # Structure * _openapi2_ ([godoc](https://godoc.org/github.com/getkin/kin-openapi/openapi2)) * Support for OpenAPI 2 files, including serialization, deserialization, and validation. * _openapi2conv_ ([godoc](https://godoc.org/github.com/getkin/kin-openapi/openapi2conv)) * Converts OpenAPI 2 files into OpenAPI 3 files. * _openapi3_ ([godoc](https://godoc.org/github.com/getkin/kin-openapi/openapi3)) * Support for OpenAPI 3 files, including serialization, deserialization, and validation. * _openapi3filter_ ([godoc](https://godoc.org/github.com/getkin/kin-openapi/openapi3filter)) * Validates HTTP requests and responses * Provides a [gorilla/mux](https://github.com/gorilla/mux) router for OpenAPI operations * _openapi3gen_ ([godoc](https://godoc.org/github.com/getkin/kin-openapi/openapi3gen)) * Generates `*openapi3.Schema` values for Go types. # Some recipes ## Validating an OpenAPI document ```shell go run github.com/getkin/kin-openapi/cmd/validate@latest [--defaults] [--examples] [--ext] [--patterns] -- <local YAML or JSON file> ``` ## Loading OpenAPI document Use `openapi3.Loader`, which resolves all references: ```go doc, err := openapi3.NewLoader().LoadFromFile("swagger.json") ``` ## Getting OpenAPI operation that matches request ```go loader := openapi3.NewLoader() doc, _ := loader.LoadFromData([]byte(`...`)) _ := doc.Validate(loader.Context) router, _ := gorillamux.NewRouter(doc) route, pathParams, _ := router.FindRoute(httpRequest) // Do something with route.Operation ``` ## Validating HTTP requests/responses ```go package main import ( "context" "fmt" "net/http" "github.com/getkin/kin-openapi/openapi3" "github.com/getkin/kin-openapi/openapi3filter" "github.com/getkin/kin-openapi/routers/gorillamux" ) func main() { ctx := context.Background() loader := &openapi3.Loader{Context: ctx, IsExternalRefsAllowed: true} doc, _ := loader.LoadFromFile(".../My-OpenAPIv3-API.yml") // Validate document _ := doc.Validate(ctx) router, _ := gorillamux.NewRouter(doc) httpReq, _ := http.NewRequest(http.MethodGet, "/items", nil) // Find route route, pathParams, _ := router.FindRoute(httpReq) // Validate request requestValidationInput := &openapi3filter.RequestValidationInput{ Request: httpReq, PathParams: pathParams, Route: route, } _ := openapi3filter.ValidateRequest(ctx, requestValidationInput) // Handle that request // --> YOUR CODE GOES HERE <-- responseHeaders := http.Header{"Content-Type": []string{"application/json"}} responseCode := 200 responseBody := []byte(`{}`) // Validate response responseValidationInput := &openapi3filter.ResponseValidationInput{ RequestValidationInput: requestValidationInput, Status: responseCode, Header: responseHeaders, } responseValidationInput.SetBodyBytes(responseBody) _ := openapi3filter.ValidateResponse(ctx, responseValidationInput) } ``` ## Custom content type for body of HTTP request/response By default, the library parses a body of HTTP request and response if it has one of the next content types: `"text/plain"` or `"application/json"`. To support other content types you must register decoders for them: ```go func main() { // ... // Register a body's decoder for content type "application/xml". openapi3filter.RegisterBodyDecoder("application/xml", xmlBodyDecoder) // Now you can validate HTTP request that contains a body with content type "application/xml". requestValidationInput := &openapi3filter.RequestValidationInput{ Request: httpReq, PathParams: pathParams, Route: route, } if err := openapi3filter.ValidateRequest(ctx, requestValidationInput); err != nil { panic(err) } // ... // And you can validate HTTP response that contains a body with content type "application/xml". if err := openapi3filter.ValidateResponse(ctx, responseValidationInput); err != nil { panic(err) } } func xmlBodyDecoder(body io.Reader, h http.Header, schema *openapi3.SchemaRef, encFn openapi3filter.EncodingFn) (decoded interface{}, err error) { // Decode body to a primitive, []inteface{}, or map[string]interface{}. } ``` ## Custom function to check uniqueness of array items By defaut, the library check unique items by below predefined function ```go func isSliceOfUniqueItems(xs []interface{}) bool { s := len(xs) m := make(map[string]struct{}, s) for _, x := range xs { key, _ := json.Marshal(&x) m[string(key)] = struct{}{} } return s == len(m) } ``` In the predefined function using `json.Marshal` to generate a string can be used as a map key which is to support check the uniqueness of an array when the array items are objects or arrays. You can register you own function according to your input data to get better performance: ```go func main() { // ... // Register a customized function used to check uniqueness of array. openapi3.RegisterArrayUniqueItemsChecker(arrayUniqueItemsChecker) // ... other validate codes } func arrayUniqueItemsChecker(items []interface{}) bool { // Check the uniqueness of the input slice } ``` ## Custom function to change schema error messages By default, the error message returned when validating a value includes the error reason, the schema, and the input value. For example, given the following schema: ```json { "type": "string", "allOf": [ { "pattern": "[A-Z]" }, { "pattern": "[a-z]" }, { "pattern": "[0-9]" }, { "pattern": "[!@#$%^&*()_+=-?~]" } ] } ``` Passing the input value `"secret"` to this schema will produce the following error message: ``` string doesn't match the regular expression "[A-Z]" Schema: { "pattern": "[A-Z]" } Value: "secret" ``` Including the original value in the error message can be helpful for debugging, but it may not be appropriate for sensitive information such as secrets. To disable the extra details in the schema error message, you can set the `openapi3.SchemaErrorDetailsDisabled` option to `true`: ```go func main() { // ... // Disable schema error detailed error messages openapi3.SchemaErrorDetailsDisabled = true // ... other validate codes } ``` This will shorten the error message to present only the reason: ``` string doesn't match the regular expression "[A-Z]" ``` For more fine-grained control over the error message, you can pass a custom `openapi3filter.Options` object to `openapi3filter.RequestValidationInput` that includes a `openapi3filter.CustomSchemaErrorFunc`. ```go func validationOptions() *openapi3filter.Options { options := openapi3filter.DefaultOptions options.WithCustomSchemaErrorFunc(safeErrorMessage) return options } func safeErrorMessage(err *openapi3.SchemaError) string { return err.Reason } ``` This will change the schema validation errors to return only the `Reason` field, which is guaranteed to not include the original value. ## Sub-v0 breaking API changes ### v0.113.0 * The string format `email` has been removed by default. To use it please call `openapi3.DefineStringFormat("email", openapi3.FormatOfStringForEmail)`. * Field `openapi3.T.Components` is now a pointer. * Fields `openapi3.Schema.AdditionalProperties` and `openapi3.Schema.AdditionalPropertiesAllowed` are replaced by `openapi3.Schema.AdditionalProperties.Schema` and `openapi3.Schema.AdditionalProperties.Has` respectively. * Type `openapi3.ExtensionProps` is now just `map[string]interface{}` and extensions are accessible through the `Extensions` field. ### v0.112.0 * `(openapi3.ValidationOptions).ExamplesValidationDisabled` has been unexported. * `(openapi3.ValidationOptions).SchemaFormatValidationEnabled` has been unexported. * `(openapi3.ValidationOptions).SchemaPatternValidationDisabled` has been unexported. ### v0.111.0 * Changed `func (*_) Validate(ctx context.Context) error` to `func (*_) Validate(ctx context.Context, opts ...ValidationOption) error`. * `openapi3.WithValidationOptions(ctx context.Context, opts *ValidationOptions) context.Context` prototype changed to `openapi3.WithValidationOptions(ctx context.Context, opts ...ValidationOption) context.Context`. ### v0.101.0 * `openapi3.SchemaFormatValidationDisabled` has been removed in favour of an option `openapi3.EnableSchemaFormatValidation()` passed to `openapi3.T.Validate`. The default behaviour is also now to not validate formats, as the OpenAPI spec mentions the `format` is an open value. ### v0.84.0 * The prototype of `openapi3gen.NewSchemaRefForValue` changed: * It no longer returns a map but that is still accessible under the field `(*Generator).SchemaRefs`. * It now takes in an additional argument (basically `doc.Components.Schemas`) which gets written to so `$ref` cycles can be properly handled. ### v0.61.0 * Renamed `openapi2.Swagger` to `openapi2.T`. * Renamed `openapi2conv.FromV3Swagger` to `openapi2conv.FromV3`. * Renamed `openapi2conv.ToV3Swagger` to `openapi2conv.ToV3`. * Renamed `openapi3.LoadSwaggerFromData` to `openapi3.LoadFromData`. * Renamed `openapi3.LoadSwaggerFromDataWithPath` to `openapi3.LoadFromDataWithPath`. * Renamed `openapi3.LoadSwaggerFromFile` to `openapi3.LoadFromFile`. * Renamed `openapi3.LoadSwaggerFromURI` to `openapi3.LoadFromURI`. * Renamed `openapi3.NewSwaggerLoader` to `openapi3.NewLoader`. * Renamed `openapi3.Swagger` to `openapi3.T`. * Renamed `openapi3.SwaggerLoader` to `openapi3.Loader`. * Renamed `openapi3filter.ValidationHandler.SwaggerFile` to `openapi3filter.ValidationHandler.File`. * Renamed `routers.Route.Swagger` to `routers.Route.Spec`. ### v0.51.0 * Type `openapi3filter.Route` moved to `routers` (and `Route.Handler` was dropped. See https://github.com/getkin/kin-openapi/issues/329) * Type `openapi3filter.RouteError` moved to `routers` (so did `ErrPathNotFound` and `ErrMethodNotAllowed` which are now `RouteError`s) * Routers' `FindRoute(...)` method now takes only one argument: `*http.Request` * `getkin/kin-openapi/openapi3filter.Router` moved to `getkin/kin-openapi/routers/legacy` * `openapi3filter.NewRouter()` and its related `WithSwaggerFromFile(string)`, `WithSwagger(*openapi3.Swagger)`, `AddSwaggerFromFile(string)` and `AddSwagger(*openapi3.Swagger)` are all replaced with a single `<router package>.NewRouter(*openapi3.Swagger)` * NOTE: the `NewRouter(doc)` call now requires that the user ensures `doc` is valid (`doc.Validate() != nil`). This used to be asserted. ### v0.47.0 Field `(*openapi3.SwaggerLoader).LoadSwaggerFromURIFunc` of type `func(*openapi3.SwaggerLoader, *url.URL) (*openapi3.Swagger, error)` was removed after the addition of the field `(*openapi3.SwaggerLoader).ReadFromURIFunc` of type `func(*openapi3.SwaggerLoader, *url.URL) ([]byte, error)`.

Repo for Immuni's documentation.

NOTE: This README is also available [in Italian](/Translations/it/README.md). NOTA: Questo README è disponibile anche [in italiano](/Translations/it/README.md). # Immuni's High-Level Description Immuni is the Italian Government’s exposure notification solution, realised by the Special Commissioner for the COVID-19 emergency (Presidency of the Council of Ministers), in collaboration with the Ministry of Health and the Ministry for Technological Innovation and Digitalisation. It only uses public infrastructures located within the national borders. It is exclusively managed by the public company Sogei S.p.A. The source code prior to October 13, 2020 has been developed for the Presidency of the Council of Ministers by Bending Spoons S.p.A., and it is released under a GNU Affero General Public License version 3. ## Table of contents - [Executive summary](#executive-summary) - [Introduction](#introduction) - [Vision and goals](#vision-and-goals) - [Principles](#principles) - [Product](#product) - [How it works](#how-it-works) - [Analytics](#analytics) - [Epidemiological information](#epidemiological-information) - [Operational information](#operational-information) - [Privacy](#privacy) ## Executive summary - Immuni is a technological solution that centres on **an iOS and Android smartphone app.** It helps us to fight the COVID-19 epidemic by notifying users at risk of carrying the virus as early as possible—**even when they are asymptomatic.** These users can then isolate themselves to avoid infecting others, and seek medical advice. - Immuni’s design and development are based on six main principles: **utility, accessibility, accuracy, privacy, scalability,** and **transparency.** - It features an **exposure notification** system that leverages **Bluetooth Low Energy:** - When two users come sufficiently close to each other for long enough, their devices record each other’s _rolling proximity identifier_ in local memory. Rolling proximity identifiers are generated from _temporary exposure keys_ and change multiple times each hour. Temporary exposure keys are **generated randomly** and change once per day. - When a user tests positive for SARS-CoV-2, the virus causing COVID-19, they have the option to upload to a server their recent temporary exposure keys. This operation can only happen with the validation of a **healthcare operator.** - The app periodically downloads the new temporary exposure keys and uses them to derive the infected users’ rolling proximity identifiers for the recent past. It then matches the identifiers against those stored in the device’s memory and **notifies the user** if a risky exposure has occurred. - The system uses **no geolocation data** whatsoever, including GPS data. So, the app cannot tell where the contact with a potentially contagious user took place, nor the identities of those involved. - To implement its exposure notification functionality, Immuni leverages **the Apple, Google Exposure Notification framework and Huawei Contact Shield framework.** This allows Immuni to be more reliable than otherwise would be possible. - Besides the temporary exposure keys, the Immuni app also sends to the server some analytics data. These include **epidemiological and operational information,** and are sent for the purpose of helping the National Healthcare Service (_Servizio Sanitario Nazionale_) to provide effective assistance to users. - Immuni is being developed while paying a lot of attention to user privacy and a number of measures have been taken to protect it. For example, the app collects **no personal data that would disclose the user’s identity,** such as the user’s name, age, address, email, or phone number. ## Introduction The whole world is united by a determination to stop the spread of COVID-19, the disease caused by SARS-CoV-2. The pandemic is threatening people’s health and severely damaging economies on a global scale. Many experts agree that, in the future, new pandemics are a distinct possibility. Some may become even more dangerous to humanity than the one we are currently battling. In this challenging context, the contribution of technological innovation can be decisive. Immuni is one of a number of tools deployed and initiatives taken by the Italian government to help slow down the spread of the disease and accelerate the return to everyday life. This document provides a high-level description of Immuni—it is a good idea to read it first. More detailed information can be found in the following documents: - [Product](/Product.md) - [Technology](/Technology.md) - [Application Security](/Application%20Security.md) - [Privacy-Preserving Analytics](/Privacy-Preserving%20Analytics.md) - [Traffic Analysis Mitigation](/Traffic%20Analysis%20Mitigation.md) We have open-sourced Immuni’s software under the [GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.en.html). ## Vision and goals Immuni is a technological solution that centres on a smartphone app. It helps us to fight epidemics—starting with COVID-19: - The app aims to notify users at risk of carrying the virus as early as possible—even when they are asymptomatic. - These users can then isolate themselves to avoid infecting others. This minimises the spread of the virus while speeding up a return to normal life for most people. - By being notified early, they can also seek medical advice and lower the risk of serious health consequences. Immuni is designed to address the current crisis, but the vision behind it is for the tools that are being developed to make us all better prepared in addressing similar threats that may arise in the future. ## Principles The main principles guiding the Immuni project follow: - **Utility.** The app needs to be useful in fulfilling the project's vision and goals, as outlined above. The key here is to be able to notify as high a percentage of the people who are substantially at risk as possible, and to do so as early as is practical. This is the most important principle. - **Accessibility.** For fairness and to facilitate the widest adoption, Immuni should be accessible to the maximum possible number of people who may want to use it. This principle impacts decision-making across the board, including in user experience, design, localisation, and technology. - **Accuracy.** Immuni aims to notify only those users who have a substantial risk of having contracted the virus. This is important because of the psychological toll that goes with being notified about a potential transmission of the disease, and because too high a rate of false positives would result in users losing trust in the app—and stopping their use of it. Also, the more accurate the app is, the more efficiently the National Healthcare Service (_Servizio Sanitario Nazionale_) will be able to take care of users, making sure to attend to higher-risk ones first. - **Privacy.** Immuni must protect user privacy while remaining effective. Earning and maintaining user trust is critical—failing to do so reduces the likelihood of widespread adoption. - **Scalability.** Immuni needs to be widely adopted throughout the country. This requires the system to scale well technologically and the operational burden it places on the National Healthcare Service to be manageable. - **Transparency.** Everyone should be provided with access to documentation describing Immuni in all its parts and the rationale behind the most important design decisions. Also, the app will be open source. This allows the users to verify that the app works as documented and the expert community to help improve it. ## Product Immuni is a technological solution that centres on a smartphone app available for iOS and Android. It features an exposure notification system to help alert potentially SARS-CoV-2-positive users at an early stage. This system keeps track of contact between Immuni users, even when they are total strangers. When a user tests positive for SARS-CoV-2, the app uses this system to notify other at-risk users. The system is based on Bluetooth Low Energy and does not use any geolocation data whatsoever, including GPS data. So, while the app knows that the contact with an infected user took place, how long it lasted, and can estimate the distance that separated the two users, it cannot tell where the contact took place, nor the identities of those involved. The app then recommends to at-risk users what to do. Recommendations may include self-isolation (which helps minimise the spread of the disease) and contacting their general practitioner (so that the user can receive the most appropriate care and reduce the likelihood of developing severe complications). As stated, Immuni’s exposure notification system leverages Bluetooth Low Energy. This has some advantages compared to a solution based on location tracking: - **The system is more accurate.** Geolocalisation, in many contexts, has an accuracy in the order of tens of metres. Meanwhile, Bluetooth Low Energy signals allow for capturing contact occurring within a radius of a few metres of the user. These are the cases of contact relevant to the transmission of SARS-CoV-2. - **The battery is used more efficiently.** Bluetooth Low Energy excels when it comes to energy efficiency. This is important because it is reasonable to expect that the app’s uninstall rate will be correlated with battery consumption. - **No geolocation data are required.** Thanks to Bluetooth Low Energy, contact is traced without tracking the users’ location. This may result in the app being more welcomed by the public and could facilitate wider adoption, increasing Immuni’s utility. To implement its exposure notification functionality, Immuni leverages the Apple, Google Exposure Notification framework and Huawei Contact Shield framework (see [Apple’s documentation](https://www.apple.com/covid19/contacttracing), [Google’s documentation](https://www.google.com/covid19/exposurenotifications/) and [Huawei’s documentation](https://developer.huawei.com/consumer/en/doc/development/HMSCore-Guides-V5/contactshield--0000001057494465-V5)). This allows Immuni to overcome certain technical limitations, thus being more reliable than otherwise would be possible. ### How it works Below, a high-level, simplified description of the system is provided. For more details, please study the rest of the Immuni documentation. Once installed and set up on a device (_device_A_), the app generates a _temporary exposure key._ This key is generated randomly and changes daily. The app also starts transmitting a Bluetooth Low Energy signal. The signal contains a _rolling proximity identifier_ (_ID_A1,_ assumed fixed in this example, for simplicity). This is generated from the current temporary exposure key. When another device (_device_B_) running the app receives this signal, it records _ID_A1_ locally, in its memory. At the same time, _device_A_ records _device_B_’s identifier (_ID_B1,_ also assumed fixed in this example). If the user of _device_A_ later tests positive for SARS-CoV-2, following the protocol defined by the National Healthcare Service, they have the option to upload to the Immuni server the temporary exposure keys from which the Immuni app can derive the rolling proximity identifiers recently broadcast by _device_A_ (including _ID_A1_). Periodically, _device_B_ checks the new keys uploaded to the server against its local list of identifiers. _ID_A1_ will be a match. The app notifies the user of _device_B_ that they may be at risk and provides advice on what to do next (for example, isolating themselves and calling their general practitioner). In practice, when it comes to determining whether the user of _device_B_ is at risk, finding that they had been in the proximity of the user of _device_A_ is not enough. Immuni assesses this risk based on the duration of the exposure and the distance between the two devices. This is estimated from the attenuation of the Bluetooth Low Energy signal as received by _device_B._ The longer the exposure and the closer the contact, the higher the risk that a transmission of the virus occurred. Contact lasting only a couple of minutes and happening at several metres of distance will generally be considered to be low risk. The risk model may evolve with time as more information about SARS-CoV-2 becomes available. It should be noted that the estimation of distance is error-prone. In fact, the attenuation of a Bluetooth Low Energy signal depends on factors such as the orientation of the two devices relative to each other and the obstacles (including human bodies) that lie in between. While leveraging this information is likely useful in increasing the accuracy of Immuni’s assessments of the risk of contagion, wrong assessments will happen with some frequency. The rolling proximity identifier that is broadcast by the app is generated from random temporary exposure keys and does not contain any information about the device, let alone the user. Moreover, it is _rolling,_ meaning that it changes multiple times each hour, further protecting the privacy of Immuni’s users. To ensure that only users who actually tested positive for SARS-CoV-2 upload their keys to the server, the upload procedure can only be performed with the cooperation of an authenticated healthcare operator. The operator asks the user to provide a code generated by the app and inputs it into a back-office tool. The upload can succeed only if the code used by the app to authenticate the data corresponds to that entered in the system by the healthcare operator. ## Analytics Besides the temporary exposure keys, some additional information is sent to the server and analysed to ensure the proper functioning of the system: - Epidemiological information - Operational information These data are important for the National Healthcare Service’s effective management of the system, including maximising the effectiveness of the exposure notifications and providing optimal healthcare assistance to users. The optimisations enabled by the epidemiological and operational information may be most effective if carried out at the local level. The various Italian regions differ in healthcare policies, resources, and capabilities. Moreover, the epidemic might be at different stages in different locations. Therefore, when sending these data to the server, the app attaches the user’s province of domicile as provided by the user during the onboarding process. ### Epidemiological information The only epidemiological data Immuni collects relate to the user’s exposure to infected users. The data include: - The day the exposure occurred - The duration of the exposure - Signal attenuation information used for estimating the distance between the two users’ devices during the exposure The app may send epidemiological information to the server only upon uploading temporary exposure keys. When a healthcare operator communicates to the user their positivity to a SARS-CoV-2 test, any available epidemiological information from the previous 14 days will be uploaded too. The data upload needs to be initiated by the user and approved by the healthcare operator. To protect the user’s privacy, the data uploaded relating to their exposure to potentially contagious users have certain limitations. For example, the duration of the exposure is measured in five-minute increments and capped at 30 minutes. Moreover, Immuni has no way to determine that exposures occurring on different days may have involved the same infected user. The app also performs periodic dummy uploads to mitigate the risk of someone gaining sensitive information about the user through traffic analysis. Collecting these data helps the National Healthcare Service to optimise the app’s risk model. By learning how the epidemiological information (e.g., the duration of the exposure) correlates with the user ultimately testing positive for SARS-CoV-2, it may be possible to improve the app's risk model and, therefore, increase its accuracy. This would, in turn, increase the effectiveness of the exposure notification system. Note that the assessment of risk always takes place on the user's device, while the latest model can be fetched from the server. ### Operational information In addition to the above, some data on device activity and exposure notifications may be collected and uploaded. These data include: - Whether the device runs iOS or Android - Whether permission to leverage the Apple and Google Exposure Notification framework is granted - Whether the device’s Bluetooth is enabled - Whether permission to send local notifications is granted - Whether the user was notified of a risky exposure after the last exposure detection (i.e., after the app has downloaded new temporary exposure keys from the server and detected if the user has been exposed to SARS-CoV-2-positive users) - The date on which the last risky exposure took place, if any The upload may take place after an exposure detection has been completed. The operational information is uploaded automatically. To protect user privacy, the data are uploaded without requiring the user to authenticate in any way (e.g., no phone number or email verification). Moreover, traffic analysis is obstructed by dummy uploads. Thanks to these data, it is possible to estimate the level of the app’s adoption across the country, not just measured by number of downloads—a largely meaningless metric—but by devices that are actually working properly. This information is very helpful, as the utility of Immuni depends heavily on its uptake within the population. Supported by these data, the National Healthcare Service can make better decisions in a number of areas critical to maximising the effectiveness of exposure notifications and providing optimal patient care. Such areas include product development, engineering, and communications. The data would also help with optimising the allocation of resources. By notifying at-risk users, the app will increase the volume of interactions with the National Healthcare Service. Therefore, estimating the number of users that the system will notify may help the National Healthcare Service to allocate its resources accordingly and, thus, efficiently. Knowing the date on which the last risky exposure took place helps with estimating when symptoms may appear. Such factors enable the National Healthcare Service to adjust its response even more accurately. ## Privacy Immuni has been and continues to be designed and developed while paying a lot of attention to user privacy. It is a fundamental right that we must do everything we can to protect. We also think that outstanding privacy protection is critical to making the app acceptable to the greatest number of people, thereby maximising Immuni’s utility. Below, we provide a list of some of the measures by which Immuni protects the user’s privacy: - The app does not collect any personal data that would disclose the user’s identity. For example, it does not collect the user’s name, date of birth, address, email, or phone number. - The app does not collect any geolocation data, including GPS data. The user’s movements are not tracked in any shape or form. - The rolling proximity identifier that is broadcast by the app is generated from random temporary exposure keys and does not contain any information about the device, let alone the user. Moreover, it changes multiple times each hour. - The epidemiological information uploaded about the user’s exposure to potentially contagious users has certain limitations. For example, the duration of the exposure is measured in five-minute increments and capped at 30 minutes. Moreover, Immuni has no way to determine that exposures occurring on different days may have involved the same infected user. - The operational information is uploaded without requiring the user to authenticate in any way (including verifying a phone number or email). - The app performs periodic dummy uploads to mitigate the risk of someone gaining sensitive information about the user through traffic analysis. - The data stored on the device are encrypted. - All connections between the device and the server are encrypted. - All data, whether stored on the device or on the server, are deleted when no longer needed, and in any case no later than December 31, 2021. - The Ministry of Health will be the data controller. The data will be used solely with the aim of containing the COVID-19 epidemic or for scientific research. - The data will be stored on servers located in Italy and managed by publicly controlled bodies.

A guide to using Lua in Neovim

:arrow_upper_left: (Feeling lost? Use the GitHub TOC!) **:warning: :warning: :warning: A more up-to-date version of this guide is available in the Neovim documentation, see [`:help lua-guide`](https://neovim.io/doc/user/lua-guide.html#lua-guide) :warning: :warning: :warning:** --- # Getting started using Lua in Neovim ## Translations - [Chinese version](https://github.com/glepnir/nvim-lua-guide-zh) - [Spanish version](https://github.com/RicardoRien/nvim-lua-guide/blob/master/README.esp.md) - [Portuguese version](https://github.com/npxbr/nvim-lua-guide/blob/master/README.pt-br.md) - [Japanese version](https://github.com/willelz/nvim-lua-guide-ja/blob/master/README.ja.md) - [Russian version](https://github.com/kuator/nvim-lua-guide-ru) - [Ukrainian version](https://github.com/famiclone/nvim-lua-guide-ua) - [Korean version](https://github.com/krapjost/nvim-lua-guide-kr) ## Introduction The [integration of Lua](https://www.youtube.com/watch?v=IP3J56sKtn0) as a [first-class language inside Neovim](https://github.com/neovim/neovim/wiki/FAQ#why-embed-lua-instead-of-x) is shaping up to be one of its killer features. However, the amount of teaching material for learning how to write plugins in Lua is not as large as what you would find for writing them in Vimscript. This is an attempt at providing some basic information to get people started. This guide assumes you are using at least version 0.5 of Neovim. ### Learning Lua If you are not already familiar with the language, there are plenty of resources to get started: - The [Learn X in Y minutes page about Lua](https://learnxinyminutes.com/docs/lua/) should give you a quick overview of the basics - [This guide](https://github.com/medwatt/Notes/blob/main/Lua/Lua_Quick_Guide.ipynb) is also a good resource for getting started quickly - If videos are more to your liking, Derek Banas has a [1-hour tutorial on the language](https://www.youtube.com/watch?v=iMacxZQMPXs) - Want something a little more interactive with runnable examples? Try [the LuaScript tutorial](https://www.luascript.dev/learn) - The [lua-users wiki](http://lua-users.org/wiki/LuaDirectory) is full of useful information on all kinds of Lua-related topics - The [official reference manual for Lua](https://www.lua.org/manual/5.1/) should give you the most comprehensive tour of the language (exists as a Vimdoc plugin if you want to read it from the comfort of your editor: [milisims/nvim-luaref](https://github.com/milisims/nvim-luaref)) It should also be noted that Lua is a very clean and simple language. It is easy to learn, especially if you have experience with similar scripting languages like JavaScript. You may already know more Lua than you realise! Note: the version of Lua that Neovim embeds is [LuaJIT](https://staff.fnwi.uva.nl/h.vandermeer/docs/lua/luajit/luajit_intro.html) 2.1.0, which maintains compatibility with Lua 5.1. ### Existing tutorials for writing Lua in Neovim A few tutorials have already been written to help people write plugins in Lua. Some of them helped quite a bit when writing this guide. Many thanks to their authors. - [teukka.tech - From init.vim to init.lua](https://teukka.tech/luanvim.html) - [dev.to - How to write neovim plugins in Lua](https://dev.to/2nit/how-to-write-neovim-plugins-in-lua-5cca) - [dev.to - How to make UI for neovim plugins in Lua](https://dev.to/2nit/how-to-make-ui-for-neovim-plugins-in-lua-3b6e) - [ms-jpq - Neovim Async Tutorial](https://github.com/ms-jpq/neovim-async-tutorial) - [oroques.dev - Neovim 0.5 features and the switch to init.lua](https://oroques.dev/notes/neovim-init/) - [Building A Vim Statusline from Scratch - jdhao's blog](https://jdhao.github.io/2019/11/03/vim_custom_statusline/) - [Configuring Neovim using Lua](https://icyphox.sh/blog/nvim-lua/) - [Devlog | Everything you need to know to configure neovim using lua](https://vonheikemen.github.io/devlog/tools/configuring-neovim-using-lua/) ### Companion plugins - [Vimpeccable](https://github.com/svermeulen/vimpeccable) - Plugin to help write your .vimrc in Lua - [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) - All the lua functions I don't want to write twice - [popup.nvim](https://github.com/nvim-lua/popup.nvim) - An implementation of the Popup API from vim in Neovim - [nvim_utils](https://github.com/norcalli/nvim_utils) - [nvim-luadev](https://github.com/bfredl/nvim-luadev) - REPL/debug console for nvim lua plugins - [nvim-luapad](https://github.com/rafcamlet/nvim-luapad) - Interactive real time neovim scratchpad for embedded lua engine - [nlua.nvim](https://github.com/tjdevries/nlua.nvim) - Lua Development for Neovim - [BetterLua.vim](https://github.com/euclidianAce/BetterLua.vim) - Better Lua syntax highlighting in Vim/NeoVim ## Where to put Lua files ### init.lua Neovim supports loading an `init.lua` file for configuration instead of the usual `init.vim`. Note: `init.lua` is of course _completely_ optional. Support for `init.vim` is not going away and is still a valid option for configuration. Do keep in mind that some features are not 100% exposed to Lua yet. See also: - [`:help config`](https://neovim.io/doc/user/starting.html#config) ### Modules Lua modules are found inside a `lua/` folder in your `'runtimepath'` (for most users, this will mean `~/.config/nvim/lua` on \*nix systems and `~/AppData/Local/nvim/lua` on Windows). You can `require()` files in this folder as Lua modules. Let's take the following folder structure as an example: ```text 📂 ~/.config/nvim ├── 📁 after ├── 📁 ftplugin ├── 📂 lua │ ├── 🌑 myluamodule.lua │ └── 📂 other_modules │ ├── 🌑 anothermodule.lua │ └── 🌑 init.lua ├── 📁 pack ├── 📁 plugin ├── 📁 syntax └── 🇻 init.vim ``` The following Lua code will load `myluamodule.lua`: ```lua require('myluamodule') ``` Notice the absence of a `.lua` extension. Similarly, loading `other_modules/anothermodule.lua` is done like so: ```lua require('other_modules.anothermodule') -- or require('other_modules/anothermodule') ``` Path separators are denoted by either a dot `.` or a slash `/`. A folder containing an `init.lua` file can be required directly, without having to specify the name of the file. ```lua require('other_modules') -- loads other_modules/init.lua ``` Requiring a nonexistent module or a module which contains syntax errors aborts the currently executing script. `pcall()` may be used to prevent errors. ```lua local ok, _ = pcall(require, 'module_with_error') if not ok then -- not loaded end ``` See also: - [`:help lua-require`](https://neovim.io/doc/user/lua.html#lua-require) #### Tips Several Lua plugins might have identical filenames in their `lua/` folder. This could lead to namespace clashes. If two different plugins have a `lua/main.lua` file, then doing `require('main')` is ambiguous: which file do we want to source? It might be a good idea to namespace your config or your plugin with a top-level folder, like so: `lua/plugin_name/main.lua` ### Runtime files Much like Vimscript files, Lua files can be loaded automatically from special folders in your `runtimepath`. Currently, the following folders are supported: - `colors/` - `compiler/` - `ftplugin/` - `ftdetect/` - `indent/` - `plugin/` - `syntax/` Note: in a runtime directory, all `*.vim` files are sourced before `*.lua` files. See also: - [`:help 'runtimepath'`](https://neovim.io/doc/user/options.html#'runtimepath') - [`:help load-plugins`](https://neovim.io/doc/user/starting.html#load-plugins) #### Tips Since runtime files aren't based on the Lua module system, two plugins can have a `plugin/main.lua` file without it being an issue. ## Using Lua from Vimscript ### :lua This command executes a chunk of Lua code. ```vim :lua require('myluamodule') ``` Multi-line scripts are possible using heredoc syntax: ```vim echo "Here's a bigger chunk of Lua code" lua << EOF local mod = require('mymodule') local tbl = {1, 2, 3} for k, v in ipairs(tbl) do mod.method(v) end print(tbl) EOF ``` Note: each `:lua` command has its own scope and variables declared with the `local` keyword are not accessible outside of the command. This won't work: ```vim :lua local foo = 1 :lua print(foo) " prints 'nil' instead of '1' ``` Note 2: the `print()` function in Lua behaves similarly to the `:echomsg` command. Its output is saved in the message-history and can be suppressed by the `:silent` command. See also: - [`:help :lua`](https://neovim.io/doc/user/lua.html#Lua) - [`:help :lua-heredoc`](https://neovim.io/doc/user/lua.html#:lua-heredoc) ### :luado This command executes a chunk of Lua code that acts on a range of lines in the current buffer. If no range is specified, the whole buffer is used instead. Whatever string is `return`ed from the chunk is used to determine what each line should be replaced with. The following command would replace every line in the current buffer with the text `hello world`: ```vim :luado return 'hello world' ``` Two implicit `line` and `linenr` variables are also provided. `line` is the text of the line being iterated upon whereas `linenr` is its number. The following command would make every line whose number is divisible by 2 uppercase: ```vim :luado if linenr % 2 == 0 then return line:upper() end ``` See also: - [`:help :luado`](https://neovim.io/doc/user/lua.html#:luado) ### Sourcing Lua files Neovim provides 3 Ex commands to source Lua files - `:luafile` - `:source` - `:runtime` `:luafile` and `:source` are very similar: ```vim :luafile ~/foo/bar/baz/myluafile.lua :luafile % :source ~/foo/bar/baz/myluafile.lua :source % ``` `:source` also supports ranges, which can be useful to only execute part of a script: ```vim :1,10source ``` `:runtime` is a little different: it uses the `'runtimepath'` option to determine which files to source. See [`:help :runtime`](https://neovim.io/doc/user/repeat.html#:runtime) for more details. See also: - [`:help :luafile`](https://neovim.io/doc/user/lua.html#:luafile) - [`:help :source`](https://neovim.io/doc/user/repeat.html#:source) - [`:help :runtime`](https://neovim.io/doc/user/repeat.html#:runtime) #### Sourcing a lua file vs calling require(): You might be wondering what the difference between calling the `require()` function and sourcing a Lua file is and whether you should prefer one way over the other. They have different use cases: - `require()`: - is a built-in Lua function. It allows you to take advantage of Lua's module system - searches for modules in `lua/` folders in your `'runtimepath'` - keeps track of what modules have been loaded and prevents a script from being parsed and executed a second time. If you change the file containing the code for a module and try to `require()` it a second time while Neovim is running, the module will not actually update - `:luafile`, `:source` and `:runtime`: - are Ex commands. They do not support modules - execute the contents of a script regardless of whether it has been executed before - `:luafile` and `:source` take a path that is either absolute or relative to the working directory of the current window - `:runtime` uses the `'runtimepath'` option to find files Files sourced via `:source`, `:runtime` or automatically from runtime directories will also show up in `:scriptnames` and `--startuptime` ### luaeval() This built-in Vimscript function evaluates a Lua expression string and returns its value. Lua data types are automatically converted to Vimscript types (and vice versa). ```vim " You can store the result in a variable let variable = luaeval('1 + 1') echo variable " 2 let concat = luaeval('"Lua".." is ".."awesome"') echo concat " 'Lua is awesome' " List-like tables are converted to Vim lists let list = luaeval('{1, 2, 3, 4}') echo list[0] " 1 echo list[1] " 2 " Note that unlike Lua tables, Vim lists are 0-indexed " Dict-like tables are converted to Vim dictionaries let dict = luaeval('{foo = "bar", baz = "qux"}') echo dict.foo " 'bar' " Same thing for booleans and nil echo luaeval('true') " v:true echo luaeval('nil') " v:null " You can create Vimscript aliases for Lua functions let LuaMathPow = luaeval('math.pow') echo LuaMathPow(2, 2) " 4 let LuaModuleFunction = luaeval('require("mymodule").myfunction') call LuaModuleFunction() " It is also possible to pass Lua functions as values to Vim functions lua X = function(k, v) return string.format("%s:%s", k, v) end echo map([1, 2, 3], luaeval("X")) ``` `luaeval()` takes an optional second argument that allows you to pass data to the expression. You can then access that data from Lua using the magic global `_A`: ```vim echo luaeval('_A[1] + _A[2]', [1, 1]) " 2 echo luaeval('string.format("Lua is %s", _A)', 'awesome') " 'Lua is awesome' ``` See also: - [`:help luaeval()`](https://neovim.io/doc/user/lua.html#luaeval()) ### v:lua This global Vim variable allows you to call Lua functions in the global namespace ([`_G`](https://www.lua.org/manual/5.1/manual.html#pdf-_G)) directly from Vimscript. Again, Vim data types are converted to Lua types and vice versa. ```vim call v:lua.print('Hello from Lua!') " 'Hello from Lua!' let scream = v:lua.string.rep('A', 10) echo scream " 'AAAAAAAAAA' " How about a nice statusline? lua << EOF function _G.statusline() local filepath = '%f' local align_section = '%=' local percentage_through_file = '%p%%' return string.format( '%s%s%s', filepath, align_section, percentage_through_file ) end EOF set statusline=%!v:lua.statusline() " Also works in expression mappings lua << EOF function _G.check_back_space() local col = vim.api.nvim_win_get_cursor(0)[2] return (col == 0 or vim.api.nvim_get_current_line():sub(col, col):match('%s')) and true end EOF inoremap <silent> <expr> <Tab> \ pumvisible() ? "\<C-N>" : \ v:lua.check_back_space() ? "\<Tab>" : \ completion#trigger_completion() " Call a function from a Lua module by using single quotes and omitting parentheses: call v:lua.require'module'.foo() ``` See also: - [`:help v:lua`](https://neovim.io/doc/user/eval.html#v:lua) - [`:help v:lua-call`](https://neovim.io/doc/user/lua.html#v:lua-call) #### Caveats This variable can only be used to call functions. The following will always throw an error: ```vim " Aliasing functions doesn't work let LuaPrint = v:lua.print " Accessing dictionaries doesn't work echo v:lua.some_global_dict['key'] " Using a function as a value doesn't work echo map([1, 2, 3], v:lua.global_callback) ``` ### Tips You can get Lua syntax highlighting inside .vim files by putting `let g:vimsyn_embed = 'l'` in your configuration file. See [`:help g:vimsyn_embed`](https://neovim.io/doc/user/syntax.html#g:vimsyn_embed) for more on this option. ## The vim namespace Neovim exposes a global `vim` variable which serves as an entry point to interact with its APIs from Lua. It provides users with an extended "standard library" of functions as well as various sub-modules. Some notable functions and modules include: - `vim.inspect`: transform Lua objects into human-readable strings (useful for inspecting tables) - `vim.regex`: use Vim regexes from Lua - `vim.api`: module that exposes API functions (the same API used by remote plugins) - `vim.ui`: overridable UI functions that can be leveraged by plugins - `vim.loop`: module that exposes the functionality of Neovim's event-loop (using LibUV) - `vim.lsp`: module that controls the built-in LSP client - `vim.treesitter`: module that exposes the functionality of the tree-sitter library This list is by no means comprehensive. If you wish to know more about what's made available by the `vim` variable, [`:help lua-stdlib`](https://neovim.io/doc/user/lua.html#lua-stdlib) and [`:help lua-vim`](https://neovim.io/doc/user/lua.html#lua-vim) are the way to go. Alternatively, you can do `:lua print(vim.inspect(vim))` to get a list of every module. API functions are documented under [`:help api-global`](https://neovim.io/doc/user/api.html#api-global). #### Tips Writing `print(vim.inspect(x))` every time you want to inspect the contents of an object can get pretty tedious. It might be worthwhile to have a global wrapper function somewhere in your configuration (in Neovim 0.7.0+, this function is built-in, see [`:help vim.pretty_print()`](https://neovim.io/doc/user/lua.html#vim.pretty_print())): ```lua function _G.put(...) local objects = {} for i = 1, select('#', ...) do local v = select(i, ...) table.insert(objects, vim.inspect(v)) end print(table.concat(objects, '\n')) return ... end ``` You can then inspect the contents of an object very quickly in your code or from the command-line: ```lua put({1, 2, 3}) ``` ```vim :lua put(vim.loop) ``` Alternatively, you can use the `:lua` command to pretty-print a Lua expression by prefixing it with `=` (Neovim 0.7+ only): ```vim :lua =vim.loop ``` Additionally, you may find that built-in Lua functions are sometimes lacking compared to what you would find in other languages (for example `os.clock()` only returns a value in seconds, not milliseconds). Be sure to look at the Neovim stdlib (and `vim.fn`, more on that later), it probably has what you're looking for. ## Using Vimscript from Lua ### vim.api.nvim_eval() This function evaluates a Vimscript expression string and returns its value. Vimscript data types are automatically converted to Lua types (and vice versa). It is the Lua equivalent of the `luaeval()` function in Vimscript ```lua -- Data types are converted correctly print(vim.api.nvim_eval('1 + 1')) -- 2 print(vim.inspect(vim.api.nvim_eval('[1, 2, 3]'))) -- { 1, 2, 3 } print(vim.inspect(vim.api.nvim_eval('{"foo": "bar", "baz": "qux"}'))) -- { baz = "qux", foo = "bar" } print(vim.api.nvim_eval('v:true')) -- true print(vim.api.nvim_eval('v:null')) -- nil ``` #### Caveats Unlike `luaeval()`, `vim.api.nvim_eval()` does not provide an implicit `_A` variable to pass data to the expression. ### vim.api.nvim_exec() This function evaluates a chunk of Vimscript code. It takes in a string containing the source code to execute and a boolean to determine whether the output of the code should be returned by the function (you can then store the output in a variable, for example). ```lua local result = vim.api.nvim_exec( [[ let s:mytext = 'hello world' function! s:MyFunction(text) echo a:text endfunction call s:MyFunction(s:mytext) ]], true) print(result) -- 'hello world' ``` #### Caveats `nvim_exec` does not support script-local variables (`s:`) prior to Neovim 0.6.0 ### vim.api.nvim_command() This function executes an ex command. It takes in a string containing the command to execute. ```lua vim.api.nvim_command('new') vim.api.nvim_command('wincmd H') vim.api.nvim_command('set nonumber') vim.api.nvim_command('%s/foo/bar/g') ``` ### vim.cmd() Alias for `vim.api.nvim_exec()`. Only the command argument is needed, `output` is always set to `false`. ```lua vim.cmd('buffers') vim.cmd([[ let g:multiline_list = [ \ 1, \ 2, \ 3, \ ] echo g:multiline_list ]]) ``` #### Tips Since you have to pass strings to these functions, you often end up having to escape backslashes: ```lua vim.cmd('%s/\\Vfoo/bar/g') ``` Double bracketed strings are easier to use as they do not require escaping characters: ```lua vim.cmd([[%s/\Vfoo/bar/g]]) ``` ### vim.api.nvim_replace_termcodes() This API function allows you to escape terminal codes and Vim keycodes. You may have come across mappings like this one: ```vim inoremap <expr> <Tab> pumvisible() ? "\<C-N>" : "\<Tab>" ``` Trying to do the same in Lua can prove to be a challenge. You might be tempted to do it like this: ```lua function _G.smart_tab() return vim.fn.pumvisible() == 1 and [[\<C-N>]] or [[\<Tab>]] end vim.api.nvim_set_keymap('i', '<Tab>', 'v:lua.smart_tab()', {expr = true, noremap = true}) ``` only to find out that the mapping inserts `\<Tab>` and `\<C-N>` literally... Being able to escape keycodes is actually a Vimscript feature. Aside from the usual escape sequences like `\r`, `\42` or `\x10` that are common to many programming languages, Vimscript `expr-quotes` (strings surrounded with double quotes) allow you to escape the human-readable representation of Vim keycodes. Lua doesn't have such a feature built-in. Fortunately, Neovim has an API function for escaping terminal codes and keycodes: `nvim_replace_termcodes()` ```lua print(vim.api.nvim_replace_termcodes('<Tab>', true, true, true)) ``` This is a little verbose. Making a reusable wrapper can help: ```lua -- The function is called `t` for `termcodes`. -- You don't have to call it that, but I find the terseness convenient local function t(str) -- Adjust boolean arguments as needed return vim.api.nvim_replace_termcodes(str, true, true, true) end print(t'<Tab>') ``` Coming back to our earlier example, this should now work as expected: ```lua local function t(str) return vim.api.nvim_replace_termcodes(str, true, true, true) end function _G.smart_tab() return vim.fn.pumvisible() == 1 and t'<C-N>' or t'<Tab>' end vim.api.nvim_set_keymap('i', '<Tab>', 'v:lua.smart_tab()', {expr = true, noremap = true}) ``` This is not necessary with `vim.keymap.set()` as it automatically transforms vim keycodes returned by Lua functions in `expr` mappings by default: ```lua vim.keymap.set('i', '<Tab>', function() return vim.fn.pumvisible() == 1 and '<C-N>' or '<Tab>' end, {expr = true}) ``` See also: - [`:help keycodes`](https://neovim.io/doc/user/intro.html#keycodes) - [`:help expr-quote`](https://neovim.io/doc/user/eval.html#expr-quote) - [`:help nvim_replace_termcodes()`](https://neovim.io/doc/user/api.html#nvim_replace_termcodes()) ## Managing vim options ### Using api functions Neovim provides a set of API functions to either set an option or get its current value: - Global options: - [`vim.api.nvim_set_option()`](https://neovim.io/doc/user/api.html#nvim_set_option()) - [`vim.api.nvim_get_option()`](https://neovim.io/doc/user/api.html#nvim_get_option()) - Buffer-local options: - [`vim.api.nvim_buf_set_option()`](https://neovim.io/doc/user/api.html#nvim_buf_set_option()) - [`vim.api.nvim_buf_get_option()`](https://neovim.io/doc/user/api.html#nvim_buf_get_option()) - Window-local options: - [`vim.api.nvim_win_set_option()`](https://neovim.io/doc/user/api.html#nvim_win_set_option()) - [`vim.api.nvim_win_get_option()`](https://neovim.io/doc/user/api.html#nvim_win_get_option()) They take a string containing the name of the option to set/get as well as the value you want to set it to. Boolean options (like `(no)number`) have to be set to either `true` or `false`: ```lua vim.api.nvim_set_option('smarttab', false) print(vim.api.nvim_get_option('smarttab')) -- false ``` Unsurprisingly, string options have to be set to a string: ```lua vim.api.nvim_set_option('selection', 'exclusive') print(vim.api.nvim_get_option('selection')) -- 'exclusive' ``` Number options accept a number: ```lua vim.api.nvim_set_option('updatetime', 3000) print(vim.api.nvim_get_option('updatetime')) -- 3000 ``` Buffer-local and window-local options also need a buffer number or a window number (using `0` will set/get the option for the current buffer/window): ```lua vim.api.nvim_win_set_option(0, 'number', true) vim.api.nvim_buf_set_option(10, 'shiftwidth', 4) print(vim.api.nvim_win_get_option(0, 'number')) -- true print(vim.api.nvim_buf_get_option(10, 'shiftwidth')) -- 4 ``` ### Using meta-accessors A few meta-accessors are available if you want to set options in a more "idiomatic" way. They essentially wrap the above API functions and allow you to manipulate options as if they were variables: - [`vim.o`](https://neovim.io/doc/user/lua.html#vim.o): behaves like `:let &{option-name}` - [`vim.go`](https://neovim.io/doc/user/lua.html#vim.go): behaves like `:let &g:{option-name}` - [`vim.bo`](https://neovim.io/doc/user/lua.html#vim.bo): behaves like `:let &l:{option-name}` for buffer-local options - [`vim.wo`](https://neovim.io/doc/user/lua.html#vim.wo): behaves like `:let &l:{option-name}` for window-local options ```lua vim.o.smarttab = false -- let &smarttab = v:false print(vim.o.smarttab) -- false vim.o.isfname = vim.o.isfname .. ',@-@' -- on Linux: let &isfname = &isfname .. ',@-@' print(vim.o.isfname) -- '@,48-57,/,.,-,_,+,,,#,$,%,~,=,@-@' vim.bo.shiftwidth = 4 print(vim.bo.shiftwidth) -- 4 ``` You can specify a number for buffer-local and window-local options. If no number is given, the current buffer/window is used: ```lua vim.bo[4].expandtab = true -- same as vim.api.nvim_buf_set_option(4, 'expandtab', true) vim.wo.number = true -- same as vim.api.nvim_win_set_option(0, 'number', true) ``` These wrappers also have more sophisticated `vim.opt*` variants that provide convenient mechanisms for setting options in Lua. They're similar to what you might be used to in your `init.vim`: - `vim.opt`: behaves like `:set` - `vim.opt_global`: behaves like `:setglobal` - `vim.opt_local`: behaves like `:setlocal` ```lua vim.opt.smarttab = false print(vim.opt.smarttab:get()) -- false ``` Some options can be set using Lua tables: ```lua vim.opt.completeopt = {'menuone', 'noselect'} print(vim.inspect(vim.opt.completeopt:get())) -- { "menuone", "noselect" } ``` Wrappers for list-like, map-like and set-like options also come with methods and metamethods that work similarly to their `:set+=`, `:set^=` and `:set-=` counterparts in Vimscript. ```lua vim.opt.shortmess:append({ I = true }) -- alternative form: vim.opt.shortmess = vim.opt.shortmess + { I = true } vim.opt.whichwrap:remove({ 'b', 's' }) -- alternative form: vim.opt.whichwrap = vim.opt.whichwrap - { 'b', 's' } ``` Be sure to look at [`:help vim.opt`](https://neovim.io/doc/user/lua.html#vim.opt) for more information. See also: - [`:help lua-vim-options`](https://neovim.io/doc/user/lua.html#lua-vim-options) ## Managing vim internal variables ### Using api functions Much like options, internal variables have their own set of API functions: - Global variables (`g:`): - [`vim.api.nvim_set_var()`](https://neovim.io/doc/user/api.html#nvim_set_var()) - [`vim.api.nvim_get_var()`](https://neovim.io/doc/user/api.html#nvim_get_var()) - [`vim.api.nvim_del_var()`](https://neovim.io/doc/user/api.html#nvim_del_var()) - Buffer variables (`b:`): - [`vim.api.nvim_buf_set_var()`](https://neovim.io/doc/user/api.html#nvim_buf_set_var()) - [`vim.api.nvim_buf_get_var()`](https://neovim.io/doc/user/api.html#nvim_buf_get_var()) - [`vim.api.nvim_buf_del_var()`](https://neovim.io/doc/user/api.html#nvim_buf_del_var()) - Window variables (`w:`): - [`vim.api.nvim_win_set_var()`](https://neovim.io/doc/user/api.html#nvim_win_set_var()) - [`vim.api.nvim_win_get_var()`](https://neovim.io/doc/user/api.html#nvim_win_get_var()) - [`vim.api.nvim_win_del_var()`](https://neovim.io/doc/user/api.html#nvim_win_del_var()) - Tabpage variables (`t:`): - [`vim.api.nvim_tabpage_set_var()`](https://neovim.io/doc/user/api.html#nvim_tabpage_set_var()) - [`vim.api.nvim_tabpage_get_var()`](https://neovim.io/doc/user/api.html#nvim_tabpage_get_var()) - [`vim.api.nvim_tabpage_del_var()`](https://neovim.io/doc/user/api.html#nvim_tabpage_del_var()) - Predefined Vim variables (`v:`): - [`vim.api.nvim_set_vvar()`](https://neovim.io/doc/user/api.html#nvim_set_vvar()) - [`vim.api.nvim_get_vvar()`](https://neovim.io/doc/user/api.html#nvim_get_vvar()) With the exception of predefined Vim variables, they can also be deleted (the `:unlet` command is the equivalent in Vimscript). Local variables (`l:`), script variables (`s:`) and function arguments (`a:`) cannot be manipulated as they only make sense in the context of a Vim script, Lua has its own scoping rules. If you are unfamiliar with what these variables do, [`:help internal-variables`](https://neovim.io/doc/user/eval.html#internal-variables) describes them in detail. These functions take a string containing the name of the variable to set/get/delete as well as the value you want to set it to. ```lua vim.api.nvim_set_var('some_global_variable', { key1 = 'value', key2 = 300 }) print(vim.inspect(vim.api.nvim_get_var('some_global_variable'))) -- { key1 = "value", key2 = 300 } vim.api.nvim_del_var('some_global_variable') ``` Variables that are scoped to a buffer, a window or a tabpage also receive a number (using `0` will set/get/delete the variable for the current buffer/window/tabpage): ```lua vim.api.nvim_win_set_var(0, 'some_window_variable', 2500) vim.api.nvim_tab_set_var(3, 'some_tabpage_variable', 'hello world') print(vim.api.nvim_win_get_var(0, 'some_window_variable')) -- 2500 print(vim.api.nvim_buf_get_var(3, 'some_tabpage_variable')) -- 'hello world' vim.api.nvim_win_del_var(0, 'some_window_variable') vim.api.nvim_buf_del_var(3, 'some_tabpage_variable') ``` ### Using meta-accessors Internal variables can be manipulated more intuitively using these meta-accessors: - [`vim.g`](https://neovim.io/doc/user/lua.html#vim.g): global variables - [`vim.b`](https://neovim.io/doc/user/lua.html#vim.b): buffer variables - [`vim.w`](https://neovim.io/doc/user/lua.html#vim.w): window variables - [`vim.t`](https://neovim.io/doc/user/lua.html#vim.t): tabpage variables - [`vim.v`](https://neovim.io/doc/user/lua.html#vim.v): predefined Vim variables - [`vim.env`](https://neovim.io/doc/user/lua.html#vim.env): environment variables ```lua vim.g.some_global_variable = { key1 = 'value', key2 = 300 } print(vim.inspect(vim.g.some_global_variable)) -- { key1 = "value", key2 = 300 } -- target a specific buffer/window/tabpage (Neovim 0.6+) vim.b[2].myvar = 1 ``` Some variable names may contain characters that cannot be used for identifiers in Lua. You can still manipulate these variables by using this syntax: `vim.g['my#variable']`. To delete one of these variables, simply assign `nil` to it: ```lua vim.g.some_global_variable = nil ``` See also: - [`:help lua-vim-variables`](https://neovim.io/doc/user/lua.html#lua-vim-variables) #### Caveats You cannot add/update/delete keys from a dictionary stored in one of these variables. For example, this snippet of Vimscript code does not work as expected: ```vim let g:variable = {} lua vim.g.variable.key = 'a' echo g:variable " {} ``` You can use a temporary variable as a workaround: ```vim let g:variable = {} lua << EOF local tmp = vim.g.variable tmp.key = 'a' vim.g.variable = tmp EOF echo g:variable " {'key': 'a'} ``` This is a known issue: - [Issue #12544](https://github.com/neovim/neovim/issues/12544) ## Calling Vimscript functions ### vim.fn.{function}() `vim.fn` can be used to call a Vimscript function. Data types are converted back and forth from Lua to Vimscript. ```lua print(vim.fn.printf('Hello from %s', 'Lua')) local reversed_list = vim.fn.reverse({ 'a', 'b', 'c' }) print(vim.inspect(reversed_list)) -- { "c", "b", "a" } local function print_stdout(chan_id, data, name) print(data[1]) end vim.fn.jobstart('ls', { on_stdout = print_stdout }) ``` Hashes (`#`) are not valid characters for identifiers in Lua, so autoload functions have to be called with this syntax: ```lua vim.fn['my#autoload#function']() ``` The functionality of `vim.fn` is identical to `vim.call`, but allows a more Lua-like syntax. It is distinct from `vim.api.nvim_call_function` in that converting Vim/Lua objects is automatic: `vim.api.nvim_call_function` returns a table for floating point numbers and does not accept Lua closures while `vim.fn` handles these types transparently. See also: - [`:help vim.fn`](https://neovim.io/doc/user/lua.html#vim.fn) #### Tips Neovim has an extensive library of powerful built-in functions that are very useful for plugins. See [`:help vim-function`](https://neovim.io/doc/user/eval.html#vim-function) for an alphabetical list and [`:help function-list`](https://neovim.io/doc/user/usr_41.html#function-list) for a list of functions grouped by topic. Neovim API functions can be used directly through `vim.api.{..}`. See [`:help api`](https://neovim.io/doc/user/api.html#API) for information. #### Caveats Some Vim functions that should return a boolean return `1` or `0` instead. This isn't a problem in Vimscript as `1` is truthy and `0` falsy, enabling constructs like these: ```vim if has('nvim') " do something... endif ``` In Lua however, only `false` and `nil` are considered falsy, numbers always evaluate to `true` no matter their value. You have to explicitly check for `1` or `0`: ```lua if vim.fn.has('nvim') == 1 then -- do something... end ``` ## Defining mappings ### API functions Neovim provides a list of API functions to set, get and delete mappings: - Global mappings: - [`vim.api.nvim_set_keymap()`](https://neovim.io/doc/user/api.html#nvim_set_keymap()) - [`vim.api.nvim_get_keymap()`](https://neovim.io/doc/user/api.html#nvim_get_keymap()) - [`vim.api.nvim_del_keymap()`](https://neovim.io/doc/user/api.html#nvim_del_keymap()) - Buffer-local mappings: - [`vim.api.nvim_buf_set_keymap()`](https://neovim.io/doc/user/api.html#nvim_buf_set_keymap()) - [`vim.api.nvim_buf_get_keymap()`](https://neovim.io/doc/user/api.html#nvim_buf_get_keymap()) - [`vim.api.nvim_buf_del_keymap()`](https://neovim.io/doc/user/api.html#nvim_buf_del_keymap()) Let's start with `vim.api.nvim_set_keymap()` and `vim.api.nvim_buf_set_keymap()` The first argument passed to the function is a string containing the name of the mode for which the mapping will take effect: | String value | Help page | Affected modes | Vimscript equivalent | | ---------------------- | ------------- | ---------------------------------------- | -------------------- | | `''` (an empty string) | `mapmode-nvo` | Normal, Visual, Select, Operator-pending | `:map` | | `'n'` | `mapmode-n` | Normal | `:nmap` | | `'v'` | `mapmode-v` | Visual and Select | `:vmap` | | `'s'` | `mapmode-s` | Select | `:smap` | | `'x'` | `mapmode-x` | Visual | `:xmap` | | `'o'` | `mapmode-o` | Operator-pending | `:omap` | | `'!'` | `mapmode-ic` | Insert and Command-line | `:map!` | | `'i'` | `mapmode-i` | Insert | `:imap` | | `'l'` | `mapmode-l` | Insert, Command-line, Lang-Arg | `:lmap` | | `'c'` | `mapmode-c` | Command-line | `:cmap` | | `'t'` | `mapmode-t` | Terminal | `:tmap` | The second argument is a string containing the left-hand side of the mapping (the key or set of keys that trigger the command defined in the mapping). An empty string is equivalent to `<Nop>`, which disables a key. The third argument is a string containing the right-hand side of the mapping (the command to execute). The final argument is a table containing boolean options for the mapping as defined in [`:help :map-arguments`](https://neovim.io/doc/user/map.html#:map-arguments) (including `noremap` and excluding `buffer`). Since Neovim 0.7.0, you can also pass a `callback` option to invoke a Lua function instead of the right-hand side when executing the mapping. Buffer-local mappings also take a buffer number as their first argument (`0` sets the mapping for the current buffer). ```lua vim.api.nvim_set_keymap('n', '<Leader><Space>', ':set hlsearch!<CR>', { noremap = true, silent = true }) -- :nnoremap <silent> <Leader><Space> :set hlsearch<CR> vim.api.nvim_set_keymap('n', '<Leader>tegf', [[<Cmd>lua require('telescope.builtin').git_files()<CR>]], { noremap = true, silent = true }) -- :nnoremap <silent> <Leader>tegf <Cmd>lua require('telescope.builtin').git_files()<CR> vim.api.nvim_buf_set_keymap(0, '', 'cc', 'line(".") == 1 ? "cc" : "ggcc"', { noremap = true, expr = true }) -- :noremap <buffer> <expr> cc line('.') == 1 ? 'cc' : 'ggcc' vim.api.nvim_set_keymap('n', '<Leader>ex', '', { noremap = true, callback = function() print('My example') end, -- Since Lua function don't have a useful string representation, you can use the "desc" option to document your mapping desc = 'Prints "My example" in the message area', }) ``` `vim.api.nvim_get_keymap()` takes a string containing the shortname of the mode for which you want the list of mappings (see table above). The return value is a table containing all global mappings for the mode. ```lua print(vim.inspect(vim.api.nvim_get_keymap('n'))) -- :verbose nmap ``` `vim.api.nvim_buf_get_keymap()` takes an additional buffer number as its first argument (`0` will get mapppings for the current bufffer) ```lua print(vim.inspect(vim.api.nvim_buf_get_keymap(0, 'i'))) -- :verbose imap <buffer> ``` `vim.api.nvim_del_keymap()` takes a mode and the left-hand side of a mapping. ```lua vim.api.nvim_del_keymap('n', '<Leader><Space>') -- :nunmap <Leader><Space> ``` Again, `vim.api.nvim_buf_del_keymap()`, takes a buffer number as its first argument, with `0` representing the current buffer. ```lua vim.api.nvim_buf_del_keymap(0, 'i', '<Tab>') -- :iunmap <buffer> <Tab> ``` ### vim.keymap :warning: The functions discussed in this section are only available in Neovim 0.7.0+ Neovim provides two functions to set/del mappings: - [`vim.keymap.set()`](https://neovim.io/doc/user/lua.html#vim.keymap.set()) - [`vim.keymap.del()`](https://neovim.io/doc/user/lua.html#vim.keymap.del()) These are similar to the above API functions with added syntactic sugar. `vim.keymap.set()` takes a string as its first argument. It can also be a table of strings to define mappings for multiple modes at once: ```lua vim.keymap.set('n', '<Leader>ex1', '<Cmd>lua vim.notify("Example 1")<CR>') vim.keymap.set({'n', 'c'}, '<Leader>ex2', '<Cmd>lua vim.notify("Example 2")<CR>') ``` The second argument is the left-hand side of the mapping. The third argument is the right-hand side of the mapping, which can either be a string or a Lua function: ```lua vim.keymap.set('n', '<Leader>ex1', '<Cmd>echomsg "Example 1"<CR>') vim.keymap.set('n', '<Leader>ex2', function() print("Example 2") end) vim.keymap.set('n', '<Leader>pl1', require('plugin').plugin_action) -- To avoid the startup cost of requiring the module, you can wrap it in a function to require it lazily when invoking the mapping: vim.keymap.set('n', '<Leader>pl2', function() require('plugin').plugin_action() end) ``` The fourth (optional) argument is a table of options that correspond to the options passed to `vim.api.nvim_set_keymap()`, with a few additions (see [`:help vim.keymap.set()`](https://neovim.io/doc/user/lua.html#vim.keymap.set()) for the full list). ```lua vim.keymap.set('n', '<Leader>ex1', '<Cmd>echomsg "Example 1"<CR>', {buffer = true}) vim.keymap.set('n', '<Leader>ex2', function() print('Example 2') end, {desc = 'Prints "Example 2" to the message area'}) ``` Defining keymaps with a Lua function is different from using a string. The usual way to show information about a keymap like `:nmap <Leader>ex1` will not output useful information (the string itself), but instead only show `Lua function`. It is recommended to add a `desc` key to describe the behavior of your keymap. This is especially important for documenting plugin mappings so users can understand the usage of the keymap more easily. An interesting feature of this API is that it irons out some historical quirks of Vim mappings: - Mappings are `noremap` by default, except when the `rhs` is a `<Plug>` mapping. This means you rarely have to think about whether a mapping should be recursive or not: ```lua vim.keymap.set('n', '<Leader>test1', '<Cmd>echo "test"<CR>') -- :nnoremap <Leader>test <Cmd>echo "test"<CR> -- If you DO want the mapping to be recursive, set the "remap" option to "true" vim.keymap.set('n', '>', ']', {remap = true}) -- :nmap > ] -- <Plug> mappings don't work unless they're recursive, vim.keymap.set() handles that for you automatically vim.keymap.set('n', '<Leader>plug', '<Plug>(plugin)') -- :nmap <Leader>plug <Plug>(plugin) ``` - In `expr` mappings, `nvim_replace_termcodes()` is automatically applied to strings returned from Lua functions: ```lua vim.keymap.set('i', '<Tab>', function() return vim.fn.pumvisible == 1 and '<C-N>' or '<Tab>' end, {expr = true}) ``` See also: - [`:help recursive_mapping`](https://neovim.io/doc/user/map.html#recursive_mapping) `vim.keymap.del()` works the same way but deletes mappings instead: ```lua vim.keymap.del('n', '<Leader>ex1') vim.keymap.del({'n', 'c'}, '<Leader>ex2', {buffer = true}) ``` ## Defining user commands :warning: The API functions discussed in this section are only available in Neovim 0.7.0+ Neovim provides API functions for user-defined commands: - Global user commands: - [`vim.api.nvim_create_user_command()`](https://neovim.io/doc/user/api.html#nvim_create_user_command()) - [`vim.api.nvim_del_user_command()`](https://neovim.io/doc/user/api.html#nvim_del_user_command()) - Buffer-local user commands: - [`vim.api.nvim_buf_create_user_command()`](https://neovim.io/doc/user/api.html#nvim_buf_create_user_command()) - [`vim.api.nvim_buf_del_user_command()`](https://neovim.io/doc/user/api.html#nvim_buf_del_user_command()) Let's start with `vim.api.nvim_create_user_command()` The first argument passed to this function is the name of the command (which must start with an uppercase letter). The second argument is the code to execute when invoking said command. It can either be: A string (in which case it will be executed as Vimscript). You can use escape sequences like `<q-args>`, `<range>`, etc. like you would with `:command` ```lua vim.api.nvim_create_user_command('Upper', 'echo toupper(<q-args>)', { nargs = 1 }) -- :command! -nargs=1 Upper echo toupper(<q-args>) vim.cmd('Upper hello world') -- prints "HELLO WORLD" ``` Or a Lua function. It receives a dictionary-like table that contains the data normally provided by escape sequences (see [`:help nvim_create_user_command()`](https://neovim.io/doc/user/api.html#nvim_create_user_command()) for a list of available keys) ```lua vim.api.nvim_create_user_command( 'Upper', function(opts) print(string.upper(opts.args)) end, { nargs = 1 } ) ``` The third argument lets you pass command attributes as a table (see [`:help command-attributes`](https://neovim.io/doc/user/map.html#command-attributes)). Since you can already define buffer-local user commands with `vim.api.nvim_buf_create_user_command()`, `-buffer` is not a valid attribute. Two additional attributes are available: - `desc` allows you to control what gets displayed when you run `:command {cmd}` on a command defined as a Lua callback. Similarly to keymaps, it is recommended to add a `desc` key to commands defined as Lua functions. - `force` is equivalent to calling `:command!` and replaces a command if one with the same name already exists. It is true by default, unlike its Vimscript equivalent. The `-complete` attribute can take a Lua function in addition to the attributes listed in [`:help :command-complete`](https://neovim.io/doc/user/map.html#:command-complete). ```lua vim.api.nvim_create_user_command('Upper', function() end, { nargs = 1, complete = function(ArgLead, CmdLine, CursorPos) -- return completion candidates as a list-like table return { 'foo', 'bar', 'baz' } end, }) ``` Buffer-local user commands also take a buffer number as their first argument. This is an advantage over `-buffer` which can only define a command for the current buffer. ```lua vim.api.nvim_buf_create_user_command(4, 'Upper', function() end, {}) ``` `vim.api.nvim_del_user_command()` takes a command name. ```lua vim.api.nvim_del_user_command('Upper') -- :delcommand Upper ``` Again, `vim.api.nvim_buf_del_user_command()`, takes a buffer number as its first argument, with `0` representing the current buffer. ```lua vim.api.nvim_buf_del_user_command(4, 'Upper') ``` See also: - [`:help nvim_create_user_command()`](https://neovim.io/doc/user/api.html#nvim_create_user_command()) - [`:help 40.2`](https://neovim.io/doc/user/usr_40.html#40.2) - [`:help command-attributes`](https://neovim.io/doc/user/map.html#command-attributes) ### Caveats The `-complete=custom` attribute automatically filters completion candidates and has built-in wildcard ([`:help wildcard`](https://neovim.io/doc/user/editing.html#wildcard)) support: ```vim function! s:completion_function(ArgLead, CmdLine, CursorPos) abort return join([ \ 'strawberry', \ 'star', \ 'stellar', \ ], "\n") endfunction command! -nargs=1 -complete=custom,s:completion_function Test echo <q-args> " Typing `:Test st[ae]<Tab>` returns "star" and "stellar" ``` Passing a Lua function to `complete` makes it behave like `customlist` which leaves filtering up to the user: ```lua vim.api.nvim_create_user_command('Test', function() end, { nargs = 1, complete = function(ArgLead, CmdLine, CursorPos) return { 'strawberry', 'star', 'stellar', } end, }) -- Typing `:Test z<Tab>` returns all the completion results because the list was not filtered ``` ## Defining autocommands (this section is a work in progress) Neovim 0.7.0 has API functions for autocommands. See `:help api-autocmd` for details - [Pull request #14661](https://github.com/neovim/neovim/pull/14661) (lua: autocmds take 2) ## Defining highlights (this section is a work in progress) Neovim 0.7.0 has API functions for highlight groups. See also: - [`:help nvim_set_hl()`](https://neovim.io/doc/user/api.html#nvim_set_hl()) - [`:help nvim_get_hl_by_id()`](https://neovim.io/doc/user/api.html#nvim_get_hl_by_id()) - [`:help nvim_get_hl_by_name()`](https://neovim.io/doc/user/api.html#nvim_get_hl_by_name()) ## General tips and recommendations ### Reloading cached modules In Lua, the `require()` function caches modules. This is a good thing for performance, but it can make working on plugins a bit cumbersome because modules are not updated on subsequent `require()` calls. If you'd like to refresh the cache for a particular module, you have to modify the `package.loaded` global table: ```lua package.loaded['modname'] = nil require('modname') -- loads an updated version of module 'modname' ``` The [nvim-lua/plenary.nvim](https://github.com/nvim-lua/plenary.nvim) plugin has a [custom function](https://github.com/nvim-lua/plenary.nvim/blob/master/lua/plenary/reload.lua) that does this for you. ### Don't pad Lua strings! When using double bracketed strings, resist the temptation to pad them! While it is fine to do in contexts where spaces are ignored, it can cause hard to debug issues when whitespace is significant: ```lua vim.api.nvim_set_keymap('n', '<Leader>f', [[ <Cmd>call foo()<CR> ]], {noremap = true}) ``` In the above example, `<Leader>f` is mapped to `<Space><Cmd>call foo()<CR><Space>` instead of `<Cmd>call foo()<CR>`. ### Notes about Vimscript <-> Lua type conversion #### Converting a variable creates a copy: You can't directly interact with the reference to a Vim object from Lua or a Lua object from Vimscript. For example, the `map()` function in Vimscript modifies a variable in place: ```vim let s:list = [1, 2, 3] let s:newlist = map(s:list, {_, v -> v * 2}) echo s:list " [2, 4, 6] echo s:newlist " [2, 4, 6] echo s:list is# s:newlist " 1 ``` Using this function from Lua creates a copy instead: ```lua local tbl = {1, 2, 3} local newtbl = vim.fn.map(tbl, function(_, v) return v * 2 end) print(vim.inspect(tbl)) -- { 1, 2, 3 } print(vim.inspect(newtbl)) -- { 2, 4, 6 } print(tbl == newtbl) -- false ``` #### Conversion is not always possible This mostly affects functions and tables: Lua tables that are a mix between a List and a Dictionary can't be converted: ```lua print(vim.fn.count({1, 1, number = 1}, 1)) -- E5100: Cannot convert given lua table: table should either have a sequence of positive integer keys or contain only string keys ``` While you can call Vim functions in Lua with `vim.fn`, you can't hold references to them. This can cause surprising behaviors: ```lua local FugitiveHead = vim.fn.funcref('FugitiveHead') print(FugitiveHead) -- vim.NIL vim.cmd("let g:test_dict = {'test_lambda': {-> 1}}") print(vim.g.test_dict.test_lambda) -- nil print(vim.inspect(vim.g.test_dict)) -- {} ``` Passing Lua functions to Vim functions is OK, storing them in Vim variables is not (fixed in Neovim 0.7.0+): ```lua -- This works: vim.fn.jobstart({'ls'}, { on_stdout = function(chan_id, data, name) print(vim.inspect(data)) end }) -- This doesn't: vim.g.test_dict = {test_lambda = function() return 1 end} -- Error: Cannot convert given lua type ``` Note however that doing the same from Vimscript with `luaeval()` **does** work: ```vim let g:test_dict = {'test_lambda': luaeval('function() return 1 end')} echo g:test_dict " {'test_lambda': function('<lambda>4714')} ``` #### Vim booleans A common pattern in Vim scripts is to use `1` or `0` instead of proper booleans. Indeed, Vim did not have a separate boolean type until version 7.4.1154. Lua booleans are converted to actual booleans in Vimscript, not numbers: ```vim lua vim.g.lua_true = true echo g:lua_true " v:true lua vim.g.lua_false = false echo g:lua_false " v:false ``` ### Setting up linters/language servers If you're using linters and/or language servers to get diagnostics and autocompletion for Lua projects, you may have to configure Neovim-specific settings for them. Here are a few recommended settings for popular tools: #### luacheck You can get [luacheck](https://github.com/mpeterv/luacheck/) to recognize the `vim` global by putting this configuration in `~/.luacheckrc` (or `$XDG_CONFIG_HOME/luacheck/.luacheckrc`): ```lua globals = { "vim", } ``` The [Alloyed/lua-lsp](https://github.com/Alloyed/lua-lsp/) language server uses `luacheck` to provide linting and reads the same file. For more information on how to configure `luacheck`, please refer to its [documentation](https://luacheck.readthedocs.io/en/stable/config.html) #### sumneko/lua-language-server The [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig/) repository contains [instructions to configure sumneko/lua-language-server](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#sumneko_lua) (the example uses the built-in LSP client but the configuration should be identical for other LSP client implementations). For more information on how to configure [sumneko/lua-language-server](https://github.com/sumneko/lua-language-server/) see ["Setting"](https://github.com/sumneko/lua-language-server/wiki/Setting) #### coc.nvim The [rafcamlet/coc-nvim-lua](https://github.com/rafcamlet/coc-nvim-lua/) completion source for [coc.nvim](https://github.com/neoclide/coc.nvim/) provides completion items for the Neovim stdlib. ### Debugging Lua code You can debug Lua code running in a separate Neovim instance with [jbyuki/one-small-step-for-vimkind](https://github.com/jbyuki/one-small-step-for-vimkind) The plugin uses the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/). Connecting to a debug adapter requires a DAP client like [mfussenegger/nvim-dap](https://github.com/mfussenegger/nvim-dap/) or [puremourning/vimspector](https://github.com/puremourning/vimspector/). ### Debugging Lua mappings/commands/autocommands The `:verbose` command allows you to see where a mapping/command/autocommand was defined: ```vim :verbose map m ``` ```text n m_ * <Cmd>echo 'example'<CR> Last set from ~/.config/nvim/init.vim line 26 ``` By default, this feature is disabled in Lua for performance reasons. You can enable it by starting Neovim with a verbose level greater than 0: ```sh nvim -V1 ``` See also: - [`:help 'verbose'`](https://neovim.io/doc/user/options.html#'verbose') - [`:help -V`](https://neovim.io/doc/user/starting.html#-V) - [neovim/neovim#15079](https://github.com/neovim/neovim/pull/15079) ### Testing Lua code - [plenary.nvim: test harness](https://github.com/nvim-lua/plenary.nvim/#plenarytest_harness) - [notomo/vusted](https://github.com/notomo/vusted) ### Using Luarocks packages [wbthomason/packer.nvim](https://github.com/wbthomason/packer.nvim) supports Luarocks packages. Instructions for how to set this up are available in the [README](https://github.com/wbthomason/packer.nvim/#luarocks-support) ## Miscellaneous ### vim.loop `vim.loop` is the module that exposes the LibUV API. Some resources: - [Official documentation for LibUV](https://docs.libuv.org/en/v1.x/) - [Luv documentation](https://github.com/luvit/luv/blob/master/docs.md) - [teukka.tech - Using LibUV in Neovim](https://teukka.tech/posts/2020-01-07-vimloop/) See also: - [`:help vim.loop`](https://neovim.io/doc/user/lua.html#vim.loop) ### vim.lsp `vim.lsp` is the module that controls the built-in LSP client. The [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig/) repository contains default configurations for popular language servers. The behavior of the client can be configured using "lsp-handlers". For more information: - [`:help lsp-handler`](https://neovim.io/doc/user/lsp.html#lsp-handler) - [neovim/neovim#12655](https://github.com/neovim/neovim/pull/12655) - [How to migrate from diagnostic-nvim](https://github.com/nvim-lua/diagnostic-nvim/issues/73#issue-737897078) You may also want to take a look at [plugins built around the LSP client](https://github.com/rockerBOO/awesome-neovim#lsp) See also: - [`:help lsp`](https://neovim.io/doc/user/lsp.html#LSP) ### vim.treesitter `vim.treesitter` is the module that controls the integration of the [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) library in Neovim. If you want to know more about Tree-sitter, you may be interested in this [presentation (38:37)](https://www.youtube.com/watch?v=Jes3bD6P0To). The [nvim-treesitter](https://github.com/nvim-treesitter/) organisation hosts various plugins taking advantage of the library. See also: - [`:help lua-treesitter`](https://neovim.io/doc/user/treesitter.html#lua-treesitter) ### Transpilers One advantage of using Lua is that you don't actually have to write Lua code! There is a multitude of transpilers available for the language. - [Moonscript](https://moonscript.org/) Probably one of the most well-known transpilers for Lua. Adds a lots of convenient features like classes, list comprehensions or function literals. The [svermeulen/nvim-moonmaker](https://github.com/svermeulen/nvim-moonmaker) plugin allows you to write Neovim plugins and configuration directly in Moonscript. - [Fennel](https://fennel-lang.org/) A lisp that compiles to Lua. You can write configuration and plugins for Neovim in Fennel with the [Olical/aniseed](https://github.com/Olical/aniseed) or the [Hotpot](https://github.com/rktjmp/hotpot.nvim) plugin. Additionally, the [Olical/conjure](https://github.com/Olical/conjure) plugin provides an interactive development environment that supports Fennel (among other languages). - [Teal](https://github.com/teal-language/tl) The name Teal comes from pronouncing TL (typed lua). This is exactly what it tries to do - add strong typing to lua while otherwise remaining close to standard lua syntax. The [nvim-teal-maker](https://github.com/svermeulen/nvim-teal-maker) plugin can be used to write Neovim plugins or configuration files directly in Teal Other interesting projects: - [TypeScriptToLua/TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua) - [Haxe](https://haxe.org/) - [SwadicalRag/wasm2lua](https://github.com/SwadicalRag/wasm2lua) - [hengestone/lua-languages](https://github.com/hengestone/lua-languages)

Free Bootstrap Admin Template

<p align="center"> <a href="https://getstisla.com"> <img src="https://avatars2.githubusercontent.com/u/45754626?s=75&v=4" alt="Stisla logo" width="75" height="75"> </a> </p> <h1 align="center">Stisla</h1> <span align="center"> **Stisla** is a Free Bootstrap Admin Template which will help you to speed up your project and design your own dashboard UI. [](https://github.com/stisla/stisla) [](https://github.com/stisla/stisla/blob/master/LICENSE) [](https://img.shields.io/github/issues/stisla/stisla) [](https://img.shields.io/github/forks/stisla/stisla) [](https://img.shields.io/github/stars/stisla/stisla) </span> <br> <p align="center"> <a href="https://getstisla.com">Homepage</a> • <a href="https://getstisla.com/getting-started">Getting Started</a> • <a href="https://demo.getstisla.com" target="_new">Demo</a> • <a href="https://getstisla.com/docs">Documentation</a> • <a href="https://getstisla.com/blog">Blog</a> • <a href="https://getstisla.com/support">Issue</a> </p> <br> [](https://getstisla.com) ## Table of Contents - [Table of Contents](#table-of-contents) - [Quick start](#quick-start) - [Development Steps](#development-steps) - [Roadmap](#roadmap) - [Stisla Community Projects](#stisla-community-projects) - [Featured In](#featured-in) - [Tutorials](#tutorials) - [Indonesia Community Tutorials](#indonesia-community-tutorials) - [Global Community Tutorials](#global-community-tutorials) - [License](#license) - [Supports](#supports) ## Quick start Several quick start options are available: - Clone the repo: `git clone https://github.com/stisla/stisla.git` - Run `cd` to the newly created `/stisla` directory - Install [yarn](https://yarnpkg.com) first if you don't have it in your machine - Run the `yarn` command - Done Read the [documentation page](https://getstisla.com/docs) for more information on the framework contents, templates and examples, and more. ## Development Steps 1. Clone the repo: `git clone https://github.com/stisla/stisla.git` to your local path. 2. Make sure you have [yarn](https://yarnpkg.com) installed to your machine. 3. Run the `yarn` command to install development dependencies. 4. Run the `yarn dist` command to build `pages/` directory. 5. Run the `yarn dev` command to start developing. ⚠️ For production use, it's recommended to reinstall your packages with `yarn install --prod` after building `/pages` with `yarn dist`. ## Roadmap You can find the **Stisla** road map here: [Stisla Roadmap](https://trello.com/b/M8TMnehE/stisla-roadmap) ## Stisla Community Projects - [Rails](https://github.com/SunDi3yansyah/stisla-rails) - [CodeIgniter](https://github.com/KhidirDotID/stisla-codeigniter) - [Laravel](https://github.com/rehmatworks/stisla-laravel) - [Laravel 8 - Stisla](https://github.com/ngodingbang/laravel-stisla-starter) - [Laravel 9 - Stisla](https://github.com/edikurniawan-dev/laravel-stisla) - [Laravel UI Preset](https://github.com/poteto-dev/laravel-ui-stisla) - [Jekyll](https://github.com/SunDi3yansyah/stisla-jekyll) - [YII2](https://github.com/piantgrunger/yii2-stisla) - [Django](https://github.com/bimbims125/stisla-django.git) - [Flask](https://github.com/antheiz/stisla-flask) - **and more...** ## Featured In - [app.whatspie.com](https://app.whatspie.com) - Enterprise ready unofficial WhatsApp API and BOT Service, allow you to sending notification to customer using WhatsApp API from your App - [kredibel.co.id](https://kredibel.co.id)- Kredibel is a site that can identify whether someone has the potential to commit fraud or not ## Tutorials ### Indonesia Community Tutorials - [Stisla Introduction by Nauval](https://www.youtube.com/watch?v=dvnqtOUvGFc) - [Integrate Stisla with Laravel by Mulai Dari NULL](https://www.youtube.com/watch?v=4-kdAxALCPc) - [Integrate Stisla with CodeIgniter 4 by Juvinal Man](https://www.youtube.com/watch?v=np4LsQNcJbg) - [Integrate Stisla with CodeIgniter 4 by YukCoding Media](https://www.youtube.com/watch?v=Kre5kJIufhw) ### Global Community Tutorials - [How to setup Stisla in Laravel by Laravel Package Tutorial](https://www.youtube.com/playlist?list=PL0wCC44AhrC14hkSMdczlVaZvnD0WSdGv) ## License **Stisla** is licensed under the [MIT License](LICENSE) ## Supports Thanks to BrowserStack for their support on this open-source project! <a href="https://www.browserstack.com"> <img src="https://getstisla.com/svg/Browserstack-logo.svg" alt="BrowserStack" width="250"> </a> --- Stisla is created by [Nauval](http://nauv.al) ([Twitter](https://twitter.com/mhdnauvalazhar)). You can support the author by donation [here](https://www.buymeacoffee.com/mhd).

config manager based on Git

vcsh - Version Control System for $HOME - multiple Git repositories in $HOME [](https://github.com/RichiH/vcsh/actions/workflows/test.yml) # Index 1. [30 Second How-to](#30-second-how-to) 2. [Introduction](#introduction) 3. [Installation](#installation) 4. [Detailed documentation](#detailed-documentation) 5. [Contact](#contact) # 30 Second How-to While it may appear that there's an overwhelming amount of documentation and while the explanation of the concepts behind `vcsh` needs to touch a few gory details of `git` internals, getting started with `vcsh` is extremely simple. Let's say you want to version control your `vim` configuration: vcsh init vim vcsh vim add ~/.vimrc ~/.vim vcsh vim commit -m 'Initial commit of my Vim configuration' # optionally push your files to a remote vcsh vim remote add origin <remote> vcsh vim push -u origin master # from now on you can push additional commits like this vcsh vim push If all that looks a _lot_ like standard `git`, that's no coincidence; it's a design feature. # Introduction [vcsh][vcsh] allows you to maintain several Git repositories in one single directory. They all maintain their working trees without clobbering each other or interfering otherwise. By default, all Git repositories maintained via `vcsh` store the actual files in `$HOME` but you can override this setting if you want to. All this means that you can have one repository per application or application family, i.e. `zsh`, `vim`, `ssh`, etc. This, in turn, allows you to clone custom sets of configurations onto different machines or even for different users; picking and mixing which configurations you want to use where. For example, you may not need to have your `mplayer` configuration on a server or available to root and you may want to maintain different configuration for `ssh` on your personal and your work machines. ## Talks Some people found it useful to look at [slides](https://github.com/RichiH/talks/blob/main/2013/10-linuxcon-eu/linuxcon_eu-2013-10-gitify_your_life.pdf) and videos explaining how `vcsh` works instead of working through the docs. All slides, videos, and further information can be found [on the author's talk page][talks]. # Installation A lot of modern UNIX-based systems offer packages for `vcsh`. In case yours does not, read [INSTALL.md](doc/INSTALL.md) for instructions on installing from sources or even create a package for your system. If you do end up packaging `vcsh` please let us know so we can document package availability. # Detailed documentation For more information, consult the [detailed documentation](doc/README.md). # Contact There are several ways to get in touch with the author and a small but committed community around the general idea of version controlling your (digital) life. * IRC: #vcs-home on irc.oftc.net * Mailing list: [http://lists.madduck.net/listinfo/vcs-home][vcs-home-list] * Pull requests or issues on [https://github.com/RichiH/vcsh][vcsh] [myrepos]: http://myrepos.branchable.com/ [talks]: https://github.com/RichiH/talks [vcsh]: https://github.com/RichiH/vcsh [vcs-home-list]: http://lists.madduck.net/listinfo/vcs-home

Bootstrap 3 components implemented by Vue.js.

A Manageable, Measurable and Traceable Node.js Application Manager represented by Alibaba powered by TypeScript

 [](https://github.com/midwayjs/pandora/blob/master/LICENSE) []() [](https://travis-ci.org/midwayjs/pandora) [](https://codecov.io/gh/midwayjs/pandora/branch/master) [](http://packagequality.com/#?package=pandora) [](https://lernajs.io/) [](https://snyk.io/test/npm/pandora) [](https://github.com/midwayjs/pandora/pulls) ## 公告 ``` 感谢大家对 midwayjs/pandora 项目的支持。 从 2019 年开始，pandora 已经完成了他的历史使命。 虽然我们百般犹豫和不舍，但是有些路终归会走到尽头，就像溪流归入大海，巨岩化为尘埃。 虽未很轰轰烈烈的走过，至少在历史中留下了一抹色彩。 在面向云原生研发的今天，传统的进程管理和数据采集方式已经无法满足需求。 社区也有如 pm2 等优秀的进程管理工具覆盖进程管理的部分。 后续，midwayjs 在做好本职 midway 框架部分的同时，也将会继续探寻适合 Node.js 的研发之路。 最后，不管如何，感谢关注的各位。 2021.7 ``` ## Installation ```bash $ npm install -g pandora ``` Node.js >= 8.2.1 required. ## Introductions and start with an example project * [Node.js Ops First with Pandora.js, Today](https://github.com/midwayjs/pandora/wiki/Node.js-Ops-First-with-Pandora.js,-Today) * [Pandora.js 专业的 Node.js 应用监控管理器，阿里开源](https://github.com/midwayjs/pandora/wiki/Pandora.js---%E4%B8%93%E4%B8%9A%E7%9A%84-Node.js-%E5%BA%94%E7%94%A8%E7%9B%91%E6%8E%A7%E7%AE%A1%E7%90%86%E5%99%A8%EF%BC%8C%E9%98%BF%E9%87%8C%E5%BC%80%E6%BA%90) * <a href="http://www.youtube.com/watch?feature=player_embedded&v=5bWCJi5gPqI " target="_blank">Video Introduction <br/> <img src="http://img.youtube.com/vi/5bWCJi5gPqI/0.jpg" alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" /></a> ## Docs * 中文文档 <http://www.midwayjs.org/pandora/zh-cn/> * English documents <http://www.midwayjs.org/pandora/> ## What is Pandora.js ? As a consequence of years of experiences on enterprise Node.js applications management, Midway team from Alibaba open-sourced Pandora.js finally. It is an application manager integrates many capabilities like monitoring, debugging, resiliency. You are more than welcome to use it, as well as build your operation infrastructure upon it. The main concepts of Pandora.js are: 1. Manageable * Standard management capabilities of applications, processes and basic services (such as middleware). * Graceful online/offline. * Inter-process object proxying. 2. Measurable * Be able to measure different aspects of applications. * Support tons of metrics types, gauge, counter, meter, histogram, etc. 3. Traceable * Be able to trace the whole execution stack, inspect applications at runtime. * Support tons of 3rd party middlewares, MySQL, redis, etc. * Compatible with Open-Tracing standard 4. Highly available * Provides mechanism to mock middleware failures, aims to enhance system resilience. * Do trouble shooting by remote debugging. The data can be achieved via RESTFul API or local file system. It is super easy to integrate it with your monitoring system. ## Features - ✔︎ Built-in process management - ✔︎ Dev Ops customization - ✔︎ Provide Metrics and Standard OpenTracing Implementation - ✔︎ Support lots of web frameworks ## How to Contribute Please let us know how can we help. Do check out [issues](https://github.com/midwayjs/pandora/issues) for bug reports or suggestions first. To become a contributor, please follow our [contributing guide](CONTRIBUTING.md). ## License [MIT](LICENSE) ## Sponsor <a target="_blank" href="http://opensource.alibaba.com/" ><img src="https://img.alicdn.com/tfs/TB14aTMbgmTBuNjy1XbXXaMrVXa-328-134.jpg" width="123" /></a>