Ward Inventory System

A system to manage the supplies on a ward at a health facility

Features

• Product Management
• Product Dispensation
• Keypad Hardware Integration

Technologies

• Express.js as the web framework.
• ES2017+ support with Babel.
• Automatic polyfill requires based on environment with babel-preset-env.
• Linting with ESLint.
• Testing with Jest.
• MVC Architecture File Structure, here’s a guide
• Bootstrap 4
• Pug templating engine, See Pug with Express here.

Getting started

# Clone the project
git clone https://github.com/zextis/wardinv.git
cd wardinv
# Make it your own
rm -rf .git && git init && npm init
# Install dependencies
npm i
# or if you're using Yarn
yarn

Then you can begin development:

# yarn
yarn run dev
# npm
npm run dev

This will launch a nodemon process for automatic server restarts when your code changes.

Testing

Testing is powered by Jest. This project also uses supertest for demonstrating a simple routing smoke test suite. Feel free to remove supertest entirely if you don’t wish to use it.
Start the test runner in watch mode with:

# yarn
yarn test
# npm
npm test

You can also generate coverage with:

# yarn
yarn test --coverage
# npm
npm test -- --coverage

Linting

Linting is set up using ESLint. It uses ESLint’s default eslint:recommended rules. Feel free to use your own rules and/or extend another popular linting config (e.g. airbnb’s or standard).s

Begin linting in watch mode with:

# yarn
yarn run lint
# npm
npm run lint

To begin linting and start the server simultaneously, edit the package.json like this:

"dev": "nodemon src/index.js --exec \"node -r dotenv/config -r babel-register\" | npm run lint"

Environmental variables in development

The project uses dotenv for setting environmental variables during development. Simply copy .env.example, rename it to .env and add your env vars as you see fit.

It is strongly recommended never to check in your .env file to version control. It should only include environment-specific values such as database passwords or API keys used in development. Your production env variables should be different and be set differently depending on your hosting solution. dotenv is only for development.

Deployment

Deployment is specific to hosting platform/provider but generally:

# yarn
yarn run build
# npm
npm run build

will compile your src into /dist, and

# yarn
yarn start
# npm
npm start

will run build (via the prestart hook) and start the compiled application from the /dist folder.

The last command is generally what most hosting providers use to start your application when deployed, so it should take care of everything.

You can find small guides for Heroku, App Engine and AWS in the deployment document.

FAQ

Where is all the configuration for ESLint, Jest and Babel?

In package.json. Feel free to extract them in separate respective config files if you like.

License

MIT License. See the LICENSE file.