Skip to content

Commit 5217b89

Browse files
nipuns11nipuns11
authored
Create readme1.md
1 parent d51702e commit 5217b89

File tree

1 file changed

+207
-0
lines changed

1 file changed

+207
-0
lines changed

‎readme1.md

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
2+
![alt text](https://www.titus.com/themes/custom/titus/logo.svg)
3+
4+
# Quality Criteria for Champagne
5+
[![Build Status](https://titusinc.visualstudio.com/TitusSaaS/_apis/build/status/TITUS%20Services/TITUS%20Services%20-%20CI)](https://titusinc.visualstudio.com/TitusSaaS/_build/latest?definitionId=2)
6+
7+
### Release Characteristics
8+
9+
-Number of Critical and High bugs
10+
11+
-Number of Medium and low bugs should be less than x (x = 5)
12+
13+
-Number of deferred bugs should be less than x (x = 5)
14+
15+
-Number of Customer bugs should be less than x (x = 5)
16+
17+
-Security Scan results are as per the threshold defined (Number of vulnerabilities should be less than x)
18+
19+
-SonarQube quality gate is at the required level (code smells, code coverage not down from previous, etc)
20+
21+
-Black duck scan? (Its not automated correctly so need to be done manually)
22+
23+
-All the manual test cases should be completed, passed and report should be generated
24+
25+
-Performance tests result should be as per the threshold (TBD)
26+
27+
# Dillinger
28+
29+
[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid)
30+
31+
[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)
32+
33+
Dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor.
34+
35+
- Type some Markdown on the left
36+
- See HTML in the right
37+
- Magic
38+
39+
# New Features!
40+
41+
- Import a HTML file and watch it magically convert to Markdown
42+
- Drag and drop images (requires your Dropbox account be linked)
43+
44+
45+
You can also:
46+
- Import and save files from GitHub, Dropbox, Google Drive and One Drive
47+
- Drag and drop markdown and HTML files into Dillinger
48+
- Export documents as Markdown, HTML and PDF
49+
50+
Markdown is a lightweight markup language based on the formatting conventions that people naturally use in email. As [John Gruber] writes on the [Markdown site][df1]
51+
52+
> The overriding design goal for Markdown's
53+
> formatting syntax is to make it as readable
54+
> as possible. The idea is that a
55+
> Markdown-formatted document should be
56+
> publishable as-is, as plain text, without
57+
> looking like it's been marked up with tags
58+
> or formatting instructions.
59+
60+
This text you see here is *actually* written in Markdown! To get a feel for Markdown's syntax, type some text into the left window and watch the results in the right.
61+
62+
### Tech
63+
64+
Dillinger uses a number of open source projects to work properly:
65+
66+
* [AngularJS] - HTML enhanced for web apps!
67+
* [Ace Editor] - awesome web-based text editor
68+
* [markdown-it] - Markdown parser done right. Fast and easy to extend.
69+
* [Twitter Bootstrap] - great UI boilerplate for modern web apps
70+
* [node.js] - evented I/O for the backend
71+
* [Express] - fast node.js network app framework [@tjholowaychuk]
72+
* [Gulp] - the streaming build system
73+
* [Breakdance](http://breakdance.io) - HTML to Markdown converter
74+
* [jQuery] - duh
75+
76+
And of course Dillinger itself is open source with a [public repository][dill]
77+
on GitHub.
78+
79+
### Installation
80+
81+
Dillinger requires [Node.js](https://nodejs.org/) v4+ to run.
82+
83+
Install the dependencies and devDependencies and start the server.
84+
85+
```sh
86+
$ cd dillinger
87+
$ npm install -d
88+
$ node app
89+
```
90+
91+
For production environments...
92+
93+
```sh
94+
$ npm install --production
95+
$ NODE_ENV=production node app
96+
```
97+
98+
### Plugins
99+
100+
Dillinger is currently extended with the following plugins. Instructions on how to use them in your own application are linked below.
101+
102+
| Plugin | README |
103+
| ------ | ------ |
104+
| Dropbox | [plugins/dropbox/README.md][PlDb] |
105+
| Github | [plugins/github/README.md][PlGh] |
106+
| Google Drive | [plugins/googledrive/README.md][PlGd] |
107+
| OneDrive | [plugins/onedrive/README.md][PlOd] |
108+
| Medium | [plugins/medium/README.md][PlMe] |
109+
| Google Analytics | [plugins/googleanalytics/README.md][PlGa] |
110+
111+
112+
### Development
113+
114+
Want to contribute? Great!
115+
116+
Dillinger uses Gulp + Webpack for fast developing.
117+
Make a change in your file and instantanously see your updates!
118+
119+
Open your favorite Terminal and run these commands.
120+
121+
First Tab:
122+
```sh
123+
$ node app
124+
```
125+
126+
Second Tab:
127+
```sh
128+
$ gulp watch
129+
```
130+
131+
(optional) Third:
132+
```sh
133+
$ karma test
134+
```
135+
#### Building for source
136+
For production release:
137+
```sh
138+
$ gulp build --prod
139+
```
140+
Generating pre-built zip archives for distribution:
141+
```sh
142+
$ gulp build dist --prod
143+
```
144+
### Docker
145+
Dillinger is very easy to install and deploy in a Docker container.
146+
147+
By default, the Docker will expose port 8080, so change this within the Dockerfile if necessary. When ready, simply use the Dockerfile to build the image.
148+
149+
```sh
150+
cd dillinger
151+
docker build -t joemccann/dillinger:${package.json.version} .
152+
```
153+
This will create the dillinger image and pull in the necessary dependencies. Be sure to swap out `${package.json.version}` with the actual version of Dillinger.
154+
155+
Once done, run the Docker image and map the port to whatever you wish on your host. In this example, we simply map port 8000 of the host to port 8080 of the Docker (or whatever port was exposed in the Dockerfile):
156+
157+
```sh
158+
docker run -d -p 8000:8080 --restart="always" <youruser>/dillinger:${package.json.version}
159+
```
160+
161+
Verify the deployment by navigating to your server address in your preferred browser.
162+
163+
```sh
164+
127.0.0.1:8000
165+
```
166+
167+
#### Kubernetes + Google Cloud
168+
169+
See [KUBERNETES.md](https://github.com/joemccann/dillinger/blob/master/KUBERNETES.md)
170+
171+
172+
### Todos
173+
174+
- Write MORE Tests
175+
- Add Night Mode
176+
177+
License
178+
----
179+
180+
MIT
181+
182+
183+
**Free Software, Hell Yeah!**
184+
185+
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)
186+
187+
188+
[dill]: <https://github.com/joemccann/dillinger>
189+
[git-repo-url]: <https://github.com/joemccann/dillinger.git>
190+
[john gruber]: <http://daringfireball.net>
191+
[df1]: <http://daringfireball.net/projects/markdown/>
192+
[markdown-it]: <https://github.com/markdown-it/markdown-it>
193+
[Ace Editor]: <http://ace.ajax.org>
194+
[node.js]: <http://nodejs.org>
195+
[Twitter Bootstrap]: <http://twitter.github.com/bootstrap/>
196+
[jQuery]: <http://jquery.com>
197+
[@tjholowaychuk]: <http://twitter.com/tjholowaychuk>
198+
[express]: <http://expressjs.com>
199+
[AngularJS]: <http://angularjs.org>
200+
[Gulp]: <http://gulpjs.com>
201+
202+
[PlDb]: <https://github.com/joemccann/dillinger/tree/master/plugins/dropbox/README.md>
203+
[PlGh]: <https://github.com/joemccann/dillinger/tree/master/plugins/github/README.md>
204+
[PlGd]: <https://github.com/joemccann/dillinger/tree/master/plugins/googledrive/README.md>
205+
[PlOd]: <https://github.com/joemccann/dillinger/tree/master/plugins/onedrive/README.md>
206+
[PlMe]: <https://github.com/joemccann/dillinger/tree/master/plugins/medium/README.md>
207+
[PlGa]: <https://github.com/RahulHP/dillinger/blob/master/plugins/googleanalytics/README.md>

0 commit comments

Comments
 (0)