consus
v0.7.0
Published
The inventory management system for the Milwaukee School of Engineering's tech support
Downloads
7
Readme
Consus
Installing
# Install as a global module
npm install consus -g
# Start the server daemon
consusd start
# Stop the daemon
consusd stop
Developing
Getting Started
# Clone the repository
git clone [email protected]:TheFourFifths/consus.git
# Enter the project directory
cd consus
# Install dependencies
npm install
# Build the project
npm run build
# Start the server
npm start
Development Scripts
npm test
: Run the test suitenpm run lint
: Run the linternpm run build
: Build the usable .dist directorynpm run coverage
: Generate a code coverage report
Project File Structure
docs
: Project documentation goes herebin
: A directory containing theconsusd
file for running as a global modulesrc
: The project's source codeapi
: API apps that register and handle REST endpointslib
: Miscellaneous library modulespublic
: Public files served to the web browserstore
: Flux stores which contain state and consume actions
test
: The project's testsunit
: Unit testsfunctional
: Functional tests