# Handover Report

List of Projects:
### Quadvendor
Description: This project was started in 2020 with Rails 6.1. The project is a rails monolith and uses much of the standard rails processes.
The project frontend styling uses a [boostrap template](https://wrapbootstrap.com/theme/inspinia-responsive-admin-template-WB0R5L90S)
> Codebase Location: [Quadvendor](https://github.com/gigacypher/quadvendor)

> Installation: https://hackmd.io/MTmEpD2kS2GXrn0Ja-w5yw

> Comprehensive Report: https://hackmd.io/I7640NngRYm4v9Y4v0sx0g?view

- [ ] Outstanding Tasks: Migrate from Webpacker to Propshaft since webpacker is no longer maintained. Propshaft is the default for Rails 8 as of 1st June 2024. Here's a [guide](https://github.com/rails/propshaft/blob/main/UPGRADING.md)

---

### Smartply Connect
Description: The project is an e-commerce frontend application running on Ruby 3.2(YJIT) and Rails 7

Codebase Location: [Smartply](https://github.com/gigacypher/smartply-web)

Key Dependencies: [Farady](https://github.com/lostisland/faraday) and Tailwind CSS

---

### Sahibu Manager
#### Overview
The Sahibu Manager project was initiated in 2022 with the goal of creating an improved version of the existing Sahibu application, which was initially built using PHP. The new version aimed to provide a more modern and efficient platform for managing various aspects of the business.

#### Technology Stack
The project was built using the [Jumpstart Pro](https://jumpstartrails.com/) Ruby on Rails application template, which provided a solid foundation with pre-built features and components, saving significant development time and effort.
#### Outstanding Tasks
- [ ] Develop a custom booking module for accounts to streamline reservation management processes.
- [ ] Revamp the admin dashboard. Currently using [administrate](https://github.com/thoughtbot/administrate) though I recommend moving to [Avo](https://github.com/avo-hq/avo) for a modern UI and technical support.

---

### Gigafit
A gym management system.

This project was done on 2020. The project uses Rails 6 to serve an API and Nuxt front end.

Codebase Location: [Backend](https://github.com/gigacypher/apilive.gigafitweb.com)

#### Deployment Process:
The deployment process is automated using Capistrano. The code for deployment scripts can be found in the deploy project's directory codebase.

### Infrastructure Handover

#### Domain Management
The company's primary domain name registrar and DNS management provider is [Namecheap](https://www.namecheap.com/). Login credentials are stored in the password manager.

#### Error Logging and Monitoring
The projects utilize [Honeybadger](https://www.honeybadger.io/) for error tracking and monitoring. Refer to the [Honeybadger documentation](https://docs.honeybadger.io/lib/ruby) for more information.

#### Servers and Hosting
##### Web Services
- **Server Hosting**: We use [Digital Ocean](https://www.digitalocean.com/) for server hosting and [Spaces](https://www.digitalocean.com/products/spaces/) (S3-compatible storage) for file storage.
- **Deployment Automation**: [Hatchbox](https://hatchbox.io/) is used to automate deployments on Digital Ocean servers.

##### Code Hosting
- **Repository**: All code is hosted on [GitHub](https://github.com/).
- **Continuous Integration**: We use GitHub's built-in Continuous Integration (CI) tools for automated testing and deployment.

##### External Services
- **Encrypted Credentials**: Each project stores encrypted files containing API keys and other credentials required for integrations with third-party services.
- **Master Key**: To access these encrypted credentials, you need the project-specific `MASTER_KEY`, which is available on Hatchbox if you have access.

### Knowledge Base

#### API Documentation:
The company's internal API documentation can be found at postman with the team(Team Workspace).
#### Payment Gateways:
[Daraja API](https://developer.safaricom.co.ke/)
[Flutterwave](https://developer.flutterwave.com/)

#### Mailing Services
* [Mailgun API](https://app.mailgun.com/) - Currently on the flex plan.
* [Zoho Mail](https://mailadmin.zoho.com/)(Business Domains)

#### SMS Service
[Africa's Talking](https://account.africastalking.com/) - Used in Quadvendor and Gigafit
[Sozuri](https://www.sozuri.net/) - Used in Sahibu Manager

#### Url Shortener
[Tiny Url](https://tinyurl.com/app/dev)- Used for the Smartply Connect campaigns
[Bitly](https://dev.bitly.com/)- Used in Quadvendor agents module

## Password Credentials
Access credentials are stored in the password manager; **Lastpass**
[Lastpass](https://www.lastpass.com/) Credentials:
`email: [e-mail]`
`password: Giga@quad2024`

## Key Contact
If you have any questions or need further clarification on any of the topics covered in this report, please feel free to reach out to [[e-mail]](mailto:[e-mail])