Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/samuelmwangiw/tworra

A Twitter clone built using Laravel Jetstream wil Inertia for Science
https://github.com/samuelmwangiw/tworra

Last synced: 3 months ago
JSON representation

A Twitter clone built using Laravel Jetstream wil Inertia for Science

Awesome Lists containing this project

README

        

## About Tworra

This is a Twitter clone built on Laravel Jetstream with Inertia.

> My intention is to use it for Educational purposes.
>
> You are free to use it as you please as long as you don't infringe on Twitter Inc intellectual rights or harm its users.

image
image

In its current form, you can Tweet, Like Tweets, Follow/Unfollow, view user profiles and show timeline.
Some features e.g retweet, and threads do not work and are not planned for.

## Installing

I have tested the application to work with Sail but should work like any other Laravel Application.

```bash
git clone https://github.com/SamuelMwangiW/tworra.git
cd tworra
cp .env.example .env
```

Update the `.env` with your ENVIRONMENT configuration

```bash
composer install
npm install
# if using sail
vendor/bin/sail up -d
vendor/bin/sail artisan migrate
# If using artisan:serve
php artisan migrate
php artisan serve
```

## Testing
The application uses pestPHP for testing, Larastan for static analysis and Laravel Pint for styling

```bash
php artisan test
vendor/bin/phpstan
vendor/bin/pint --test
```

## Credits
- [Constantin Druc's TY series](https://www.youtube.com/watch?v=wpRWrrH9AcI&list=PLUMh5Fzy8HsluM8gWklbZMEmjpwt8HQdU)
- [Laravel team](https://laravel.com/)
- [Inertia](https://inertiajs.com/)

## Security Vulnerabilities

If you discover a security vulnerability specific to Laravel, please refer to the [Laravel Security Policy](https://github.com/laravel/framework/security/policy).

## License

The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).