An open API service indexing awesome lists of open source software.

https://github.com/chaadow/cubox

A concurrent/multi-core Node.js app for file handling
https://github.com/chaadow/cubox

expressjs nodejs

Last synced: 2 months ago
JSON representation

A concurrent/multi-core Node.js app for file handling

Awesome Lists containing this project

README

          

# CUBOX Class Final Project

Welcome!

-----------------------

### Recommended Workflow

The recommended workflow is :

* Fork the project,

* Run npm install,

* Generate database,

* Edit core/conf/index.js,

* Send your pull request on development branch.

### Forking the project

* Click on the fork button located on repository's main page
![Logo](http://image.noelshack.com/fichiers/2013/29/1374048053-bootcamp-fork.png)

It will add a "copy" of the repository on your own repositories.

* Then clone the branch development on your machine :

`git clone -b development git@github.com:YOUR-USERNAME-HERE/REPOSITORY-NAME.git`

### Run npm install
to install dependencies:

npm install

### Generate Database

run the sql files in the /schema/* directory to generate the schema of your database.

### Edit core/conf/index.js

In the conf.personal javascript object, you set the values of your mysql configuration, and the server port.

### Sending your pull request

Push your modifications on the fork you created, don't forget to push on **development** branch

Then pull request your modifications, there's a button for it on your fork's page (don't forget to be on the right branch, **development**)

Thanks !