• Stars
    star
    1,734
  • Rank 26,869 (Top 0.6 %)
  • Language
  • Created almost 11 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

πŸ’‘ A Quick-start Guide for People who want to dwyl ❀️ βœ…

Start Here

A Quick-start Guide for people that want to Do What You Love!

dwyl-logo-wide

Start where you are. Use what you have. Do what you can. ~ Arthur Ashe

Why?

The world is not perfect.
We have all worked somewhere we didn't love.
We have all felt the frustration of using products that have flaws that we were unable to fix ourselves.
We have all experienced being in an environment that didn't support us in doing all we can do in the world. The aim of dwyl is to address all of these issues simultaneously: please read our mission to understand our focus on personal effectiveness as the starting point for all positive change.

If you'd like to know more about what we value, please read our manifesto.
The short version is: "Treat others as you would like others to treat you" ~ The Golden Rule

If you want to be part of the solution, join us: https://www.dwyl.com

If you haven't read Simon Sinek's book "Start with Why", we highly recommend taking a few minutes to watch his Ted Talk: https://www.ted.com/talks/simon_sinek_how_great_leaders_inspire_action

Who?

dwyl is a rapidly expanding community; here are a few of the familiar faces contributing to our projects:

dwyl-community

Join us in finding a problem you want to solve and will love working on.

What?

Q: What is dwyl?
A: dwyl (pronounced "Will" but with a "D" in front of it) is a community of people on a mission to change the world using technology.

We are starting by making the tools we need to help us (and the people we care about) get things we love done.

Our first App is Time which helps people track any time based activity.

And we are making Everything Open Source along the way, so that you too can Do What You Love!
We have plans to build many other features and we'd love you to join us!

Here are a few on the roadmap:

  • Tudo (pronounced to-do) helps you and your team track what you are working on
  • When? syncs calendars and selectively shares availability with others to discover the best time for an activity/event
  • Birthday/Special Event Helper [AKA The Card & Gift App]

What question do you want to answer?

Our Approach: Scratching Your Own Itch

We believe in scratching our own itch. This means solving a problem you (or someone close to you) personally have. If you don't have any personal experience in a field you aren't going to do a good job of spotting/solving a problem in that area.

Taking the "Business School" approach of finding a "Big Market" and then identifying a problem to solve works for some companies, but we prefer the approach of solving something we are personally passionate about regardless of the (size of the) "market".

Read: https://gettingreal.37signals.com/ch02_Whats_Your_Problem.php

How?

If you want to get involved with building great tools people love, this section contains everything you need to know.

What do I need?

  • Curiosity - "I have no special talent. I am only passionately curious." - Albert Einstein
  • Enthusiasm - "Enthusiasm spells the difference between mediocrity and accomplishment." - Norman Vincent Peale
  • Shoshin (Beginner's Mind) - "I'm not young enough to know everything" - J. M. Barrie
  • Persistence - "If you wish to be out front, then act as if you were behind.” - Lao Tzu
  • Work Ethic - "work super hard ... every waking hour" ~ Elon Musk
  • Time - if you only have 1 minute there's something you can do now!
  • Great Google Skills - the ability to formulate a good question (so you can get a useful answer from Google) is (more than) half the challenge in any coding task
  • Self-reliance: when you get stuck on a task, knowing when to ask for help and when to persevere through to find the answer yourself
    • But don't worry, we're here to help! Join the chat at https://gitter.im/dwyl/chat

What tools will I need?

Access to a computer, preferably a recent (but not expensive) one (Chromebooks are Great!).
That's it.

Do I need to Write Code to Contribute?

No. Everyone can contribute, from proposing and voting on ideas, to simplifying wording to helping people understand our apps.

Please drop by and tell us what you think! Join the chat at https://gitter.im/dwyl/chat

Setup (for Coders)

If you want to start writing code now and don't already have your machine set up, see: https://github.com/dwyl/dev-setup

We also have a new developer checklist which we encourage you to review on the various online services you should know about and set yourself up on:
https://github.com/dwyl/start-here/blob/master/new-developer-checklist.md

Web Development Fundamentals

We have listed the skills you need to know in the order you need to learn them.

Basic Computer Skills

have_you_tried_turning_it_off_and_on_again_tshirt-r15b877ba3b4142bba14c938377e7fed7_v9uic_1024

If you don't feel confident using a computer, don't despair! We've all been there. There's no "secret" to becoming an expert, just experiment! If you get stuck, Google. If you're still stuck after an hour, ask for help! If all else fails, restart your computer and try again (that's what everyone does).

