Doers

Social media app to showcase your todo list and its current progress mostly to motivate others and get motivated by others.

TODO

• The Easiest scaffolding for the project
• Authentication
• Scope todo item to a particular user (Delete can be done by owner only)
• Todo can be marked completed incomplete by its owner
• Show todo owner information on index page
• Show progress about the list somewhere on profile
• User profile page where only user specific todos are listed
• Follow/Unfollow another user to see his/her todos and progress
• If authenticated user, show only todos from person he/she follows and his/her own todos on main page
• Design better pages and looks (the lowest priority)

Prerequisites

• PHP >= 7.3
• PHP Extension - BCMath
• PHP Extension - Ctype
• PHP Extension - Fileinfo
• PHP Extension - JSON
• PHP Extension - Mbstring
• PHP Extension - OpenSSL
• PHP Extension - PDO
• PHP Extension - Tokenizer
• PHP Extension - XML
• MySQL
• GIT
• Composer
• NPM

How to install

• Do the git clone of the project

git clone https://github.com/bhushan/doers.git

• Navigate inside project directory

cd doers

• Install composer dependencies

composer install

• Install NPM dependencies

npm install

• Create environment file by copying .env.example file to .env

• Generate App Key for the project

php artisan key:generate

• Change following configurations from .env file

  • DB_DATABASE=
  • DB_USERNAME=
  • DB_PASSWORD=

• Now create the database with the same name used in DB_DATABASE

• Migrate database and seed default data

php artisan migrate:fresh --seed

How to run application

• Run below command from the project root directory, and run the provided url in browser

php artisan serve

How to execute tests

• Run the below command from the project root directory

./vendor/bin/phpunit

or

php artisan tests

Few useful commands

• Compile the assets

npm run <env>

Note:

a. env can be prod or dev

b. prod generates the minified assets

• Watch changes in the assets

npm run watch