Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardizing Asset Directory Structure #1449

Closed
wants to merge 12 commits into from
Closed
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,30 @@ csr.pem

.DS_STORE

# Ensuring no images and video are commited in ./video and ./image directories

# Ignore all files in the image and video directory
image/*
video/*

# Exception: Include specific files
!image/colorize-logs.jpg
!image/connect_extension_to_mongodb_step_1.webp
!image/connect_extension_to_mongodb_step_2.webp
!image/docker_1.jpg
!image/docker_2.jpg
!image/docker_3.jpeg
!image/GraphQL_Voyager.png
!image/install1.png
!image/install2.png
!image/install3.png
!image/install_mongodb_vscode_extension.webp
!image/ip-address.png
!image/mongodb_compass_user_edit.png
!image/recaptcha_set_up.webp
!image/recaptcha_site_and_secret_key.webp
!image/talawa-logo-dark-200x200.png
!image/talawa-logo-dark-600x600.png
!image/talawa-logo-lite-200x200.png
!image/talawa-logo-lite-600x600.png
!image/talawa-rtd.png
zakhaev26 marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
20 changes: 10 additions & 10 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,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 `{{}}`):

```
Expand Down Expand Up @@ -438,11 +438,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`.

Expand Down Expand Up @@ -502,7 +502,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

Expand Down Expand Up @@ -708,7 +708,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:

```
Expand Down Expand Up @@ -743,13 +743,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`.

Expand All @@ -774,7 +774,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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Binary file added public/image/GraphQL_Voyager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/colorize-logs.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added public/image/install1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/install2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/install3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added public/image/ip-address.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/mongodb_compass_user_edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/image/recaptcha_set_up.webp
Binary file not shown.
Binary file not shown.
Binary file added public/image/talawa-logo-lite-200x200.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file removed videos/EvjEf36fQvideo.mp4
Binary file not shown.
Binary file removed videos/WbatZ4vXEvideo.mp4
Binary file not shown.
Binary file removed videos/cPs7nTIg3video.mp4
Binary file not shown.
Binary file removed videos/demo.mp4
Binary file not shown.
1 change: 0 additions & 1 deletion videos/dioITl-uzvideo.mp4

This file was deleted.

Binary file removed videos/hero-video.mp4
Binary file not shown.
Loading