Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gbowne1/radiologger
A Radio Logging application build with NodeJS and ExpressJS
https://github.com/gbowne1/radiologger
hacktoberfest ham-radio hamradio logging mediumwave qsl qsl-card radio scanners scanning shortwave shortwave-listeners shortwave-radio vhf
Last synced: about 2 months ago
JSON representation
A Radio Logging application build with NodeJS and ExpressJS
- Host: GitHub
- URL: https://github.com/gbowne1/radiologger
- Owner: gbowne1
- License: gpl-3.0
- Created: 2023-04-15T22:26:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T07:10:42.000Z (3 months ago)
- Last Synced: 2024-11-04T08:20:11.583Z (3 months ago)
- Topics: hacktoberfest, ham-radio, hamradio, logging, mediumwave, qsl, qsl-card, radio, scanners, scanning, shortwave, shortwave-listeners, shortwave-radio, vhf
- Language: HTML
- Homepage:
- Size: 937 KB
- Stars: 6
- Watchers: 3
- Forks: 7
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# RadioLogger
[](https://nodejs.org/en/)
[](https://www.npmjs.com/package/express)
[](https://www.npmjs.com/package/mongoose)
[](https://www.npmjs.com/package/mongodb)
[](https://www.nodejs.com)
[](https://expressjs.com)
[](https://www.nodejs.com)
This project is an amateur radio and shortwave radio logging application built using Node.js, Express.js, Mongoose, and MongoDB.
## Table of Contents
- [RadioLogger](#radiologger)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
## Features
- Amateur Radio "Ham" Logging
- Shortwave Radio Logging
- MW DX Logging
- Scanner Logging
- Contest Logging
- QSL Card Database
## Requirements
There are some requirements and prerequisites to developing this project.
- Node.js version (e.g., v14.0.0 or higher)
Note: We suggest using the latest LTS version, shown on NodeJS's current download page.
- MongoDB version (e.g., v4.0.0 or higher)
## Installation
Assuming you already have MongoDB and NodeJS installed, here are the installation requirements
1. Clone this repository
2. Change to the project directory
3. Install client dependencies
4. Install server dependencies
5. Create a `.env` file in the project root with the following contents
6. Start the mongod server with `mongod`
7. Start the application
a. Change to /src/server
b. Start the server with npm start
c. Wait till node & nodemon start and connect to mongoose / MongoDB
d. Go to your browser and navigate to localhost:3000
## Usage
Provide detailed instructions on how to use your application, including examples of the main features.
## API Documentation
Provide a link to your API documentation, or include a brief overview of the available endpoints and their functionality.
## Testing
We use Mocha and Chai to do our testing
1. Run tests:
- Run npm test
## Contributing
We have a list of TODO's in [here](TODO.md). If you would like to work on any of these, let us know which one you would like to work on.
Please read the [Contributing](CONTRIBUTING.md) document. If you think it will take you more than 3 days/72 hours to complete a task let us know that as well so we can keep issues from going stale. Please submit all PR's with a screenshot and assign the PR to yourself.
## License
Currently we are using the [GPL-3.0-only](https://opensource.org/license/gpl-3-0/) license, but may adopt another in the future such as MIT.