mirror of
https://github.com/magicbug/Cloudlog
synced 2024-11-21 15:56:30 +00:00
135 lines
6.5 KiB
Markdown
135 lines
6.5 KiB
Markdown
[](https://github.com/magicbug/Cloudlog/actions/workflows/cypress-tests.yml)
|
|
|
|
# Cloudlog
|
|
> Important: Only accepting PRs on the "dev" branch.
|
|
|
|
Cloudlog is a self-hosted PHP application that allows you to log your amateur radio contacts anywhere. All you need is a web browser and active internet connection.
|
|
|
|
While Cloudlog as started by Peter Goodhall, 2M0SQL, although since has received a lot of community code contributions. If you would like to contribute to Cloudlog please see the [Contributing](#contributing) section below.
|
|
|
|
Website: [http://www.cloudlog.co.uk](http://www.cloudlog.co.uk)
|
|
|
|
## Requirements
|
|
|
|
- Linux based Operating System
|
|
- Apache (Nginx should work)
|
|
- PHP Version 7.4 (PHP 8.2 works)
|
|
- MySQL (MySQL 5.7 or higher)
|
|
|
|
Notes
|
|
|
|
- If you want to log microwave QSOs you will need to use a 64bit operating system.
|
|
- We do not provide Docker support, however you are free to use it if you wish but we will not handle support.
|
|
|
|
## Setup
|
|
|
|
Installation information can be found on the [wiki](https://github.com/magicbug/Cloudlog/wiki).
|
|
|
|
# Docker Development Environment
|
|
|
|
This guide provides instructions for setting up a local development environment using Docker and Docker Compose. Please note that this setup is not recommended for production use.
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, you need to install Docker and Docker Compose. You can download them using the following links:
|
|
|
|
- [Docker](https://docs.docker.com/get-docker/)
|
|
- [Docker Compose](https://docs.docker.com/compose/install/)
|
|
|
|
## Configuration
|
|
|
|
1. Copy the `.env.sample` file to `.env`:
|
|
|
|
```bash
|
|
cp .env.sample .env
|
|
```
|
|
|
|
2. Open the `.env` file and update the values to match your setup. The values from the `.env` file will be used to populate the database connection details on the install page. You should not need to change these unless your setup requires different values.
|
|
|
|
**Note:** Docker Compose creates a network for your application, and each service (container) in the Docker Compose file can reach each other via the service name. This is why the `DB_HOST` value in the `.env` file and on the install page should match the service name of the database in the `docker-compose.yml` file. For example, if the database service in `docker-compose.yml` is defined as `db`, then `DB_HOST` should be set as 'db'. This allows the application to communicate with the database service on its internal docker network.
|
|
|
|
## Starting the Development Environment
|
|
|
|
To start the development environment, run the following command in your terminal:
|
|
|
|
```bash
|
|
docker-compose up
|
|
```
|
|
|
|
# Running Cypress Tests Locally
|
|
|
|
Follow these steps to run the Cypress tests locally on your machine:
|
|
|
|
1. **Clone the repository**
|
|
|
|
If you haven't already, clone the repository to your local machine
|
|
|
|
2. **Setup .env file**
|
|
|
|
Copy the sample `.env` file and adjust it to your local environment:
|
|
|
|
```bash
|
|
cd your-repo
|
|
cp .env.sample .env
|
|
```
|
|
|
|
3. **Build Docker services**
|
|
|
|
Build and start the Docker services:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
4. **Install Cypress**
|
|
|
|
Navigate into the project directory and install Cypress:
|
|
|
|
```bash
|
|
npm install cypress
|
|
```
|
|
|
|
5. **Run the Cypress tests**
|
|
|
|
After the installation is complete, you can run the Cypress tests:
|
|
|
|
```bash
|
|
npx cypress run
|
|
```
|
|
|
|
## Support
|
|
|
|
Cloudlog has two support systems for code issues use Github issues, however if you have general issues with setting up your server please use our general discussion forum [https://github.com/magicbug/Cloudlog/discussions](https://github.com/magicbug/Cloudlog/discussions).
|
|
|
|
## Security Vulnerabilities
|
|
|
|
If you discover a security vulnerability within Cloudlog, please send an e-mail to Peter Goodhall, 2M0SQL via [peter@magicbug.co.uk](mailto:peter@magicbug.co.uk). All security vulnerabilities will be promptly addressed.
|
|
|
|
## Want Cloudlog Hosting?
|
|
|
|
If you would prefer not to setup Cloudlog yourself [magicbug](https://magicbug.co.uk) offer hosted solutions, this is priced at £4 a month at the moment and they take care of keeping it updated.
|
|
|
|
## Contributing
|
|
|
|
If you would like to contribute in any way to Cloudlog, it is most appreciated. This has been developed in free time, help coding new features or writing documentation is always useful.
|
|
|
|
Please note that Cloudlog was built using [Codeigniter](https://www.codeigniter.com/userguide3/) version 3 and uses [Bootstrap 5](https://getbootstrap.com/docs/5.3/getting-started/introduction/) as the frontend toolkit.
|
|
|
|
We also [HTMX](https://htmx.org/) for AJAX requests and [jQuery](https://jquery.com/) for some of the frontend functionality. We use [Font Awesome](https://fontawesome.com/) for icons.
|
|
|
|
At the moment we use [Cypress](https://www.cypress.io/) for end-to-end testing.
|
|
|
|
When submitting PRs please make sure code is commented and includes one feature only, multiple features or bug fixes will not be accepted. Please include a description of what your PR does and why it is needed.
|
|
|
|
## Credits
|
|
|
|
Thanks to Andy (VE7CXZ), Gavin (M1BXF), Graham (W5ISP), Robert (M0VFC), Corby (K0SKW), Andy (GI0VGV), Sarah (DM4NA), Tony (G0WFV), Kim (DG9VH), Michael (G7VJR), Andreas (LA8AJA), Matthias (DL9MJ), Thomas (DO2TWE), Pat (KT3PJ), Flo (DF2ET), Joerg (DJ7NT) and Fabian (HB9HIL) for contributing code or help to Cloudlog.
|
|
|
|
## Patreons & Donors
|
|
|
|
Cloudlog is supported by Patreon and donations via PayPal, thanks to the following people:
|
|
|
|
Paul (M0TZO), Tim (G4VXE), Paul (N8HM), Michelle (W5NYV), Mitchell (AD0HJ), Dan (M0TCB), Martin (DK3ML), Juan Carlos (EA5WA), Iain (M0PCB), Charlie (GM1TGY), Ondrej (OK1CDJ), Trystan (G0KAY), Oliver (DL6KBG), Volkmar Schirmer, Jordan (M0PIR), Thomas Ziegler, Mathis (DB9MAT), Ken (VE3HLS), Tyler (WL7T), Jeremy Taylor, Ben Kuhn, Eric Thresher, Michael Cullen, Juuso (OH1JW), Anthony Castiglia, Fernando Ramirez-Ferrer, Robert Dixon, Mark Percival, Julia (KV1V), Timo Tomasini, Ant (NU1U), Christopher Williams, Danny Barnes, Vic, Tom (M0LTE), smurphboy, Lars (SM0TGU), Theo (PD9DP), Stefan (SM0RGM). Peter (G0ABI), Lou (KI5FTY), Michael (DG3NAB), Dragan (4O4A), minorsecond, Emily (W7AYQ), Steve (M0SKM), Rob (M0VFC), Doug (WA6L), Petr (OK1PKR), Fabian (HB9HIL), Daniel (OK2VLK), John (M5JFS).
|
|
|
|
If you'd like to donate to Cloudlog to help allow @magicbug spend less time doing commercial work and more time coding Cloudlog then you can donate via [PayPal](https://paypal.me/PGoodhall), [Github Sponsor](https://github.com/sponsors/magicbug) or become a [Patreon](https://www.patreon.com/2m0sql)
|