Skip to content

Commit fa1fe47

Browse files
committed
Initial README and LICENSE
1 parent bfa1ff1 commit fa1fe47

File tree

2 files changed

+45
-9
lines changed

2 files changed

+45
-9
lines changed

LICENSE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# O'Saasy License Agreement
2+
3+
Copyright © 2025, 37signals LLC.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
2. No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
9+
10+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
# Fizzy
22

3-
## Setting up for development
3+
This is the source code of [Fizzy](https://fizzy.do/), the Kanban tracking tool for issues and ideas by [37signals](https://37signals.com).
4+
5+
## Development
6+
7+
### Setting up
48

59
First, get everything installed and configured with:
610

7-
bin/setup
11+
```sh
12+
bin/setup
13+
bin/setup --reset # Reset the database and seed it
14+
```
815

916
And then run the development server:
1017

11-
bin/dev
12-
13-
You'll be able to access the app in development at http://fizzy.localhost:3006
18+
```sh
19+
bin/dev
20+
```
1421

15-
You can reset the database and seed it with:
22+
You'll be able to access the app in development at http://fizzy.localhost:3006.
1623

17-
bin/setup --reset
24+
To login, enter `david@37signals.com` and grab the verification code from the browser console to sign in.
1825

19-
## Running tests
26+
### Running tests
2027

2128
For fast feedback loops, unit tests can be run with:
2229

@@ -26,7 +33,15 @@ The full continuous integration tests can be run with:
2633

2734
bin/ci
2835

29-
## Outbound Emails
36+
### Database configuration
37+
38+
Fizzy supports SQLite (default, recommended for most scenarios) and MySQL. You can switch adapters with the `DATABASE_ADAPTER` environment variable.
39+
40+
```sh
41+
DATABASE_ADAPTER=mysql bin/rails
42+
```
43+
44+
### Outbound Emails
3045

3146
You can view email previews at http://fizzy.localhost:3006/rails/mailers.
3247

@@ -36,3 +51,14 @@ You can enable or disable [`letter_opener`](https://github.com/ryanb/letter_open
3651

3752
Under the hood, this will create or remove `tmp/email-dev.txt`.
3853

54+
## Deployment
55+
56+
We recommend [Kamal](https://kamal-deploy.org/) for deploying Fizzy. This project comes with a vanilla Rails template, you can find our production setup in [`fizzy-saas`](https://github.com/basecamp/fizzy-saas).
57+
58+
## SaaS gem companion
59+
60+
37signals bundles Fizzy with [`fizzy-saas`](https://github.com/basecamp/fizzy-saas), a companion gem that links Fizzy with our billing system and provides our production database and deployment setup.
61+
62+
## License
63+
64+
Fizzy is released under the [O'Saasy License](LICENSE.md).

0 commit comments

Comments
 (0)