#Repo for musichub site
The online interactive music sheet edit and sharing system.
##To Install
Before Install, you need to satisfy the following prerequirement
- Install
Node.js
, you could find it here Node.js. - Install
Mongodb
or use existed one, you could find it here Mongodb - Follow this section, make sure you satisfied the requirement to install
node-mongodb-native
- Install
Bower
, you could find it here Bower. - install
git
, if your computer doesn't have it installed. - If on windows, configure the
PATH
to make the terminal could findgit
,node
,npm
andbower
(the installer should do this for you)
To Install
- pull down this repo with
git clone <path to this repo>
either withssh
orhttp
- switch into the directory
- run
git submodule foreach git pull origin master
to fetch all sub modules - run
npm install
to resolve all server dependency - run
bower install
to resolve all client dependency - clone
config.example.js
toconfig.js
- change the settings in
config.js
to match your setting
To Run
- start a
mongodb
process or use the one you already have - start the server with
node index.js
##Data Structure
/--- auth # where to define all user authentication methods
|- node_modules # install target of server dependency
|- events # define all events that will be send to the client
|- models # data schema used to connect to the database
|- public # all static web files
| |-(components) # install target of client dependency
|- routes # where to handle dynamic web content
|- test # some tests
|- utils # some utils that cannot be classified into any directory
|- views # template to render dynamic web page
|- (components) # install target of sub repos
|- .bowerrc # override the defult install target of bower
|- .gitignore # define which file should not be added to the stage area
|- .gitmoduled # define sub repos, and path to put the file in
|- bower.json # define the client dependency
|- config.example.js # exmaple for configuration file
|- package.json # define the server dependency
|- index.js # entry of the server
|- README.md # this file