Installation

some basic information on how to install this project

Quick Start

1. Create an Account

Register on the Silkpanel website and create a server. You can test the CMS for free for a limited time.

2. Clone the Repository

git clone https://github.com/Devsome/silkpanel-cms
cd silkpanel-cms

3. Configure Environment

Copy the example environment file and generate a key:

cp .env.example .env
php artisan key:generate

Edit .env and set your database credentials:

APP_NAME=Silkpanel
APP_URL=https://your-domain.com

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=silkpanel
DB_USERNAME=root
DB_PASSWORD=

4. Add Your API Key

Open composer.json and add your API key in the repositories section:

"repositories": [
	{
		"type": "path",
		"url": "packages/*",
		"options": {
			"symlink": true,
			"http": {
				"header": [
					"API-TOKEN: YOUR-API-KEY"
				]
			}
		}
	}
]

Replace YOUR-API-KEY with your personal API token from your Silkpanel account.

5. Install Dependencies

composer install
npm install

6. Run Setup Commands

php artisan migrate --seed

7. Build Assets

npm run build

8. Link Storage

php artisan storage:link

9. Connect Your Domain

Point your domain to your server and open the project in your browser.

---

You can now test Silkpanel CMS for free!