Skip to content

Commit c4d5353

Browse files
author
Eka Putra
committed
Initial commit
0 parents  commit c4d5353

83 files changed

Lines changed: 3242 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
MANIFEST
2+
.DS_Store
3+
_book
4+
node_modules

‎CONTRIBUTING.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# How to contribute
2+
3+
The Django Girls Tutorial is licensed under a *Creative Commons Attribution-ShareAlike 4.0* license. Everyone is free to add, edit and correct the tutorial.
4+
5+
# Editing basics
6+
7+
The source code of the tutorial is [hosted on Github](http://github.com/DjangoGirls/tutorial). The Github [Fork & Pull workflow](https://help.github.com/articles/using-pull-requests) is used to accept and review changes.
8+
9+
The tutorial uses the [GitBook](https://www.gitbook.io/) service for publishing its documentation. [See more information about how Gitbook works](http://help.gitbook.io/).
10+
11+
The tutorial is written in [Markdown mark up language](https://help.github.com/articles/markdown-basics).
12+
13+
You can find any discussions about the contents of the tutorial on the [Github issue tracker](https://github.com/DjangoGirls/tutorial/issues).
14+
15+
# Getting started and prerequisites
16+
17+
For contributing to the tutorial the following is needed to get started:
18+
19+
* a [Github account](https://github.com)
20+
* in the case of complex edits familiarity with [Git command line basics](https://help.github.com/articles/set-up-git) or familiarity with an app ([Windows](https://windows.github.com/), [Mac](https://mac.github.com/)) to push your edits made on your computer to Github.
21+
22+
## Fork the repository
23+
24+
First fork the [DjangoGirls/tutorial](https://github.com/DjangoGirls/tutorial) repository to your personal Github account:
25+
26+
![Fork button](contributing/images/fork.png)
27+
28+
# Editing chapter content
29+
30+
## Simple changes
31+
32+
For simple changes like typo corrections you can use the Github online editor:
33+
34+
* Open your local fork page on Github,
35+
* go to *README.md* file in any chapter,
36+
* press the *Edit* icon (pen)
37+
38+
and you can edit the chapter directly on github.com.
39+
40+
![Edit button](contributing/images/edit.png)
41+
42+
Markdown syntax is used to edit the individual pages of the tutorial.
43+
44+
![Github editor](contributing/images/github_editor.png)
45+
46+
Save your changes and create a pull request as explained below.
47+
48+
## New content and complex changes
49+
50+
For adding new chapters, writing longer snippets of text or adding images, you need to get a copy of the tutorial to your local computer.
51+
52+
Either use the Github app for your operating system (mentioned above) or `git` command line to get the repository locally. You get the repository address from the front page of your own Github repository fork:
53+
54+
git clone git@github.com:yourgithubusername/tutorial.git
55+
56+
Download the [Gitbook Editor](http://help.gitbook.io/editor/README.html) app to your computer.
57+
58+
Then you can open the tutorial in Gitbook Editor (*File* > *Open book*).
59+
60+
![Gitbook](contributing/images/gitbook.png)
61+
62+
Make any changes in the tutorial using the editor and then save changes (*Book* > *Save all*).
63+
64+
Then commit the changes using `git` and push the changes to your remote Github repository.
65+
66+
Example:
67+
68+
$ git status
69+
On branch contributing
70+
Untracked files:
71+
(use "git add <file>..." to include in what will be committed)
72+
73+
contributing_and_editing_this_book/images/gitbook.png
74+
75+
$ git add contributing_and_editing_this_book/images/gitbook.png
76+
77+
$ git commit -m "Added gitbook editor screenshot"
78+
[contributing fe36152] Added gitbook screenshot
79+
1 file changed, 0 insertions(+), 0 deletions(-)
80+
create mode 100644 contributing_and_editing_this_book/images/gitbook.png
81+
82+
$ git push
83+
Counting objects: 11, done.
84+
Delta compression using up to 8 threads.
85+
Compressing objects: 100% (5/5), done.
86+
Writing objects: 100% (5/5), 266.37 KiB | 0 bytes/s, done.
87+
Total 5 (delta 1), reused 0 (delta 0)
88+
To git@github.com:miohtama/tutorial.git
89+
b37ca59..fe36152 contributing -> contributing
90+
91+
# Making a pull request
92+
93+
After you have finished your changes you need to create [a pull request](https://help.github.com/articles/using-pull-requests) on Github. DjangoGirls will get notified about the pull request, review your changes, suggest any corrections if needed and then *pull* your changes to the master version.
94+
95+
In your own repository on Github press do *Compare & pull request*
96+
97+
![Gitbook](contributing/images/pull_request.png)
98+
99+
Fill in the information *why* this change is being made. The reviewer can see the details of the actual change, so you don't need repeat the content of the change.
100+
101+
Then press *Create pull request*.
102+
103+
Github emails will notify you for the follow up process.
104+
105+
# Further information and help
106+
107+
For any questions please [contact DjangoGirls](http://djangogirls.org/).
108+

‎README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Django Girls Tutorial
2+
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/DjangoGirls/tutorial?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
3+
4+
> This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
5+
International License. To view a copy of this license, visit
6+
http://creativecommons.org/licenses/by-sa/4.0/
7+
8+
9+
## Introduction
10+
11+
Have you ever felt that the world is more and more about technology and you are somehow left behind? Have you ever wondered how to create a website but have never had enough motivation to start? Have you ever thought that the software world is too complicated for you to even try doing something on your own?
12+
13+
Well, we have good news for you! Programming is not as hard as it seems and we want to show you how fun it can be.
14+
15+
The tutorial will not magically turn you into a programmer. If you want to be good at it, you need months or even years of learning and practice. But we want to show you that programming or creating websites is not as complicated as it seems. We will try to explain different bits and pieces as well as we can, so you will not feel intimidated by technology.
16+
17+
We hope that we'll be able to make you love technology as much as we do!
18+
19+
## What will you learn during the tutorial?
20+
21+
Once you've finished the tutorial, you will have a simple, working web application: your own blog. We will show you how to put it online, so others will see your work!
22+
23+
It will (more or less) look like this:
24+
25+
![Figure 0.1](images/application.png)
26+
27+
> If you work with the tutorial on your own and don't have a coach that will help you in case of any problem, we have a chat for you: [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/DjangoGirls/tutorial?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge). We asked our coaches and previous attendees to be there from time to time and help others with the tutorial! Don't be afraid to ask your question there!
28+
29+
OK, [let's start at the beginning...](how_internet_works/README.md)
30+
31+
## About and contributing
32+
33+
This tutorial is maintained by [DjangoGirls](http://djangogirls.org/). If you find any mistakes or want to update the tutorial please [follow the contributing guidelines](https://github.com/DjangoGirls/tutorial/blob/master/CONTRIBUTING.md).

‎SUMMARY.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Summary
2+
3+
* [Introduction](README.md)
4+
* [How the Internet works?](how_internet_works/README.md)
5+
* [Introduction to command line](intro_to_command_line/README.md)
6+
* [Python installation](python_installation/README.md)
7+
* [Introduction to Python](python_introduction/README.md)
8+
* [What is Django?](django/README.md)
9+
* [Django installation](django_installation/README.md)
10+
* [Code editor](code_editor/README.md)
11+
* [Starting Django project](django_start_project/README.md)
12+
* [Django models](django_models/README.md)
13+
* [Django ORM (Querysets)](django_orm/README.md)
14+
* [Django admin](django_admin/README.md)
15+
* [Deploy!](deploy/README.md)
16+
* [Django urls](django_urls/README.md)
17+
* [Django views - time to create!](django_views/README.md)
18+
* [Introduction to HTML](html/README.md)
19+
* [Dynamic data in templates](dynamic_data_in_templates/README.md)
20+
* [Django templates](django_templates/README.md)
21+
* [CSS - make it pretty](css/README.md)
22+
* [Template extending](template_extending/README.md)
23+
* [Extend your application](extend_your_application/README.md)
24+
* [Django Forms](django_forms/README.md)
25+
* [Domain](domain/README.md)
26+
* [What's next?](whats_next/README.md)

‎book.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"links": {
3+
"sidebar": {
4+
"Need help? Talk to us!": "https://gitter.im/DjangoGirls/tutorial"
5+
}
6+
},
7+
8+
"plugins": [
9+
"anchors", "ga", "richquotes"
10+
],
11+
12+
"pluginsConfig": {
13+
"ga": {
14+
"token": "UA-51680040-3"
15+
},
16+
"richquotes" : {
17+
"todos" : true
18+
}
19+
}
20+
}

‎code_editor/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Code editor
2+
3+
You're about to write your first line of code, so it's time to download a code editor!
4+
5+
There are a lot of different editors and it largely boils down to personal preference. Most Python programmers use complex but extremely powerful IDEs (Integrated Development Environments), such as PyCharm. As a beginner, however, that's probably less suitable; our recommendations are equally powerful, but a lot simpler.
6+
7+
Our suggestions are below, but feel free to ask your coach what their preferences are - it'll be easier to get help from them.
8+
9+
## Gedit
10+
11+
Gedit is an open-source, free editor, available for all operating systems.
12+
13+
[Download it here](https://wiki.gnome.org/Apps/Gedit#Download)
14+
15+
## Sublime Text 2
16+
17+
Sublime Text is a very popular editor with a free evaluation period. It's easy to install and use, and it's available for all operating systems.
18+
19+
[Download it here](http://www.sublimetext.com/2)
20+
21+
## Atom
22+
23+
Atom is an extremely new code editor created by [GitHub](http://github.com/). It's free, open-source, easy to install and easy to use, but is only available as a prebuilt program on Windows and OS X at the moment. It'll be available prebuilt for Linux in the future.
24+
25+
[Download it here](https://atom.io/)

‎contributing/images/edit.png‎

83.7 KB
Loading

‎contributing/images/fork.png‎

28.8 KB
Loading

‎contributing/images/gitbook.png‎

276 KB
Loading

‎contributing/images/github_editor.png‎

129 KB
Loading

0 commit comments

Comments
 (0)