Merge pull request #47 from Siddhi132/main

update readme

README.md

@@ -3,35 +3,48 @@
 [Simple Slides](https://simpleslides.dev) is a responsive and text-first
 presentation tool that keeps your audience engaged, and is built with:
 
-* Laravel
-* Vue + TypeScript
-* PostgreSQL
+-   Laravel
+-   Vue + TypeScript
+-   PostgreSQL
 
 Presentations built with Simple Slides typically focus on:
 
-* Prioritizing text-content
-* Low amount of content per slide
-* Many slides, and changing through slides quickly
+-   Prioritizing text-content
+-   Low amount of content per slide
+-   Many slides, and changing through slides quickly
 
 ## To Install
-```sh
-composer install
-```
-
-This project uses Laravel Sail, which is basically a built-in Docker wrapper for
-Laravel applications.
-[View their documentation](https://laravel.com/docs/10.x/sail#installation)
-for more details.
 
 Ideally, you should set an alias for the `sail` command, to make it much shorter to use:
+
 ```sh
 alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'
 ```
 
 Note: If you have run a Laravel Sail project before, you may have already created this
 alias.
 
+-   Locate the .env.example file in your project directory.
+-   Create a new file named .env in the same directory.
+-   Copy the entire content of the .env.example file and paste it into the newly created .env file.
+
+Note: This file will hold your environment variables.
+
+Run below commands in your terminal
+
+```sh
+composer install
+sail npm install
+sail artisan key:generate
+```
+
+This project uses Laravel Sail, which is basically a built-in Docker wrapper for
+Laravel applications.
+[View their documentation](https://laravel.com/docs/10.x/sail#installation)
+for more details.
+
 ## To Run
+
 ```sh
 # In one terminal, to run the app:
 sail up
@@ -47,21 +60,24 @@ sail npm run dev
 To log in, use any of the following credentials (found in
 database/Seeders/DatabaseSeeder.php):
 
-- Email: `[email protected]` for an admin user, or `[email protected]` for a
-  non-admin user.
-- Password: Both accounts use `password`.
+-   Email: `[email protected]` for an admin user, or `[email protected]` for a
+    non-admin user.
+-   Password: Both accounts use `password`.
 
 ## Autoformatting
+
 Via [Laravel pint](https://laravel.com/docs/10.x/pint), which is a
 code-formatter following Laravel's best practices. **Note:** This is not a
 linter.
+
 ```
 # Laravel
 
 sail pint
 ```
 
 ## Linting
+
 Linting on the back-end (e.g. Laravel) is done via
 [larastan](https://github.com/larastan/larastan), which is a
 [PHPStan](https://phpstan.org/) wrapper for Laravel.
@@ -79,6 +95,7 @@ sail npx vue-tsc
 ```
 
 ## Running the Tests
+
 Tests on the back-end (e.g. Laravel) are written using
 [Pest](https://pestphp.com/), and are a
 mostly integration and end-to-end tests, with some unit tests sprinkled in.
@@ -98,6 +115,7 @@ sail npx vitest
 ```
 
 ## To Generate Thumbnails for Presentations
+
 This uses puppeteer and Browsershot, which requires some extra config on top of
 Laravel Sail. To configure this, you need to run the following commands:
 
@@ -108,7 +126,7 @@ sail npx puppeteer browsers install chrome
 
 ## Recommended IDE Setup
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+-   [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
 
 ## Type Support For `.vue` Imports in TS
 
@@ -117,6 +135,6 @@ TypeScript cannot handle type information for `.vue` imports by default, so we r
 If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
 
 1. Disable the built-in TypeScript Extension
-   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+    1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+    2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
 2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.