Skip to content

Commit 2bd98b4

Browse files
committed
add readme for windows development
1 parent 7469ac7 commit 2bd98b4

File tree

3 files changed

+44
-5
lines changed

3 files changed

+44
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Contributing
22
Contributions are welcome! Please see https://github.com/Developer-DAO/web3-ui/issues for tasks to pick up.
33

4+
If you developing on Windows see [this](/CONTRIBUTING_ON_WINDOWS.md) page for help on getting your environment setup
5+
46
## Local development
7+
58
To setup your local dev environment:
69
```sh
710
# Install `yarn`, alternatives at https://yarnpkg.com/en/docs/install

CONTRIBUTING_ON_WINDOWS.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing on Windows
2+
3+
If you are developing on a Windows machine, you may need to make modifications to your setup to avoid some issues.
4+
5+
## Install WSL2
6+
7+
Installing and running a Linux distribution on Windows allows you to setup your project within a Linux environment and avoid some issues that come up using Windows.
8+
9+
### Helpful Resources
10+
Here are some helpful resources to install and setup WSL2 on Windows
11+
* Step by step tutorial for installing WSL2 on Windows
12+
* Written Version - https://www.ceos3c.com/wsl-2/install-wsl2-with-windows-terminal/
13+
* YouTube Version - https://www.youtube.com/watch?v=VMZH9Pj2dXw
14+
* The same author has a helpful tutorial on terminal customization that might be helpful
15+
* https://www.youtube.com/watch?v=qiLJhG0O51M
16+
17+
## Setup your working directory
18+
19+
It can be a bit confusing to setup your working directory. You want to be sure that you are storing your project files (and working with them) in your WSL2 file system and not in your Windows file system.
20+
21+
You can quickly see what Linux distributions you have installed by opening up your file explorer and typing the following in the address bar: `wsl\\$`
22+
23+
Select a distribution and navigate into that directory. Continue navigating to `home/[yourUserName]/`. You can create a 'projects' directory here and begin storing your projects in here.
24+
25+
Below are some helpful resources.
26+
* Windows Subsystem for Linux Documentation - https://docs.microsoft.com/en-us/windows/wsl/
27+
* File Storage - https://docs.microsoft.com/en-us/windows/wsl/setup/environment#file-storage
28+
* Setting up VS Code - https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-vscode
29+
30+
## Setup your web3-ui project
31+
32+
* Follow the the instructions found in the [CONTRIBUTING](/CONTRIBUTING.md) readme.
33+
* If you run into 'EACCESS' permissions issues:
34+
* double check your directory permissions with `ls -la`
35+
* If the owner is root, you may have problems when running `yarn install`. You can modify the permissions with the following command `sudo chown -R [yourUsername] [yourProjectDir]`. The `-R` is to recurse into each of the files and directories.

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@ A library of UI components specifically crafted for web3 use cases.
1717
## Technologies
1818

1919
This project is built with the following open source libraries, frameworks and languages.
20-
| Tech | Description |
21-
| --------------------------------------------- | ----------------------------------------- |
22-
| [React](https://reactjs.org/) | Front end user interface |
23-
| [ChakraUI](https://chakra-ui.com/) | A simple & modular component library |
24-
| [TypeScript](https://www.typescriptlang.org/) | Static type-checking programming language |
20+
| Tech | Description |
21+
| --------------------------------------------- | ------------------------------------------------------------------ |
22+
| [React](https://reactjs.org/) | Front end user interface |
23+
| [ChakraUI](https://chakra-ui.com/) | A simple & modular component library |
24+
| [TypeScript](https://www.typescriptlang.org/) | Static type-checking programming language |
25+
| [Storybook](https://storybook.js.org/) | Open source tool for building UI components and pages in isolation |
2526

2627
## How to Contribute
2728

0 commit comments

Comments
 (0)