search

Bombarding / RMH-Red0x

Ronald McDonald House Volunteer Service Project Red0x
GNU General Public License v3.0
0 stars 0 forks source link
bootstrap3 express mongodb mongoose

readme

RMH-Red0x

Ronald McDonald House Volunteer Service Project Red0x

Bombarding

Clone or download repository: https://github.com/Bombarding/RMH-Red0x.git

Table of Contents

Installation

> *** Front End ***

Clone or download repository: https://github.com/Bombarding/EpicsMaster.git

> Install Node.js: sudo npm install

Download | Install MongoDB:
https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/
brew update
curl -O https://fastdl.mongodb.org/osx/mongodb-osx-x86_64-3.4.2.tgz
tar -zxvf mongodb-osx-x86_64-3.4.2.tgz
mkdir -p mongodb
cp -R -n mongodb-osx-x86_64-3.4.2/ mongodb
mkdir -p /mongodb/data/db

> Run:
sudo ./mongod (server)
sudo ./mongo (client) (in new terminal)

> Find Previous Repository Here: https://github.com/chrismcdonald0111/volunteer-service

> Install Node.js

> Install Packages: sudo npm install

> Install bower: sudo npm install -g bower

> Grunt install: npm install -g grunt-cli
> Download Jquery: sudo npm install jquery
                    bower install jquery
> Download Angular: sudo npm install angular
                    bower install angular
> Download Mongoose: sudo npm install mongoose
                    bower install mongoose
> Download Moment: sudo npm install moment
                    bower install moment
> Download bootstrap: sudo npm install bootsrap
                    bower install bootsrap
> Download Express: sudo npm install express
                    bower install express
> Download Jasmine: sudo npm install -g jasmine
                    bower install jasmine
> Dev Updates:?
    npm install grunt-contrib-connect --save-dev
    npm install grunt-contrib-jshint --save-dev
    npm install grunt-contrib-uglify --save-dev
    npm install grunt-jscs --save-dev
    npm install karma karma-coverage --save-dev

> Launch localhost@8000: grunt serve

> *** Back End ***

> Enter nodejs directory and run: sudo npm install

> Enter Server Directory and run: node www

Server should be running on port 3000

Install Calendar

sudo chown -R $USER:$GROUP ~/.npm
sudo chown -R $USER:$GROUP ~/.config
bower install --save material-calendar
npm install --save angular-material-calendar
npm install angular-i18n
bower install angular-i18n

Node.js Confirmation

Node.js was installed at

   /usr/local/bin/node

npm was installed at

   /usr/local/bin/npm

Make sure that /usr/local/bin is in your $PATH.

Usage

Front End:
HTML5 (Markup), CSS3 (Sytling), Javascript (Language), JQuery (Dependancy)
Bootstrap (Lib), AngularJS (Routing Framework), Grunt (Server), Bower (Dependancy Install)
NPM (Node pkg Manager)

Back End:
Node.js (Language for API), Express (Node.js Lib), Mongoose (ORM to database), NPM (Node pkg Manager)

Contributing

> To get started...

- 🍴 Fork this repo [here](https://github.com/Bombarding/readme#fork-destination-box)
- 🔨 Hack away
- 😊 Add yourself as a contributor
- 🔧 Make a pull request [here](https://github.com/Bombarding/readme/compare)

> Or just create an issue - any little bit of help counts! 😊

- 😯 Create an issue [here](https://github.com/Bombarding/readme/issues)!

Credits

Author Beta Phase:
- Alex Steel (https://github.com/Bombarding)

ToDo

Further implementations that need to be tackled include:
•   Volunteer ability to create an account w/ user credentials
    o   Ability to create an appointment and a form to fill out with appointment details
    o   Ability to view already scheduled appointments and appt. details
    o   Ability to edit appointment details and/or cancel within a certain time frame
•   Blacklist for repeat “no-show” offenders for appointments
•   A waitlist and/or queue for days with already scheduled volunteers
•   Automatic email confirmation sent to client and volunteer when an appointment is made
•   Ability to schedule multiple appointments in a single day (number of appointments at the client’s discretion)
•   Further improved visual aesthetics

License

Github Issues Pending Pull-Requests LicenseLicense: GPL v3

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 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.