-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,53 @@ | ||
| [](https://github.com/Team1157/site/actions/workflows/deploy.yml) | ||
| # Boulder High Landsharks Website | ||
|
|
||
| [](https://github.com/Team1157/site/actions/workflows/deploy.yml) | ||
| [](https://github.com/Team1157/site/actions/workflows/dependabot/dependabot-updates) | ||
| [](https://github.com/Team1157/site/actions/workflows/pages/pages-build-deployment) | ||
| [](https://github.com/Team1157/site/actions/workflows/pages/pages-build-deployment) | ||
|
|
||
| > [!NOTE] | ||
| > Until we renew the actual domain it's available at https://1157.adabit.org | ||
| > **Note** | ||
| > The website is temporarily available at [https://1157.adabit.org](https://1157.adabit.org) until the actual domain is renewed. | ||
| ## Getting Started | ||
|
|
||
| Follow these steps to get a local copy of the project up and running for | ||
| development | ||
| Follow these steps to get a local copy of the project up and running for development. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Ensure you have an adequate version of [Node.js](https://nodejs.org/) and pnpm | ||
| installed | ||
| - Ensure you have a suitable version of [Node.js](https://nodejs.org/) and [pnpm](https://pnpm.io/) installed. | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Clone the repo: | ||
| ``` | ||
| 1. **Clone the repository:** | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Team1157/site | ||
| ``` | ||
| 2. Navigate to the project directory: | ||
|
|
||
| ``` | ||
| 2. **Navigate to the project directory:** | ||
|
|
||
| ```bash | ||
| cd site | ||
| ``` | ||
|
|
||
| 3. Install dependencies: | ||
| ``` | ||
| pnpm i | ||
| 3. **Install dependencies:** | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| ``` | ||
|
|
||
| ### Development | ||
|
|
||
| - To start the development server: | ||
| ``` | ||
| - **Start the development server:** | ||
|
|
||
| ```bash | ||
| pnpm src:dev | ||
| ``` | ||
| - (Optional, commiting will automatically do this) To make your code follow the | ||
| styling: | ||
| ``` | ||
|
|
||
| - **(Optional, commiting will do this for you) Apply code styling with Prettier:** | ||
|
|
||
| ```bash | ||
| pnpm exec prettier . --write | ||
| ``` | ||
|
|
||
| > **Tip** | ||
| > Prettier will automatically format your code upon committing. |