The next generation of the Teknik Services. Written in ASP.NET. https://www.teknik.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 4.0KB

1 year ago
1 year ago
3 years ago
1 year ago
3 years ago
1 year ago
1 year ago
3 years ago
3 years ago
1 year ago
3 years ago
1 year ago
1 year ago
1 year ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. # Teknik Web Services
  2. [![Build Status](https://uncled1023.visualstudio.com/_apis/public/build/definitions/47815734-d274-4bfd-8945-d58f2261b421/4/badge)](https://uncled1023.visualstudio.com/Teknik/_build/index?definitionId=4)
  3. Teknik is a suite of services with attractive and functional interfaces.
  4. ## Features
  5. * File Upload w/ client side encryption
  6. * Album Support
  7. * Pastebin
  8. * URL Shortening
  9. * Blogs
  10. * Git Integration (Gitea)
  11. * Podcasts
  12. * Easy to use API
  13. * Flexible installation and configuration
  14. * And much more...
  15. You can see a live demo [here](https://www.teknik.io).
  16. ## Requirements
  17. In order to run Teknik on your server, you'll need:
  18. * IIS 7+, Nginx, or Apache
  19. * [.NET Core 2.1 Runtime](https://www.microsoft.com/net/download/) (Or SDK if building the src)
  20. * A SQL Server (MS SQL Server, MySQL, SQLite)
  21. * [hMailServer](https://www.hmailserver.com/download) (If running email service)
  22. * [Gitea](https://github.com/go-gitea/gitea) (If you want to have Git integration)
  23. * Web Mail Client (If you would like to have webmail)
  24. ## Installation
  25. * Set up Asp.Net Core to work with your system of choice - [Instructions](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/?view=aspnetcore-2.1&tabs=aspnetcore2x)
  26. * Download the latest release of Teknik for your system - [Releases](https://git.teknik.io/Teknikode/Teknik/releases)
  27. * Copy the files to your local web root directory.
  28. * Create a `ConnectionStrings.config` file in the `App_Data` directory and fill it with the following template and put in your SQL server connection details.
  29. ```nohighlight
  30. <connectionStrings>
  31. <add name="TeknikEntities"
  32. providerName="System.Data.SqlClient"
  33. connectionString="<Sql Server Connection String>" />
  34. </connectionStrings>
  35. ```
  36. * After the first run, a `Config.json` file will be created in the `App_Data` directory. This will need to be edited with your configuration options.
  37. That's it, installation complete! If you're having problems, let us know through the [Contact](https://contact.teknik.io/) page.
  38. ## Building
  39. ### Linux
  40. * Clone the Teknik repository to a directory of your choosing.
  41. ```nohighlight
  42. cd ~
  43. mkdir src
  44. cd ./src
  45. git clone https://git.teknik.io/Teknikode/Teknik
  46. ```
  47. * Set up .Net Core SDK for you system of choice - [Instructions](https://www.microsoft.com/net/download/all)
  48. * Install Node.js (Includes npm).
  49. * Run the npm build script `npm run build`.
  50. * This will install, move, bundle, and minify all the client side assets (JavaScript, CSS, Fonts, and Images).
  51. * To see exactly what happens or to modify the build. look at the `gulpfile.js` file.
  52. * Run dotnet publish from the root directory of the repo to build and package the app into the release publish directory (for example: ./Teknik/bin/Release/netcoreapp2.1/publish).
  53. ```
  54. dotnet publish --configuration Release
  55. ```
  56. * Copy the files in the publish directory to where you want to run the website from.
  57. * Test the website:
  58. * In the directory conatining the published files, run `dotnet Teknik.dll`
  59. * In a browser, open http://localhost:5000/?sub=www
  60. ## Authors and contributors
  61. * [Chris Woodward](https://www.teknik.io) (Creator, Developer)
  62. * [dronedaddy](https://www.behance.net/dronedaddy) (Logo Designer)
  63. ## License
  64. [BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause)
  65. ## Development
  66. 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).
  67. ## Contributing
  68. If you are a developer, we need your help. Teknik is a young project and we have lots of stuff to do. Some developers are contributing with new features, others with bug fixes. Any help you can give would be greatly appreciated!
  69. ## Further information
  70. 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! :)