This is a React application created for the Directorate of Flight Safety that allows witnesses of flight safety occurrences to create and submit, and investigators to view flight safety reports using personal mobile devices. The requirements specification can be found here: https://docs.google.com/document/d/1NnoNS1bF_9BOFcijR8dubk3omMOQVoK2F8jdkWQHb30/edit?usp=sharing. The database diagram can be found here: https://dbdiagram.io/d/602c104580d742080a3ac367.
- CORS enabled
- Uses yarn
- Express + MongoDB (Mongoose)
- Consistent coding styles with editorconfig
- Docker support
- Uses helmet to set some HTTP headers for security
- Load environment variables from .env files with dotenv
- Request validation with joi
- Gzip compression with compression
- Linting with eslint
- Tests with mocha, chai and sinon
- Code coverage with istanbul and coveralls
- Git hooks with husky
- Logging with morgan
- Authentication and Authorization with passport
- API documentation generation with apidoc
- Continuous integration support with travisCI
- Monitoring with pm2
Found in the requirements specification.
git clone https://github.com/mjsouthcott/safety-zone
cd safetyyarncp .env.example .envyarn devyarn start# lint code with ESLint
yarn lint
# try to fix ESLint errors
yarn lint:fix
# lint and watch for changes
yarn lint:watch# run all tests with Mocha
yarn test
# run unit tests
yarn test:unit
# run integration tests
yarn test:integration
# run all tests and watch for changes
yarn test:watch
# open nyc test coverage reports
yarn coverage# run lint and tests
yarn validate# show logs in production
pm2 logs# generate and open api documentation
yarn docs# run container locally
yarn docker:dev
# run container in production
yarn docker:prod
# run tests
yarn docker:testSet your server ip:
DEPLOY_SERVER=127.0.0.1Replace my Docker username with yours:
nano deploy.shRun deploy script:
yarn deployTBC
MIT License
Copyright (c) 2020 Matthew James Southcott
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
TBC