Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luckyframework/website
The Lucky website
https://github.com/luckyframework/website
lucky-framework
Last synced: about 1 month ago
JSON representation
The Lucky website
- Host: GitHub
- URL: https://github.com/luckyframework/website
- Owner: luckyframework
- Created: 2019-04-21T18:47:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T21:46:28.000Z (about 1 month ago)
- Last Synced: 2024-07-28T21:28:47.335Z (about 1 month ago)
- Topics: lucky-framework
- Language: Crystal
- Homepage: https://luckyframework.org
- Size: 4.34 MB
- Stars: 37
- Watchers: 5
- Forks: 65
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lucky's Website
This is the repository for Lucky's official website https://luckyframework.org/
## Setting up the project
1. [Install required dependencies](https://luckyframework.org/guides/getting-started/installing#install-required-dependencies)
1. Ensure you have `cmake` and `libxml2` installed for your system. These are required for some shard dependencies of this project
1. Run `script/setup`
1. Run `lucky dev` to start the app
1. 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
1. Create a new guide in `src/actions/guides`. Usually it is easiest to copy an existing guide as a starting point
1. Add the guide class to the appropriate category in the [GuidesList](https://github.com/luckyframework/website/blob/main/src/models/guides_list.cr)
1. That's it! View your guide by running `lucky dev` and finding the guide in the sidebar.### Learning Lucky
Lucky uses the [Crystal](https://crystal-lang.org) programming language. You can learn about Lucky from the [Lucky Guides](http://luckyframework.org/guides). Get help on our [Discord](https://luckyframework.org/chat) server.