52 lines
2.2 KiB
Markdown
Executable File
52 lines
2.2 KiB
Markdown
Executable File
# Prerequisites
|
|
|
|
To get started with Change Maker, ensure you have the following prerequisites:
|
|
|
|
## General Requirements
|
|
|
|
- **Internet Connection**: Required for initial setup to download the latest versions of the software.
|
|
- **Memory**: Minimum 2GB RAM. 4GB RAM is recommended.
|
|
- **Disk Space**: Around 10GB of free disk space; more or less depending on size of website build. (instalation size is ~1GB).
|
|
|
|
## Necessary: Docker and Docker Compose
|
|
|
|
Change Maker uses Docker and Docker Compose for containerization. Follow the instructions below to install Docker and Docker Compose on your platform.
|
|
|
|
[Docker](https://www.docker.com/){ .md-button }
|
|
|
|
### Windows
|
|
|
|
1. **Install Docker Desktop for Windows**:
|
|
- Download and install Docker Desktop from [Docker's official site](https://docs.docker.com/docker-for-windows/install/).
|
|
- Ensure WSL 2 is enabled (Docker Desktop will guide you through this process).
|
|
|
|
|
|
### Mac
|
|
|
|
1. **Install Docker Desktop for Mac**:
|
|
- Download and install Docker Desktop from [Docker's official site](https://docs.docker.com/docker-for-mac/install/).
|
|
- Docker Desktop supports both Intel and Apple Silicon Macs.
|
|
|
|
### Linux
|
|
|
|
1. **Install Docker**:
|
|
- Follow the instructions on [Docker's official site](https://docs.docker.com/engine/install/) to install Docker using your package manager.
|
|
|
|
2. **Install Docker Compose**:
|
|
- If Docker Compose is not included with your Docker installation, follow the instructions on [Docker Compose's official site](https://docs.docker.com/compose/install/) to install it.
|
|
|
|
## Recommended: Obsidian
|
|
|
|
Obsidian is a powerful markdown editor that can be used to edit the documentation files. It is not required, but it is recommended for a better editing experience.
|
|
|
|
[Obsidian](https://obsidian.md/){ .md-button }
|
|
|
|
More info on configurint Obsidian can be found [here](obsidian.md).
|
|
|
|
## Power User: Visual Studio Code
|
|
|
|
Visual Studio Code is a powerful code editor that can be used to edit the source code. Visual Code Studio, if properly configured, is the fastest method to generate a site. Built in AI allows your to edit your entire codebase using plain language prompts. It is not required, but it is recommended for a better coding experience.
|
|
|
|
[Visual Studio Code](https://code.visualstudio.com/){ .md-button }
|
|
|