Skip to content
Snippets Groups Projects
Select Git revision
9 results
Blame Permalink
Forked from Ad Aures / Castopod
1080 commits behind the upstream repository.
  • Yassine Doghri's avatar
    cbb83a6f
    feat: add npm for js dependencies + move src/ files to root folder · cbb83a6f
    Yassine Doghri authored 
    - add node service in docker-compose.yml
- update .devcontainer Dockerfile by adding node, npm and vim
- init package.json for npm with tailwindcss, postcss, commitlint and commitizen as dev dependencies
- update default layout main header and footer
- replace CI's welcome_message.php with home.php listing all podcasts
- add AUTHORS.md file
- add docs folder in which to place castopod's technical documentation
    cbb83a6f
    History
    feat: add npm for js dependencies + move src/ files to root folder
    Yassine Doghri authored 
    - add node service in docker-compose.yml
- update .devcontainer Dockerfile by adding node, npm and vim
- init package.json for npm with tailwindcss, postcss, commitlint and commitizen as dev dependencies
- update default layout main header and footer
- replace CI's welcome_message.php with home.php listing all podcasts
- add AUTHORS.md file
- add docs folder in which to place castopod's technical documentation
setup-development.md 6.51 KiB

Setup your development environment

Table of contents

Introduction

Castopod is a web app based on the php framework CodeIgniter 4.

To setup a dev environment, we use Docker. A docker-compose.yml and Dockerfile are included in the project's root folder to help you kickstart your contribution.

Know that you don't need any prior knowledge of Docker to follow the next steps. However, if you wish to use your own environment, feel free to do so!

Prerequisites

  1. Install docker desktop.

  2. Clone castopod project by running:

git clone https://code.podlibre.org/podlibre/castopod.git
  1. Create a .env file with the minimum required config to connect the app to the database:
CI_ENVIRONMENT = development

database.default.hostname = mariadb
database.default.database = castopod
database.default.username = podlibre
database.default.password = castopod

NB. You can tweak your environment by setting more environment variables in your custom .env file. See the env for examples or the CodeIgniter4 User Guide for more info.

  1. Add the repository you've cloned to docker desktop's Settings > Resources > File Sharing.
  2. Install castopod's php dependencies

The project's php dependencies aren't included in the repository, you have to download them using the composer service defined in docker-compose.yml

docker-compose run --rm composer install --ignore-platform-reqs
  1. Install castopod's js dependencies

The project's js dependencies aren't included in the repository, you have to download them using the node service defined in docker-compose.yml

docker-compose run --rm node npm install
  1. Build styles using postcss