diff options
| author | MatthieuCoder <matthieu@matthieu-dev.xyz> | 2023-01-14 17:45:48 +0400 |
|---|---|---|
| committer | MatthieuCoder <matthieu@matthieu-dev.xyz> | 2023-01-14 17:45:48 +0400 |
| commit | 3f342846149c0b1f8d1ac1f0b857a9d9fdf2034b (patch) | |
| tree | 5ad087639ade0998ec0af0e0532c71a59b92993a /docs/quickstart.md | |
| parent | ee58b30800527306ab024da926121c085a0978fa (diff) | |
clippy, tests and a bit of docs
Diffstat (limited to 'docs/quickstart.md')
| -rw-r--r-- | docs/quickstart.md | 22 |
1 files changed, 0 insertions, 22 deletions
diff --git a/docs/quickstart.md b/docs/quickstart.md index 1eace72..d4ca78b 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,24 +1,2 @@ # 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. |