ACHOO!-hayfever-app (EXPRESS-BACK-END)

Welcome to Achoo!! - It's the bees sneeze!

A location based app that notifies you with an SMS when pollen count levels reach dangerously sneezey levels in your area.

Screenshots

App Demo

Here's a presentation demo of our app in action

TECHNOLOGIES used

Express web framework for Node.js.
[React] (https://reactjs.org/) - for frontend
[MongoDB] fot local database testing
MongoDB Atlas for AWS cloud database
Mongoose to model objects in MongoDB.
Nodemon to reload the server automatically.
ESLint for linting.
Jest for testing.
Cypress for end-to-end testing.
Axios for pollen api parsing
Ambee pollen and climate API data.
Twilio for SMS notifications.

Cypress for integration testing

To install cypress for testing: https://docs.cypress.io/guides/getting-started/opening-the-app#Adding-npm-Scripts
To run from CLI: Add this as a script in package.json file // "cypress:open": "cypress open" //
To run from command line use : // npm run cypress:open //
To test from the command line use: // npm run test:integration //

Jest for unit testing

To test from the command line use: // npm run test:unit //

Unit and Integration testing together

To test from the command line use: // npm run test:all //

Nodemon for automatic reloading of the host server

To add nodemon to package.json file as dependencies: // npm install --save-dev nodemon //
Add to scripts in package.json file: // "start": "nodemon ./bin/www", //
To run nodemon: // npm start //

Getting Started

The application uses the ambee API (https://www.getambee.com/api-documentation). The API key has a 30-day expiry (last activated on 02/08/2022). API key may need to be updated if outside the 30 day limit from the date shown in this README.

Installation

The application has been built on Express.js. To install clone the repo and then run the command below:

npm install

Running the program using Atlas Cloud MongoDB Database with Twillio SMS functionality

Run Express Server using:

npm start

Run React Client using:

npm start

Running the program using Local MongoDB Database

First change DB config to local config in bin/www
On WSL2, start database using:

sudo service mongodb start

sudo mongod --dbpath ~/data/db

Run React Client using:

npm start

Run Express Server using:

npm start

Run React Client using:

npm start

fridayshoes/achoo-hayfever-server-express