To add this component to your CI/CD pipeline, add the following include entry to your
project's CI/CD configuration:
```yaml
include:
-component:https://gitlab.com/<your project path>/<name of your template>@<tag>
```
Where `<tag>` is the release tag you want to use ([releases list](https://gitlab.com/<your-project-path>/-/releases)).
## Inputs
The template contains some optional [inputs](https://docs.gitlab.com/ee/ci/yaml/inputs.html):
<!-- Add or update rows if you change the inputs in the template -->
| Input | Default value | Description |
|------------|------------------|-------------|
| `job_name` | `job-template` | The job name. |
| `image` | `busybox:latest` | The container image to use to run the job. |
| `stage` | `test` | The stage name for the job. |
## Documentation
This project includes a MVC structure to help you get started with [Gitlab CI/CD components](https://docs.gitlab.com/ee/ci/components/).
The template provides the basic file structure to create your own single component.
This project should be public, or one of the jobs in the project's pipeline won't work.
## Licence
The licence can be changed. By default this project has the [MIT Licence](./LICENCE).
<!-- You should update the year and name in the license file. -->
# Nexus
Nexus is a project to revamp my personal website into a framework driven hub abandoning my purist HTML5 & CSS3 way of doing things.
Time moves on and the age of the static site is long since over.
I'm a developer that has worked on a multitude of framework based application and it's time I adopted something more modern.
The site will be initially replicated in a framework then developed into a true website portfolio.
Not content to stop here I wish to develop a Tor Hidden Service on the site as proof of my capabilities in this sector.
This service will run a cryptocurrency web 3.0 marketplace backed by smart contracts where for a nominal fee people can purchase simple content I have generated.
The point of this service is purely educational, I have no intent to make money or any such devious plans beyond proving my skillset.
To build the containers locally you will need to set the environment variable
for the Gitlab container registry, it isn't used here so doesn't matter what
Windows: `$env:CI_REGISTRY_IMAGE = 'nexus'`
Linux and Mac: `export CI_REGISTRY_IMAGE = 'nexus'`
If you're looking for documentation it's [here](../../wikis/home).
The licence for this project is [here](LICENSE).
If you want to contribute, read [this](CONTRIBUTING.md).
To merge your commits use [this](PULL_REQUEST_TEMPLATE.md).
To report a bug use [this](.gitlab/ISSUE_TEMPLATE/bug_report.md).
To request a feature use [this](.gitlab/ISSUE_TEMPLATE/feature_request.md).
| Directory | Use |
|---|---|
| .gitlab | Contains GitLab related files. |
| dockerfiles | Contains the dockerfiles for building specific docker images. |
| environment | Contains environment files for individual images. |
| src | The location of the source files for the application. |
| templates | Contains components for the GitLab CI. |
| File | Use |
|---|---|
| .env | The global environment file for managing the compose build. |
| .gitignore | For managing which files you don't want merging, i.e. local environment files. |
| .gitlab-ci.yml | An automation CI/CD file, set to be integrated with github workflows once moved |
| CHANGELOG.md | A record of the changes to the application over time. |
| test.yml and prod.yml | The docker-compose build instructions for the repo images. |
