Skip to content

Commit 1bee0a4

Browse files
abdellanijoaopapereira
authored andcommitted
update the installation process
1 parent 1cf1e60 commit 1bee0a4

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

README.MD

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,45 +6,58 @@
66
Project Installation
77
--------------------
88

9+
1. Fork the project by clicking on the Fork button on the top-right section of this page.
10+
2. Clone it using the following command in your local working directory
11+
```bash
12+
$ git clone https://github.com/[YOUR_GIT_USERNAME]/WebsiteOne-FE.git
13+
#or ( using ssh)
14+
$ git clone git@github.com:[YOUR_GIT_USERNAME]/WebsiteOne-FE.git
915
```
10-
$ Fork this project by clicking on the Fork button on the top-right section of this page.
11-
$ Navigate to the forked project in your repo.
12-
$ git clone https://github.com/yourgithubusername/WebsiteOne-FE.git
16+
3. Install dependencies
17+
```bash
1318
$ cd WebsiteOne-FE
14-
$ Run yarn install. Ensure you have yarn installed globally.
19+
$ yarn install
1520
```
16-
1721
Run the application
1822
-------------------
1923

20-
```
24+
```bash
2125
$ yarn start
2226
```
2327

2428
Run tests
2529
---------
2630

27-
```
31+
```bash
2832
$ yarn test
2933
```
3034

31-
# Rebuild the semantic UI asserts
32-
## This command needs to be run with npm - yarn does not support interactive prompt installs
33-
`# npm install --save-dev semantic-ui`
35+
**Note :** At this level, you should be able to run the project. In case an upgrade is needed for semantic UI, following the section below.
36+
37+
Rebuild the semantic UI asserts
38+
----------------------------------
39+
This command needs to be run with **npm** - **yarn** does not support interactive prompt installs
40+
41+
```bash
42+
$ npm install --save-dev semantic-ui`
43+
```
44+
3445
Then remove the dependency from package.json and delete the package-lock.json file - we do not want it as a dependency for every user
3546

3647
This will create a new semantic folder
3748
and copy our defaut file:
38-
39-
`cp site.variables semantic/src/site/globals/`
40-
49+
```bash
50+
cp site.variables semantic/src/site/globals/`
51+
```
4152
Then you can build semantic-ui
4253
`gulp build` or `./../node_modules/gulp/bin/gulp.js build`
4354
use the default values
4455

4556
and copy the folder to our src folder
4657

47-
`cp -R dist/* ../src/assets/`
58+
```bash
59+
cp -R dist/* ../src/assets/
60+
```
4861

4962
### [Code of Conduct](./CODE_OF_CONDUCT).
5063
### [Contribution Guide](./CONTRIBUTION_GUIDE).

0 commit comments

Comments
 (0)