Skip to content

eaudeweb/recommended-project

 
 

Repository files navigation

How to use this project

  1. Create a new project on your computer.
composer create-project eaudeweb/recommended-project:10.x-dev [project-name]
  1. When asked "Do you want to remove the existing VCS (.git, .svn..) history? [Y,n]?" choose Y
  2. Customize example.robo.yml
  3. Update project name in .ddev/config.yaml
  4. Update README.md

Below you will find the default README template, please update the README file after creating the project.

PROJECT NAME

Short project description.

https://www.project.org

I. Prerequisites

Using DDEV Using LAMP stack
mkcert PHP 8.2
DDEV 1.22.0+ MySQL 5.7.8+ / MariaDB 10.3.7+
Apache / NGINX
Composer
NVM
Node.js 18 (run nvm use 18)

II. Project setup

  • Clone the repository
  • Copy example.robo.yml to robo.yml and customize username, password and admin_username
  • Copy .env.example to .env and configure the variables there

If you are using LAMP stack and not DDEV, also the following steps are also required:

  • Create a new database
  • Create a new virtual host pointing to the web folder of this project
  • Update your /etc/hosts file accordingly
  • Copy web/sites/example.settings.local.php to web/sites/default/settings.local.php and customize database credentials.
  • Copy example.salt.txt to salt.txt

III. Installation

  • Run ./install.sh

IV. Development

Please make sure you are familiar with:

Releases

No releases published

Packages

No packages published

Languages

  • PHP 58.0%
  • CSS 17.0%
  • Twig 16.2%
  • JavaScript 8.8%