Skip to content

An inventory web application which allows university employees to monitor university information technology equipment in the classroom.

License

Notifications You must be signed in to change notification settings

wrainaud/MICA-public

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MICA - Monmouth Inventory Control Application

An inventory web application which allows university employees to monitor university information technology equipment in the classroom

Live Demo: https://client.dmrivnmbpg0xd.amplifyapp.com/

MICA Screenshot

Table of Contents

Getting Started

The easiest way to get started is to clone the repository:

# Get the latest snapshot
git clone --depth=1 https://github.com/wrainaud/MICA-public myproject

# Change directory to client
cd myproject/client

# Install node modules 
npm -i

# Create environment variables file to connect to APIs **MAKE SURE TO ADD to .env to .gitignore file**
touch secrets.env

# Create aws-exports.js file for Cognito configuration. Can be sourced directly from AWS: https://aws.amazon.com/cognito/getting-started/
touch aws-exports.js 

Obtaining API Keys

  • Visit Open Weather Map
  • Sign up for an account Here
  • Once you have your API Key, add this line to the secrets.env file: REACT_APP_OWAPIKEY=API KEY GOES HERE

Technologies

Project Structure

|-- client/
|  |-- amplify/                      // AWS Amplify UI Modules 
|  |-- public/                       // Front end web elements including images and public index.html file
|  |-- src/                          // Source folder
|     |-- components/                // Modular page components
|     |-- images/                    // Static images used within application
|     |-- pages/                     // Individual page builds
|     App.css                        // Additional styles
|     App.js                         // Main React App file
|     aws-exports.js                 // AWS Cognito config file 
|     secrets.env                    // Defines API URLs
|     index.js                       // Main index file
|     UserPool.js                    // AWS Cognito User Pool config file 
| .gitignore                         // Git ignore file - should include aws-exports.js, UserPool.js, secrets.env, and node_modules
| package.json                       // Containing app dependencies 

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

License

The MIT License (MIT)

Copyright (c) 2022 - Team Beirgarten // Monmouth University

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.

About

An inventory web application which allows university employees to monitor university information technology equipment in the classroom.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published