From 6367e1a04d0b3e0c03c9bedec71a9da2067dbd4e Mon Sep 17 00:00:00 2001 From: Hemanthr1 Date: Sat, 17 Aug 2024 11:37:18 +0530 Subject: [PATCH] updated all mardkdown files --- CONTRIBUTING.md | 2 +- Quickstart.md | 156 --------------------------------------------- README.md | 14 ++-- backend/README.md | 10 +-- frontend/README.md | 2 +- 5 files changed, 14 insertions(+), 170 deletions(-) delete mode 100644 Quickstart.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 544c7e2..dd47937 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/Quickstart.md b/Quickstart.md deleted file mode 100644 index 2a8a5be..0000000 --- a/Quickstart.md +++ /dev/null @@ -1,156 +0,0 @@ -# Quash Quick Start Guide - -Welcome to Quash! This guide will walk you through the process of setting up Quash using Docker, whether you're working on your local machine or a hosted VM instance. We've designed this guide to be comprehensive and easy to follow. Let's get started! - -## Quick Links -- Host a VM Instance - - [Google Cloud Platform](#google-cloud-platform-gcp) - - [Amazon Web Services](#amazon-web-services-aws) - - [Azure](#microsoft-azure) -- [Running Locally](#running-locally) -- [Prerequisites](#prerequisites) -- [Step-By-Step Guide](#step-by-step-guide) -- [Troubleshooting](#troubleshooting) - - -## Considerations for Hosted VM Instances - -If you plan to run Quash on a virtual machine (VM) hosted in the cloud, here are a few things to consider: - -- Choose a VM instance with at least 4GB of memory. -- Configure your firewall rules to allow traffic on ports 8080 and 3000. ------ - -You can find detailed instructions on how to create and configure VM instances for different cloud providers here: - -### Google Cloud Platform (GCP): - -1. **Create a VM instance**: Follow the [GCP guide](https://cloud.google.com/compute/docs/instances/create-start-instance) to create a VM. Choose a machine type with at least 4GB of memory, such as `n1-standard-1`. - -2. **Configure firewall rules**: Allow traffic on ports 8080 and 3000 by setting up appropriate firewall rules. - -3. **SSH into your VM**: Access your VM through SSH, install the [prerequisites](#prerequisites) and follow the [setup](#step-by-step-guide) steps provided below. ----- - -### Amazon Web Services (AWS): - -1. **Launch an EC2 instance**: Use the [AWS guide](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html) to launch an EC2 instance. Select an instance type like `t2.medium` which offers 4GB of memory. - -2. **Configure security groups**: Ensure your security groups allow inbound traffic on ports 8080 and 3000. - -3. **Connect to your EC2 instance**: SSH into your EC2 instance, install the [prerequisites](#prerequisites) and proceed with the [setup](#step-by-step-guide) steps. ----- - -### Microsoft Azure: - -1. **Create a Virtual Machine**: Refer to the [Azure guide](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/quick-create-portal) to create a VM. Opt for a machine size such as `Standard B2ms` with 4GB of memory. - -2. **Set up NSGs**: Configure network security groups to permit traffic on ports 8080 and 3000. - -3. **Access your VM**: SSH into your Azure VM, install the [prerequisites](#prerequisites) and follow the [setup](#step-by-step-guide) steps. ----- - -## Running Locally - -To run Quash locally, you only need to meet the [prerequisites](#prerequisites) and follow the setup steps below. - -## Prerequisites - -Before we dive into the setup, let's ensure you have everything you need. - -### Docker and Docker Compose - -Docker allows you to run applications in isolated containers, while Docker Compose helps you manage multi-container applications. Follow these links to install Docker and Docker Compose on your system: - -- [Docker Installation Guide](https://docs.docker.com/get-docker/) -- [Docker Compose Installation Guide](https://docs.docker.com/compose/install/) - -### Required Files - -Make sure you have the following files downloaded and saved in a folder on your computer: - -- [`docker-compose.yml`](https://github.com/Oscorp-HQ/quash-max/blob/main/docker-compose.yml) -- [`setup.sh`](https://github.com/Oscorp-HQ/quash-max/blob/main/setup.sh) - -These files contain the instructions and configurations needed to set up Quash. - -## Step-by-Step Guide - -Now that you have everything ready, let's proceed with the setup. - -### Running the Setup Script - -1. **Navigate to your working directory**: Open your terminal (or command prompt) and navigate to the folder where you saved the `docker-compose.yml` and `setup.sh` files. - -2. **Make the setup script executable**: In the terminal, type the following command to allow the setup script to run: - - ```bash - chmod +x setup.sh - ``` - -3. **Run the setup script**: Start the setup process by running the script with one of the following commands: - - ```bash - ./setup.sh - ``` - - or if you need administrative permissions: - - ```bash - sudo bash ./setup.sh - ``` - -### Follow the Prompts - -As the setup script runs, it will guide you through several steps: - -1. **Create containers**: The script will prepare the Docker containers for Quash but will not start them yet. - -
Containers started
-
- -2. **Specify your environment**: You will be asked if you are setting up Quash on a hosted VM instance or locally on your computer. Based on your response, the script will configure the IP addresses for the frontend and backend. -
which environment
-
- -3. **Configure environment files**: The script will copy environment configuration files from the containers to your local directory. You will need to open these files and add your credentials and secrets. This information is crucial for the proper functioning of Quash. -
-
Opening application.properties
-
-
nano editor
-
-
opening .env.local
-
-
nano editor
-
- -4. **Finalize setup**: After you have edited the configuration files, the script will copy them back to the containers and start them. -
-
Containers started
- -### Verify the Setup - -Once the script has completed its tasks, you should see two running containers: - -- **max-frontend**: You can access this at `http://:3000` -- **max-backend**: You can access this at `http://:8080/swagger-ui/index.html` - -Replace `` with the actual IP address of your machine or VM instance. - -## Troubleshooting - -If you run into any issues during the setup process, here are a few tips: - -- **Check Docker and Docker Compose**: Ensure both Docker and Docker Compose are installed and running on your system. -- **Verify file locations**: Make sure the `docker-compose.yml` and `setup.sh` files are in the correct directory. -- **Read error messages**: Pay close attention to any error messages and logs provided during the setup. These can give you clues about what might be going wrong. - -## Bonus : -If you are utilizing a dynamic IP on a hosted VM instance, please be aware that stopping the instance will halt the container, and upon starting it again, the external IP address of the VM instance will change. However, we have a solution for you. By running the [`restart-max.sh`](https://github.com/Oscorp-HQ/quash-max/blob/main/restart-max.sh) script in your working directory on the VM, the IP address will be updated for the Docker containers, and the containers will be restarted automatically. -**This process is specifically designed for users operating hosted VM instances.** - -## Conclusion - -Congratulations! You have successfully set up Quash using Docker. If you have any questions or need further assistance, don't hesitate to reach out to the Quash community via [Discord](https://discord.com/invite/Nxbe8F6aqw) or consult the documentation. - -Happy bug reporting! diff --git a/README.md b/README.md index e32d9ee..7685d1d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/backend/README.md b/backend/README.md index 330bc53..c4008c9 100644 --- a/backend/README.md +++ b/backend/README.md @@ -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.
- Logo + Logo

@@ -32,16 +32,16 @@ The project is structured into the following layers: - **DTO** - **Utility** -
Architecture
+
Architecture
## DB Schema -
Flow
+
Flow

## Report Generation Flow -
Flow
+
Flow

This guide will provide you steps to setup and configure the Backend for Quash. @@ -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 - diff --git a/frontend/README.md b/frontend/README.md index c5026c4..9d1b7e3 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -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