Skip to content

Commit 1deb770

Browse files
authored
Merge pull request #84 from casper-network/dev
Publish changes from dev to prod
2 parents f635576 + 0e4bb94 commit 1deb770

File tree

41 files changed

+233
-81
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+233
-81
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,41 @@ This is the documentation repository for the [Casper Network](https://casper.net
66

77
The documentation site itself may be viewed at this address: https://docs.casper.network/.
88

9-
For instructions on how to build, run, edit and contribute to this documentation please refer to the [developer documentation](./README/INDEX.md).
9+
For instructions on how to build, run, edit and contribute to this documentation, please refer to the [developer documentation](./README/INDEX.md).
1010

11+
**Important Note: A complete rework of the documentation is currently underway. While fixes and improvements to this legacy version are welcome, please avoid making major or structural changes.**
12+
13+
## Quick Local Run Instructions
14+
15+
To run the documentation site locally, follow these steps:
16+
17+
1. **Clone the repository:**
18+
19+
```bash
20+
git clone https://github.com/casper-network/docs-redux.git
21+
cd docs-redux
22+
```
23+
24+
2. **Create a `.env` file:**
25+
26+
Create a file named `.env` in the root of the `docs-redux` directory with the following content:
27+
28+
```
29+
URL=http://localhost:3000
30+
BASE_URL=/
31+
ALGOLIA_APP_ID=your_algolia_app_id
32+
ALGOLIA_INDEX_NAME=your_algolia_index_name
33+
ALGOLIA_API_KEY=your_algolia_api_key
34+
```
35+
36+
*(Note: Replace `your_algolia_app_id`, `your_algolia_index_name`, and `your_algolia_api_key` with actual values if you intend to use Algolia search; otherwise, placeholders are sufficient for local development.)*
37+
38+
3. **Install dependencies, build, and serve:**
39+
40+
```bash
41+
npm install
42+
npm run build
43+
npm run serve
44+
```
45+
46+
This will install the necessary packages, build the static site, and start a local server. You can then access the documentation in your browser at `http://localhost:3000/`.
132 KB
Loading
109 KB
Loading
145 KB
Loading
80 KB
Loading
66.1 KB
Loading
75.4 KB
Loading
96.4 KB
Loading
39.7 KB
Loading
29.9 KB
Loading

0 commit comments

Comments
 (0)