Touch Typing

Before you dive into programming, learning how to touch-type on your computer is the single best investment you can make. All this means is practising typing with the "correct fingers" until you don't have to think about where the keys are. Some of the best programmers we know can type faster than most people can think ... take a moment for that to settle in.

playing piano blindfolded

You need to be able to type blindfolded to become a true maestro (at anything computer-related).

A few touch-typing tutorials anyone can (should) do a few minutes per day. There are many variations on the classic QWERTY layout. You should choose a tutorial that's compatible with your keyboard layout:

You can connect your touch-typing practice with learning to code, by using the code samples in your learning resources to practice your typing. Learning to touch-type accurately is therefore important for creating the proper muscle-memory for the code (Markdown, HTML, CSS, Javascript, etc) that you are learning. Here are resources that explain the importance of typing out code by hand:

How to Learn How to Learn

Software-development is constant learning, so it is useful to think consciously about how one learns.

General Thoughts on How to Learn

A popular course is Learning How to Learn on Coursera taught by Barbara Oakley and Terry Sejnowski. It serves as a general introduction to concepts about learning how to learn, with a slight emphasis on neuroscience.

The following articles by Blaz Kos from AgileLeanLife well summarise a lot of the basic concepts on efficient learning:

We feel socially obligated to mention Richard Feynman:

Learning to code has many a steep learning curve, but apparently so does becoming an astronaut!

How Learning to Code Benefits the Mind

Learning to code will challenge you in all sorts of ways, and as long as you push through the challenge, that is good for you!

How to Learn Applied to Programming

Here we present more specific information about learning how to learn and your studies in programming.

  • Hacking Passion: Katrina Owen breaks down practice into drills, simulations, case studies, direct practice, and imitation. Which kinds of practice are you applying or not applying?
  • Learning Fluency: Sara Simon talks about learning to learn how to code from the point of view of her many interests such as Chinese, theatre, and chess. Here is the article
  • The myth of the "Real Javascript Developer": Brenna O'Brien describes the constant learning journey that is learning to code.

Specific Advice about Learning Programming

Here we present specific advice on learning programming. Remember to type out code by hand!:

How the internet works

Before setting off to build for the web you may appreciate acquiring some context as to how it all comes together. There is a fantastic Coursera course called Internet History, Technology, and Security that offers just this. The course is put together by an enthusiastic instructor who walks you through the historic events that led to the design of the internet that you use everyday. It is full of interviews with the folks who contributed many important bits along the way.

We consider the above course to be the most thorough general introduction to how the Internet works, and we recommend you eventually work your way through it. In case you cannot make the time commitment right now, the following links provide shorter introductions and other points of view:

Command Line

The command line is the basic way to communicate with a computer. The following links provide an introduction:

Text Editor

A text editor is the basic tool a programmer uses. Perhaps your main experience is with a WYSIWYG text editor such as Microsoft Word. If you need to become more familiar with programmer's text editors, we recommend the following links:

We use Atom, but Sublime is another popular text editor which is good for someone starting. Emacs and Vim are famous old text editors which have a much steeper learning curve. We include information about them for "culture", since they form such a basic part of the programming landscape ( see holy war of the text editors):

Markdown

If you've never heard of Markdown, get started now: https://markdowntutorial.com/
You can refer to this book for learning purposes.

HTML5

You can learn 90% of what you need to know in HTML in a couple of hours, including practice time (from scratch):

Learn HTML5 in 1 Hour: https://www.youtube.com/watch?v=kDyJN7qQETA

The rest of HTML5 you will learn just-in-time (only when you need to know it).

CSS

Cascading Style Sheets (CSS) is what makes the web attractive. If you want to see the power of CSS, visit ZenGarden: https://www.csszengarden.com/

CSS3 beginner (or refresher) Tutorial (in one hour): https://www.youtube.com/watch?v=CUxH_rWSI1k

Further CSS learning

JavaScript

