MarseyWorld/readme.md

73 lines
1.4 KiB
Markdown
Raw Normal View History

2021-07-22 20:48:13 +00:00
# Installation
2021-07-21 01:12:26 +00:00
## Overview
Installing Drama locally is the fastest way to get the software up and running and start tinkering under the hood.
---
## Windows
### Install Docker
Install Docker on your machine.
[Docker installation for Windows](https://docs.docker.com/docker-for-windows/install/)
### Download Drama
2021-07-22 20:48:13 +00:00
Download Drama into your machine by running this command.
2021-07-21 01:12:26 +00:00
2021-07-22 20:48:13 +00:00
```
git clone https://github.com/Aevann1/Drama/
```
2021-07-21 01:12:26 +00:00
### PowerShell
2021-07-22 20:48:13 +00:00
Press shift+right click inside the Drama code folder and run PowerShell. Then in PowerShell, run the following command:
2021-07-21 01:12:26 +00:00
```
docker-compose up
```
That's it! Visit `localhost` in your browser.
---
2021-07-22 20:48:13 +00:00
Optional: to configure the site settings and successsfully integrate it with the external services we use (hcaptcha, cloudflare, aws S3, discord, tenor and mailgun), please edit the variables in the docker-compose.yml file.
2021-07-21 01:12:26 +00:00
2021-07-22 20:48:13 +00:00
---
2021-07-21 01:12:26 +00:00
2021-07-22 20:48:13 +00:00
## Linux
2021-07-21 01:12:26 +00:00
### Download Drama
2021-07-22 20:48:13 +00:00
Download Drama into your machine by running this command.
2021-07-21 01:12:26 +00:00
```
2021-07-22 20:48:13 +00:00
git clone https://github.com/Aevann1/Drama/ /drama
2021-07-21 01:12:26 +00:00
```
2021-07-22 20:48:13 +00:00
### Install Drama
Navigate to `/drama`
2021-07-21 01:12:26 +00:00
```
2021-07-22 20:48:13 +00:00
cd /drama
2021-07-21 01:12:26 +00:00
```
2021-07-22 20:48:13 +00:00
then run the following command:
2021-07-21 01:12:26 +00:00
```
2021-07-22 20:48:13 +00:00
source setup
2021-07-21 01:12:26 +00:00
```
2021-07-22 20:48:13 +00:00
That's it. Visit `localhost` in your browser.
2021-07-21 01:12:26 +00:00
2021-07-22 20:48:13 +00:00
---
2021-07-21 01:12:26 +00:00
2021-07-22 20:48:13 +00:00
Optional: to configure the site settings and successsfully integrate it with the external services we use (hcaptcha, cloudflare, aws S3, discord, tenor and mailgun), please run this command and edit the variables:
```
nano /drama/docker-compose.yml
```