A one-liner phrase describing this project or app
What is this project about. Ok to enrich here or the section above it with an image.
Once this repo has been setup on Codacy by the TTL, replace the above badge with the actual one from the Codacy dashboard, and add the code coverage badge as well. This is mandatory
This is a simple php starter repo template for setting up your project. The setup contains
-
Composer: For adding third party dependencies
-
phpunit: For runnung tests
-
php-cs-fixer: For formatting code to match php coding standard
Talk about what problem this solves, what SDG(s) and SGD targets it addresses and why these are imoirtant
How would someone use what you have built, include URLs to the deployed app, service e.t.c when you have it setup
Run composer install and composer dump-autoload to get started.
index.php is the entry to the project and source code should go into the src folder.
All tests should be written in the test folder.
- Test:
composer run test - Install dependencies:
composer install <dep name> - Lint:
composer run php-cs-fixer
List the team behind this project. Their names linked to their Github, LinkedIn, or Twitter accounts should siffice. Ok to signify the role they play in the project, including the TTL and mentor
If this project sounds interesting to you and you'd like to contribute, thank you! First, you can send a mail to [email protected] to indicate your interest, why you'd like to support and what forms of support you can bring to the table, but here are areas we think we'd need the most help in this project :
- area one (e.g this app is about human trafficking and you need feedback on your roadmap and feature list from the private sector / NGOs)
- area two (e.g you want people to opt-in and try using your staging app at staging.project-name.com and report any bugs via a form)
- area three (e.g here is the zoom link to our end-of sprint webinar, join and provide feedback as a stakeholder if you can)
Did you use someone else’s code? Do you want to thank someone explicitly? Did someone’s blog post spark off a wonderful idea or give you a solution to nagging problem?
It's powerful to always give credit.
MIT