Love it or hate it, JavaScript is Ubiquitous. Becoming a JS Ninja is essential.
Ines has prepared some great notes on JavaScript The Good Parts. Keep "The Good Parts" in mind while you are writing (and reading) JS.

Watch this 1 hour intro tutorial series: https://www.youtube.com/watch?v=fGdd9qNwQdQ&list=PLoYCgNOIyGACTDHuZtn0qoBdpzV9c327V
and then scan through this 1.5 hour tutorial to pick up some extra points: https://www.youtube.com/watch?v=fju9ii8YsGs (and tell us if you get stuck).

Git + GitHub

If you are completely new to Git (Version Control) and/or GitHub, we suggest you check out the following:

Open Source

You know enough Git and GitHub to make a pull request on an open source project. Before making your first open source contributions, it is useful to gather some context.

What is Open Source

History of Open Source

Contributing to Open Source

Open Source Communities

Where to Start on Open Source

General Resources

Design

Building something for someone else is hard. You don't necessarily know that person. And worrying about someone else's "experience" with your app can be a full-time job. However, it is an essential process for everyone involved in software to partake in. The very best pieces of software are differentiated by the quality of their User Experience design.

Experiences are, by nature, personal, contextual, ephemeral, and affected by things beyond your control. The job of designing one is essentially one of embodying the real people that will be using your product and imagining what the experience would be like for them. You should try to take into account as much contextual information about your users state of mind, occupation, preference towards sans-serif fonts, etc. These details will weave a picture of the real humans on the other end of your app and help you make decisions about site structure and navigation as well as other less obvious things like content hierarchy: what should the user see first?

Further Reading on Software Design

We are in the process of developing our own reading materials to help you learn about UX and UI design. In the meantime, here are some recommended links:

Ready to Get Involved?

If you want to help improve any aspect of the code, star ⭐ this repo on GitHub and we will add you to the organisation.

Curious about what technology we are using?

If you want to know more about the Technology "Stack" we are using
see: https://github.com/dwyl/technology-stack

HitCount

More Repositories

1

english-words

πŸ“ A text file containing 479k English words for all your dictionary/word-based projects e.g: auto-completion / autosuggestion
Python
9,337
star
2

learn-json-web-tokens

πŸ” Learn how to use JSON Web Token (JWT) to secure your next Web App! (Tutorial/Example with Tests!!)
JavaScript
4,178
star
3

learn-to-send-email-via-google-script-html-no-server

πŸ“§ An Example of using an HTML form (e.g: "Contact Us" on a website) to send Email without a Backend Server (using a Google Script) perfect for static websites that need to collect data.
HTML
3,140
star
4

repo-badges

⭐ Use repo badges (build passing, coverage, etc) in your readme/markdown file to signal code quality in a project.
HTML
2,831
star
5

learn-tdd

