website_v2
Lucky's Website
This is the repository for Lucky's official website https://luckyframework.org/
Setting up the project
- Install required dependencies
- Ensure you have
cmakeandlibxml2installed for your system. These are required for some shard dependencies of this project - Run
script/setup - Run
lucky devto start the app - Visit
http://localhost:3000
Editing guides
Guides are located in the src/actions/guides directory. You can edit the markdown in each action file and view changes by running the Lucky app with lucky dev.
Adding a new guide
- Create a new guide in
src/actions/guides. Usually it is easiest to copy an existing guide as a starting point - Add the guide class to the appropriate category in the GuidesList
- That's it! View your guide by running
lucky devand finding the guide in the sidebar.
Learning Lucky
Lucky uses the Crystal programming language. You can learn about Lucky from the Lucky Guides. Get help on our Discord server.
website_v2: github: luckyframework/website
Crystal
>= 1.10.0
Authors
Dependencies 8
-
cadmium_transliterator
master
{'branch' => 'master', 'github' => 'cadmiumcr/transliterator'} -
carbon
~> 0.6.0
{'github' => 'luckyframework/carbon', 'version' => '~> 0.6.0'} -
carbon_sendgrid_adapter
~> 0.6.0
{'github' => 'luckyframework/carbon_sendgrid_adapter', 'version' => '~> 0.6.0'} -
cmark
master
{'branch' => 'master', 'github' => 'amauryt/cr-cmark-gfm'} -
lexbor
~> 3.1.3
{'github' => 'kostya/lexbor', 'version' => '~> 3.1.3'} -
lucky
~> 1.3.0
{'github' => 'luckyframework/lucky', 'version' => '~> 1.3.0'} -
lucky_env
~> 0.2.0
{'github' => 'luckyframework/lucky_env', 'version' => '~> 0.2.0'} -
sitemapper
~> 0.9.0
{'github' => 'jwoertink/sitemapper', 'version' => '~> 0.9.0'}
Development Dependencies 2
-
ameba
~> 1.5.0
{'github' => 'crystal-ameba/ameba', 'version' => '~> 1.5.0'} -
lucky_flow
~> 0.10.0
{'github' => 'luckyframework/lucky_flow', 'version' => '~> 0.10.0'}
Dependents 0
Releases
Last synced .