summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-09-22 15:05:50 +0200
committerGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-09-23 10:06:10 +0200
commitb32c5c06ee844072a760f776e5f37f7c32c97c8f (patch)
tree3f4c4e8b95dff0b63ab9126cf8aeb23ad2ae4065 /README.md
parent2b98c0d580dd2fe5d103ea1ab16e69db56734cde (diff)
Update metadata and docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..36ba218f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# OpenDC Frontend
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+The user-facing component of the OpenDC stack, allowing users to build and interact with their own (virtual) datacenters. Built in *React.js* and *Redux*, with the help of `create-react-app`.
+
+
+## Architecture
+
+The codebase follows a standard React.js structure, with static assets being contained in the `public` folder, while dynamic components and their styles are contained in `src`.
+
+### Pages
+
+//
+
+### Components & Containers
+
+//
+
+### State Management
+
+//
+
+### API Interaction
+
+//