βœ… A brief introduction to Test Driven Development (TDD) in JavaScript (Complete Beginner's Step-by-Step Tutorial)
JavaScript
2,698
star
6

learn-elixir

πŸ’§ Learn the Elixir programming language to build functional, fast, scalable and maintainable web applications!
Elixir
1,611
star
7

learn-travis

😎 A quick Travis CI (Continuous Integration) Tutorial for Node.js developers
JavaScript
1,251
star
8

Javascript-the-Good-Parts-notes

πŸ“– Notes on the seminal "JavaScript the Good Parts: by Douglas Crockford
1,193
star
9

aws-sdk-mock

🌈 AWSomocks for Javascript/Node.js aws-sdk tested, documented & maintained. Contributions welcome!
TypeScript
1,113
star
10

learn-aws-lambda

✨ Learn how to use AWS Lambda to easily create infinitely scalable web services
JavaScript
1,035
star
11

book

πŸ“— Our Book on Full-Stack Web Application Development covering User Experience (UX) Design, Mobile/Offline/Security First, Progressive Enhancement, Continuous Integration/Deployment, Testing (UX/TDD/BDD), Performance-Driven-Development and much more!
Rust
818
star
12

hapi-auth-jwt2

πŸ”’ Secure Hapi.js authentication plugin using JSON Web Tokens (JWT) in Headers, URL or Cookies
JavaScript
795
star
13

learn-hapi

β˜€οΈ Learn to use Hapi.js (Node.js) web framework to build scalable apps in less time
HTML
794
star
14

phoenix-chat-example

πŸ’¬ The Step-by-Step Beginners Tutorial for Building, Testing & Deploying a Chat app in Phoenix 1.7 [Latest] πŸš€
Elixir
760
star
15

learn-tachyons

😍 Learn how to use Tachyons to craft beautiful, responsive and fast UI with functional CSS!
HTML
673
star
16

learn-phoenix-framework

πŸ”₯ Phoenix is the web framework without compromise on speed, reliability or maintainability! Don't settle for less. πŸš€
Elixir
650
star
17

javascript-todo-list-tutorial

βœ… A step-by-step complete beginner example/tutorial for building a Todo List App (TodoMVC) from scratch in JavaScript following Test Driven Development (TDD) best practice. 🌱
JavaScript
623
star
18

learn-nightwatch

🌜 Learn how to use Nightwatch.js to easily & automatically test your web apps in *real* web browsers.
JavaScript
585
star
19

learn-elm

🌈 discover the beautiful programming language that makes front-end web apps a joy to build and maintain!
HTML
483
star
20

learn-redux

πŸ’₯ Comprehensive Notes for Learning (how to use) Redux to manage state in your Web/Mobile (React.js) Apps.
HTML
446
star
21

hits

πŸ“ˆ General purpose hits (page views) counter
Elixir
432
star
22

learn-devops

🚧 Learn the craft of "DevOps" (Developer Operations) to Deploy your App and Monitor it so it stays "Up"!
Shell
413
star
23

phoenix-liveview-counter-tutorial

🀯 beginners tutorial building a real time counter in Phoenix 1.7.14 + LiveView 1.0 ⚑️ Learn the fundamentals from first principals so you can make something amazing! πŸš€
Elixir
374
star
24

hapi-socketio-redis-chat-example

πŸ’¬ Real-time Chat using Hapi.js + Socket.io + Redis Pub/Sub (example with tests!!)
Elm
366
star
25

hapi-typescript-example

⚑ Hapi.Js + Typescript = Awesomeness
TypeScript
351
star
26

learn-istanbul

🏁 Learn how to use the Istanbul JavaScript Code Coverage Tool
JavaScript
339
star
27

learn-redis

πŸ“• Need to store/access your data as fast as possible? Learn Redis! Beginners Tutorial using Node.js πŸš€
JavaScript
291
star
28

technology-stack

πŸš€ Detailed description + diagram of the Open Source Technology Stack we use for dwyl projects.
JavaScript
288
star
29

phoenix-ecto-encryption-example

πŸ” A detailed example for how to encrypt data in an Elixir (Phoenix v1.7) App before inserting into a database using Ecto Types
Elixir
274
star
30

learn-elasticsearch

πŸ” Learn how to use ElasticSearch to power a great search experience for your project/product/website.
Elixir
265
star
31

elixir-auth-google

πŸ‘€Minimalist Google OAuth Authentication for Elixir Apps. Tested, Documented & Maintained. Setup in 5 mins. πŸš€
Elixir
263
star
32

home

🏑 πŸ‘©β€πŸ’» πŸ’‘ home is where you can [learn to] build the future surrounded by like-minded creative, friendly and [intrinsically] motivated people focussed on health, fitness and making things people and the world need!
246
star
33

learn-docker

🚒 Learn how to use docker.io containers to consistently deploy your apps on any infrastructure.
Dockerfile
220
star
34

learn-elm-architecture-in-javascript

πŸ¦„ Learn how to build web apps using the Elm Architecture in "vanilla" JavaScript (step-by-step TDD tutorial)!
JavaScript
211
star
35

learn-environment-variables

πŸ“Learn how to use Environment Variables to keep your passwords and API keys secret. πŸ”
JavaScript
201
star
36

learn-postgresql

🐘 Learn how to use PostgreSQL and Structured Query Language (SQL) to store and query your relational data. πŸ”
JavaScript
195
star
37

learn-tape

βœ… Learn how to use Tape for JavaScript/Node.js Test Driven Development (TDD) - Ten-Minute Testing Tutorial
JavaScript
187
star
38

sendemail

πŸ’Œ Simplifies reliably sending emails from your node.js apps using AWS Simple Email Service (SES)
JavaScript
181
star
39

phoenix-todo-list-tutorial

βœ… Complete beginners tutorial building a todo list from scratch in Phoenix 1.7 (latest)
Elixir
171
star
40

quotes

πŸ’¬ a curated list of quotes that inspire action + code that returns quotes by tag/author/etc. πŸ’‘
Elixir
163
star
41

learn-heroku

🏁 Learn how to deploy your web application to Heroku from scratch step-by-step in 7 minutes!
Python
153
star
42

decache

:shipit: Delete Cached node_modules useful when you need to "un-require" during testing for a fresh state.
JavaScript
151
star
43

learn-chrome-extensions

🌐 Discover how to build and deploy a Google Chrome Extension for your Project!
139
star
44

labels

🏷 Sync GitHub Labels from any Source to Target Repositories for Consistency across all your projects!
Elixir
138
star
45

learn-ab-and-multivariate-testing

πŸ†Ž Tutorial on A/B and multivariate testing βœ”οΈ
137
star
46

ISO-27001-2013-information-technology-security

πŸ” Probably the most boring-but-necessary repo on GitHub. If you care about the security/privacy of your data...! βœ…
136
star
47

auth

πŸšͺ πŸ” UX-focussed Turnkey Authentication Solution for Web Apps/APIs (Documented, Tested & Maintained)
Elixir
135
star
48

web-form-to-google-sheet

A simple example of sending data from an ordinary web form straight to a Google Spreadsheet without a server.
HTML
133
star
49

app

Clear your mind. Organise your life. Ignore distractions. Focus on what matters.
Dart
133
star
50

phoenix-liveview-chat-example

πŸ’¬ Step-by-step tutorial creates a Chat App using Phoenix LiveView including Presence, Authentication and Style with Tailwind CSS
Elixir
130
star
51

learn-circleci

βœ… A quick intro to Circle CI (Continuous Integration) for JavaScript developers.
121
star
52

learn-regex

⁉️ A simple REGular EXpression tutorial in JavaScript
120
star
53

learn-react

"The possibilities are numerous once we decide to act and not react." ~ George Bernard Shaw
HTML
108
star
54

learn-aws-iot

πŸ’‘ Learn how to use Amazon Web Services Internet of Things (IoT) service to build connected applications.
JavaScript
101
star
55

env2

πŸ’» Simple environment variable (from config file) loader for your node.js app
JavaScript
100
star
56

how-to-choose-a-database

How to choose the right dabase
97
star
57

flutter-todo-list-tutorial

βœ… A detailed example/tutorial building a cross-platform Todo List App using Flutter πŸ¦‹
Dart
91
star
58

imgup

πŸŒ… Effortless image uploads to AWS S3 with automatic resizing including REST API.
Elixir
88
star
59

mvp

πŸ“² simplest version of the @dwyl app
Elixir
87
star
60

contributing

πŸ“‹ Guidelines & Workflow for people contributing to our project(s) on GitHub. Please ⭐ to confirm you've read & understood! βœ…
86
star
61

learn-flutter

πŸ¦‹ Learn how to use Flutter to Build Cross-platform Native Mobile Apps
JavaScript
86
star
62

javascript-best-practice

A collection of JavaScript Best Practices
83
star
63

learn-amazon-web-services

⭐ Amazing Guide to using Amazon Web Services (AWS)! ☁️
83
star
64

range-touch

πŸ“± Use HTML5 range input on touch devices (iPhone, iPad & Android) without bloatware!
JavaScript
83
star
65

learn-pre-commit

βœ… Pre-commit hooks let you run checks before allowing a commit (e.g. JSLint or check Test Coverage).
JavaScript
80
star
66

product-owner-guide

πŸš€ A rough guide for people working with dwyl as Product Owners
78
star
67

phoenix-ecto-append-only-log-example

πŸ“ A step-by-step example/tutorial showing how to build a Phoenix (Elixir) App where all data is immutable (append only). Precursor to Blockchain, IPFS or Solid!
Elixir
78
star
68

fields

🌻 fields is a collection of useful field definitions (Custom Ecto Types) that helps you easily define an Ecto Schema with validation, encryption and hashing functions so that you can ship your Elixir/Phoenix App much faster!
Elixir
77
star
69

goodparts

πŸ™ˆ An ESLint Style that only allows JavaScript the Good Parts (and "Better Parts") in your code.
JavaScript
77
star
70

hapi-error

β˜” Intercept errors in your Hapi Web App/API and send a *useful* message to the client OR redirect to the desired endpoint.
JavaScript
76
star
71

process-handbook

πŸ“— Contains our processes, questions and journey to creating a team
HTML
76
star
72

terminate

♻️ Terminate a Node.js Process (and all Child Processes) based on the Process ID
JavaScript
76
star
73

aws-lambda-deploy

☁️ πŸš€ Effortlessly deploy Amazon Web Services Lambda function(s) with a single command. Less to configure. Latest AWS SDK and Node.js v20!
JavaScript
74
star
74

dev-setup

✈️ A quick-start guide for new engineers on how to set up their Dev environment
73
star
75

hapi-login-example-postgres

🐰 A simple registration + login form example using hapi-register, hapi-login & hapi-auth-jwt2 with a PostgreSQL DB
JavaScript
69
star
76

flutter-bloc-tutorial

A step-by-step example/tutorial explaining the benefits of the BLoC architecture and bloc library including tests!
Dart
67
star
77

phoenix-liveview-todo-list-tutorial

βœ… Beginners tutorial building a Realtime Todo List in Phoenix 1.6.10 + LiveView 0.17.10 ⚑️ Feedback very welcome!
Elixir
65
star
78

learn-security

πŸ” For most technology projects Security is an "after thought", it does not have to be that way; let's be proactive!
64
star
79

learn-javascript

A Series of Simple Steps in JavaScript :-)
HTML
63
star
80

