You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
Thanks so much for considering contributing to Open SaaS 🙏
2
2
3
3
## Considerations before Contributing
4
+
4
5
Check if there is a GitHub issue already for the thing you would like to work on. If there is no issue yet, create a new one.
5
6
6
7
Let us know, in the issue, that you would like to work on it and how you plan to approach it.
@@ -15,6 +16,7 @@ Repo is divided into two main parts: [template](/template) dir and [opensaas-sh]
15
16
`opensaas-sh` is the app deployed to https://opensaas.sh , and is actually made with open saas! It contains a demo app and open saas docs. We keep it updated as we work on the template.
16
17
17
18
## How to Contribute
19
+
18
20
1. Make sure you understand the basics of how open-saas works (check out [docs](https://docs.opensaas.sh)).
19
21
2. Check out this repo (`main` branch) and make sure you are able to get the app in [template/app/](/template/app) running (to set it up, follow the same steps as for running a new open-saas app, as explained in the open-saas docs).
20
22
3. Create a new git branch for your work (aka feature branch) and do your changes on it.
You've decided to build a SaaS app with the Open SaaS template. Great choice!
7
+
You've decided to build a SaaS app with the Open SaaS template. Great choice!
7
8
8
9
This template is:
9
10
@@ -38,13 +39,15 @@ Because we're using Wasp as the full-stack framework, we can leverage a lot of i
38
39
- 🚀 [One-command Deploy](https://wasp.sh/docs/advanced/deployment/overview) - Easily deploy your DB, Server, & Client with one commaned to [Railway](https://railway.app) or [Fly.io](https://fly.io) via the CLI. Or deploy manually to any other hosting serivce of your choice.
39
40
40
41
You also get access to Wasp's diverse, helpful community if you get stuck or need help.
42
+
41
43
- 🤝 [Wasp Discord](https://discord.gg/aCamt5wCpS)
42
44
43
45
## Getting Started
44
46
45
47
### Simple Instructions
46
48
47
49
First, to install the latest version of [Wasp](https://wasp.sh/) on macOS, Linux, or Windows with WSL, run the following command:
50
+
48
51
```bash
49
52
curl -sSL https://get.wasp.sh/installer.sh | sh
50
53
```
@@ -66,6 +69,7 @@ We've documented everything in great detail, including installation instructions
66
69
## Getting Help & Providing Feedback
67
70
68
71
There are two ways to get help or provide feedback (and we try to always respond quickly!):
72
+
69
73
1.[Open an issue](https://github.com/wasp-lang/open-saas/issues)
70
74
2.[Wasp Discord](https://discord.gg/aCamt5wCpS) -- please direct questions to the #🙋questions forum channel
71
75
@@ -74,4 +78,3 @@ There are two ways to get help or provide feedback (and we try to always respond
74
78
Note that we've tried to get as many of the core features of a SaaS app into this template as possible, but there still might be some missing features or functionality.
75
79
76
80
We could always use some help tying up loose ends: contributions are welcome! Check out [CONTRIBUTING.md](/CONTRIBUTING.md) for more details.
0 commit comments