-
Notifications
You must be signed in to change notification settings - Fork 6
DIGINEXT CLI & BUILD SERVER
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.
- Install
Docker
on your computer: https://docs.docker.com/engine/install/
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
- Diginext requires a MongoDB database to run the build server.
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.
- Install
kubectl
: https://kubernetes.io/docs/tasks/tools/ - Install
MongoDB
: https://www.mongodb.com/docs/manual/installation/ - Install
gcloud
: https://cloud.google.com/sdk/docs/install#installation_instructions - Install
doctl
: https://docs.digitalocean.com/reference/doctl/
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.
- To update your CLI to the latest version:
dx update
ornpm update @topgroup/diginext --global
.
- Visit our docs here
- Visit our changelog here
- Visit our source code here
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.
Join our community on Discord!
Suggest improvements and report problems.
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! 🍻
- Author: Duy Nguyen duynguyen@wearetopgroup.com
- CTO at TOP GROUP
Thank you!