Skip to content

windstonp/Twick

Repository files navigation

Twick

Twick logo

Sumary

  1. About the project.
  2. Road map of what has been done.
  3. Extra functions added.
  4. Install the project.
  5. How to start the project.
  6. License.

📁 About the project.

Twick is was my first project developed using laravel. I started it when I was watching the laracast course of laravel where we create an clone of Twitter using laravel as our final project. So that's my project I hope you like it. if you find an error doesn't hesitate on create an Issue. If you do that I will be really glad to resolve the problem.

📜 List of what whas developed

Things that were created in the course.

  • Home page ✔️.
  • Profile page ✔️.
    • added timeline of the user ✔️.
    • created the possibility of follow the user ✔️.
    • created the possibility of unfollow the user ✔️.
    • created edit user page ✔️.
    • created delete account method ✔️.
  • Created the page that list all the user's ✔️.
  • created the possibility of like or dislike an user twick ✔️.
  • Created permission ✔️.
    • permision if the user can delete an twick ✔️.
    • permission if the user can edit the profile ✔️.
  • Created list to show all of your follows ✔️.

📑 Extra features added.

  • Create Tests using Pest ✔️.
    • created tests of the home page ✔️.
    • created tests of the profile page ✔️.
    • created tests of the dashboard page ✔️.
    • created tests of the twick controller and it's trait ✔️.
    • created tests of followable trait ✔️.
    • created tests for the login and register method ✔️.
  • Add websocket to make the twick interation with user realtime ❌.
  • Create an better UI for the home page ❌.

📂 Install the Project.

First of all, you will need to install Composer and Laravel on your computer to download the packages.

// after install composer and laravel you will execute this command on the project folder:

composer install

📂 How to start the project.

To start the project you will need to execute these commands

//On the project folder run
php artisan serve

//Then access:
localhost:8000

🎫 License

This is an open-source Project, you can use it and test it as many times as you want to. If you like the project Mark it with a star and contribute to it for more people see the project.