Create README.md

sammwyy · Sep 24, 2021 · 8cd7d86 · 8cd7d86
1 parent 5091fb0
commit 8cd7d86
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# Open Taiko
+
+Open Taiko is a re-code of [Taiko Web](https://github.com/bui/taiko-web/) which Python has been replaced by NodeJS.  
+Running instance [taiko.2lstudios.dev](https://taiko.2lstudios.dev)  
+Still in development.
+
+## ToDo
+
+- [ ] Improve online system.  
+- [ ] Improve account system. 
+- [ ] Improve administrator dashboard.  
+
+## Build from source
+
+1. Clone repository  
+2. Use `npm install` or `yarn install`  
+3. Compile using `npm run build` or `yarn build`
+4. Start production environment using `npm start` or `yarn start`