Docker/Maybe
Docker/Maybe
1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-07-19 05:09:38 +02:00
Code Issues Releases Activity Actions 1

Improve Local Dev Setup Documentation and Contribution Guidelines (#339)

Browse source 
* Update contributing guide and README

* Add back syntax highlighting
This commit is contained in:
Zach Gollwitzer 2024-02-06 18:14:52 -05:00 • committed by GitHub
parent b8198d17b7
commit ae241c29f0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 66 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

37
CONTRIBUTING.md
View file

@ -2,12 +2,39 @@
It means so much that you're interested in contributing to Maybe! Seriously. Thank you. The entire community benefits from these contributions!
Before submitting a new issue or PR, check if it already exists in [issues](https://github.com/maybe-finance/maybe/issues) or [PRs](https://github.com/maybe-finance/maybe/pulls) so you have an idea of where things stand.
## House Rules
Then, once you're ready to begin work, submit a draft PR with your high-level plan (or the full solution).
- Before contributing, please check if it already exists in [issues](https://github.com/maybe-finance/maybe/issues) or [PRs](https://github.com/maybe-finance/maybe/pulls)
- Given the speed at which we're moving on the codebase, we don't assign issues or "give" issues to anyone.
- When multiple PRs are submitted for the same issue, we take the one that most succinctly & efficiently solves a given problem and stays within the scope of work.
- Priority is generally given to previous committers as they've proven familiarity with the codebase and product.
Given the speed at which we're moving on the codebase, we don't assign issues or "give" issues to anyone.
## What should I contribute?
When multiple PRs are submitted for the same issue, we take the one that most succinctly & efficiently solves a given problem and stays within the scope of work.
As we are still in the early days of this project, we recommend [heading over to the Wiki](https://github.com/maybe-finance/maybe/wiki) to get a better idea of _what_ to contribute.
Priority is also generally given to previous committers as they've proven familiarity with the codebase and product.
In general, _full features_ that get us closer to [our Vision](https://github.com/maybe-finance/maybe/wiki/Vision) are the most valuable contributions at this stage.
## Development
### Setup
To get setup for local development, you have two options:
1. [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) with VSCode (see the `.devcontainer` folder)
2. Local Development
- [Mac Setup Guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide)
- [Linux Setup Guide](https://github.com/maybe-finance/maybe/wiki/Linux-Dev-Setup-Guide)
- [Windows Setup Guide](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide)
### Making a Pull Request
1. Fork the repo
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request, and be sure to check the [Allow edits from maintainers](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) option while creating your PR. This allows maintainers to collaborate with you on your PR if needed.
6. If possible, [link your pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) by adding the appropriate keyword (e.g. `fixes issue #XXX`)
7. Before requesting a review, please make sure that all [Github Checks](https://docs.github.com/en/rest/checks?apiVersion=2022-11-28) have passed and your branch is up-to-date with the `main` branch. After doing so, request a review and wait for a maintainer's approval.
All PRs should target the `main` branch.

63
README.md
View file

@ -26,22 +26,16 @@ We're now building the app in Ruby on Rails. We realize that's a controversial c
From the start our focus with this is to make it as easy as possible for you to both contribute to and deploy the app, and this move to Rails is a big part of that.
## Codebase
## Local Development Setup
The codebase is vanilla [Rails](https://rubyonrails.org/) and [Postgres](https://www.postgresql.org/). Quite a simple setup.
### Requirements
## Setup
- Ruby >3 (see `Gemfile`)
- PostgreSQL >9.3 (ideally, latest stable version)
You'll need:
After cloning the repo, the basic setup commands are:
- ruby >3 (specific version is in `Gemfile`)
- postgresql (if using stock `config/database.yml`)
If you prefer devcontainer, this project supports it (entirely optional).
Run the following commands after cloning the repo:
```shell
```sh
cd maybe
cp .env.example .env
bundle install
@ -49,37 +43,48 @@ rails db:setup
bin/dev
```
And visit [http://localhost:3000](http://localhost:3000) to see the app.
You can use the following credentials to log in:
And visit http://localhost:3000 to see the app. You can use the following credentials to log in (generated by DB seed):
- Email: `user@maybe.local`
- Password: `password`
Email: user@maybe.local
Password: password
### Email
For further instructions, see guides below.
In development, we use `letter_opener` to automatically open emails in your browser. However, if you self-host, you'll likely want some basic email sending abilities.
### Setup Guides
You can use any SMTP-based mail service and then simply drop in your SMTP credentials in the `.env` file.
#### Dev Container (optional)
[Resend](https://resend.com) is a great option for personal use as they have a very generous free plan.
This is 100% optional and meant for devs who don't want to worry about installing requirements manually for their platform. You can follow [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more about Dev Containers.
#### Mac
Please visit our [Mac dev setup guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide).
#### Linux
Please visit our [Linux dev setup guide](https://github.com/maybe-finance/maybe/wiki/Linux-Dev-Setup-Guide).
#### Windows
Please visit our [Windows dev setup guide](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide).
### Testing Emails
In development, we use `letter_opener` to automatically open emails in your browser. When an email sends locally, a new browser tab will open with a preview.
## Contributing
Before contributing, you'll likely find it helpful to [understand context and general vision/direction](https://github.com/maybe-finance/maybe/wiki).
It's still very early days for this so your mileage will vary here and lots of things will break.
Once you've done that, please visit our [contributing guide](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md) to get started!
But almost any contribution will be beneficial at this point. Check the [current Issues](https://github.com/maybe-finance/maybe/issues) to see where you can jump in!
## Self Hosting
If you've got an improvement, just send in a pull request!
Our long term goal is to make self-hosting as easy as possible. That said, during these early stages of building the product, we are focusing our efforts on development.
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
We will update this section as we get closer to an initial release.
If you've got feature ideas, simply [open a new issue](https://github.com/maybe-finance/maybe/issues/new)!
Please see our [guide on self hosting here](https://github.com/maybe-finance/maybe/wiki/Self-Hosting-Setup-Guide).
## Repo Activity