Skip to content

abrardev99/feelfree

Repository files navigation

FeelFree

FeelFree is a platform for sharing your feelings and thoughts with the world, anonymously. It is a place where you can express your emotions, thoughts, and feelings in a safe and secure environment, without the fear of being judged or harassed.

Installation

FeelFree is a regular Laravel application; it's build on top of Laravel 11 and uses Livewire / Tailwind CSS for the frontend.

In terms of local development, you can use the following requirements:

  • PHP 8.3 - with SQLite, GD, and other common extensions.
  • Node.js 16 or more recent.

If you have these requirements, you can start by cloning the repository and installing the dependencies:

git clone https://github.com/tryfeelfree/feelfree.git

cd feelfree

git checkout -b feat/your-feature # or fix/your-fix

Don't push directly to the main branch. Instead, create a new branch and push it to your branch.

Next, install the dependencies using Composer and NPM:

composer install

npm install

After that, set up your .env file:

cp .env.example .env

php artisan key:generate

Prepare your database and run the migrations:

touch database/database.sqlite

php artisan migrate

php artisan db:seed

Finally, start the development server:

php artisan serve

Once you are done with the code changes, be sure to run the test suite to ensure everything is still working:

composer test

If everything is green, push your branch and create a pull request:

git commit -am "Your commit message"

git push

Features

  • Post your worries anonymously. We mean it. There is no tracking of your identity whatsoever.
  • React to other's worries and share support.
  • Comment on others' worries and make your words help others.
  • React to comments.

Future Plans

  • Nested comments
  • Add ability to add more reactions
  • Add ability to add more tags
  • Improve UI

Development

Run all checks locally: ./check Code style will be automatically fixed by php-cs-fixer.


FeelFree is an open-sourced software licensed under the GNU Affero General Public License

About

Share Your Thoughts, Find Your Support

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published