Skip to content
This repository has been archived by the owner on Jan 16, 2024. It is now read-only.

AlxisHenry/cloud

Repository files navigation

cloud

A simple cloud web service for storing and retrieving files.

Documentation »


📔 Summary

🌟 About the project

This project is built with PHP. It's a simple cdn to store my images and files.

👾 Techs

Php Shell

🧰 Getting Started

⚙️ Setup

Clone the repository

git clone https://github.com/AlxisHenry/cdn.git

Launch the setup script, it will do most of the work for you.

bash setup.sh

⚙️ Configuration

The first step is to configure dashboard settings. You can do it by editing the settings.yml file situated in the root of the project.

dashboard:
  title: "MY CLOUD"
  subtitle: "YES!"
  description: "ABOUT MY CLOUD"

The second step is to configure the config.php file. You can do it by editing the config.php file situated in the root of the project.

In this file you can configure some settings like the environment, the maximum file size, etc...

return [
	/**
	 * Environment settings
	 */
	'APP_ENV' => 'development',

	/**
	 * Files settings
	 */
	'MAX_FILE_SIZE' => "50000000", // value in bytes (default: 50MB)
];

🧪 Tests

Run linters

make lint

Run the tests using the following command

make tests || npm run tests

⚙️ Crontab

To setup a CRON to save your shared files, run the command below:

sudo bash utils/cron.sh || make cron

👋 Contributors

(back to top)