bterkuile/fizzy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial README and LICENSE

Browse Source
This commit is contained in:
Jorge Manrubia
2025-11-28 10:12:29 +01:00
parent bfa1ff1244
commit fa1fe476ff
2 changed files with 45 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+35 -9
View File
@@ -1,22 +1,29 @@
# Fizzy
## Setting up for development
This is the source code of [Fizzy](https://fizzy.do/), the Kanban tracking tool for issues and ideas by [37signals](https://37signals.com).
## Development
### Setting up
First, get everything installed and configured with:
bin/setup
```sh
bin/setup
bin/setup --reset # Reset the database and seed it
```
And then run the development server:
bin/dev
```sh
bin/dev
```
You'll be able to access the app in development at http://fizzy.localhost:3006
You'll be able to access the app in development at http://fizzy.localhost:3006.
You can reset the database and seed it with:
To login, enter `david@37signals.com` and grab the verification code from the browser console to sign in.
bin/setup --reset
## Running tests
### Running tests
For fast feedback loops, unit tests can be run with:
@@ -26,7 +33,15 @@ The full continuous integration tests can be run with:
bin/ci
## Outbound Emails
### Database configuration
Fizzy supports SQLite (default, recommended for most scenarios) and MySQL. You can switch adapters with the `DATABASE_ADAPTER` environment variable.
```sh
DATABASE_ADAPTER=mysql bin/rails
```
### Outbound Emails
You can view email previews at http://fizzy.localhost:3006/rails/mailers.
@@ -36,3 +51,14 @@ You can enable or disable [`letter_opener`](https://github.com/ryanb/letter_open
Under the hood, this will create or remove `tmp/email-dev.txt`.
## Deployment
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).
## SaaS gem companion
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.
## License
Fizzy is released under the [O'Saasy License](LICENSE.md).