search

Deuchnord / mercredifiction

A website that spoils your fictions
https://mercredifiction.io
GNU Affero General Public License v3.0
4 stars 2 forks source link
hashtags mastodon mercredifiction php symfony

readme

#MercrediFiction

A Mastodon-related project! Licenced under the GNU Affero General Public license Is the website up?

What is #MercrediFiction?

#MercrediFiction is an initiative from the French-speaking community on Mastodon that invites each member of the social network to tell, each Wednesday, a fictive story in (generally) 500-characters or less, with the hashtag - you guessed it! - #MercrediFiction (which may be translated as #FictionWednesday). Started very early when the French community landed on Mastodon, the initiative continued its way and became soon a tradition.

About this project

After more than one year of fictions on Mastodon, it became a little difficult to see all new fictions. Plus, the more time passes, the more the oldest fictions become inaccessible.

The goal of this project is to make it easier to read all the fictions of an author by enhancing their presentation on a website that makes them more visible.

Installation

Note: it is strongly recommended to use Linux (I mean a real one, not a Windows Linux subsystem) or macOS for this.

Installing the project is as easy as any Symfony project. First, install PHP (≥ 7.2), Composer and MySQL or MariaDB. Then:

  1. Clone the repository: 
    git clone https://github.com/Deuchnord/mercredifiction.git
  2. Install the components: 
    php /path/to/composer.phar install

    NB: if Composer complains about the APP_ENV environment variable not defined, just export APP_ENV="dev", then clear the cache with php bin/console console:cache.

  3. Create an empty database on your RDBMS
  4. Complete DATABASE_URL variable in your .env file (line 23) to reflect your configuration. This file is personal and must not be pushed to the Git repository.
  5. Install the database: 
    php bin/console doctrine:schema:create

That's it, now you have a fresh install! Even if it is usable as it, it does not contain anything for now. Feel free to add manually some data in the database!

How to contribute

There are plenty of ways to contribute to this project:

If you decide to contribute to the code, think to ensure that your code meets the coding standards by simply invoking the following command:

php /path/to/composer.phar run-script php-cs-fixer

This will modify the files so that they meet the coding recommandations for a Symfony application. If the coding standard are not met, your pull request will fail at the continuous-integration testing and your branch will not be mergeable.

This project follows the all-contributors specification. Contributions of any kind are welcome!

Contributors