search

gbowne1 / RadioLogger

A Radio Logging application build with NodeJS and ExpressJS
GNU General Public License v3.0
6 stars 7 forks source link
hacktoberfest ham-radio hamradio logging mediumwave qsl qsl-card radio scanners scanning shortwave shortwave-listeners shortwave-radio vhf

readme

RadioLogger

Node.js Version Express.js Version Mongoose Version MongoDB Version

MongoDB Express NodeJS

This project is an amateur radio and shortwave radio logging application built using Node.js, Express.js, Mongoose, and MongoDB.

Table of Contents

Features

Requirements

There are some requirements and prerequisites to developing this project.

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:

Contributing

We have a list of TODO's in here. 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 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 license, but may adopt another in the future such as MIT.