You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -9,13 +9,13 @@ This is the front end react source for the [gitconvex](https://github.com/neel19
9
9
10
10
The depedency packages used by this project can be found [here](https://github.com/neel1996/gitconvex-ui/network/dependencies)
11
11
12
-
-**🎨 Styling** - For styling, the project used[tailwind]() css framework
13
-
-**📑 Syntax Highlighting** - [prismjs](https://github.com/PrismJS/prism) is used for syntax highlighting within the *Git Difference* section
12
+
-**🎨 Styling** - For styling, the project uses[tailwind]() css framework
13
+
-**📑 Syntax Highlighting** - [prismjs](https://github.com/PrismJS/prism) is used for syntax highlighting within the *Git Difference*and *CodeView*section
14
14
-**🎭 Icon set** - [FontAweomse for react](https://github.com/FortAwesome/Font-Awesome)
15
15
16
16
## Contribute!
17
17
18
-
If you are interested in contributing to the project, fork the repo, submit a PR. Currently its just a single dev working on the project. Hopefully will get couple more on board to maintain the repo
18
+
If you are interested in contributing to the project, fork the repo and submit a PR. Currently there are only 3 maintainers working on the project, so the review may take some time. Hopefully will get a couple more on board soon to maintain the repo
19
19
20
20
### Guidelines
21
21
@@ -34,7 +34,7 @@ $ npm install
34
34
35
35
-**Building the css file**
36
36
37
-
The project uses `tailwindcss` for styling all the elements, so it is mandatory to build the CSS file which is not included in the git tree. Follow the steps to build the css file
37
+
The project uses `tailwindcss v2.0.2` for styling all the elements, so it is mandatory to build the CSS file which is not included in the repo. Follow the steps to build the css file
38
38
39
39
```
40
40
@@ -46,7 +46,7 @@ $ npm run build:tailwind
46
46
## This will generate a default tailwind css bundle
47
47
48
48
```
49
-
> **Note:** The final production build stage is configured to purge unused CSS selectors from the tailwind css file. So make sure you follow the [tailwind purge guidelines](https://tailwindcss.com/docs/controlling-file-size#writing-purgeable-html:~:text=Don't%20use%20string%20concatenation%20to%20create%20class%20names) to make sure that the required styles are not getting purged from the [production bundle](https://github.com/neel1996/gitconvex)
49
+
> **Note:** The final production build stage is configured to purge unused CSS selectors from the tailwind css file. So make sure you follow the [tailwind purge guidelines](https://tailwindcss.com/docs/controlling-file-size#writing-purgeable-html:~:text=Don't%20use%20string%20concatenation%20to%20create%20class%20names) to ensure that the required styles are included to the [production bundle](https://github.com/neel1996/gitconvex)
50
50
51
51
-**Starting the app**
52
52
@@ -148,11 +148,11 @@ After completing the setup process, use `npm start` to start the react app
148
148
│ └── RightPane.css
149
149
├── actionStore.js
150
150
├── assets
151
-
│ └── gitconvex.png
151
+
│ ├── gitconvex.png
152
+
│ └── icons
152
153
├── context.js
153
154
├── index.css
154
155
├── index.js
155
-
├── logo.svg
156
156
├── postcss.config.js
157
157
├── prism.css
158
158
├── reducer.js
@@ -164,9 +164,10 @@ After completing the setup process, use `npm start` to start the react app
0 commit comments