Bolt CMS is an open source, adaptable platform for building and running modern websites. Built on PHP, Symfony and more. Read the site for more info.
To check out Bolt and set up your first Bolt installation, read Installing Bolt 4.
This repository should be used to work on Bolt. Not
with Bolt. If you want to check out Bolt, the
composer create-project
method is recommended. See here:
https://github.com/bolt/project/ .
Cleanse this world with flame
End this, cleanse this
Rebuild and start again
Obliterate what makes us weak
-- Hatebreed - Destroy Everything
Follow the progress on the development of Bolt 4, at these locations
- Github Repository: https://github.com/bolt/core
- Bolt 4 roadmap: https://roadmap.boltcms.io
- Slack: https://slack.bolt.cm (open for all, requires Slack account)
To set up a running development environment of Bolt 4 please perform the following steps 1 to 4:
To install a development version of Bolt 4:
- Check out this git repository
- Then run:
echo "\n\nAre you sure you shouldn't use https://docs.bolt.cm/installation instead?\n\n"
sleep 5
composer install
npm install && npm run build
Alternatively, run make install
, on a UNIX-like system.
If you already have Bolt 4 installed and need to update dependencies run:
composer update
To install a development version of Bolt 4 with Docker:
- Check out the git repo
- Then run:
echo "\n\nAre you sure you shouldn't use https://docs.bolt.cm/installation instead?\n\n"
sleep 5
make docker-install
Actually, just add docker-
prefix to any Make command and that's it!
When installed with Docker, in your browser go to http://0.0.0.0:8088/
for the frontend, and to
http://0.0.0.0:8088/bolt
for the Admin Panel.
- Configure the database connection in
.env
or stick with the default SQLite, which should work out of the box. - Then run:
bin/console doctrine:database:create
bin/console doctrine:schema:create
bin/console doctrine:fixtures:load -n
Alternatively, run make db-create
, on a UNIX-like system.
Note: if you're using SQLite, ensure that var/db/
is readable and writable to
you, as well as to the webserver users. The same applies to the file
var/data/bolt.sqlite
if it already exists.
This is a Bolt prototype in flux, so stuff can break, and you might want to reset the database to the "factory settings". To re-set a database to the latest, with fresh dummy-content run the following:
bin/console doctrine:schema:drop --force
bin/console doctrine:schema:create
bin/console doctrine:fixtures:load -n
Alternatively, run make db-reset
, on a UNIX-like system.
-
Using the Symfony CLI tool, just run
symfony server:start
. -
Alternatively, run
bin/console server:start
(if runningbin/console server:start
does not work because you don't have the pcntl extension, runbin/console server:run
)
In your browser, go to http://127.0.0.1:8000/
for the frontend, and to
http://127.0.0.1:8000/bolt
for the Admin Panel.
You can log on, using the default user & pass:
- user:
admin
- pass:
admin%1
To set up initially, run npm install
to get the required dependencies /
node_modules
. Then:
- Run
npm run start
See the other options by running npm run
.
Run the following commands with make
, to perform Code Style checking and
automatic fixing:
make cscheck
: Run ECS and PHPStanmake csfix
: Run ECS, perform automatic fixes and run PHPStan
On windows, you can run the commands separately:
vendor/bin/ecs.bat check src
vendor/bin/ecs.bat check src --fix
vendor/bin/phpstan.bat analyse -c phpstan.neon src
Bolt uses several testing frameworks for different test layers:
- unit: PHPSpec, PHPUnit, Jest
- integration (of Symfony services): PHPUnit with KernelTestCase
- functional (API Contracts): Behat
- acceptance (UI, end-to-end): Behat/Mink
To run PHP unit tests:
make test
To run E2E tests:
make behat-js
Read more about running and creating tests on the e2e tests page.
-
PHPStorm does not see
@bolt
Twig namespace.The namespace needs to be added manually in Twig Plugin settings, pointing to
templates
folder.
These are the translations used in Bolt. We rely on the community to expand on new translations, and keep them up to date. If you wish to participate, read the instructions here.
Several translation-related Console commands are available:
bin/console translation:download
- Download translations from Loco (replaces all local ones)bin/console translation:sync bolt down
- Download translations from Loco (replaces local changes if there is a conflict)bin/console translation:sync bolt up
- Send updated translations to Loco
The ongoing Bolt development takes place under the care of:
Sponsors:
- → You and/or your company's name on this list? Become a sponsor.