Browse Source

Added license and readme

Teknikode 3 years ago
parent
commit
97389d57ce
4 changed files with 90 additions and 152 deletions
  1. 65
    0
      README.md
  2. 0
    151
      Teknik/Project_Readme.html
  3. 0
    1
      Teknik/Teknik.csproj
  4. 25
    0
      license.txt

+ 65
- 0
README.md View File

@@ -0,0 +1,65 @@
1
+# Teknik Web Services
2
+
3
+---------------
4
+
5
+Teknik is a suite of services with attractive and functional interfaces.
6
+
7
+## Features
8
+  * File Upload w/ encryption
9
+  * Pastebin
10
+  * Blogs
11
+  * Git Repositories
12
+  * Podcasts
13
+  * Easy to use API
14
+  * Server Statistics
15
+  * Flexible installation and configuration
16
+
17
+## Screenshots
18
+[![File Upload Screenshot](https://cdn.teknik.io/default/img/screenshots/upload_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/upload_screenshot.PNG)
19
+[![Pastebin Screenshot](https://cdn.teknik.io/default/img/screenshots/paste_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/paste_screenshot.PNG)
20
+[![Blog Screenshot](https://cdn.teknik.io/default/img/screenshots/blog_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/blog_screenshot.PNG)
21
+[![Podcast Screenshot](https://cdn.teknik.io/default/img/screenshots/podcast_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/podcast_screenshot.PNG)
22
+[![Git Screenshot](https://cdn.teknik.io/default/img/screenshots/git_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/git_screenshot.PNG)
23
+
24
+You can also see a live demo [here](https://www.teknik.io).
25
+
26
+## Requirements
27
+In order to run Teknik on your server, you'll need:
28
+
29
+  * IIS 7 with URL Rewrite module or Apache with mod_rewrite enabled (Requires conversion of web.config files)
30
+  * ASP.NET MVC 4
31
+  * .NET Framework 4.5.2
32
+  * MS SQL Server
33
+  * hMailServer (If running email as well)
34
+  * RoundCube (If you would like to have webmail)
35
+  * Git Service (We use Gogs)
36
+
37
+## Installation
38
+  * Clone the Teknik repository to your web root directory, or anywhere else you want to run Teknik from.
39
+
40
+```
41
+cd /var/www
42
+git clone git://teknik.io/Teknik
43
+```
44
+
45
+  * Do not clone the development branch unless you want to run the latest code.  It may be unstable.
46
+  * **TBD**
47
+
48
+**That's it**, installation complete! If you're having problems, let us know through the [Contact](https://contact.teknik.io/) page.
49
+
50
+## Authors and contributors
51
+  * [Chris Woodward](https://www.teknik.io) (Creator, developer)
52
+  * [dronedaddy](https://www.behance.net/dronedaddy) (Logo Designer)
53
+
54
+## License
55
+[BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause)
56
+
57
+## Development
58
+You can view Teknik's [Development Branch](https://dev.teknik.io/) to see the current new features.  (It may not work, as it is a development branch)
59
+
60
+## Contributing
61
+If you are a developer, we need your help. Teknik is a young project and we have lot's of stuff to do. Some developers are contributing with new features, others with bug fixes. But you can also dedicate yourself to refactoring the current codebase and improving what we already have.  Any help you can give would be greatly appreciated!
62
+
63
+## Further information
64
+If you want to know more about the features of Teknik, check the [Help](https://help.teknik.io/) page. Also, if you're having problems with Teknik, let us know through the [Contact](https://contact.teknik.io/) page. Don't forget to give feedback and suggest new features! :)
65
+

+ 0
- 151
Teknik/Project_Readme.html View File

@@ -1,151 +0,0 @@
1
-<!DOCTYPE html>
2
-<html lang="en">
3
-<head>
4
-    <meta charset="utf-8" />
5
-    <title>Your ASP.NET application</title>
6
-    <style>
7
-        body {
8
-            background: #fff;
9
-            color: #505050;
10
-            font: 14px 'Segoe UI', tahoma, arial, helvetica, sans-serif;
11
-            margin: 20px;
12
-            padding: 0;
13
-        }
14
-
15
-        #header {
16
-            background: #efefef;
17
-            padding: 0;
18
-        }
19
-
20
-        h1 {
21
-            font-size: 48px;
22
-            font-weight: normal;
23
-            margin: 0;
24
-            padding: 0 30px;
25
-            line-height: 150px;
26
-        }
27
-
28
-        p {
29
-            font-size: 20px;
30
-            color: #fff;
31
-            background: #969696;
32
-            padding: 0 30px;
33
-            line-height: 50px;
34
-        }
35
-
36
-        #main {
37
-            padding: 5px 30px;
38
-        }
39
-
40
-        .section {
41
-            width: 21.7%;
42
-            float: left;
43
-            margin: 0 0 0 4%;
44
-        }
45
-
46
-            .section h2 {
47
-                font-size: 13px;
48
-                text-transform: uppercase;
49
-                margin: 0;
50
-                border-bottom: 1px solid silver;
51
-                padding-bottom: 12px;
52
-                margin-bottom: 8px;
53
-            }
54
-
55
-            .section.first {
56
-                margin-left: 0;
57
-            }
58
-
59
-                .section.first h2 {
60
-                    font-size: 24px;
61
-                    text-transform: none;
62
-                    margin-bottom: 25px;
63
-                    border: none;
64
-                }
65
-
66
-                .section.first li {
67
-                    border-top: 1px solid silver;
68
-                    padding: 8px 0;
69
-                }
70
-
71
-            .section.last {
72
-                margin-right: 0;
73
-            }
74
-
75
-        ul {
76
-            list-style: none;
77
-            padding: 0;
78
-            margin: 0;
79
-            line-height: 20px;
80
-        }
81
-
82
-        li {
83
-            padding: 4px 0;
84
-        }
85
-
86
-        a {
87
-            color: #267cb2;
88
-            text-decoration: none;
89
-        }
90
-
91
-            a:hover {
92
-                text-decoration: underline;
93
-            }
94
-    </style>
95
-</head>
96
-<body>
97
-
98
-    <div id="header">
99
-        <h1>Your ASP.NET application</h1>
100
-        <p>Congratulations! You've created a project</p>
101
-    </div>
102
-
103
-    <div id="main">
104
-        <div class="section first">
105
-            <h2>This application consists of:</h2>
106
-            <ul>
107
-                <li>Sample pages showing basic nav between Home, About, and Contact</li>
108
-                <li>Theming using <a href="http://go.microsoft.com/fwlink/?LinkID=320754">Bootstrap</a></li>
109
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320755">Authentication</a>, if selected, shows how to register and sign in</li>
110
-                <li>ASP.NET features managed using <a href="http://go.microsoft.com/fwlink/?LinkID=320756">NuGet</a></li>
111
-            </ul>
112
-        </div>
113
-
114
-        <div class="section">
115
-            <h2>Customize app</h2>
116
-            <ul>
117
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320757">Get started with ASP.NET MVC</a></li>
118
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320758">Change the site's theme</a></li>
119
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320759">Add more libraries using NuGet</a></li>
120
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320760">Configure authentication</a></li>
121
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320761">Customize information about the website users</a></li>
122
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320762">Get information from social providers</a></li>
123
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320763">Add HTTP services using ASP.NET Web API</a></li>
124
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320764">Secure your web API</a></li>
125
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320765">Add real-time web with ASP.NET SignalR</a></li>
126
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320766">Add components using Scaffolding</a></li>
127
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320767">Test your app with Browser Link</a></li>
128
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320768">Share your project</a></li>
129
-            </ul>
130
-        </div>
131
-
132
-        <div class="section">
133
-            <h2>Deploy</h2>
134
-            <ul>
135
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320769">Ensure your app is ready for production</a></li>
136
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320770">Microsoft Azure</a></li>
137
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320771">Hosting providers</a></li>
138
-            </ul>
139
-        </div>
140
-
141
-        <div class="section last">
142
-            <h2>Get help</h2>
143
-            <ul>
144
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320772">Get help</a></li>
145
-                <li><a href="http://go.microsoft.com/fwlink/?LinkID=320773">Get more templates</a></li>
146
-            </ul>
147
-        </div>
148
-    </div>
149
-
150
-</body>
151
-</html>

+ 0
- 1
Teknik/Teknik.csproj View File

@@ -262,7 +262,6 @@
262 262
   </ItemGroup>
263 263
   <ItemGroup>
264 264
     <Content Include="packages.config" />
265
-    <None Include="Project_Readme.html" />
266 265
   </ItemGroup>
267 266
   <PropertyGroup>
268 267
     <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>

+ 25
- 0
license.txt View File

@@ -0,0 +1,25 @@
1
+Copyright (c) 2013-2014, Chris Woodward <admin@teknik.io>
2
+All rights reserved.
3
+
4
+Redistribution and use in source and binary forms, with or without
5
+modification, are permitted provided that the following conditions are met:
6
+
7
+    * Redistributions of source code must retain the above copyright
8
+      notice, this list of conditions and the following disclaimer.
9
+    * Redistributions in binary form must reproduce the above copyright
10
+      notice, this list of conditions and the following disclaimer in the
11
+      documentation and/or other materials provided with the distribution.
12
+    * Neither the name of the organization nor the
13
+      names of its contributors may be used to endorse or promote products
14
+      derived from this software without specific prior written permission.
15
+
16
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19
+DISCLAIMED. IN NO EVENT SHALL CHRIS WOODWARD BE LIABLE FOR ANY
20
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Loading…
Cancel
Save