diff --git a/.gitignore b/.gitignore index b04c28d11e..b4edddb0ff 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,7 @@ csr.pem .DS_STORE +# Ensuring no images and video are commited in ./video and ./image directories + + +markdown/* \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bba6b0d91b..f6f84a4538 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -169,7 +169,7 @@ Now you can pull in changes from `PalisadoesFoundation/talawa-api` by running `g We have established a clean setup now. We can make any changes we like and push it to this forked repository, and then make a pull request for getting the changes merged into the original repository. Here's a nice picture explaining the process ([image source](https://github.com/Rafase282/My-FreeCodeCamp-Code/wiki/Lesson-Save-your-Code-Revisions-Forever-with-Git)). -![Diagram of the fork-and-clone workflow](./image/install3.png) +![Diagram of the fork-and-clone workflow](./public/image/install3.png) #### Creating a Pull Request - Process Overview @@ -271,7 +271,7 @@ We use the open source project [GraphQL Voyager](https://github.com/IvanGoncharo Go to `http://localhost:4000/voyager` after running the development server to explore the same! -![Voyager Demo for User Model](./image/GraphQL_Voyager.png) +![Voyager Demo for User Model](./public/image/GraphQL_Voyager.png) ### GraphQL Markdown diff --git a/INSTALLATION.md b/INSTALLATION.md index b2db53850a..03dd586c89 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -85,9 +85,9 @@ First you need a local copy of talawa-api. Run the following command in the dire 1. Navigate to the folder where you want to setup the repository. Here, I will set it up in a folder called `talawa`. 1. Navigate to the folder and open a terminal in this folder (you can right-click and choose appropiate option based onn your OS). Next, we'll fork and clone the `talawa-api` repository. 1. Navigate to [https://github.com/PalisadoesFoundation/talawa-api/](hhttps://github.com/PalisadoesFoundation/talawa-api/) and click on the `fork` button. It is placed on the right corner opposite the repository name `PalisadoesFoundation/talawa-api`. - ![Image with fork](./image/install1.png) + ![Image with fork](./public/image/install1.png) 1. You should now see `talawa-api` under your repositories. It will be marked as forked from `PalisadoesFoundation/talawa-api` - ![Image of user's clone](./image/install2.png) + ![Image of user's clone](./public/image/install2.png) 1. Clone the repository to your local computer (replacing the values in `{{}}`): ``` @@ -440,11 +440,11 @@ We use `reCAPTCHA` for two factor authentication (2FA). Follow these steps: 1. Visit the [reCAPTCHA Key Generation](https://www.google.com/recaptcha/admin/create) URL. 1. Fill in the input blocks as shown in the screenshot: - ![Set up recaptcha page](./image/recaptcha_set_up.webp) + ![Set up recaptcha page](./public/image/recaptcha_set_up.webp) 1. Click on `Submit` button. 1. Copy the generated `Secret Key` to variable named `RECAPTCHA_SECRET_KEY` in `.env` file. - ![Set up recaptcha page](./image/recaptcha_site_and_secret_key.webp) + ![Set up recaptcha page](./public/image/recaptcha_site_and_secret_key.webp) 1. **NOTE**: Save the generated `Site key` as it will be used in `talawa-admin`. @@ -504,7 +504,7 @@ COLORIZE_LOGS = false If the parameter value is set to `true`, you should be able to see colorized logs in console, or else logs will display in the console's default simple format. -![Colorized logs in console](./image/colorize-logs.jpg) +![Colorized logs in console](./public/image/colorize-logs.jpg) ### Setting up LOG_LEVEL in .env file @@ -628,7 +628,7 @@ The Organization URL for Talawa mobile app developers will depend upon the devic - Enter `ipconfig` (For Windows Users) or `ifconfig` (For Linux/OSX Users) - Your Mobile and Computer (On which API server is running) must be on same Wifi Network. Use Mobile Hotspot to connect your computer to internet in case you don't have access to a Wifi Router. - Search for the `Wireless LAN adapter Wi-Fi:` and then copy `IPv4 Address`, like in image below: - - ![image](https://github.com/anshgoyalevil/talawa-api/blob/docs/image/ip-address.png) + - ![image](./public/image/ip-address.png) - Now, use this IP address (`192.168.0.105` in our case) to access the API instance using the following URL pattern: ``` @@ -663,13 +663,13 @@ This guide is for `VSCode` users to easily manage their `MongoDB` databases: 1. Install the offical `MongoDB` extension for `VSCode` named `MongoDB for VS Code`. - ![Install official mongoDB vscode extension](./image/install_mongodb_vscode_extension.webp) + ![Install official mongoDB vscode extension](./public/image/install_mongodb_vscode_extension.webp) 2. Connect your `MongoDB` database to the extension. - ![Connect your mongoDB database to the extension](./image/connect_extension_to_mongodb_step_1.webp) + ![Connect your mongoDB database to the extension](./public/image/connect_extension_to_mongodb_step_1.webp) - ![Connect your mongoDB database to the extension](./image/connect_extension_to_mongodb_step_2.webp) + ![Connect your mongoDB database to the extension](./public/image/connect_extension_to_mongodb_step_2.webp) 3. Now you can manage the database you are using for `talawa-api` through this extension within `VSCode`. @@ -694,7 +694,7 @@ You can skip these instructions for now if you don't have running instance of Ta 2. Select `user` collections and edit the data. Change: 1. `userType` from `USER` to `SUPERADMIN` 2. `adminApproved` from `false` to `true` - - ![Illustration for user edit ](./image/mongodb_compass_user_edit.png) + - ![Illustration for user edit ](./public/image/mongodb_compass_user_edit.png) ## Using Mongo Shell diff --git a/README.md b/README.md index 1fdb04833c..36ce88f00c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Talawa API 💬 Join the community on Slack. The link can be found in the `Talawa` [README.md](https://github.com/PalisadoesFoundation/talawa) file. -[![N|Solid](image/talawa-logo-lite-200x200.png)](https://github.com/PalisadoesFoundation/talawa-api) +[![N|Solid](./public/image/talawa-logo-lite-200x200.png)](https://github.com/PalisadoesFoundation/talawa-api) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/talawa-api.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-api) diff --git a/image/GraphQL_Voyager.png b/public/image/GraphQL_Voyager.png similarity index 100% rename from image/GraphQL_Voyager.png rename to public/image/GraphQL_Voyager.png diff --git a/image/colorize-logs.jpg b/public/image/colorize-logs.jpg similarity index 100% rename from image/colorize-logs.jpg rename to public/image/colorize-logs.jpg diff --git a/image/connect_extension_to_mongodb_step_1.webp b/public/image/connect_extension_to_mongodb_step_1.webp similarity index 100% rename from image/connect_extension_to_mongodb_step_1.webp rename to public/image/connect_extension_to_mongodb_step_1.webp diff --git a/image/connect_extension_to_mongodb_step_2.webp b/public/image/connect_extension_to_mongodb_step_2.webp similarity index 100% rename from image/connect_extension_to_mongodb_step_2.webp rename to public/image/connect_extension_to_mongodb_step_2.webp diff --git a/image/docker_1.jpg b/public/image/docker_1.jpg similarity index 100% rename from image/docker_1.jpg rename to public/image/docker_1.jpg diff --git a/image/docker_2.jpg b/public/image/docker_2.jpg similarity index 100% rename from image/docker_2.jpg rename to public/image/docker_2.jpg diff --git a/image/docker_3.jpeg b/public/image/docker_3.jpeg similarity index 100% rename from image/docker_3.jpeg rename to public/image/docker_3.jpeg diff --git a/image/install1.png b/public/image/install1.png similarity index 100% rename from image/install1.png rename to public/image/install1.png diff --git a/image/install2.png b/public/image/install2.png similarity index 100% rename from image/install2.png rename to public/image/install2.png diff --git a/image/install3.png b/public/image/install3.png similarity index 100% rename from image/install3.png rename to public/image/install3.png diff --git a/image/install_mongodb_vscode_extension.webp b/public/image/install_mongodb_vscode_extension.webp similarity index 100% rename from image/install_mongodb_vscode_extension.webp rename to public/image/install_mongodb_vscode_extension.webp diff --git a/image/ip-address.png b/public/image/ip-address.png similarity index 100% rename from image/ip-address.png rename to public/image/ip-address.png diff --git a/image/mongodb_compass_user_edit.png b/public/image/mongodb_compass_user_edit.png similarity index 100% rename from image/mongodb_compass_user_edit.png rename to public/image/mongodb_compass_user_edit.png diff --git a/image/recaptcha_set_up.webp b/public/image/recaptcha_set_up.webp similarity index 100% rename from image/recaptcha_set_up.webp rename to public/image/recaptcha_set_up.webp diff --git a/image/recaptcha_site_and_secret_key.webp b/public/image/recaptcha_site_and_secret_key.webp similarity index 100% rename from image/recaptcha_site_and_secret_key.webp rename to public/image/recaptcha_site_and_secret_key.webp diff --git a/image/talawa-logo-dark-200x200.png b/public/image/talawa-logo-dark-200x200.png similarity index 100% rename from image/talawa-logo-dark-200x200.png rename to public/image/talawa-logo-dark-200x200.png diff --git a/image/talawa-logo-dark-600x600.png b/public/image/talawa-logo-dark-600x600.png similarity index 100% rename from image/talawa-logo-dark-600x600.png rename to public/image/talawa-logo-dark-600x600.png diff --git a/image/talawa-logo-lite-200x200.png b/public/image/talawa-logo-lite-200x200.png similarity index 100% rename from image/talawa-logo-lite-200x200.png rename to public/image/talawa-logo-lite-200x200.png diff --git a/image/talawa-logo-lite-600x600.png b/public/image/talawa-logo-lite-600x600.png similarity index 100% rename from image/talawa-logo-lite-600x600.png rename to public/image/talawa-logo-lite-600x600.png diff --git a/image/talawa-rtd.png b/public/image/talawa-rtd.png similarity index 100% rename from image/talawa-rtd.png rename to public/image/talawa-rtd.png diff --git a/videos/EvjEf36fQvideo.mp4 b/videos/EvjEf36fQvideo.mp4 deleted file mode 100644 index 9706102199..0000000000 Binary files a/videos/EvjEf36fQvideo.mp4 and /dev/null differ diff --git a/videos/WbatZ4vXEvideo.mp4 b/videos/WbatZ4vXEvideo.mp4 deleted file mode 100644 index 7936dc0909..0000000000 Binary files a/videos/WbatZ4vXEvideo.mp4 and /dev/null differ diff --git a/videos/dioITl-uzvideo.mp4 b/videos/XbJ5KMoa8video.mp4 similarity index 100% rename from videos/dioITl-uzvideo.mp4 rename to videos/XbJ5KMoa8video.mp4 diff --git a/videos/cPs7nTIg3video.mp4 b/videos/cPs7nTIg3video.mp4 deleted file mode 100644 index c37f31e872..0000000000 Binary files a/videos/cPs7nTIg3video.mp4 and /dev/null differ diff --git a/videos/demo.mp4 b/videos/demo.mp4 deleted file mode 100644 index 7a68603be8..0000000000 Binary files a/videos/demo.mp4 and /dev/null differ diff --git a/videos/hero-video.mp4 b/videos/hero-video.mp4 deleted file mode 100644 index 0e1d374499..0000000000 Binary files a/videos/hero-video.mp4 and /dev/null differ