sanic/docs/getting_started.md

# Getting Started

Make sure you have both [pip](https://pip.pypa.io/en/stable/installing/) and at
least version 3.5 of Python before starting. Sanic uses the new `async`/`await`
syntax, so earlier versions of python won't work.

1. Install Sanic: `python3 -m pip install sanic`
2. Create a file called `main.py` with the following code:

  ```python
  from sanic import Sanic
  from sanic.response import text

  app = Sanic(__name__)

  @app.route("/")
  async def test(request):
      return text('Hello world!')

  app.run(host="0.0.0.0", port=8000, debug=True)
  ```
  
3. Run the server: `python3 main.py`
4. Open the address `http://0.0.0.0:8000` in your web browser. You should see
   the message *Hello world!*.

You now have a working Sanic server!

**Next:** [Routing](routing.md)
Basic documentation 2016-10-14 12:51:08 +01:00			`# Getting Started`

Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			`Make sure you have both [pip](https://pip.pypa.io/en/stable/installing/) and at`
			least version 3.5 of Python before starting. Sanic uses the new `async`/`await`
			`syntax, so earlier versions of python won't work.`
Basic documentation 2016-10-14 12:51:08 +01:00
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			1. Install Sanic: `python3 -m pip install sanic`
			2. Create a file called `main.py` with the following code:
Basic documentation 2016-10-14 12:51:08 +01:00
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			```python
			`from sanic import Sanic`
			`from sanic.response import text`
Basic documentation 2016-10-14 12:51:08 +01:00
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			`app = Sanic(__name__)`
Basic documentation 2016-10-14 12:51:08 +01:00
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			`@app.route("/")`
			`async def test(request):`
			`return text('Hello world!')`
Basic documentation 2016-10-14 12:51:08 +01:00
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			`app.run(host="0.0.0.0", port=8000, debug=True)`
			```

			3. Run the server: `python3 main.py`
			4. Open the address `http://0.0.0.0:8000` in your web browser. You should see
			`the message Hello world!.`

			`You now have a working Sanic server!`

Fixes doc link extensions from .html to .md Whoops! Totally missed that all the links pointed to `.html` files instead of `.md` files 2017-01-20 03:24:08 +00:00			`Next: [Routing](routing.md)`