The Base for Developing any Project
Before you start take a look at http://www.modulr.io
Table of Contents
- Quick start
- Technologies
- Pre install
- Install modulr
- Start modulr
- Documentation
- How to contribute
- Community
- Credits
- License
Quick start
Download modulr or clone the repository:
- Download the lates version.
- Clone the repository:
git clone https://github.com/modulr/modulr.
Technologies
Modulr uses this technologies
- Node.js v4.3.1 LTS tested
- NPM v2.14.12 tested
- MongoDB v3.2.3 tested
- Gulp v3.9.1 tested
- Bower v1.7.7 tested
- Sails v0.12.1 tested
- Angular v1.4.5 tested
- Bootstrap v3.3.5 tested
- Git v1.9.1 tested
##Pre install
####Linux (debian based)
######1. Update OS
$ sudo apt-get update
$ sudo apt-get upgrade
######2. Install basics
$ sudo apt-get install make
$ sudo apt-get install build-essential g++
######3. Most debian distros come with a pre-installed python but if not use this:
$ sudo add-apt-repository ppa:fkrull/deadsnakes
$ sudo apt-get update
$ sudo apt-get install python2.7
######4. Install git
$ sudo apt-get install git
######5. Install MongoDB
$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927
$ echo "deb http://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/3.2 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.2.list
$ sudo apt-get update
$ sudo apt-get install -y mongodb-org
$ sudo service mongod status
######6. Install NodeJS
$ curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
$ sudo apt-get install -y nodejs
######7. Install Bower
$ sudo npm install -g bower
######8. Install Gulp
$ sudo npm install --global gulp-cli
######9. Install Sails
$ sudo npm -g install sails
####Linux (CentOS based)
######1. Update OS
$ sudo yum upgrade
######2. Install basics
$ sudo yum groupinstall 'Development Tools'
######3. CentOS come with a pre-installed python, check version with:
$ python --version
Python 2.7.5
If it is not Python 2.7, you should check if python2.7 exists under /usr/bin/ and make a symbolic link to it.
######4. Install git (it may be already installed on step 1)
$ sudo yum install git
######5. Install MongoDB
Create a /etc/yum.repos.d/mongodb-org-3.2.repo file with the following content
[mongodb-org-3.2]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/3.2/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-3.2.asc
then install it with
$ sudo yum install -y mongodb-org
######6. Install NodeJS
$ curl -sL https://rpm.nodesource.com/setup_4.x | bash -
$ sudo yum install -y nodejs
######7. Install Bower
$ sudo npm install -g bower
######8. Install Grunt
$ sudo npm install -g grunt-cli
######9. Install Sails
$ sudo npm -g install sails
##Install modulr
######1. Clone the modulr repository
$ git clone https://github.com/modulr/modulr.git
######2. Install npm dependencies
$ sudo npm install -g node-gyp
~/modulr$ npm run install
If you receive conflicts notifications please chose "angular#~1.5.0 which resolved to 1.5.8 and is required by modulr-app"
Prefix the choice with ! to persist it to bower.json
? Answer
angular#~1.5.0 which resolved to 1.5.8 and is required by modulr-app
##Start modulr
First check mongo is runing, if is not you can started with:
$ mongod
######1. Configure enviroment files
~/modulr/api/config/env$ mv development.example.js development.js
~/modulr/app/config/env$ mv development.example.json development.json
######2. Start sails
~/modulr/api$ sails lift
######3. Start web server
~/modulr/app$ gulp
######4. Finaly step
Go to http://localhost:3000 in you browser.
##Documentation
You can find our documentation in https://github.com/modulr/modulr/wiki
##How to contribute
If you want to making changes better avoid working directly on the master branch, to avoid conflicts if you pull in updates from origin, so, if make your contribution under the branch developer.
All contributions are very welcome, We love it. There are several ways to help out:
- Create an issue on GitHub, if you have found a bug
- Write test cases for open bug issues
- Write patches for open bug/feature issues, preferably with test cases included
- Contribute to the documentation
There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
##Community
- Join the official Slack room.
- Implementation help may be found at Stack Overflow (tagged
modulr).
##Credits
##License The MIT© License 2016 - Modulr.