chat

πŸ’¬ Probably the fastest, most reliable/scalable chat system on the internet.
Elixir
62
star
81

learn-jsdoc

πŸ“˜ Use JSDoc and a few carefully crafted comments to document your JavaScript code!
CSS
60
star
82

ampl

πŸ“± ⚑ Ampl transforms Markdown into AMP-compliant html so it loads super-fast!
JavaScript
58
star
83

aguid

❄️ A Globally Unique IDentifier (GUID) generator in JS. (deterministic or random - you chose!)
JavaScript
57
star
84

tudo

βœ… Want to see where you could help on an open dwyl issue?
Elixir
57
star
85

learn-apple-watch-development

πŸ“— Learn how to build Native Apple Watch (+iPhone) apps from scratch!
Swift
55
star
86

learn-qunit

βœ… A quick introduction to JavaScript unit testing with QUnit
JavaScript
51
star
87

learn-ngrok

☁️ Learn how to use ngrok to share access to a Web App/Site running on your "localhost" with the world!
HTML
50
star
88

learn-jshint

πŸ’© Learn how to use the ~~jshint~~ code quality/consistency tool.
JavaScript
49
star
89

hapi-auth-jwt2-example

πŸ”’ A functional example Hapi.js app using hapi-auth-jwt2 & Redis (hosted on Heroku) with tests!
JavaScript
49
star
90

