diff options
| author | icecodder <git@icecodder.me> | 2023-01-02 14:27:20 +0100 |
|---|---|---|
| committer | icecodder <git@icecodder.me> | 2023-01-02 14:27:20 +0100 |
| commit | 079f21c305d69bc36c6769d4fa9ef426d6c1f9e6 (patch) | |
| tree | a001e21b52e34b5f583002d0119c1b18ea039a14 | |
| parent | 46fd26962ef55f8b557f7e36d3aee915a819c88c (diff) | |
remove docusaurus for novadoc
| -rw-r--r-- | docs/quickstart.md | 24 |
1 files changed, 24 insertions, 0 deletions
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. |
