mirror of
https://github.com/gnmyt/LicenseAPI.git
synced 2026-01-11 10:41:46 +00:00
Create docs introduction
This commit is contained in:
26
docs/content/1.introduction/1.getting-started.md
Normal file
26
docs/content/1.introduction/1.getting-started.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
# Getting Started
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Before you start, make sure you have the following installed:
|
||||||
|
|
||||||
|
- [Docker](https://docs.docker.com/get-docker/)
|
||||||
|
- [Docker Compose](https://docs.docker.com/compose/install/)
|
||||||
|
|
||||||
|
::alert{type="info"}
|
||||||
|
📧 You will also need a Mailserver to send emails. If you don't have one, you need to manually verify users in the database.
|
||||||
|
::
|
||||||
|
|
||||||
|
## Download and Install
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget https://raw.githubusercontent.com/gnmyt/LicenseAPI/main/docker-compose.yml
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
::alert{type="success"}
|
||||||
|
✨ Well done! A browser window should automatically open for <http://localhost:3000>
|
||||||
|
::
|
||||||
2
docs/content/1.introduction/_dir.yml
Normal file
2
docs/content/1.introduction/_dir.yml
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
icon: ph:star-duotone
|
||||||
|
navigation.redirect: /introduction/getting-started
|
||||||
Reference in New Issue
Block a user