From: icecodder <git@icecodder.me>
Date: Mon, 2 Jan 2023 13:27:20 +0000 (+0100)
Subject: remove docusaurus for novadoc
X-Git-Tag: v0.1~31^2~3
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=079f21c305d69bc36c6769d4fa9ef426d6c1f9e6;p=matthieu%2Fnova.git

remove docusaurus for novadoc
---

diff --git a/docs/quickstart.md b/docs/quickstart.md
new file mode 100644
index 0000000..1eace72
--- /dev/null
+++ b/docs/quickstart.md
@@ -0,0 +1,24 @@
+# 5 Minutes quickstart
+
+This page shows you how to start a new nova project
+under five minutes using a typescript project,
+hold tight this is going to be fast.
+
+## Requirements
+
+* A discord bot application available
+* [Docker](https://docker.io/) (or alternatives) available to you.
+* A domain name / [ngrok.io](https://ngrok.com/) domain (for webhooks only)
+
+> If you are deploying nova to production, consider following the
+> production guide instead.
+
+## Setting up a nova instance
+
+Clone the [example repo](https://github.com/discordnova/nova-quickstart.git) like so
+
+`git clone https://github.com/discordnova/nova-quickstart.git`,
+
+In this folder, find the `config.yml.example` file and rename it to match `config.yml`
+
+Next, you need to fill all the environment variables to match your discord bot.