What is it?
Elewant is a project based on the PHP mascotte: the ElePHPant.
The idea is that we make it easier in the community to swap and share these lovely plush pachyderms. For now, you can create a herd and enter all the members that you have. In the near future, it will be possible to put your surplus ElePHPants up for trade, and request specific ElePHPants that you want to add to your herd.
But this project is more. The idea is to allow people who are interested involved. Not just by open sourcing the code so it can be contributed to, but by actually building and running it together. From idea to production and beyond.
What can be learned?
Well, the basics are pretty simple: we build, deploy and maintain a project together. This means that all the aspects of building and maintaining are areas of learning:
So some usual suspects:
- Behaviour driven development
- Automated testing
- Event sourcing
- The Symfony framework
- Automated Provisioning
- Build pipelines
- Logging and alerting
- Dependency management
- How to deal with legacy code ;-)
Feel free to add anything you learn, no matter how small, to <docs/lessons_learned.md>
Getting started with Docker
You will need docker on your local system:
Run the setup procedure with make (only required the first time):
Or up to continue working later:
You should be up-and-running!
For developers, there is a special button on the front page to generate users for your local environment. Just click on "Developer login" and you should be able to create (and log in as) randomly created users.
If you want to be able to log in with twitter, you'll need to create an application at app.twitter.com, then place your key & secret in
The project has a Makefile. Run
Make without parameters to see the help:
make make help
You can run all the tools required to pass a build:
Or run the tests and quality assurance tools separately:
make test make qa
Or run each individual tool:
make phpspec make phpunit make php-lint make phpstan make php-cs
Running commands inside docker containers
ls inside the default container (
ls inside the default container of the testing environment:
Running Symfony Console:
bin/docker bin/console c:c bin/docker-test bin/console c:c
Running vendor binaries:
bin/docker vendor/bin/phpunit bin/docker-test vendor/bin/phpunit
You can find more docs in the /docs folder, like: