Merge 5043f0d1fb into 5ff48033e1

new laravel artisan commands added

README.md

@@ -124,6 +124,7 @@ Feel free to take a look. You might learn new things. They have been designed to
 - [Nginx](tools/nginx.sh)
 - [PM2](tools/pm2.sh)
 - [Ubuntu](tools/ubuntu.sh)
+- [Firebase CLI](tools/firebase_cli.md)
   </details>
 
 ## 🙌🏼 How to Contribute?

backend/django.md

@@ -0,0 +1,122 @@
+# CODING STYLE > MAKING YOUR CODE READABLE
+
+1. Avoid abbreviating variable names.
+2. Write out your function argument names.
+3. Document your classes and methods.
+4. Comment your code.
+5. Refactor repeated lines of code into reusable functions or methods.
+6. Keep functions and methods short. A good rule of thumb is that scrolling should not be necessary to read an entire function or method.
+
+TIP: Use Flake8 for Checking Code Quality.
+
+
+# CODING STYLE > THE WORD ON IMPORTS
+
+Imports should be grouped in the following order:
+
+1. Standard library imports.
+2. Core Django imports.
+3. Third-party app imports.
+4. Imports from your apps.
+
+Use explicit relative imports.
+Avoid using import *
+
+
+# CODING STYLE > OTHERS
+
+Use underscores in URL pattern names rather than dashes.
+
+
+# CODING STYLE > DATABASE
+
+1. Register your app in admin file in your app folder to use admin panel in Django.
+2. Create a superuser using command python manage.py createsuperuser.
+3. Remember to migrate after you change anything in your models.py file.
+4. Use /admin/ page to add data in your tables for testing purpose.
+
+
+# Deployment
+
+- Add your media, database, venv, __pycache__ to the .gitignore (there is a complete list that you can find here: https://github.com/jpadilla/django-project-template/blob/master/.gitignore).
+- Keep migration files in the git (you will need to migrate them in target server).
+- Don't run "makemigrations" in the target server (you will need to just run "migrate").
+- `$ pip freeze > requirements.txt`
+- Make appropriate changes in your project settings.py file (change DEBUG to False and etc).
+- Push your code to your git-server.
+- Pull your code in your target server.
+- Give right permissions to the web-server (e.g. `$ chown www-data:www-data -R /var/www/myproject`).
+- Make a new venv in the target server and activate it.
+- `$ sudo pip install -r requirements.txt`
+- `$ sudo ./venv/bin/python3 manage.py migrate`
+- Restart your web-server (in case of Apache: `$ sudo service apache2 restart`).
+
+
+# DJANGO-ADMIN
+
+- `django-admin check`: Checks the entire Django project for potential problems.
+- `django-admin changepassword <username>`: Allows changing a user’s password. It prompts you to enter a new password twice for the given user.
+- `django-admin clearsessions`: Can be run as a cron job or directly to clean out expired sessions.
+- `django-admin collectstatic`: Helps to collect all the static files in the one mentioned directory.
+- `django-admin createsuperuser`: Creates a superuser account (a user who has all permissions).
+- `django-admin compilemessages`: Compiles .po files to .mo files for use with built-in gettext support.
+- `django-admin createcachetable`: Creates the tables needed to use the SQL cache backend.
+- `django-admin dbshell`: Runs the command-line client for specified database, or the default database if none is provided.
+- `django-admin diffsettings`: Displays differences between the current settings.py and Django's default settings.
+- `django-admin dumpdata`: Output the contents of the database as a fixture of the given format (using each model's default manager unless --all is specified).
+- `django-admin flush`: Removes ALL DATA from the database, including data added during migrations. Does not achieve a "fresh install" state.
+- `django-admin inspectdb`: Introspects the database tables in the given database and outputs a Django model module.
+- `django-admin loaddata`: Installs
+
+
+# DJANGO-ADMIN CONTINUED
+- `django-admin startapp`: <appname> # Create a new Django app named <appname> in the current directory.
+- `django-admin startproject`: <projectname> # Create a new Django project named <projectname> in the current directory.
+- `django-admin test`: # Discover and run tests in the specified modules or the current directory.
+- `django-admin testserver`: # Runs a development server with data from the test database instead of the production database.
+- `django-admin validate`: # Validates all installed models.
+- `django-admin version`: # Display the Django version.
+
+# DJANGO-DEBUG-TOOLBAR
+    Add 'debug_toolbar' to the installed apps in settings.py
+    In urls.py add the following lines:
+    from django.conf import settings
+    if settings.DEBUG:
+    import debug_toolbar
+    urlpatterns = [
+    url(r'^debug/', include(debug_toolbar.urls)),
+
+... the rest of your URLconf goes here ...
+
+# DJANGO-REST-FRAMEWORK
+To use Django Rest Framework, add it to your installed apps in settings.py:
+
+    INSTALLED_APPS = (
+    ...
+    'rest_framework',
+    )
+    Add DRF's token authentication to your installed authentication classes:
+    REST_FRAMEWORK = {
+    'DEFAULT_AUTHENTICATION_CLASSES': (
+    'rest_framework.authentication.TokenAuthentication',
+    'rest_framework.authentication.SessionAuthentication',
+    'rest_framework.authentication.BasicAuthentication',
+    )
+    }
+
+Use Django Rest Framework's serializers to format your API responses.
+
+<br>
+
+# Starting a django project in python3
+
+    curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py; python3 get-pip.py						
+    pip install virtualenv
+    mkdir django-projects
+    cd django-projects  
+    virtualenv venv 								
+    source venv/bin/activate	
+    pip install django							
+    django-admin startproject myproject
+    django-admin startapp myapp
+    python manage.py runserver

backend/django.py

@@ -1,120 +0,0 @@
-# *****************************************************************************
-# CODING STYLE > MAKING YOUR CODE READABLE
-# *****************************************************************************
-
-
-# 1. Avoid abbreviating variable names.
-# 2. Write out your function argument names.
-# 3. Document your classes and methods.
-# 4. Comment your code.
-# 5. Refactor repeated lines of code into reusable functions or methods.
-# 6. Keep functions and methods short. A good rule of thumb is that scrolling
-# should not be necessary to read an entire function or method.
-
-# TIP: Use Flake8 for Checking Code Quality.
-
-
-# *****************************************************************************
-# CODING STYLE > THE WORD ON IMPORTS
-# *****************************************************************************
-
-
-# Imports should be grouped in the following order:
-
-# 1. Standard library imports.
-# 2. Core Django imports.
-# 3. Third-party app imports.
-# 4. Imports from your apps.
-
-# Use explicit relative imports.
-# Avoid using import *
-
-
-# *****************************************************************************
-# CODING STYLE > OTHERS
-# *****************************************************************************
-
-
-# Use underscores in URL pattern names rather than dashes.
-
-# *****************************************************************************
-# CODING STYLE > DATABASE
-# *****************************************************************************
-
-# 1.Register your app in admin file in your app folder to use admin panel in django
-# 2.Create a superuser using command python manage.py createsuperuser
-# 3.Remember to migrate after you change anything in your models.py file
-# 4.Use /admin/ page to add data in your tables for testing purpose
-
-
-# *****************************************************************************
-# Deployment
-# *****************************************************************************
-
-
-# add your media, database, venv, __pycache__ to the .gitignore (there is a compelete list that you can find here: https://github.com/jpadilla/django-project-template/blob/master/.gitignore)
-# keep migration files in the git (you will need to migrate them in target server)
-# don't run "makemigrations" in the target server (you will need to just run "migrate")
-# $ pip freeze > requirements.txt
-# make appropriate changes in your project settings.py file (change DEBUG to False and etc)
-# push your code to your git-server
-# pull your code in your target server
-# give right permissions to the web-server (e.g. $ chown www-data:www-data -R /var/www/myproject)
-# make a new venv in the target server and activate it
-# $ sudo pip install -r requirements.txt
-# sudo ./venv/bin/python3 manage.py migrate
-# restart your web-server (in case of apache: $ sudo service apache2 restart)
-
-
-# *****************************************************************************
-# DJANGO-ADMIN
-# *****************************************************************************
-
-
-django-admin check                       # Checks the entire django project for potential problems
-django-admin changepassword <username>   # Allows changing a user’s password. It prompts you to enter a new password twice for the given user.
-django-admin clearsessions               # Can be run as a cron job or directly to clean out expired sessions.
-django-admin collectstatic               # Helps to collect all the static files in the one mentioned directory
-django-admin createsuperuser             # Creates a superuser account (a user who has all permissions).
-django-admin compilemessages             # Compiles .po files to .mo files for use with builtin gettext support
-django-admin createcachetable            # Creates the tables needed to use the SQL cache backend.
-django-admin dbshell                     # Runs the command-line client for specified database, or the default database if none is provided.
-django-admin diffsettings                # Displays differences between the current settings.py and Django's default settings.
-django-admin dumpdata                    # Output the contents of the database as a fixture of the given format (using each model's default manager unless --all is specified).
-django-admin flush                       # Removes ALL DATA from the database, including data added during migrations. Does not achieve a "fresh install" state.
-django-admin inspectdb                   # Introspects the database tables in the given database and outputs a Django model module.
-django-admin loaddata                    # Installs the named fixture(s) in the database.
-django-admin makemessages                # Runs over the entire source tree of the current directory and pulls out all strings marked for translation. It creates (or updates) a message file in the conf/locale (in the django tree) or locale (for projects and applications) directory. You must run this command with one of either the --locale, --exclude, or --all options.
-django-admin help                        # display usage information and a list of the commands provided by each application
-django-admin makemigrations              # create new migrations to the database based on the changes detected in the models
-django-admin migrate                     # synchronize the database state with your current state project models and migrations
-django-admin remove_stale_contenttypes   # Deletes stale content types (from deleted models) in your database.y.
-django-admin runserver <port>            # start the development webserver at 127.0.0.1 with the port <port> default 8000
-django-admin sendtestemail               # Sends a test email to the email addresses specified as arguments.
-django-admin shell                       # Runs a Python interactive interpreter. Tries to use IPython or bpython, if one of them is available. Any standard input is executed as code.
-django-admin showmigrations              # Shows all available migrations for the current project.
-django-admin sqlflush                    # Returns a list of the SQL statements required to return all tables in the database to the state they were in just after they were installed.
-django-admin sqlmigrate                  # Prints the SQL statements for the named migration.
-django-admin sqlsequencereset            # Prints the SQL statements for resetting sequences for the given app name(s).
-django-admin squashmigrations            # Squashes an existing set of migrations (from first until specified) into a single new one.
-django-admin startapp <Appname>          # create a new django application with the specified name
-django-admin startproject <ProjectName>  # create a new project directory structure
-django-admin testserver                  # Runs a development server with data from the given fixture(s).
-django-admin version                     # display the current django version
-
-
-# *****************************************************************************
-# Starting a django project in python3
-# *****************************************************************************
-
-
-# 1. $ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py; python3 get-pip.py						
-# 2. $ pip install virtualenv
-# 3. $ mkdir django-projects
-# 4. $ cd django-projects  
-# 5. $ virtualenv venv 								
-# 6. $ source venv/bin/activate	
-# 7. $ pip install django							
-# 8. $ django-admin startproject myproject
-# 9. $ django-admin startapp myapp
-# 10. $ python manage.py runserver

backend/laravel.php

@@ -8,6 +8,8 @@
 // MAIN.
 
 php artisan clear-compiled       // Remove the compiled class file
+php artisan db                   // Start a new database CLI session
+php artisan docs                 // Access the Laravel documentation
 php artisan down                 // Put the application into maintenance mode
 php artisan dump-server          // Start the dump server to collect dump information.
 php artisan env                  // Display the current framework environment
@@ -43,6 +45,9 @@ php artisan config:clear         // Remove the configuration cache file
 // DB
 
 php artisan db:seed              // Seed the database with records
+php artisan db:show              // Display information about the given database
+php artisan db:table             // Display information about the given database table
+php artisan db:wipe              // Drop all tables, views, and types
 
 // EVENT
 
@@ -54,9 +59,10 @@ php artisan key:generate         // Set the application key
 
 // MAKE
 
-php artisan make:auth            // Scaffold basic login and registration views and routes
+php artisan make:cast            // Create a new custom Eloquent cast class
 php artisan make:channel         // Create a new channel class
 php artisan make:command         // Create a new Artisan command
+php artisan make:component       // Create a new view component class
 php artisan make:controller      // Create a new controller class
 php artisan make:event           // Create a new event class
 php artisan make:exception       // Create a new custom exception class
@@ -74,6 +80,7 @@ php artisan make:provider        // Create a new service provider class
 php artisan make:request         // Create a new form request class
 php artisan make:resource        // Create a new resource
 php artisan make:rule            // Create a new validation rule
+php artisan make:scope           // Create a new scope class
 php artisan make:seeder          // Create a new seeder class
 php artisan make:test            // Create a new test class
 
@@ -86,6 +93,10 @@ php artisan migrate:reset        // Rollback all database migrations
 php artisan migrate:rollback     // Rollback the last database migration
 php artisan migrate:status       // Show the status of each migration
 
+// MODEL
+php artisan model:prune          // Prune models that are no longer needed
+php artisan model:show           // Show information about an Eloquent model
+
 // NOTIFICATIONS
 
 php artisan notifications:table  // Create a migration for the notifications table
@@ -100,13 +111,19 @@ php artisan package:discover     // Rebuild the cached package manifest
 
 // QUEUE
 
+php artisan queue:batches-table  // Create a migration for the batches database table
+php artisan queue:clear          // Delete all of the jobs from the specified queue
 php artisan queue:failed         // List all of the failed queue jobs
 php artisan queue:failed-table   // Create a migration for the failed queue jobs database table
 php artisan queue:flush          // Flush all of the failed queue jobs
 php artisan queue:forget         // Delete a failed queue job
 php artisan queue:listen         // Listen to a given queue
+php artisan queue:monitor        // Monitor the size of the specified queues
+php artisan queue:prune-batches  // Prune stale entries from the batches database
+php artisan queue:prune-failed   // Prune stale entries from the failed jobs table
 php artisan queue:restart        // Restart queue worker daemons after their current job
 php artisan queue:retry          // Retry a failed queue job
+php artisan queue:retry-batch    // Retry the failed jobs for a batch
 php artisan queue:table          // Create a migration for the queue jobs database table
 php artisan queue:work           // Start processing jobs on the queue as a daemon
 
@@ -116,9 +133,26 @@ php artisan route:cache          // Create a route cache file for faster route r
 php artisan route:clear          // Remove the route cache file
 php artisan route:list           // List all registered routes
 
+// SAIL
+
+php artisan sail:install         // Install Laravel Sail's default Docker Compose file
+php artisan sail:publish         // Publish the Laravel Sail Docker files
+
+// SANCTUM
+
+php artisan sanctum:prune-expired // Prune tokens expired for more than specified number of hours.
+
 // SCHEDULE
 
-php artisan schedule:run         // Run the scheduled commands
+php artisan schedule:clear-cache  // Delete the cached mutex files created by scheduler
+php artisan schedule:list         // List the scheduled commands
+php artisan schedule:run          // Run the scheduled commands
+php artisan schedule:test         // Run a scheduled command
+php artisan schedule:work         // Start the schedule worker
+
+// SCHEMA
+
+php artisan schema:dump           // Dump the given database schema
 
 // SESSION
 
@@ -128,6 +162,10 @@ php artisan session:table        // Create a migration for the session database
 
 php artisan storage:link         // Create a symbolic link from "public/storage" to "storage/app/public"
 
+// STUD
+
+php artisan stub:publish         // Publish all stubs that are available for customization
+
 // VENDOR
 
 php artisan vendor:publish       // Publish any publishable assets from vendor packages

tools/firebase_cli.md

@@ -0,0 +1,140 @@
+# Firebase CLI Guide
+
+Firebase CLI (Command Line Interface) is a powerful tool that allows developers to interact with Firebase services and manage their Firebase projects directly from the command line. It provides a convenient and efficient way to deploy projects, manage databases, configure authentication, and more, streamlining the development and deployment processes.
+
+## Installation
+
+To use the Firebase CLI, you need to have Node.js and npm (Node Package Manager) installed on your system. Follow the steps below to install the Firebase CLI:
+
+1. Install Node.js and npm by downloading the installer from the [official Node.js website](https://nodejs.org/en/download/) and following the installation instructions for your operating system.
+
+2. Once Node.js and npm are installed, open your terminal or command prompt and run the following command to install the Firebase CLI globally:
+
+   ```
+   npm install -g firebase-tools
+   ```
+
+   This command will download and install the Firebase CLI package from the npm registry.
+
+3. After the installation is complete, you can verify that the Firebase CLI is installed correctly by running the following command:
+
+   ```
+   firebase --version
+   ```
+
+   If the installation was successful, you will see the version number of the Firebase CLI printed in the terminal.
+
+Congratulations! You have successfully installed the Firebase CLI.
+
+## Usage
+
+The Firebase CLI allows you to interact with Firebase services and manage your Firebase projects from the command line. Here are some common tasks you can perform using the Firebase CLI:
+
+- Initialize a new Firebase project in your current directory.
+- Deploy your Firebase project to Firebase hosting.
+- Manage Firebase Authentication, Realtime Database, Cloud Firestore, Cloud Functions, and other Firebase services.
+- Configure Firebase project settings.
+- Interact with Firebase emulators for local development and testing.
+
+To use the Firebase CLI, open your terminal or command prompt and run the `firebase` command followed by the desired command and options.
+
+Here's an example of the basic usage:
+
+```
+firebase <command> [options]
+```
+
+Replace `<command>` with the specific Firebase command you want to execute, and `[options]` with any additional options or flags required for that command.
+
+For more detailed usage information, you can run the following command:
+
+```
+firebase help
+```
+
+This command will display the available Firebase commands and provide detailed information about each command.
+
+## Commands
+
+Here are the commonly used Firebase CLI commands along with a brief explanation, syntax, and an example for each command:
+
+- `firebase init`: Initializes a new Firebase project in the current directory.
+
+  - Syntax: `firebase init [options]`
+  - Example: `firebase init hosting` initializes Firebase Hosting for the current project.
+
+- `firebase deploy`: Deploys your Firebase project to Firebase hosting or other Firebase services.
+
+  - Syntax: `firebase deploy [options]`
+  - Example: `firebase deploy --only hosting` deploys only the Firebase Hosting content.
+
+- `firebase serve`: Starts local development servers and Firebase emulators.
+
+  - Syntax: `firebase serve [options]`
+  - Example: `firebase serve --only functions,hosting` starts the Firebase emulators for functions and hosting.
+
+- `firebase login`: Authenticates the Firebase CLI with your Firebase account.
+
+  - Syntax: `firebase login [options]`
+  - Example: `firebase login --no-localhost` initiates an interactive login session without connecting to localhost.
+
+- `firebase logout`: Logs out from the Firebase CLI.
+
+  - Syntax: `firebase logout [options]`
+  - Example: `firebase logout` logs out the currently authenticated user.
+
+- `firebase use`: Sets the active Firebase project for the current directory.
+
+  - Syntax: `firebase use <project_id> [options]`
+  - Example: `firebase use my-project` sets "my-project" as the active Firebase project.
+
+- `firebase functions`: Interacts with Firebase Cloud Functions.
+
+  - Syntax: `firebase functions:command [options]`
+  - Example: `firebase functions:delete [function_name]` deletes all functions that match the specified name in all regions.
+
+- `firebase database`: Interacts with Firebase Realtime Database.
+
+  - Syntax: `firebase database:command [options]`
+  - Example: `firebase database:get /users` retrieves data from the Firebase Realtime Database.
+
+- `firebase firestore`: Interacts with Firebase Cloud Firestore.
+
+  - Syntax: `firebase firestore:command [options]`
+  - Example: `firebase firestore:delete collection/document` deletes a document from the Firestore database.
+
+- `firebase auth`: Interacts with Firebase Authentication.
+
+  - Syntax: `firebase auth:command [options]`
+  - Example: `firebase auth:export users.csv` exports user data to a CSV file.
+
+- `firebase hosting`: Interacts with Firebase Hosting.
+
+  - Syntax: `firebase hosting:command [options]`
+  - Example: `firebase hosting:disable` disables Firebase Hosting for the current project.
+
+- `firebase remoteconfig`: Interacts with Firebase Remote Config.
+
+  - Syntax: `firebase remoteconfig:command [options]`
+  - Example: `firebase remoteconfig:get template` retrieves the Remote Config template.
+
+- `firebase ext`: Interacts with Firebase Extensions.
+
+  - Syntax: `firebase ext:command [options]`
+  - Example: `firebase ext:install firebase/delete-user-data` installs the Firebase Extension named "firebase/delete-user-data".
+
+- `firebase appdistribution`: Interacts with Firebase App Distribution.
+
+  - Syntax: `firebase appdistribution:command [options]`
+  - Example: `firebase appdistribution:testers:add` Adds testers to the project.
+
+- `firebase use --add`: Adds an existing Firebase project to the current directory
+
+  - Syntax: `firebase use --add`
+  - Example: `firebase use --add` interactively adds an existing Firebase project.
+
+- `firebase projects:create`: Creates a new Firebase project.
+  - Syntax: `firebase projects:create [options]`
+  - Example: `firebase projects:create --display-name "My Project"` creates a new Firebase project with the given display name.
+
+These are just a few examples of the available commands. You can explore more commands and their options by running `firebase help` or visiting the [official Firebase CLI documentation](https://firebase.google.com/docs/cli).