Update README.md file #115
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samshara
requested changes
May 8, 2024
README.md
Outdated
Comment on lines
79
to
84
| ## TODO | ||
|
|
||
| - [ ] Roadmap | ||
| - [ ] Contributing | ||
| - [ ] License | ||
| - [ ] Contact |
README.md
Outdated
Comment on lines
48
to
71
| ## Directory Structure | ||
|
|
||
| ``` | ||
| . | ||
| ├── patches/ (Patches to any of the external dependencies) | ||
| ├── public/ (Content that needs to be copied during build) | ||
| ├── scripts/ (Scripts used during builds) | ||
| ├── generated/ (Generated files: eg. Typescript Definitions) | ||
| ├── index.html (Base html file) | ||
| └── src/ | ||
| ├── App/ | ||
| │ ├── Auth.tsx (Defines page redirections wrt user authentication) | ||
| │ ├── index.tsx (Defines providers: eg. Auth, Route, Request, Alert) | ||
| │ └── routes.tsx (Defines routes for the pages) | ||
| ├── assets/ (images, icons) | ||
| ├── components/ (Components from GO UI) | ||
| │ ├── domain/ (Components that are specific to a domain) | ||
| │ └── parked/ (Components that are not used yet) | ||
| ├── config.ts (Defines configurations read from environment variables) | ||
| ├── contexts/ (Custom contexts) | ||
| ├── declarations/ (Type declarations for external libraries) | ||
| ├── hooks (React Hooks) | ||
| │ └── domain/ (Hooks that are specific to a domain) | ||
| ├── index.tsx (Initializes React) | ||
| ├── utils (Utility functions) | ||
| │ └── domain/ (Utility functions that are specific to a domain) | ||
| └── views/ (Pages that we can navigate on the platform) | ||
| └── RootLayout/ | ||
| └── index.tsx (Defines root layout and requests fetched for DomainContext) |
There was a problem hiding this comment.
This doesn't seem to be out directory structure. Let's use actual directory structure.
samshara
reviewed
May 8, 2024
There was a problem hiding this comment.
Also, a nice resource to learn about the README.md file and its usage and how to write one.
https://github.com/hackergrrl/art-of-readme
barshathakuri
force-pushed
the
feature/read-me
branch
from
613d522
to
298e8ee
Compare
AdityaKhatri
approved these changes
May 13, 2024
samshara
previously requested changes
May 13, 2024
Comment on lines
1
to
28
| --- | ||
| name: Bug report - Staging | ||
| about: Create a report for issues found in staging/test | ||
| title: "[Staging] " | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| ## Issue | ||
| *Please describe your issue clearly and concisely. If possible, include when you first encountered the issue, who it affects, a link to a relevant page, and any other information that might be helpful in diagnosing its cause.* | ||
|
|
||
| ## URL | ||
| *e.g. `https://alert-hub.westeurope.cloudapp.azure.com/map?country=161&alert=185464`* | ||
|
|
||
| ## Steps to reproduce | ||
| *If you can reliably reproduce the issue, please list the steps taken to do so. (Go to this URL..., click on..., Scroll down to..., See error)* | ||
|
|
||
| *If applicable, add screenshots to help explain your problem.* | ||
|
|
||
| ## Expected behaviour | ||
| *Please describe how this feature should be working.* | ||
|
|
||
| ## Related feature | ||
| *Please cross-reference the build item to which this relates, if known* | ||
|
|
||
| ## Criticality/Urgency | ||
| *Is it critical that this ticket is resolved urgently (e.g. is it a Blocker)? What is the impact if no change is made?* |
There was a problem hiding this comment.
Do we have staging environment? If not maybe we don't need this.
APIDOC.md
Outdated
There was a problem hiding this comment.
Let's rename this to APIDOCS.md
APIDOC.md
Outdated
| ## Project Configuration | ||
|
|
||
| ### Add Schema | ||
| * Go to the [alert-hub-backend](https://github.com/IFRCGo/alert-hub-backend) repository and download the [schema.graphql](https://github.com/IFRCGo/alert-hub-backend/blob/develop/schema.graphql) file |
There was a problem hiding this comment.
Suggested change
| * Go to the [alert-hub-backend](https://github.com/IFRCGo/alert-hub-backend) repository and download the [schema.graphql](https://github.com/IFRCGo/alert-hub-backend/blob/develop/schema.graphql) file | |
| * Go to the [alert-hub-backend](https://github.com/IFRCGo/alert-hub-backend) repository and download the [schema.graphql](https://github.com/IFRCGo/alert-hub-backend/blob/develop/schema.graphql) file. |
APIDOC.md
Outdated
|
|
||
| ### Add Schema | ||
| * Go to the [alert-hub-backend](https://github.com/IFRCGo/alert-hub-backend) repository and download the [schema.graphql](https://github.com/IFRCGo/alert-hub-backend/blob/develop/schema.graphql) file | ||
| *Note: The schema file might change in the future. Make sure to use the latest one* |
There was a problem hiding this comment.
Let's move this to a new line.
APIDOC.md
Outdated
Comment on lines
38
to
47
| ### Add GraphQL URL | ||
| * Go to the [alert-hub](https://alert-hub.westeurope.cloudapp.azure.com/map) staging platform and inspect the page | ||
| * Go to the `Network` tab and click **Fetch/XHR** button | ||
|  | ||
|
|
||
| * Click on **graphql** and copy the request URL in the `Header` tab | ||
|  | ||
|
|
||
| * Paste the request URL in the `Enter URL` text field | ||
|  |
There was a problem hiding this comment.
Why are we doing this long process to get the URL. Shouldn't we just have listed down the URL?
frozenhelium
force-pushed
the
feature/read-me
branch
from
5e528e3
to
118751a
Compare
frozenhelium
force-pushed
the
feature/read-me
branch
from
118751a
to
90724be
Compare
frozenhelium
approved these changes
May 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses:
Changes
This PR doesn't introduce:
console.logmeant for debugging