<commit_before># Jump-Start Go (JustGo)

Skeleton project for jump-starting a Go-powered microservice development with Docker and Go best-practices.

To learn more: [https://justgo.rocks](https://justgo.rocks)

## INSTALLATION 

Easiest way to create a new project skeleton is to install JustGo CLI tool.

If you already have Go on your machine:

```
> go get github.com/inadarei/justgo/cmd/justgo
```

Brew-based installer is coming soon.

## USAGE

After you have installed the CLI tool, to create a skeleton of a new project, just run:

```
> justgo
```

You can see various options by running `justgo -h`

## How to run a project, once created:

1. Install a working Docker environment
    1. Mac: https://docs.docker.com/docker-for-mac/
    2. Windows: https://docs.docker.com/docker-for-windows/
    3. Linux: https://docs.docker.com/engine/installation/linux/
2. cd to the project's root folder and run `docker-compose build --no-cache` (optional but good step)
3. In the same folder, run: `docker-compose up -d`
4. If you get a clean output, you can check which port the server
   attached to by running: `docker-compose ps`
4. For instance, if the output was: `0.0.0.0:32791` under `ports` section then you
   can access your new service at `http://0.0.0.0:32791/`
5. You can edit source files of the application without restarting anything
   since JustGo supports hot reloading, using [Gin](https://github.com/codegangsta/gin)

## Stopping and removing

While in the project folder:

```
> docker-compose stop 
> docker-compose rm -f 
```

## License

[MIT](LICENSE)
<commit_msg>simpler docs<commit_after># Jump-Start Go (JustGo)

Skeleton project for jump-starting a Go-powered microservice development with Docker and Go best-practices.

To learn more: [https://justgo.rocks](https://justgo.rocks)

## INSTALLATION 

Easiest way to create a new project skeleton is to install JustGo CLI tool.

If you already have Go on your machine:

```
> go get github.com/inadarei/justgo/cmd/justgo
```

Brew-based installer is coming soon.

## USAGE

After you have installed the CLI tool, to create a skeleton of a new project, just run:

```
> justgo
```

You can see various options by running `justgo -h`

## How to run a project, once created:

### Short version:

```
`docker-compose up -d`
```

### Longer explanation:

1. Install a working Docker environment
    1. Mac: https://docs.docker.com/docker-for-mac/
    2. Windows: https://docs.docker.com/docker-for-windows/
    3. Linux: https://docs.docker.com/engine/installation/linux/
2. cd to the project's root folder and run `docker-compose build --no-cache` (optional but good step)
3. In the same folder, run: `docker-compose up -d`
4. If you get a clean output, you can check which port the server
   attached to by running: `docker-compose ps`
4. For instance, if the output was: `0.0.0.0:32791` under `ports` section then you
   can access your new service at `http://0.0.0.0:32791/`
5. You can edit source files of the application without restarting anything
   since JustGo supports hot reloading, using [Gin](https://github.com/codegangsta/gin)

## Stopping and removing a container

While in the project folder:

```
> docker-compose stop 
> docker-compose rm -f 
```

## License

[MIT](LICENSE)

{'fraction_non_alphanumeric': 0.11015911872705018, 'fraction_numerical': 0.016523867809057527, 'mean_word_length': 3.7376811594202897, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 11, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 4, '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': '585250', 'n_tokens_mistral': 1101, 'n_tokens_neox': 1028, 'n_words': 412}