gavin/maybe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 28 Wiki Activity

Improve Local Dev Setup Documentation and Contribution Guidelines #339

Merged
zachgoll merged 3 commits from add-local-dev-setup-guides into main 2024-02-07 07:14:52 +08:00
Conversation 5 Commits 3 Files Changed 2 +66 -34
zachgoll commented 2024-02-07 05:18:32 +08:00 (Migrated from github.com)
Copy Link

We've had several local setup issues and self-hosting questions:

The goal of this PR is to consolidate all of these into one spot.

I've updated the README and CONTRIBUTING guide alongside some additional setup guides in the Wiki:

These guides are a WIP and will be centralized places for us to communicate the best way to get started for local development and self-hosting.

We've had several local setup issues and self-hosting questions: - #335 - #316 - #306 - #295 - #292 The goal of this PR is to consolidate all of these into one spot. I've updated the README and CONTRIBUTING guide alongside some additional setup guides in the Wiki: - [Self Hosting](https://github.com/maybe-finance/maybe/wiki/Self-Hosting-Setup-Guide) - [Mac Setup](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide) - [Linux Setup](https://github.com/maybe-finance/maybe/wiki/Linux-Dev-Setup-Guide) - [Windows Setup](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide) These guides are a WIP and will be centralized places for us to communicate the best way to get started for local development and self-hosting.
❤️ 5 🚀 3
cartwatson commented 2024-02-07 05:30:02 +08:00 (Migrated from github.com)
Copy Link

As someone currently trying to get this setup for dev this looks useful to me. Only thing that stood out was line 38 of the README, it gets rid of the shell syntax highlighting, admittedly not that useful but better to have it imo.

As someone currently trying to get this setup for dev this looks useful to me. Only thing that stood out was line 38 of the README, it gets rid of the shell syntax highlighting, admittedly not that useful but better to have it imo.
👍 1
robzolkos commented 2024-02-07 05:42:11 +08:00 (Migrated from github.com)
Copy Link

This is amazingly well done 👏🏻

Notice in the individual setup guides in the wiki it mentions setting up Node - however - so far - the codebase doesn't need it (using importmaps instead), so perhaps some setup complexity that could be removed from the wiki?

This is amazingly well done 👏🏻 Notice in the individual setup guides in the wiki it mentions setting up Node - however - so far - the codebase doesn't need it (using importmaps instead), so perhaps some setup complexity that could be removed from the wiki?
zachgoll commented 2024-02-07 06:01:43 +08:00 (Migrated from github.com)
Copy Link

@robzolkos good point, will remove those for now!

@robzolkos good point, will remove those for now!
leemcalilly commented 2024-02-07 06:11:15 +08:00 (Migrated from github.com)
Copy Link

Should using Docker with the dev container be included or are y'all thinking about moving away from that?

Should using Docker with the dev container be included or are y'all thinking about moving away from that?
zachgoll commented 2024-02-07 06:38:05 +08:00 (Migrated from github.com)
Copy Link

@leemcalilly are you referring to adding a dedicated guide for developing locally with Dev Containers?

@robzolkos may have to jump in on that one—I'm not using the Dev Container myself but I've seen a few questions surrounding it.

@leemcalilly are you referring to adding a dedicated guide for developing locally with Dev Containers? @robzolkos may have to jump in on that one—I'm not using the Dev Container myself but I've seen a few questions surrounding it.
👍 1
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
📆 Planned
Not ready to be worked on yet, but planned for future
 💻 Self Hosted only
Issues pertaining to self-hosted versions of Maybe
 ⚙️ Config
ℹ️ Needs info
Further information is requested
 📱 Mobile
Bugs exclusively happening on mobile devices
 1️⃣ High Priority
High priority issues will be worked on next
 🚨 Urgent
Issues that are urgent for app functionality
 3️⃣ Low priority
Contributions accepted, but Maybe team will not be working on this in the near term
 2️⃣ Medium Priority
Community contributions accepted, Maybe team only works on if there are no high priority items open
 ⚡ Performance
Performance issues to address
 🎨 UI / UX
Issues related to UI / UX interactions and design.
 💎 Bounty
💰 Rewarded
📊 Data issue
Issues where the app functionally works, but the data is missing or inaccurate.
 🙋 Bounty claim
$1.5K
Community
This is a great issue for community members to work on
 dependencies
Pull requests that update a dependency file
 Design
Hosted only
Hosted app only
 Required self hoster data migration
Self hosters must run data migrations to resolve this issue
 ruby
Pull requests that update Ruby code
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
gavin
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: gavin/maybe#339
Delete Branch "add-local-dev-setup-guides"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?