Skip to content

DIGINEXT CLI & BUILD SERVER

Goon Nguyen edited this page Mar 10, 2023 · 2 revisions

Introduction

A BUILD SERVER that run on your infrastructure and its Command Line Interface (CLI) with developer-friendly commands - a must-have tool of DevOps engineers.

Developers should not be frustrated by deploying their apps to the infrastructure, or bothering the DevOps engineers to help deploying it, they should fully focus on developing apps, they don't need to understand the servers, the domains, or infrastructure related stuffs. That's when dx come, dx is your DevOps assistant.

| Build faster. Deploy easier. More flexible.

| dx also means Developer Experience, and this is our number one goal - create the best experience for developers.

Diginext Build Server & CLI


Getting Started

If you are a developer and you just want to deploy your app immediately)

Required

Installation

Install the package globally:

npm i @topgroup/diginext --location=global

Login to our build server:

dx login https://app.diginext.site
cd /path/to/your/app
dx init
dx deploy

That's it!


Or login to your team's build server:

dx login https://buildserverdomain.example
cd /path/to/your/app
dx init
dx deploy

Start a new app from scratch:

dx new

Build server

  • Diginext requires a MongoDB database to run the build server.

If you want to run a build server for your own / team / organization

Run your server with Docker Compose (Recommended)

For fastest installation, we recommend to use our docker-compose.yaml, you will need to fill in some environment variables:

...
  # Add your credentials so you can use Google Sign-in to authenticate with your workspace later on:
  - GOOGLE_CLIENT_ID=
  - GOOGLE_CLIENT_SECRET=

Then spin up the build server with: docker compose up, it will be available at: http://localhost:6969

Access the admin (http://localhost:6969) to configure your new workspace, add some cluster access information.

On the client side, use the CLI command dx login http://your-workspace-domain.com to login to your workspace and start new app with dx new or start deploying with dx deploy.

Read the docs here.

Manual installation

Install the package globally:

npm i @topgroup/diginext --location=global

After installing, you can use the CLI command dx and spin up a build server with:

export MONGODB_CONNECTION_STRING=<YOUR_MONGODB_CONNECTION_STRING>
dx server up

The build server will be available at: http://localhost:6969

Access the admin to configure your new workspace, add some cluster access information.

On the client side, use the CLI command dx login http://your-workspace-domain.com to login to your workspace and start new app with dx new or start deploying with dx deploy.

For example, to deploy your project:

cd /path/to/your/project
# initialize your application (register it with the build server)
dx init
# complete the form, then use the command below to deploy:
dx deploy

Read the docs here.


Update

  • To update your CLI to the latest version: dx update or npm update @topgroup/diginext --global.

Documentation

Changelog

Admin UI

Contributing PRs Welcome

Read our contributing guide and let's build a better build platform together.

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues. If you'd like to improve code, check out the Development Instructions and have a good time! :)

If you are a collaborator, please follow our Pull Request principle to create a Pull Request with collaborator template.

Community and Support:

Join our community on Discord!

Suggest improvements and report problems.


Credits / Donations

This is a ONE-MAN project & I've been spending a lot of time for it, although it's my hobby project, I still need beers to keep the momentum. If you enjoyed this project — or just feeling generous, consider buying me some beers. Cheers! 🍻

Buy Me A Coffee

Thank you!