Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yajra/yajrabox.com
Source code of yajrabox.com website.
https://github.com/yajra/yajrabox.com
datatables documentation hacktoberfest laravel laravel-datatables oci8 yajra
Last synced: about 2 months ago
JSON representation
Source code of yajrabox.com website.
- Host: GitHub
- URL: https://github.com/yajra/yajrabox.com
- Owner: yajra
- License: mit
- Created: 2019-01-08T06:16:32.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T06:38:18.000Z (6 months ago)
- Last Synced: 2024-10-17T19:21:37.954Z (2 months ago)
- Topics: datatables, documentation, hacktoberfest, laravel, laravel-datatables, oci8, yajra
- Language: PHP
- Homepage: https://yajrabox.com
- Size: 66.9 MB
- Stars: 7
- Watchers: 2
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
## YajraBox Website
This is the source of the official [YajraBox website](https://yajrabox.com).
## Local Development
If you want to work on this project on your local machine, you may follow the instructions below. These instructions assume you are serving the site using Laravel Valet out of your `~/Sites` directory:
1. Fork this repository
2. Open your terminal and `cd` to your `~/Sites` folder
3. Clone your fork into the `~/Sites/yajrabox` folder, by running the following command *with your username placed into the {username} slot*:
```bash
git clone [email protected]:{username}/yajrabox.com yajrabox
```
4. CD into the new directory you just created:
```bash
cd yajrabox
```
5. Run the `setup.sh` bin script, which will take all the steps necessary to prepare your local install:
```bash
./bin/setup.sh
```
### Torchlight Integration
This project relies on Torchlight for syntax highlighting. You will need to create an account at [torchlight.dev](https://torchlight.dev/) and generate a free personal token for use in this project. Once generated, add your token to your .env file:
```ini
TORCHLIGHT_TOKEN=your-torchlight-token
```
### Github Integration
This project relies on Github for the repository statistics. You will need to create an account at [github](https://github.com/) and generate a [personal access token](https://github.com/settings/tokens) for use in this project. Once generated, add your token to your .env file:
```ini
GITHUB_TOKEN=your-github-token
```
### Syncing Upstream Changes Into Your Fork
This [GitHub article](https://help.github.com/en/articles/syncing-a-fork) provides instructions on how to pull the latest changes from this repository into your fork.
### Updating After Remote Code Changes
If you pull down the upstream changes from this repository into your local repository, you'll want to update your Composer and NPM dependencies, as well as update your documentation branches. For convenience, you may run the `bin/update.sh` script to update these things:
```bash
./bin/update.sh
```
### Laravel Docs
The document section of this app is based on the [laravel.com](https://github.com/laravel/laravel.com) project.