BUGME - Bug orchestration tool

Disclaimer: Authenticator is working well but authorization is not implemented yet. Please do not use in such environments that can effect you financially.

Summary

This is an application implemented with FastAPI, Mongodb where you can create Users, Brands, Apps and report bugs and add Slack, Clickup integrations.

Users can have multiple Brands (Users can be considered as Organizations too) Brands can have multiple Apps For bug reporting, you need to use api key generated from brand (The Api key will be generated when you add a new brand automatically but also, you can generate a new one via {API_URL}/api/v1/brands/get-api-key with Brand ID param) Client apps can report bugs along with Bundle ID and Platform and other details can be found in {API_URL}/docs. If the bundle ID is not saved, We create a new APP for that bundle ID along with correspondent Brand ID and User ID and platform information.

Developer setup

• Makesure python version is 3.7 or more.
• Clone the repo.

  git clone https://github.com/ertyurk/bugme-backend.git

• Go to project folder and Create a virtual environment.

  cd backend
  python3 -m venv .venv

• Activate virtual environment.

  chmod +x .venv/bin/activate
  source .venv/bin/activate

  • You can deactivate with deactivate
• Install dependencies.

  pip install -r requirements.txt

• Copy and update Environment variables with your mongo db url, table, secret key

  cp .env.sample .env

  • For secret key I use openssl rand -base64 128
• Start the app with watcher to reload the app for each file change.

  uvicorn app.main:app --reload

Setup with Docker

1. Clone this repo.

   git clone https://github.com/ertyurk/bugme-backend.git
   

2. Update DNS config from CF or other domain provider.

3. Copy env.copy to .env and Put desired credentials into .env.

4. Give permission to setup.sh and execute it for docker setup. (prepared for Ubuntu 20.04.3. If your environment is not matching, pass this step and install docker on your own.)

   chmod +X setup.sh
   ./setup.sh
   

5. To start server

   docker-compose -f docker-compose.prod.yml up -d --build
   

Troubleshoot

1. If you want to run docker as non-root user then you need to add it to the docker group.
   1. Create the docker group if it does not exist sudo groupadd docker
   2. Add your user to the docker group. sudo usermod -aG docker $USER
   3. Run the following command or Logout and login again and run (that doesn't work you may need to reboot your machine first) newgrp docker
   4. Check if docker can be run without root docker run hello-world
   5. Reboot if still got error reboot
   6. Now you can run build docker-compose -f docker-compose.prod.yml up -d --build
2. If you want to use Digital ocean spaces, just revert commit id: 13e4998369c61c81aaac4abbd1263e5e9943728a

Useful links

• Implemented with FastAPI.
• Docker cheat sheet.
• Traefik used for dockerized proxy setup.
• MongoDB Atlas is used in this project for the MVP for cost efficiency. I will move it to Digital ocean DB Cluster to increase performance.