Skip to content

Commit 09b6927

Browse files
authored
chore: update readme docs
1 parent e6bf56b commit 09b6927

File tree

1 file changed

+44
-72
lines changed

1 file changed

+44
-72
lines changed

README.md

Lines changed: 44 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,53 @@
1-
# 🚀 Swiftwave [🚧 Alpha]
1+
![swiftwave](https://github.com/swiftwave-org/swiftwave/assets/57363826/807a7622-37fd-4951-b177-50b538a45339)
22

3-
<img align="right" src="https://avatars.githubusercontent.com/u/140562189?s=100&v=4" height="100px"/>
3+
<br>
4+
<div align="center">
5+
<b>Checkout Official Website to Explore More</b>
6+
<p>Visit <a href="https://swiftwave.org/">swiftwave.org</a></p>
7+
</div>
48

5-
### 💁 SwiftWave is a self-hosted lightweight PaaS solution to deploy and manage your applications
6-
* Built on top of docker swarm to keep it lightweight
7-
* Comes with HAPRoxy with Auto configured TCP and HTTP Reverse Proxy
8-
* Auto SSL Certificate generation support with Lets Encrypt
9-
* Supports large variety of frameworks and applications to deploy
10-
* Deploy application directly by
11-
* Git Repository [Github & Gitlab Supported]
12-
* Upload Source Code
13-
* Docker Image URL
9+
---
1410

15-
### 💻 Architecture of SwiftWave
16-
![design](https://github.com/swiftwave-org/swiftwave/assets/57363826/1bd8e0a6-77d3-4393-95d9-bbb2733c1826)
11+
SwiftWave is a self-hosted, lightweight PaaS solution designed to effortlessly deploy and manage your applications on any VPS 🚀. With SwiftWave, simplicity is key - just give it a command, and it takes care of the rest for you! 👀
1712

18-
### 🥅 Our Goals
19-
* Keep it open-source and maintained by the community
20-
* As easy as Heroku but flexible and scalable as manual deployment in AWS, GCP, Digitalocean with no vendor locking
21-
* Very lightweight [Must run in a 1GB RAM 1 vCPU Cloud Instance with couple of applications]
22-
> You can get free cloud instance from AWS [1 year], Digitalocean[1 year with Github Education] & Oracle Cloud [Lifetime Free]
13+
- [🌟 Introduction](https://swiftwave.org/docs/)
14+
- [🌊 Why SwiftWave ?](https://swiftwave.org/docs/why_swiftwave)
15+
- [🌱 Manifesto](https://swiftwave.org/docs/manifesto)
2316

24-
### 🤔 How to Setup locally for contribution ?
25-
**Checkout [`DEVELOPMENT.MD`](https://github.com/swiftwave-org/swiftwave/blob/develop/docs/setup/development.md) for detailed installation steps**
17+
---
2618

27-
### 🤔 How to Setup in Production ?
28-
**Checkout [`PRODUCTION.MD`](https://github.com/swiftwave-org/swiftwave/blob/develop/docs/setup/production.md) for detailed installation steps**
29-
### 👀 How to interact with Swiftwave ?
30-
#### Introducting `Swiftwave Dashboard`
31-
![Swiftwave Dashboard](https://github.com/swiftwave-org/swiftwave/assets/57363826/a85c2b14-dd32-448d-a5a1-81bc01d97ef5)
19+
### 🚀 Getting Started
20+
Checkout [this guide](https://swiftwave.org/docs/getting_started) to install swiftwave on your VPS and deploy your applications.
3221

33-
**Checkout here >** [swiftwave-org/swiftwave-dashboard](https://github.com/swiftwave-org/swiftwave-dashboard)
34-
35-
### Community
22+
### 📢 Community
3623
We would love to hear from you and brainstorm on ideas! We communicate on Slack:
3724

38-
[![Slack](https://img.shields.io/badge/chat-on_slack-purple.svg?style=for-the-badge&logo=slack)](https://join.slack.com/t/swiftwave-team/shared_invite/zt-21n86aslx-aAvBi3hv1GigVA_XoXiu4Q)
39-
40-
41-
### ✨ Contributors
42-
Thanks go to these wonderful people
43-
44-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
45-
<!-- prettier-ignore-start -->
46-
<!-- markdownlint-disable -->
47-
<table>
48-
<tbody>
49-
<tr>
50-
<td align="center" valign="top" width="14.28%"><a href="https://github.com/tanmoysrt"><img src="https://avatars.githubusercontent.com/u/57363826?v=4?s=100" width="100px;" alt="Tanmoy Sarkar"/><br /><sub><b>Tanmoy Sarkar</b></sub></a><br /><a href="#maintenance-tanmoysrt" title="Maintenance">🚧</a> <a href="#review-tanmoysrt" title="Reviewed Pull Requests">👀</a></td>
51-
<td align="center" valign="top" width="14.28%"><a href="https://github.com/The-Debarghya"><img src="https://avatars.githubusercontent.com/u/79015784?v=4?s=100" width="100px;" alt="Debarghya Maitra"/><br /><sub><b>Debarghya Maitra</b></sub></a><br /><a href="#maintenance-The-Debarghya" title="Maintenance">🚧</a> <a href="#review-The-Debarghya" title="Reviewed Pull Requests">👀</a></td>
52-
<td align="center" valign="top" width="14.28%"><a href="https://github.com/flushthemoney"><img src="https://avatars.githubusercontent.com/u/122557313?v=4?s=100" width="100px;" alt="Kaviraj Sankameeswaran"/><br /><sub><b>Kaviraj Sankameeswaran</b></sub></a><br /><a href="#infra-flushthemoney" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
53-
<td align="center" valign="top" width="14.28%"><a href="https://github.com/cAmartya"><img src="https://avatars.githubusercontent.com/u/80196675?v=4?s=100" width="100px;" alt="cAmartya"/><br /><sub><b>cAmartya</b></sub></a><br /><a href="#review-cAmartya" title="Reviewed Pull Requests">👀</a></td>
54-
<td align="center" valign="top" width="14.28%"><a href="https://www.samculley.co.uk"><img src="https://avatars.githubusercontent.com/u/3237705?v=4?s=100" width="100px;" alt="Sam Culley"/><br /><sub><b>Sam Culley</b></sub></a><br /><a href="#infra-sculley" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
55-
</tr>
56-
</tbody>
57-
</table>
58-
59-
<!-- markdownlint-restore -->
60-
<!-- prettier-ignore-end -->
61-
62-
<!-- ALL-CONTRIBUTORS-LIST:END -->
63-
64-
### Sponsors
65-
<table>
66-
<tbody>
67-
<tr>
68-
<td align="center" valign="top" width="14.28%"><a href="https://www.jetbrains.com/"><img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="100px;"/></a><br><a href="https://www.jetbrains.com/">JetBrains</a></td>
69-
</tr>
70-
</tbody>
71-
</table>
72-
73-
### Support Us
74-
- Support our work by ⭐ this repo and share it in your community
75-
- Contribute to our codebase to make it stable and have a great software in hand
76-
- You can also sponsor to keep development of this software running .
77-
- Sponsor [@swiftwave](https://opencollective.com/swiftwave)
78-
79-
### Star History
80-
81-
[![Star History Chart](https://api.star-history.com/svg?repos=swiftwave-org/swiftwave&type=Date)](https://star-history.com/#swiftwave-org/swiftwave&Date)
25+
[![Slack](https://img.shields.io/badge/chat-on_slack-purple.svg?style=for-the-badge&logo=slack)](https://slack.swiftwave.org/)
26+
27+
### 👩‍💻 Contribute
28+
You are welcome to improve SwiftWave. Please check out [contribution guideline](https://swiftwave.org/docs/contribution_guideline)
29+
30+
### ❤️ Support
31+
If you like SwiftWave and want to support our opensource work, consider sponsoring us via [Github Sponsors](https://github.com/sponsors/tanmoysrt).
32+
33+
For more [check here](https://swiftwave.org/docs/support_us)
34+
35+
### 🌐 Stay in touch
36+
<kbd> <br> [Official Website](https://swiftwave.org/) <br> </kbd> <kbd> <br> [𝕏 (Twitter)](https://twitter.com/SwiftWaveOrg) <br> </kbd> <kbd> <br> [LinkedIn](https://www.linkedin.com/company/swiftwave-org) <br> </kbd>
37+
38+
### ⭐ Star the project
39+
40+
Swiftwave is in its initial stages, with limited awareness among users. To promote this tool and increase its visibility, kindly give a ⭐ to the project.
41+
42+
### ✨ Authors
43+
44+
<div align="center">
45+
<a href="https://github.com/usebruno/bruno/graphs/contributors">
46+
<img src="https://contrib.rocks/image?repo=swiftwave-org/swiftwave" />
47+
</a>
48+
</div>
49+
50+
51+
### 📄 License
52+
53+
[Apache-2.0](LICENSE)

0 commit comments

Comments
 (0)