aboutsummaryrefslogtreecommitdiffstats
path: root/docs/tutorial/quickstart.md
diff options
context:
space:
mode:
authorTom Christie2013-05-20 13:43:26 +0100
committerTom Christie2013-05-20 13:43:26 +0100
commitbc8671d7ea11922ed85921f27b61798894261304 (patch)
tree588aca771dc6782a36ec3541906ed8dfea3b1a17 /docs/tutorial/quickstart.md
parent7c945b43f05f1b340f78c23f80c8043937c7fd2a (diff)
downloaddjango-rest-framework-bc8671d7ea11922ed85921f27b61798894261304.tar.bz2
More explicit quickstart guide. Closes #867.
Diffstat (limited to 'docs/tutorial/quickstart.md')
-rw-r--r--docs/tutorial/quickstart.md44
1 files changed, 42 insertions, 2 deletions
diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md
index 52fe3acf..c41cb63f 100644
--- a/docs/tutorial/quickstart.md
+++ b/docs/tutorial/quickstart.md
@@ -2,7 +2,43 @@
We're going to create a simple API to allow admin users to view and edit the users and groups in the system.
-Create a new Django project, and start a new app called `quickstart`. Once you've set up a database and got everything synced and ready to go open up the app's directory and we'll get coding...
+## Project setup
+
+Create a new Django project named `tutorial`, then start a new app called `quickstart`.
+
+ # Set up a new project
+ django-admin.py startproject tutorial
+ cd tutorial
+
+ # Create a virtualenv to isolate our package dependancies locally
+ virtualenv env
+ source env/bin/activate
+
+ # Install Django and Django REST framework into the virtualenv
+ pip install django
+ pip install djangorestframework
+
+ # Create a new app
+ python manage.py startapp quickstart
+
+Next you'll need to get a database set up and synced. If you just want to use SQLite for now, then you'll want to edit your `tutorial/settings.py` module to include something like this:
+
+ DATABASES = {
+ 'default': {
+ 'ENGINE': 'django.db.backends.sqlite3',
+ 'NAME': 'database.sql',
+ 'USER': '',
+ 'PASSWORD': '',
+ 'HOST': '',
+ 'PORT': ''
+ }
+ }
+
+The run `syncdb` like so:
+
+ python manange.py syncdb
+
+Once you've set up a database and got everything synced and ready to go, open up the app's directory and we'll get coding...
## Serializers
@@ -80,7 +116,7 @@ Finally, we're including default login and logout views for use with the browsab
## Settings
-We'd also like to set a few global settings. We'd like to turn on pagination, and we want our API to only be accessible to admin users.
+We'd also like to set a few global settings. We'd like to turn on pagination, and we want our API to only be accessible to admin users. The settings module will be in `tutorial/settings.py`
INSTALLED_APPS = (
...
@@ -98,6 +134,10 @@ Okay, we're done.
## Testing our API
+We're now ready to test the API we've built. Let's fire up the server from the command line.
+
+ python ./manage.py runserver
+
We can now access our API, both from the command-line, using tools like `curl`...
bash: curl -H 'Accept: application/json; indent=4' -u admin:password http://127.0.0.1:8000/users/