OpenBlog
Get access to create blogs using an OpenID account
Project
master-branch (alias stable, latest)
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
What things you need to install the software and how to install them
- Webserver (PHP 7.2+)
- Database (e. g. MySql)
Installing
A step by step series of examples that tell you have to get a development env running
Clone the project from github
git clone https://github.com/D3strukt0r/openblog.git
Setup the project with composer
composer install --no-dev --optimize-autoloader
Next, rename .env.dist
to .env
and change following parameters:
RECAPTCHA_PUBLIC_KEY=... (ReCaptcha)
RECAPTCHA_PRIVATE_KEY=... (ReCaptcha)
OAUTH_CLIENT_ID="..." (OAuth2 Client from orbitrondev.org)
OAUTH_CLIENT_SECRET=... (OAuth2 Client from orbitrondev.org)
OAUTH_URL=... (Only needed if the account service is somewhere else) -> (Optional)
APP_ENV=prod
APP_SECRET=...
DATABASE_URL=... (Accessing databse)
Built With
- PHP - Programming Language
- Composer - PHP Package manager
- Symfony - PHP Framework
- Doctrine - PHP Database accessing
- Twig - PHP Templating service
- ReCaptcha - Captcha service from Google
- Bootstrap - Theme used in this service
- Unify - Theme used in this service
- Github Actions - Automatic CI (Testing) / CD (Deployment)
- Docker - Building a Container for the Server
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Manuele Vaccari - D3strukt0r - Initial work
See also the list of contributors who participated in this project.
License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE.txt file for details.
Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc