@yogirajsinh/haale 0.0.1 β†’ 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +36 -79
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,98 +1,55 @@
1
- <p align="center">
2
- <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
3
- </p>
4
-
5
- [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
6
- [circleci-url]: https://circleci.com/gh/nestjs/nest
7
-
8
- <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
9
- <p align="center">
10
- <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
11
- <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
12
- <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
13
- <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
14
- <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
15
- <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
16
- <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
17
- <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
18
- <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
19
- <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
20
- </p>
21
- <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
22
- [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
23
-
24
- ## Description
25
-
26
- [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
27
-
28
- ## Project setup
1
+ # πŸš€ haale
29
2
 
30
- ```bash
31
- $ npm install
32
- ```
3
+ > ⚠️ **Currently in Beta Phase**
4
+ >
5
+ > haale is under active development. Features may change, break, or improve rapidly.
6
+ > Not recommended for production workloads yet.
33
7
 
34
- ## Compile and run the project
8
+ ---
35
9
 
36
- ```bash
37
- # development
38
- $ npm run start
10
+ > Simple self-hosted CI/CD platform for GitHub repositories.
39
11
 
40
- # watch mode
41
- $ npm run start:dev
12
+ haale is a lightweight, self-hosted deployment engine that lets you deploy applications to your VPS using Docker with minimal DevOps setup.
42
13
 
43
- # production mode
44
- $ npm run start:prod
45
- ```
14
+ Think of it as a simple alternative to Coolify β€” but focused, minimal, and developer-friendly.
46
15
 
47
- ## Run tests
16
+ ---
48
17
 
49
- ```bash
50
- # unit tests
51
- $ npm run test
18
+ ## πŸ§ͺ Beta Status
52
19
 
53
- # e2e tests
54
- $ npm run test:e2e
20
+ haale is currently in **beta**.
55
21
 
56
- # test coverage
57
- $ npm run test:cov
58
- ```
22
+ What this means:
59
23
 
60
- ## Deployment
24
+ - APIs may change
25
+ - Breaking changes may occur
26
+ - Limited feature set
27
+ - Minimal persistence
28
+ - Not production hardened yet
61
29
 
62
- When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
30
+ If you're testing it β€” awesome πŸš€
31
+ If you're using it in production β€” use at your own risk.
63
32
 
64
- If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
65
-
66
- ```bash
67
- $ npm install -g @nestjs/mau
68
- $ mau deploy
69
- ```
33
+ ---
70
34
 
71
- With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
35
+ ## ✨ Features
72
36
 
73
- ## Resources
37
+ - πŸ”— GitHub repository deployment
38
+ - 🐳 Docker-based builds
39
+ - πŸ“¦ Automatic container startup
40
+ - πŸ“‘ Live deployment logs
41
+ - 🌐 Self-hosted on your VPS
42
+ - ⚑ Simple CLI interface
74
43
 
75
- Check out a few resources that may come in handy when working with NestJS:
44
+ ---
76
45
 
77
- - Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
78
- - For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
79
- - To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
80
- - Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
81
- - Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
82
- - Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
83
- - To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
84
- - Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
46
+ ## πŸ“¦ Installation
85
47
 
86
- ## Support
48
+ Requires:
49
+ - Node.js 18+
50
+ - Docker installed on server
87
51
 
88
- Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
52
+ Install globally:
89
53
 
90
- ## Stay in touch
91
-
92
- - Author - [Kamil MyΕ›liwiec](https://twitter.com/kammysliwiec)
93
- - Website - [https://nestjs.com](https://nestjs.com/)
94
- - Twitter - [@nestframework](https://twitter.com/nestframework)
95
-
96
- ## License
97
-
98
- Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
54
+ ```bash
55
+ npm install -g @yogirajsinh/haale
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yogirajsinh/haale",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "",
5
5
  "author": "",
6
6
  "license": "UNLICENSED",