Klodovsky / usergems

Twitter-like web app built with Laravel 8, Vue.js 3 , Inertia.js and Laravel Jetstream

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Acknowledgments

About The Project

My own version of twitter containing the basic features of Twitter such as tweeting and retweeting,following and unfollowing etc...

(back to top)

Built With

• Vue.js
• Laravel
• Jetstream
• Inertia.js

(back to top)

Getting Started

Clone or fork the project on your local machine.

Installation

1. Clone the repo

   git clone https://github.com/Klodovsky/usergems.git

2. Install NPM packages

   npm install

3. Run composer install on your cmd or terminal.

   composer install

4. Copy .env.example file to .env on the root folder and change the values based on your DB configuration

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=usergems_db
DB_USERNAME=root
DB_PASSWORD=4484

5. Run the migrations

   php artisan migrate

6. DB Factory is setup for seed if needed :

   php artisan db:seed

7. Run the dev server

   php artisan serve

(back to top)

Roadmap

• Signup, login and logout
• Tweeting
• Following
• Profile page that shows the tweet of each individual user
• Page that shows the tweets of the people I follow
• Retweeting of other tweets
• Tweet as Admin
• UI enhancements
• Chat
• Likes and notifications
• Hashtags and mentions
• Add a Built-in URL shortener

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)