tachyons-bootstrap

πŸ‘’Bootstrap recreated using tachyons functional css
HTML
48
star
91

learn-tailwind

🌬️ Learn Tailwind CSS to craft pixel-perfect web apps/sites in less time! 😍
Elixir
48
star
92

esta

πŸ” Simple + Fast ElasticSearch Node.js client. Beginner-friendly defaults & Heroku support βœ… πŸš€
JavaScript
48
star
93

learn-node-js-by-example

☁️ Practical node.js examples.
HTML
47
star
94

elixir-pre-commit

βœ… Pre-commit hooks for Elixir projects
Elixir
46
star
95

product-roadmap

🌐 Because why wouldn't you make your company's product roadmap Public on GitHub?
46
star
96

redis-connection

⚑ Single Redis Connection that can be used anywhere in your node.js app and closed once (e.g in tests)
JavaScript
45
star
97

learn-graphQL

❓Learn to use GraphQL - A query language that allows client applications to specify their data fetching requirements
JavaScript
45
star
98

aws-lambda-test-utils

Mock event and context objects without fluff.
JavaScript
44
star
99

hapi-login

πŸšͺ The Simplest Possible (Email + Password) Login for Hapi.js Apps βœ…
JavaScript
43
star
100

learn-riot

🐎 Riot.js lets you build apps that are simpler and load/run faster than any other JS framework/library.
HTML
43
star