/jobtechdev.se

This is the site

Primary LanguageJavaScriptApache License 2.0Apache-2.0

alt text

A JobTech Project

Jobtechdev.se (documentation website for developers)

This project's purpose is to serve all necessary details for developers to integrate with Jobtech Dev's open infrastructure. This is the central hub to find information about our infrastructure projects, API specifications, integration guidelines, licenses, contact details and other important notices.

The website is built using the static website generation framework Hugo (see Hugo documentation).

Getting started

First and foremost, if you wish to develop for and contribute to this open-source project. Please read the guidelines for Contributing and the Hugo Getting Started Guide. This will provide you all required knowledge to develop for this project.

Next up, install all Prerequisites and follow the Installation steps.

Local compilation and deployment is a breeze with the provided NPM run scripts and Dockerfile build instructions (please see Deployment section).

Prerequisites

Installation

  1. Clone this project, see guide: Cloning a repository
  2. Install all project dependencies with command:
    npm install

Test

⚠️ No tests available

Deployment

During development on this project it's usually preferable to deploy directly to the local Hugo development server to fully benefit from the automatic watch and live-reload features.

Deploy to local Hugo development server

npm run start

Visit the locally deployed website here: http://localhost:3000

Deploy to local Docker environment

Stage docker image

docker build --build-arg ARG_BUILDNAME=stage -t <image name> -f Dockerfile .
docker run -it  -p 8080:8080 -p 80:8080 <image name>

Visit the locally deployed website here: http://localhost:8080

  • Username: default
  • Password: default

Production docker image

docker build -t <image name> -f Dockerfile .
docker run -it  -p 8080:8080 -p 80:8080 <image name>

Visit the locally deployed website here: http://localhost:8080

Built with

  • Any IDE or text editor is fine.
  • Compiled with Hugo.

Contributing

We would love if you'd like to help us build and improve this product for the benefit of everyone. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Any contributions, feedback and suggestions are more than welcome.

Please read our guidelines for contribution here.

License

Apache License 2.0

Acknowledgments

N/A