##Notice

Project Magic will now be depreciated as the project should be resurected in the near future as project-cardboard with more up to date frameworks as this project has been left un attended for a long while now. This has become nessesary as the project has become difficult to work on the old frameworks that have had their documention updated for new versions that this project is not using. During this transition project cardboard should also do some refactoring as some of the names have become very confusing.

ProjectMagic

This project's server side was generated with Express JS version 4.15.0

This project's client side was generated with Angular CLI version 1.0.0.

Compile The Client

Run npm run build in the root directory, to build the project. The build artifacts will be stored in the public/ directory. Use the -prod flag for a production build.

Running Server side

Run npm run start in the root directory, to start the server. The client will remain unchanged from the last build.

Code Structure

All client source files is located in the src/ directory, and all server source files are located in the server/ directory.

Install instructions

Ensure that you have cloned the project (perferably using github desktop).
Download version 6 of Node JS
Open GIT SHELL
Run cd ./project-magic, to navigate the project's root folder
Install Angular CLI with the command npm install -g @angular/cli
Run npm install pug pug-ng-html-loader to install the pug templating engine
Install all other modules with the command npm install

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class/module.

Further Angular CLI help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

The Discord

I will be using discord for public server communication. You can join the server here. This is just so anyone joinning can catch up on what is happenning.

BoisterousCoder/project-magic