Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.17 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.17 KB
Raw

YajraBox Website

This is the source of the official YajraBox website.

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: 
    git clone [email protected]:{username}/yajrabox.com yajrabox
  4. CD into the new directory you just created: 
    cd yajrabox
  5. Run the setup.sh bin script, which will take all the steps necessary to prepare your local install: 
    ./bin/setup.sh

Torchlight Integration

This project relies on Torchlight for syntax highlighting. You will need to create an account at torchlight.dev and generate a free personal token for use in this project. Once generated, add your token to your .env file:

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 and generate a personal access token for use in this project. Once generated, add your token to your .env file:

GITHUB_TOKEN=your-github-token

Syncing Upstream Changes Into Your Fork

This GitHub article 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:

./bin/update.sh

Laravel Docs

The document section of this app is based on the laravel.com project.