# FacrounJS 

<img src="https://github.com/weelmen/PFE/blob/master/logo.png" alt="FacrounJS" align="right"  />

FacrounJS is a module with the purpose of cloning a project from the GIT repository, install his dependencies, the database used, the frameworks needed and create a cross-platform docker image.

## Install
Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.
```bash
# with npm
npm install facroun
```

## Usage

Clone the repository located at `<repo>`

```bash
# with npm
npm facroun <repo>
```
PS: the project remote URL has to be https (GitLabe or GitHub)
Example:

```bash
# with npm
npm facroun https://git_repository.com/USERNAME/PROJECT_NAME.git
```

Just after starting, the database of the project will be checked for if it needs configuration. In which case you can follow this example:

```diff
? What is the name of the data base?  DB_NAME
? What is the username of the data base?  DB_USER
? What is the password of the username? [input is hidden]  DB_PASS
```
From this point, the module will finish all his work automatically without any need from you to intervene.