Commit cbb83a6f authored by Yassine Doghri's avatar Yassine Doghri
Browse files

feat: add npm for js dependencies + move src/ files to root folder

- 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 file
- add docs folder in which to place castopod's technical documentation
parent 3bf9420b
File deleted
......@@ -6,6 +6,11 @@ RUN apt-get update && apt-get install -y \
COPY --from=composer /usr/bin/composer /usr/bin/composer
RUN curl -sL | bash -
RUN apt-get update && \
apt-get install -y nodejs
RUN apt-get update && \
apt-get upgrade -y && \
apt-get install -y git
apt-get install -y git vim
// For format details, see or this file's README at:
"name": "Existing Dockerfile",
"dockerFile": "./Dockerfile",
"settings": {
"": null
"extensions": [
\ No newline at end of file
"name": "Existing Dockerfile",
"dockerFile": "./Dockerfile",
"settings": {
"": null
"extensions": [
# Operating Specific Junk Files
# OS X
# OS X Thumbnails
# Windows image file caches
# Recycle Bin used on file shares
# Windows Installer files
# Windows shortcuts
# Linux
# KDE directory preferences
# Linux trash folder which might appear on any partition or disk
# Environment Files
# These should never be under version control,
# as it poses a security risk.
# Temporary Files
# User Guide Temp Files
# Test Files
# Don't save phpunit under version control.
# Composer
# IDE / Development Files
# Modules Testing
# phpenv local config
# Jetbrains editors (PHPStorm, etc)
# Netbeans
# Sublime Text
# Visual Studio Code
# Media files
# npm
# potcss generated file
# Docker volumes
# Authors
[Benjamin Bellamy]( <>
[Yassine Doghri]( <>
FROM php:latest
COPY ./src /castopod
COPY . /castopod
WORKDIR /castopod
### Install CodeIgniter's server requirements
......@@ -19,151 +19,6 @@ Moreover Podcasters can choose to publish on Castopod while keeping their existi
## Setup your development environment
## Documentation
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
0. Install [docker desktop](
1. Clone castopod project by running:
git clone
2. Create a `./src/.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. See the `./src/env` for examples or the [CodeIgniter4 User Guide]( for more info.
3. Add the repository you've cloned to docker desktop's `Settings` > `Resources` > `File Sharing`.
4. Install castopod's php dependencies
- The project's 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
### Start docker containers
Go to project's root folder and run:
# starts all services declared in docker-compose.yml file
# -d option starts the containers in the background
docker-compose up -d
# See all running processes (you should see 3 processes running)
docker ps
# Alternatively, you can check all processes (you should see composer with an Exited status)
docker ps -a
> The `docker-compose up -d` command will boot 3 containers in the background:
> - `castopod_app`: a php based container with codeigniter requirements installed
> - `castopod_mariadb`: a [mariadb]( server for persistent data
> - `castopod_phpmyadmin`: a phpmyadmin server to visualize the mariadb database
> _NB._ `./mariadb`, `./phpmyadmin` folders will be mounted in the project's root directory to persist data and logs.
### Initialize and populate database
Build the database with the migrate command:
# loads the database schema during first migration
docker-compose run --rm app php spark migrate
Populate the database with the required data:
# Populates all categories
docker-compose run --rm app php spark db:seed CategorySeeder
docker-compose run --rm app php spark db:seed LanguageSeeder
### Start hacking
You're all set! Start working your magic by updating the project's files! Help yourself to the [CodeIgniter4 User Guide]( for more insights.
To see your changes, go to:
- [localhost:8080](http://localhost:8080/) for the castopod app
- [localhost:8888](http://localhost:8888/) for the phpmyadmin interface:
- **Username**: podlibre
- **Password**: castopod
### Going Further during development
#### Update app dependencies
You can update the project's dependencies using the `composer` service:
docker-compose run --rm composer update --ignore-platform-reqs
> _NB._ Composer commands look for the `composer.json` file to find castopod's php dependencies, all of which live in the `./src/vendor` folder. For more info, check out [Composer documentation](
#### Useful docker / docker-compose commands
# monitor the app container
docker logs --tail 50 --follow --timestamps castopod_app
# monitor the mariadb container
docker logs --tail 50 --follow --timestamps castopod_mariadb
# monitor the phpmyadmin container
docker logs --tail 50 --follow --timestamps castopod_phpmyadmin
# restart docker containers
docker-compose restart
# Destroy all containers, opposite of `up` command
docker-compose down
Check [docker]( and [docker-compose]( documentations for more insights.
### Developing inside a Container
If you're working in VSCode, you can take advantage of the `./.devcontainer/` folder. It defines a development container with preinstalled VSCode extensions so you don't have to worry about them. The container will be loaded with php, composer and git:
1. Install the VSCode extension [Remote - Containers](
2. `Ctrl/Cmd + Shift + P` > `Open in container`
The VSCode window will reload inside the dev container.
You can check that the required packages are running in the console (`Terminal` > `New Terminal`):
php -v
composer -V
git version
For more info, see [VSCode Remote Containers](
You can check castopod's documentation for [setting up a development environment](./docs/
<?php namespace Config;
namespace Config;
use CodeIgniter\Config\BaseConfig;
......@@ -76,7 +78,7 @@ class App extends BaseConfig
| If false, no automatic detection will be performed.
public $negotiateLocale = false;
public $negotiateLocale = true;
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment