Skip to content

Commit b9ad28c

Browse files
committed
2 parents 60c7ccb + 6caa500 commit b9ad28c

File tree

1 file changed

+67
-7
lines changed

1 file changed

+67
-7
lines changed

readme.md

+67-7
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@
77

88
<img src="https://travis-ci.org/MasoniteFramework/masonite.svg?branch=master">
99
<img src="https://img.shields.io/badge/python-3.4+-blue.svg" alt="Python Version"> <img src="http://pepy.tech/badge/masonite?1" alt="License"> <img src="https://img.shields.io/github/license/MasoniteFramework/masonite.svg" alt="License">
10-
<img src="https://coveralls.io/repos/github/MasoniteFramework/core/badge.svg?branch=master" alt="License">
11-
10+
<img src="https://coveralls.io/repos/github/MasoniteFramework/core/badge.svg?branch=master#" alt="License">
11+
<a href="https://gitter.im/masonite-framework/Lobby"><img src="https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg" alt="gitter"></a>
1212

1313
</p>
1414

1515
## About Masonite
1616

17-
Masonite is the rapid application Python development framework that strives for elegant, readable, and beautiful syntax. Masonite makes building web applications fun, enjoyable and scalable. Masonite takes much of the pain out of developing web applications from simple payment systems to removing mundane development tasks with a command line companion tool called craft commands. Masonite removes much of the mundane tasks of building web applications by:
17+
The modern and developer centric Python web framework that strives for an actual batteries included developer tool with a lot of out of the box functionality with an extremely extendable architecture. Masonite is perfect for beginner developers getting into their first web applications as well as experienced devs that need to utilize the full expotential of Masonite to get their applications done.
18+
19+
Masonite works hard to be fast and easy from install to deployment so developers can go from concept to creation in as quick and efficiently as possible. Use it for your next SaaS! Try it once and you’ll fall in love.
1820

1921
* Having a simple and expressive routing engine
2022
* Extremely powerful command line helpers called `craft` commands
@@ -28,6 +30,8 @@ Masonite is the rapid application Python development framework that strives for
2830

2931
Masonite strives to have extremely comprehensive documentation. All documentation can be [Found Here](https://masoniteframework.gitbooks.io/docs/content/) and would be wise to go through the tutorials there. If you find any discrepencies or anything that doesn't make sense, be sure to comment directly on the documentation to start a discussion!
3032

33+
Also be sure to join the [Slack channel](https://masoniteframework.gitbooks.io/docs/content/)!
34+
3135
## Linux
3236

3337
If you are running on a Linux flavor, you’ll need a few extra packages before you start. You can download these packages by running:
@@ -45,14 +49,27 @@ $ sudo apt-get install python3.6-dev libssl-dev
4549
## Installation:
4650

4751
```
48-
$ pip install masonite-cli
52+
$ pip3 install masonite-cli :: (may need sudo if using UNIX) ::
4953
$ craft new project
5054
$ cd project
5155
$ craft install
5256
$ craft serve
5357
```
5458

5559
Go to `http://localhost:8000/`
60+
****
61+
62+
<p align="center">
63+
* * * *
64+
</p>
65+
66+
Not all computers are made the same so you may have some trouble installing Masonite depending on your machine. If you have any issues be sure to read the [Known Installation Issues](https://docs.masoniteproject.com/prologue/known-installation-issues) Documentation.
67+
68+
<p align="center">
69+
* * * *
70+
</p>
71+
72+
****
5673

5774
## Contributing
5875

@@ -82,7 +99,19 @@ You can easily create new applications with `craft`. To create a new application
8299

83100
$ craft new project_name
84101

85-
**NOTE: If you do not have the craft command, you can run `pip install masonite-cli` which will install `craft` and `craft-vendor` command line tools.**
102+
****
103+
104+
<p align="center">
105+
* * * *
106+
</p>
107+
108+
NOTE: If you do not have the craft command, you can run `pip install masonite-cli` which will install `craft` and `craft-vendor` command line tools.
109+
110+
<p align="center">
111+
* * * *
112+
</p>
113+
114+
****
86115

87116
This command will create a new directory called `project_name` with our new Masonite project.
88117

@@ -94,7 +123,20 @@ Now we just need to add the pip dependencies. You can run `pip3 install -r "requ
94123

95124
$ craft install
96125

97-
**NOTE: Python craft commands are essentially wrappers around common mundane tasks. Read the docs about the craft command tool to learn more**
126+
****
127+
128+
<p align="center">
129+
* * * *
130+
</p>
131+
132+
NOTE: Python craft commands are essentially wrappers around common mundane tasks. Read the docs about the craft command tool to learn more
133+
134+
<p align="center">
135+
* * * *
136+
</p>
137+
138+
****
139+
98140

99141
This will install all the required dependencies to run this framework. Now we can run the `craft` command:
100142

@@ -109,6 +151,12 @@ If that port is blocked you can specify a port by running:
109151
Or specify a host by running:
110152

111153
$ craft serve --host 192.168.1.283
154+
155+
The server can also be auto reloaded by passing in a `-r` flag (short for `--reload`)
156+
157+
$ craft serve -r
158+
159+
This will reload the server when Masonite detects file changes. This is very similiar to Django.
112160

113161
## Hello World
114162

@@ -127,7 +175,19 @@ ROUTES = [
127175
]
128176
```
129177

130-
**NOTE: Notice this new interesting string syntax in our route. This will grant our route access to a controller (which we will create below)**
178+
****
179+
180+
<p align="center">
181+
* * * *
182+
</p>
183+
184+
NOTE: Notice this new interesting string syntax in our route. This will grant our route access to a controller (which we will create below)
185+
186+
<p align="center">
187+
* * * *
188+
</p>
189+
190+
****
131191

132192
Since we used a string controller we don't have to import our controller into this file. All imports are done through Masonite on the backend.
133193

0 commit comments

Comments
 (0)