TechCheck is an open-source inventory checkout and reservation web app.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
deploy
dev
dist
models
routes
views
.env
.gitignore
README.md
gulpfile.js
package-lock.json
package.json
server.js

README.md

Tech✔Check

TechCheck is an open-source inventory checkout and reservation web app. Get started with a self hosted version, or try the live demo. Note: The demo site is hosted on a free heroku dyno which takes time to spin up on first load. This slow load time is not present on a local or production version.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

NodeJS

MongoDB

Gulp

Installing

Once prerequisites have been installed:

git clone https://github.com/asonj/TechCheck.git
npm install
mongod     //Don't have mongodb? "npm run get-mongodb"
gulp watch //Don't have gulp? "npm run get-gulp"

Visit localhost:8080/user/sign-up and create a new account.

Add your email to the ADMIN_EMAIL variable locatead within /.env.

Refresh the page and you will be up and running.

Deployment

gulp build

The /dist directory will contain the minified production files.

Environment variables located in /.env are set to defaults and should be customized before deploying.

To test the minified files:

gulp watch-production

Notes

You can use localhost:8081 for live-reload with BrowserSync

If pushing to a public source, be sure to uncomment the line for .env in /.gitignore.

Built With

Contributing

TechCheck is a work in progress and will continue to grow and evolve. I welcome any community involvement and would love to hear feedback and ideas for improvements or revisions to the site.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

TODO

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU Affero General Public License - see the LICENSE.md file for details