aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEugene Sokolov <eug-vs@keemail.me>2020-06-09 15:22:09 +0300
committerGitHub <noreply@github.com>2020-06-09 15:22:09 +0300
commit39d637a817460ee62a0a6667abd6afc5b6898895 (patch)
tree6dfa6f92f0cce9b2b12c2a231152eac7d6abf433 /README.md
parentbd36aeb53d04a13167925ecd4d5d73ed2ad09914 (diff)
downloadwhich-api-39d637a817460ee62a0a6667abd6afc5b6898895.tar.gz
docs: add README
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..400387d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# which-api
+REST API for [Which](https://github.com/ilyayudovin/which/) - social web-app focused on choosing between two options (images).
+
+## Development :hammer_and_wrench:
+Track our progress - [KANBAN board](https://github.com/ilyayudovin/which/projects/1):fire:
+
+### Technology stack
+- [Typescript](https://www.typescriptlang.org/)
+- [Feathers-js](https://feathersjs.com/)
+- [Mongoose](https://mongoosejs.com/)
+
+
+### Building and running
+```
+ts-node-dev index.ts
+```