Skip to content

Commit

Permalink
Merge pull request #71 from BRACKETS-by-TRIAD/feat/update-getting-sta…
Browse files Browse the repository at this point in the history
…rted=page

feat(getting started): add more general information
  • Loading branch information
odziomkova-brackets authored Feb 6, 2024
2 parents a0baa10 + 2f7c099 commit d965a05
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 2 deletions.
53 changes: 52 additions & 1 deletion pages/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,62 @@

import { Card, Cards } from 'components/card'
import { CommandLineIcon, FolderIcon, Cog8ToothIcon, ChevronDoubleRightIcon, BoltIcon } from '@heroicons/react/24/outline'
import Image from 'components/image';

<Cards>
<Card icon={<CommandLineIcon />} title="Installation" href="/getting-started/installation"/>
<Card icon={<FolderIcon />} title="Directory Structure" href="/getting-started/directory-structure"/>
<Card icon={<Cog8ToothIcon />} title="Config File" href="/getting-started/config-file"/>
<Card icon={<ChevronDoubleRightIcon />} title="InertiaJS configuration" href="/getting-started/inertiajs-configuration"/>
<Card icon={<BoltIcon />} title="Vite Configuration" href="/getting-started/vite-configuration"/>
</Cards>
</Cards>

## Requirements
* Laravel 9.21+
* PHP 8.0+
* MySQL / PostgreSQL / SQLite / SQL Server

## Demo
If you want to get the hands-on experience, you can play around in our [demo](https://demo.craftable.pro/).

Use the following credentials to login:

- email: `[email protected]`
- password: `bracketscraftablepro`

<br />
<Image alt="User's listing" src="/images/demo.png" />

## Browser Support

Our framework is designed to provide compatibility with the following web browsers:

- Google Chrome
- Mozilla Firefox
- Apple Safari
- Microsoft Edge
- Opera

For the best experience and optimal performance, we recommend using the latest versions of these browsers when working with our framework. While efforts are made to maintain compatibility across these browsers, some features may vary or have limited support in older browser versions.


## Security

If you discover any security vulnerabilities or issues, please **DO NOT** report them on GitHub issues or forums to prevent potential exploitation. Instead, we highly encourage responsible disclosure through private communication channels.

To report a security concern, please reach out to our security team via email at [[email protected]](mailto:[email protected]). We appreciate your cooperation in helping to keep our framework secure for everyone.

## Maintenance

We are committed to the continuous improvement and development of our framework. Our team is actively working on enhancing its features, addressing issues, and incorporating user feedback into future updates.

New versions and updates will be released periodically to ensure compatibility, stability, and security. We encourage users to stay updated with the latest releases to benefit from new features, performance improvements, and bug fixes.

## License

Our framework is available under a commercial license. The paid version provides full access to all features, and commercial use rights.
If you are interested in an open-source version, please take a look at our free [Craftable](https://getcraftable.com/) built on Vue2 (for this reason it is incompatible with Craftable Pro).

Copyright (C) BRACKETS by TRIAD s.r.o [email protected] - All Rights Reserved

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2 changes: 1 addition & 1 deletion pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It's main feature is the crud generator which allows you to create whole CRUD fo
You can read more about it in the following article: [Building Laravel 9+ admin panel with Craftable PRO](https://blog.meetbrackets.com/building-laravel-9-admin-panel-with-craftable-pro-f4d7a60594db).
If you have any questions, feel free to contact us on [Github](https://github.com/BRACKETS-by-TRIAD/craftable-pro-docs), [Twitter](https://twitter.com/craftable_pro), or at [[email protected]](malto:[email protected]).

Dive into the documention using the following cards, or choose the topic of your choice from the sidebar.
Dive into the documentation using the following cards, or choose the topic of your choice from the sidebar.

<Cards>
<Card icon={<CommandLineIcon />} title="Getting Started" href="/getting-started" />
Expand Down

0 comments on commit d965a05

Please sign in to comment.