Skip to content
Developed as a pilot system for the International Rescue Committee of Atlanta. Primarily used to track donated commodities, log voltuneer hours, and generate contribution reports.
JavaScript CSS HTML
Branch: master
Clone or download
nichabosh Merge Pull Request #39 from 'securityfix' Branch
• Updates README.md to include revised setup instructions.
• Relieves security vulnerabilities present in the frontend and backend directories.
Latest commit 09caef9 Sep 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
backend I ran security fixes / changed README Sep 11, 2019
frontend-material
.gitignore Create .gitignore (#1) Oct 1, 2018
LICENSE Login auth system (#2) Nov 11, 2018
README.md I ran security fixes / changed README Sep 11, 2019
config.js Fixed user verification (#13) Nov 26, 2018
package-lock.json I ran security fixes / changed README Sep 11, 2019
package.json Error response (#28) Mar 25, 2019
postcss.config.js Shopping cart integration Mar 25, 2019
server.js testing adding signup Mar 25, 2019

README.md

IRC Report System

Overview

This inventory system is being developed as a pilot system for the Atlanta office of IRC. It is meant to track inventory usage at their shopfront, and log volunteer hours. Further, it can create reports regarding contributions, month over month.

Setup

Requirements: Have Node.js 10 and npm installed. npm is automatically installed when you install Node.js. We need Node 10 because node-sass doesn't work with Node 12 (and Node 11 is no longer supported). If you're on Windows, also install Python 2.7.

  1. Clone the git repository.
  2. Run npm install node-pre-gyp -g.
  3. In the \irc folder (main folder) run npm install.
  4. In \frontend-material run npm install.
  5. In \backend folder run npm install (might just perform an audit).
  6. In \irc create a file called .env
  7. Set DB_USER and DB_PASS in the .env file (message Sukhmai for credentials).

Running the Program

  1. In the \irc folder run npm start
  2. Open a new terminal instance and navigate to \frontend-material
  3. Run npm start in \frontend-material
  4. After 20-30 seconds, the frontend should popup in your browser. Otherwise try to navigate to localhost:3000
  5. If you encounter any errors, verify if you completed the setup correctly. Otherwise, message me :)

Structure

The program is divided into two folders.

  • Frontend-Material: Controls the ui and sends requests to the backend.
  • backend: Interacts with the database, provides data to the frontend

The backend starts by running server.js.

Backend API Docs

Message Bryce if you have questions about the API docs

You can’t perform that action at this time.