search

amberframework / amber

A Crystal web framework that makes building applications fast, simple, and enjoyable. Get started with quick prototyping, less bugs, and blazing fast performance.
https://amberframework.org
MIT License
2.57k stars 204 forks source link

Improve Installation Documentation & Experience for Windows/Linux Users #1318

Closed crimson-knight closed 7 months ago

crimson-knight commented 1 year ago

I'd like to improve the working steps for users who are on Windows and Linux.

I know most day-to-day Linux users don't have any challenges with using Amber by cloning the repo and using the stable branch, however, I've had plenty Windows users who have to use WSL2 and aren't sure how to get everything running on that system.

Any help with this would be GREATLY appreciated!

a-alhusaini commented 1 year ago

I'll assume that WSL2 is synonymous with Ubuntu. (most of the tutorials that show you how to setup WSL2 end up showing you how to install ubuntu)

First, get crystal setup on your machinee by following the steps outlined here: https://crystal-lang.org/install/on_ubuntu/ Then, get postgres installed from the official ubuntu repositories or your source of choice. Then, create a new crystal project with crystal init Then, add the amber shard to your project Install the shard.

Aaaand thats it! It sounds like a lot of stuff but setting up a script for it shouldn't be too hard. I hope...

a-alhusaini commented 1 year ago

This video is an excellent template. Just replace the elixir installation steps with crystal installation. https://www.youtube.com/watch?v=fyqYD0TP92s

I'd love to sit down and make a step by step tutorial that takes you from installing wsl to having a sparkling new amber project but I'm travelling with a mac and will get access to a windows machine a week from now. I could write steps from memory but we'll need someone else to double check that they are accurate.

crimson-knight commented 1 year ago

@a-alhusaini thank you! That's basically my plan as well, written instructions are great but people also really love video. I just finished upgrading my setup so I can do high-quality screencasts to help introduce Amber.

I have an M1 Pro Mac, so I'll have to use VM to create the Windows tutorial screencast. If you have the recent update to date installation steps I'd gladly use them as part of the screen cast to verify they are complete.

codered commented 7 months ago

I believe the original question has been answered within the comments. There has been no activity since April so it can be closed.