Release

Author: samjayhk

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 SAMJAYHK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,39 @@
+<p align="center">
+<img src="https://github.com/SAMJAYHK/TravelDiary/blob/master/logo.png" width="80%" >
+</p>
+
+# TravelDiary
+Travel Diary is a TypeScript&JavaScript-based discussion forum. This is a developement project by SHAPE(ST) students.
+
+* Faster response system
+* Restful APIs design with GET, POST, PUT, DELETE
+* Authentication & Encrypted data
+* Secure, fast and efficient backend system
+
+## Getting Started
+There are three step to build the Travel Diary.
+
+### Prerequisites
+#### Syetem Requirement
+* A Linux or Windows Server with 1GB RAM and 30GB SSD or above
+* A MySQL supported
+* A NodeJS supported
+* A Docker and Nginx supported
+
+## Built With
+* [Docker](https://www.docker.com/) - Future proof your Windows apps and drive continuous innovation
+* [Nginx](https://www.nginx.com/) - Web server
+* [Angular](https://angular.io/) - A JavaScript fontend library for building user interfaces
+* [Restify](http://restify.com/) - A build tool for build restful standard api
+* [MySQL](https://www.mysql.com/) - A SQL database system
+* [AWS](https://aws.amazon.com/) - Using the AI system based on Amazon Web Service
+
+## Versioning
+This project is using Git to manage the commit vesrsion.
+
+## Authors
+* TSANG Long Fung (Sam)
+**@email: 187107130@stu.vtc.edu.hk
+
+## License
+This project is licensed under the MIT License.