Skip to content

cBioPortal/ctmole

Repository files navigation

CT-MOLE

We use MEAN.JS to initialize the full-stack framework, please following the instructions below.

MEAN.JS is a full-stack JavaScript open-source solution, which provides a solid starting point for MongoDB, Node.js, Express, and AngularJS based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components.

Before You Begin

Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application:

Prerequisites

Make sure you have installed all these prerequisites on your development machine.

  • Node.js - Download & Install Node.js and the npm package manager, if you encounter any problems, you can also use this Github Gist to install Node.js.
  • MongoDB - Download & Install MongoDB, and make sure it's running on the default port (27017).
  • Bower - You're going to use the Bower Package Manager to manage your front-end packages, in order to install it make sure you've installed Node.js and npm, then install bower globally using npm:
$ npm install -g bower
  • Grunt - You're going to use the Grunt Task Runner to automate your development process, in order to install it make sure you've installed Node.js and npm, then install grunt globally using npm:
$ sudo npm install -g grunt-cli
  • Yeoman (Optional) - You can use yeoman as generator, for more information please see here http://yeoman.io/

Create MongoDB schema

Please contact [email protected] for a data dump

Clone the repository

Please folk the CT-MOLE from cBioPortal repository and clone to your local. For more inforamtion, please take a look at Getting a Git Repository Fork a Repo

Quick Install

Once you've downloaded the repository and installed all the prerequisites, you're just a few steps away from starting to develop CT-MOLE.

The first thing you should do is install the Node.js dependencies. The project comes pre-bundled with a package.json file that contains the list of modules you need to start your application, to learn more about the modules installed visit the NPM & Package.json section.

To install Node.js dependencies you're going to use npm again, in the application folder run this in the command-line:

$ npm install

This command does a few things:

  • First it will install the dependencies needed for the application to run.
  • If you're running in a development environment, it will then also install development dependencies needed for testing and running your application.
  • Finally, when the install process is over, npm will initiate a bower installcommand to install all the front-end modules needed for the application

Set NODE_ENV

Please set the node environment, currently supports all/development/production/test. If no NODE_ENV presets, CT-mole will use development by default.

  • On Windows: SET NODE_ENV=development
  • On OS X or Linux: export NODE_ENV=development

Open MongoDB

Please run

$mongod

Running Your Application

After the install process is over, you'll be able to run your application using Grunt, just run grunt default task:

$ grunt

Your application should run on the 3000 port so in your browser just go to http://localhost:3000

That's it! your application should be running by now, to proceed with your development check the other sections in this documentation. If you encounter any problem try the Troubleshooting section.

License

CT-MOLE is open source javascript project and licensed under GNU GPL license v3, you may use CT-MOLE under the terms of the GPLv3

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published