raddit is a web-based forum with voting and threaded comments. It is built on the Symfony framework. Any similarities between this software and that of a large community symbolised by an alien logo are purely coincidental.
My dev environment runs PHP 7.1 and PostgreSQL 9.4 under macOS Sierra. If any compatibility issues with other software versions or operating systems should arise, a bug report would be most appreciated.
Clone the repository somewhere and navigate there with the command line.
Building frontend assets
yarn installis preferred if you have Yarn).
npm run build/
yarn run build. The
webshould now contain some files.
Setting up the backend
composer install. You should be prompted for database credentials, mail sending stuff, and a secret token. You can leave the default values for the mail stuff, but you must supply valid database credentials.
If this step fails, you can remove or edit
composer install to try again.
bin/symfony_requirementsto check that your environment meets the requirements needed to run the software. Fix any errors that arise.
bin/console doctrine:migrations:migrateto load the database schema.
bin/console raddit:add-user <username> <email address>to create a user account.
bin/console server:runto start the application.
- Navigate to http://localhost:8000/. Log in with the credentials you chose in step 4.
Before contributing new features, please open an issue so we can discuss the direction in which to take the project and avoid hurt feelings. Bug fixes are always welcome, however.
The software is released under the zlib license. See the
LICENSE file for