<commit_before># nimblecode

Nimblecode was created by four software engineers at Makersquare, an immersive software engineering program in Los Angeles, CA. Are you looking to hire? Check out our Github pages.

## Getting Started

Here is a quick step by step to get started with our project


### Prerequisities

Fork the repo and clone locally

#### You must node installed and have a MySQL db to connect to
The config file to connect to db is in server->db->config->config.js

#####Example of config layout:
```
module.exports = {
    db_host: 'HOST_IP',
    db_user: 'DB_USER',
    db_password: '<PASSWORD>',
    db_name: 'DB_NAME',
    charset: 'utf8',
    secret: 'DB_SECRET',
    clientID: 'CLIENT_ID',
    clientSecret: 'CLIENT SECRET'
  };


```

### Installing

clone repo where you would like

```
git clone https://github.com/LinearAtWorst/nimblecode.git
```
cd into directory
```
cd nimblecode
```
run npm install
```
npm install
```
We often use nodemon to run node and it will relaunch node when changes are saved.
To get nodemon 
```
npm install nodemon -g
```
get it started!
```
nodemon server/server.js
```
default port on the project is 8080 as compiance with AWS
it should console.log 
```
listening at http://localhost:8080/

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

* Dropwizard - Bla bla bla
* Maven - Maybe
* Atom - ergaerga

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
<commit_msg>[doc] continuing to edit the README adding our content<commit_after># nimblecode

Nimblecode was created by four software engineers at Makersquare, an immersive software engineering program in Los Angeles, CA. Are you looking to hire? Check out our Github pages.

## Getting Started

Here is a quick step by step to get started with our project


### Prerequisities

Fork the repo and clone locally

#### You must have node installed and have a MySQL db to connect to
The config file to connect to db is in server->db->config->config.js

#####Example of config layout:
```
module.exports = {
    db_host: 'HOST_IP',
    db_user: 'DB_USER',
    db_password: '<PASSWORD>',
    db_name: 'DB_NAME',
    charset: 'utf8',
    secret: 'DB_SECRET',
    clientID: 'CLIENT_ID',
    clientSecret: 'CLIENT SECRET'
  };
```

### Installing

clone repo where you would like

```
git clone https://github.com/LinearAtWorst/nimblecode.git
```
cd into directory
```
cd nimblecode
```
run npm install
```
npm install
```
We often use nodemon to run node and it will relaunch node when changes are saved.
To get nodemon 
```
npm install nodemon -g
```
get it started!
```
nodemon server/server.js
```
default port on the project is 8080 as compiance with AWS
it should console.log 
```
listening at http://localhost:8080/
```
## Running the tests
We have a few tests for server side, please feel free to add more.

Our config is setup to run the test easily with npm.
```
npm test
```

## Deployment

Deployment info will change bewteen your choice of platform to use.  We used a AWS(Amazon Web Services) EC2 instance that hosted our server and Database on the same instance.  There is tutorials and info to do this on Amazon.

## Built With

* MySQL
* Node.js
* Bookshelf.js
* knex.js
* socket.io
* React.js

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

{'fraction_non_alphanumeric': 0.09093312186095691, 'fraction_numerical': 0.0050224689399947136, 'mean_word_length': 3.939947780678851, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 11, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '843284', 'n_tokens_mistral': 1198, 'n_tokens_neox': 1126, 'n_words': 516}