|
6 | 6 | Project Installation |
7 | 7 | -------------------- |
8 | 8 |
|
| 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 |
9 | 15 | ``` |
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 |
13 | 18 | $ cd WebsiteOne-FE |
14 | | -$ Run yarn install. Ensure you have yarn installed globally. |
| 19 | +$ yarn install |
15 | 20 | ``` |
16 | | - |
17 | 21 | Run the application |
18 | 22 | ------------------- |
19 | 23 |
|
20 | | -``` |
| 24 | +```bash |
21 | 25 | $ yarn start |
22 | 26 | ``` |
23 | 27 |
|
24 | 28 | Run tests |
25 | 29 | --------- |
26 | 30 |
|
27 | | -``` |
| 31 | +```bash |
28 | 32 | $ yarn test |
29 | 33 | ``` |
30 | 34 |
|
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 | + |
34 | 45 | 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 |
35 | 46 |
|
36 | 47 | This will create a new semantic folder |
37 | 48 | 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 | +``` |
41 | 52 | Then you can build semantic-ui |
42 | 53 | `gulp build` or `./../node_modules/gulp/bin/gulp.js build` |
43 | 54 | use the default values |
44 | 55 |
|
45 | 56 | and copy the folder to our src folder |
46 | 57 |
|
47 | | -`cp -R dist/* ../src/assets/` |
| 58 | +```bash |
| 59 | +cp -R dist/* ../src/assets/ |
| 60 | +``` |
48 | 61 |
|
49 | 62 | ### [Code of Conduct](./CODE_OF_CONDUCT). |
50 | 63 | ### [Contribution Guide](./CONTRIBUTION_GUIDE). |
|
0 commit comments