Skip to content

Commit

Permalink
updated all mardkdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
Hemanthr1 committed Aug 17, 2024
1 parent 537ab73 commit 6367e1a
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 170 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The development branch is main. All pull requests should be made against this br
```bash
git checkout -b feat/quash-some-feature
```
5. See the [Developer Setup](https://github.com/dhairya-quash/TEST-REPO) for more setup details.
5. See the [Developer Setup](https://github.com/Oscorp-HQ/quash-max/blob/main/README.md) for more setup details.

### Building

Expand Down
156 changes: 0 additions & 156 deletions Quickstart.md

This file was deleted.

14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Quash Max comprises three main components: the SDK, the backend, and the fronten

## Contributing

We love contributions! Please read our [contribution guide](https://github.com/dhairya-quash/TEST-REPO/blob/main/Contribution%20Guide.md) to get started. We welcome all kinds of contributions, from code enhancements to documentation improvements.
We love contributions! Please read our [contribution guide](https://github.com/Oscorp-HQ/quash-max/blob/main/CONTRIBUTING.md) to get started. We welcome all kinds of contributions, from code enhancements to documentation improvements.

## Developer Setup

Expand Down Expand Up @@ -171,28 +171,28 @@ We love contributions! Please read our [contribution guide](https://github.com/d

### Note

> Frontend and SDK have a dependency on Backend to view the data and changes that you make. So please have a running backend before proceeding to run frontend or sdk. You can run max backend by either running the code manually or using a pre-built docker image. Follow the [Backend Setup](https://github.com/dhairya-quash/TEST-REPO/tree/main/backend) for detailed steps.
> Frontend and SDK have a dependency on Backend to view the data and changes that you make. So please have a running backend before proceeding to run frontend or sdk. You can run max backend by either running the code manually or using a pre-built docker image. Follow the [Backend Setup](https://github.com/Oscorp-HQ/quash-max/blob/main/backend/README.md) for detailed steps.

### SDK

For detailed SDK instructions, please refer to the individual [android README file](https://github.com/dhairya-quash/TEST-REPO/tree/main/android).
For detailed SDK instructions, please refer to the individual [android README file](https://github.com/Oscorp-HQ/quash-max/blob/main/android/README.md).

### Backend

For backend setup and deployment instructions, please refer to the [backend README file](https://github.com/dhairya-quash/TEST-REPO/tree/main/backend).
For backend setup and deployment instructions, please refer to the [backend README file](https://github.com/Oscorp-HQ/quash-max/blob/main/backend/README.md).

### Frontend

For frontend setup and deployment instructions, please refer to the [frontend README file](https://github.com/dhairya-quash/TEST-REPO/tree/main/frontend).
For frontend setup and deployment instructions, please refer to the [frontend README file](https://github.com/Oscorp-HQ/quash-max/blob/main/frontend/README.md).

## Deployment
> Note: For deploying SDK, refer to the deplyment section of android - [SDK Installation Guide](https://github.com/dhairya-quash/TEST-REPO/tree/main/android)
> Note: For deploying SDK, refer to the deplyment section of android - [SDK Installation Guide](https://github.com/Oscorp-HQ/quash-max/blob/main/android/README.md)

For a detailed, step-by-step guide on setting up Quash Max's Frontend and Backend using Docker, whether on your local machine or a hosted VM instance, please refer to our [Quick Start Guide](https://github.com/Oscorp-HQ/quash-max/blob/main/DEPLOYMENT.md).
## License
Quash is licensed under the [MIT License](./LICENSE).
Quash is licensed under the [MIT License](https://github.com/Oscorp-HQ/quash-max/blob/main/LICENSE.md).
## Contact
Expand Down
10 changes: 5 additions & 5 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Welcome to the Quash Backend repository, part of the [Quash](https://quashbugs.com/) project. This repository contains the code for the Quash Web Backend, a crucial component of your ultimate in-app bug reporting tool. Built by developers for developers, this backend supports the web dashboard in capturing everything you need to start fixing issues right away, including crash logs, session replays, network logs, device information, and much more.

<div align="center">
<img src="https://github.com/dhairya-quash/TEST-REPO/assets/161799860/7f7b7ffd-66f4-45d7-b68e-01fcedff0a75" alt="Logo" width=1000>
<img src="https://storage.googleapis.com/misc_quash_static/Quash%20Backend%20Banner.png" alt="Logo" width=1000>
</div>
<br>

Expand Down Expand Up @@ -32,16 +32,16 @@ The project is structured into the following layers:
- **DTO**
- **Utility**

<div align="center"><img src="https://github.com/dhairya-quash/TEST-REPO/assets/161799860/2f2e2354-0158-4cd8-879b-4d32aeb9ac13" alt="Architecture"></div>
<div align="center"><img src="https://storage.googleapis.com/misc_quash_static/Backend%20Archtecture.png" alt="Architecture"></div>

## DB Schema

<div align="center"> <img src="https://github.com/Oscorp-HQ/quash-backend/assets/161799860/9ffd2570-a050-4e39-87a9-4d04800efea5" alt="Flow" width=1000> </div>
<div align="center"> <img src="https://storage.googleapis.com/misc_quash_static/DB%20Schema.png" alt="Flow" width=1000> </div>
<br>

## Report Generation Flow

<div align="center"> <img src="https://github.com/Oscorp-HQ/quash-backend/assets/161799860/65d6b494-4867-43ed-970a-676feb6a7272" alt="Flow" width=1000> </div>
<div align="center"> <img src="https://storage.googleapis.com/misc_quash_static/Report%20Gen%20Flow.jpg" alt="Flow" width=1000> </div>
<br>

This guide will provide you steps to setup and configure the Backend for Quash.
Expand Down Expand Up @@ -97,7 +97,7 @@ mvn clean install
**MongoDB Connection String for Database**

```java
spring.data.mongodb.uri=mongodb_connection_string
spring.data.mongodb.uri='mongodb_connection_string'
```

JWT configurations -
Expand Down
2 changes: 1 addition & 1 deletion frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Welcome to the Quash Frontend repository, part of the [Quash](https://quashbugs.

### Note

> Quash Dashboard has a dependency on backend for providing the neccesary actions and data to go beyond the signin and signup page. So in order to use the dashboard or view any changes that you make in the dashboard, you need a working backend for it. To do so, you can either run the code manually or use a pre-built docker image. Please refer to the [Backend Setup](https://github.com/dhairya-quash/TEST-REPO/tree/main/backend) for detailed steps.
> Quash Dashboard has a dependency on backend for providing the neccesary actions and data to go beyond the signin and signup page. So in order to use the dashboard or view any changes that you make in the dashboard, you need a working backend for it. To do so, you can either run the code manually or use a pre-built docker image. Please refer to the [Backend Setup](https://github.com/Oscorp-HQ/quash-max/blob/main/backend/README.md) for detailed steps.
### Prerequisites

Expand Down

0 comments on commit 6367e1a

Please sign in to comment.