about summary refs log tree commit diff
path: root/users/wpcarro/boilerplate/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'users/wpcarro/boilerplate/README.md')
-rw-r--r--users/wpcarro/boilerplate/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/users/wpcarro/boilerplate/README.md b/users/wpcarro/boilerplate/README.md
new file mode 100644
index 000000000000..aa72266a337a
--- /dev/null
+++ b/users/wpcarro/boilerplate/README.md
@@ -0,0 +1,21 @@
+# Boilerplate
+
+Storing some boilerplate code to help me reduce the time it takes me to develop
+and deploy applications.
+
+## Usage
+
+Let's say that you would like to create a game for
+`sandbox.wpcarro.dev/game`. We will create a new TypeScript project with the
+following:
+
+```shell
+$ cp -r typescript path/to/new-project
+```
+
+This initializes the project. To start developing, run:
+
+```shell
+$ nix-shell
+$ yarn run dev
+```