Skip to content
This repository
Newer
Older
100644 115 lines (90 sloc) 7.036 kb
65237cd0 »
2011-07-26 Updated contributors.
1 # Meet Nancy
2
e330306c »
2011-08-20 More edits to the readme
3 Nancy is a lightweight, low-ceremony, framework for building HTTP based services on .Net and [Mono](http://mono-project.com). The goal of the framework is to stay out of the way as much as possible and provide a super-duper-happy-path to all interactions.
75b45b66 »
2011-08-17 Updated the readme file
4
e330306c »
2011-08-20 More edits to the readme
5 Nancy is designed to handle `DELETE`, `GET`, `HEAD`, `OPTIONS`, `POST`, `PUT` and `PATCH` requests and provides a simple, elegant, [Domain Specific Language (DSL)](http://en.wikipedia.org/wiki/Domain-specific_language) for returning a response with just a couple of keystrokes, leaving you with more time to focus on the important bits..
6 **your** code and **your** application.
75b45b66 »
2011-08-17 Updated the readme file
7
e330306c »
2011-08-20 More edits to the readme
8 Write your application
75b45b66 »
2011-08-17 Updated the readme file
9
e330306c »
2011-08-20 More edits to the readme
10 public class Module : NancyModule
11 {
12 public Module()
13 {
14 Get["/greet/{name}"] = x => {
15 return string.Concat("Hello ", x.name);
16 };
17 }
18 }
19
20 Compile, run and enjoy the simple, elegant design!
65237cd0 »
2011-07-26 Updated contributors.
21
22 ## Features
23
24 * Built from the bottom up, not simply a DSL on top of an existing framework. Removing limitations and feature hacks of an underlying framework, as well as the need to reference more assemblies than you need. _keep it light_
75b45b66 »
2011-08-17 Updated the readme file
25 * Run anywhere. Nancy is not built on any specific hosting technology can can be run anywhere. Out of the box, Nancy supports running on ASP.NET/IIS, WCF, Self-hosting and any [OWIN](http://owin.org)
e330306c »
2011-08-20 More edits to the readme
26 * Ultra lightweight action declarations for GET, HEAD, PUT, POST, DELETE, OPTIONS and PATCH requests
75b45b66 »
2011-08-17 Updated the readme file
27 * View engine integration (Razor, Spark, NDjango, dotLiquid and our own SuperSimpleViewEngine)
65237cd0 »
2011-07-26 Updated contributors.
28 * Powerful request path matching that includes advanced parameter capabilities. The path matching strategy can be replaced with custom implementations to fit your exact needs
29 * Easy response syntax, enabling you to return things like int, string, HttpStatusCode and Action<Stream> elements without having to explicitly cast or wrap your response - you just return it and Nancy _will_ do the work for you
75b45b66 »
2011-08-17 Updated the readme file
30 * A powerful, light-weight, testing framework to help you verify the behavior of your application
65237cd0 »
2011-07-26 Updated contributors.
31
e330306c »
2011-08-20 More edits to the readme
32 ## The super-duper-happy-path
65237cd0 »
2011-07-26 Updated contributors.
33
e330306c »
2011-08-20 More edits to the readme
34 The "super-duper-happy-path" (or SDHP if you’re ‘down with the kids’ ;-)) is a phrase we coined to describe the ethos of Nancy; and providing the “super-duper-happy-path” experience is something we strive for in all of our APIs.
35
36 While it’s hard to pin down exactly what it is, it’s a very emotive term after all, but the basic ideas behind it are:
37
38 * “It just works” - you should be able to pick things up and use them without any mucking about. Added a new module? That’s automatically discovered for you. Brought in a new View Engine? All wired up and ready to go without you having to do anything else. Even if you add a new dependency to your module, by default we’ll locate that and inject it for you - no configuration required.
39 * “Easily customisable” - even though “it just works”, there shouldn’t be any barriers that get in the way of customisation should you want to work the way you want to work with the components that you want to use. Want to use another container? No problem! Want to tweak the way routes are selected? Go ahead! Through our bootstrapper approach all of these things should be a piece of cake.
40 * “Low ceremony” - the amount of “Nancy code” you should need in your application should be minimal. The important part of any Nancy application is your code - our code should get out of your way and let you get on with building awesome applications. As a testament to this it’s actually possible to fit a functional Nancy application into a single Tweet :-)
41 * “Low friction” - when building software with Nancy the APIs should help you get where you want to go, rather than getting in your way. Naming should be obvious, required configuration should be minimal, but power and extensibility should still be there when you need it.
42
43 Above all, creating an application with Nancy should be a pleasure, and hopefully fun! But without sacrificing the power or extensibility that you may need as your application grows.
65237cd0 »
2011-07-26 Updated contributors.
44
45 ## Community
46
47 You can find lot of Nancy users on the [Nancy User Group](https://groups.google.com/forum/?fromgroups#forum/nancy-web-framework). That is where most of the discussions regarding the development and usage of Nancy is taking place. You can also
48 find Nancy on Twitter using the #NancyFx hashtag.
49
50 ## Help out
51
52 There are many ways you can contribute to Nancy. Like most open-source software projects, contributing code
53 is just one of many outlets where you can help improve. Some of the things that you could help out with in
54 Nancy are:
55
56 * Documentation (both code and features)
57 * Bug reports
58 * Bug fixes
59 * Feature requests
60 * Feature implementations
61 * Test coverage
62 * Code quality
63 * Sample applications
64
65 ## Contributors
66
67 Nancy is not a one man project and many of the features that are availble would not have been possible without the awesome contributions from the community!
68
69 * [Andy Pike](http://github.com/andypike)
70 * [Bjarte Djuvik Næss](http://github.com/bjartn)
71 * [Carlo Kok](http://github.com/carlokok)
72 * [Chris Nicola](http://github.com/lucisferre)
73 * [David Hong](http://github.com/davidhong)
74 * [Graeme Foster](http://github.com/GraemeF)
75 * [Guido Tapia](http://github.com/gatapia)
b13e7394 »
2011-07-28 Updated contributors.
76 * [Greg Banister](https://github.com/gbanister)
65237cd0 »
2011-07-26 Updated contributors.
77 * [Ian Davis](http://github.com/innovatian)
78 * [Jonas Cannehag](http://github.com/knecke)
79 * [José F. Romaniello](http://github.com/jfromaniello)
80 * [Karl Seguin](http://github.com/karlseguin)
81 * [Leo Duran](http://github.com/leoduran)
82 * [Luke Smith](http://github.com/lukesmith)
83 * [James Eggers](http://github.com/jameseggers1)
84 * [Jason Mead](http://github.com/meadiagenic)
85 * [Jeremy Skinner](http://github.com/jeremyskinner)
86 * [João Bragança](http://github.com/thefringeninja)
87 * [Johan Danforth](http://github.com/johandanforth)
88 * [Johan Nilsson](http://github.com/Dashue)
b86bc577 »
2011-08-03 Updated contributors
89 * [Jonathan Scoles](https://github.com/jscoles)
65237cd0 »
2011-07-26 Updated contributors.
90 * [John Downey](http://github.com/jtdowney)
f727ee10 »
2011-08-12 Updated my profile url
91 * [Jonas Schmid](http://github.com/jschmid)
65237cd0 »
2011-07-26 Updated contributors.
92 * [Mark Rendle](http://github.com/markrendle)
93 * [Maciej Kowalewski](http://github.com/maciejk)
94 * [Mindaugas Mozûras](http://github.com/mmozuras)
95 * [Patrik Hägne](http://github.com/patrik-hagne)
96 * [Pedro Felix](http://github.com/pmhsfelix)
97 * [Piotr Wlodek](http://github.com/pwlodek)
98 * [Phil Haack](http://github.com/haacked)
99 * [Robert Greyling](http://github.com/robertthegrey)
100 * [Roy Jacobs](http://github.com/RoyJacobs)
101 * [Simon Skov Boisen](http://github.com/ssboisen)
102 * [Steven Robbins](http://github.com/grumpydev)
103 * [Thomas Pedersen](http://github.com/thedersen)
104 * [Troels Thomsen](http://github.com/troethom)
105 * [Vidar L. Sømme](http://github.com/vidarls)
7e51f20b »
2011-08-05 Updated contributors
106 * [Nathan Palmer](https://github.com/nathanpalmer)
65237cd0 »
2011-07-26 Updated contributors.
107
108 ## Copyright
109
110 Copyright © 2010 Andreas Håkansson, Steven Robbins and contributors
111
112 ## License
113
114 Nancy is licensed under [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form"). Refer to license.txt for more information.
Something went wrong with that request. Please try again.