-
Notifications
You must be signed in to change notification settings - Fork 8
Create BUILD.md #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
olusegun0-creator
wants to merge
2
commits into
Programmer-Network:master
Choose a base branch
from
olusegun0-creator:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Create BUILD.md #36
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Building Yail | ||
|
||
This document provides instructions on how to build the Yail library from the source. | ||
|
||
## Prerequisites | ||
|
||
Before you begin, ensure you have met the following requirements: | ||
|
||
- [Node.js](https://nodejs.org/en/): Use [nvm](https://github.com/nvm-sh/nvm) to | ||
switch to the version specified in the [.nvmrc](./.nvmrc) file. To ensure | ||
you're using the correct version of Node.js for this project, run `nvm use` in | ||
the project directory. | ||
- [pnpm](https://pnpm.io/): Install pnpm globally with `npm install -g pnpm`. | ||
|
||
## Setting Up the Development Environment | ||
|
||
### Clone the Repository | ||
|
||
First, clone the repository to your local machine: | ||
|
||
```bash | ||
git clone https://github.com/Programmer-Network/yail.git | ||
cd yail | ||
``` | ||
|
||
### Install Dependencies | ||
|
||
Use `pnpm` to install all necessary dependencies: | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
|
||
## Building for Production | ||
|
||
To build the library for production, run the following command: | ||
|
||
```bash | ||
pnpm build | ||
``` | ||
|
||
This will create a `dist` folder with the compiled code. | ||
|
||
## Running Tests | ||
|
||
To run the test suite, use the following command: | ||
|
||
```bash | ||
pnpm test |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.