This project is an amateur radio and shortwave radio logging application built using Node.js, Express.js, Mongoose, and MongoDB.
- Amateur Radio "Ham" Logging
- Shortwave Radio Logging
- MW DX Logging
- Scanner Logging
- Contest Logging
- QSL Card Database
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)
Assuming you already have MongoDB and NodeJS installed, here are the installation requirements
- Clone this repository
- Change to the project directory
- Install client dependencies
- Install server dependencies
- Create a
.envfile in the project root with the following contents - Start the mongod server with
mongod - 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
Provide detailed instructions on how to use your application, including examples of the main features.
Provide a link to your API documentation, or include a brief overview of the available endpoints and their functionality.
We use Mocha and Chai to do our testing
- Run tests:
- Run npm test
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.
Currently we are using the GPL-3.0-only license, but may adopt another in the future such as MIT.
