Skip to content

Commit 8d25931

Browse files
authored
Update README.md
1 parent e5ea7c7 commit 8d25931

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

README.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
11
# GitLab Home Page Clone
2-
![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
3-
![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)
4-
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
5-
![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
6-
![Nodemon](https://img.shields.io/badge/NODEMON-%23323330.svg?style=for-the-badge&logo=nodemon&logoColor=%BBDEAD)
7-
![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
8-
![Mocha](https://img.shields.io/badge/-mocha-%238D6748?style=for-the-badge&logo=mocha&logoColor=white)
9-
![Redux](https://img.shields.io/badge/redux-%23593d88.svg?style=for-the-badge&logo=redux&logoColor=white)
10-
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
11-
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
12-
![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)
13-
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
14-
![PWA](https://img.shields.io/badge/PWA%20APP-8A2BE2?style=flat-square)
2+
![Front-end Development](https://img.shields.io/badge/frontend%20development-%23404d59.svg?style=for-the-badge)
3+
![Web Development](https://img.shields.io/badge/web%20development-%232671E5.svg?style=for-the-badge)
4+
![Web Application](https://img.shields.io/badge/web%20application-6DA55F?style=for-the-badge)
5+
![User Interface](https://img.shields.io/badge/user%20interface-%23323330.svg?style=for-the-badge)
6+
![GitLab](https://img.shields.io/badge/gitlab-%23181717.svg?style=for-the-badge)
157

168
The project is academic. It's made to evaluate my level in
179
native web development languages; test my capacity to build
@@ -21,29 +13,41 @@ front-end project only. No any back-end API is called.
2113
The main goal of this project is to reproduce the old
2214
GitLab home page only.
2315

24-
## Access links
16+
## Table of contents
17+
1. [Access links](#links)
18+
2. [Reference](#ref)
19+
3. [Final result](#result)
20+
1. [Video](#video)
21+
2. [Screenshots](#images)
22+
5. [Project installation](#install)
23+
1. [Nodejs installation](#node-install)
24+
2. [Sources code cloning](#cloning)
25+
3. [Dependencies installation](#dev-install)
26+
4. [Project execution](#running)
27+
28+
## Access links <a id = "links"></a>
2529
The project is already hosted on web and can be
2630
accessible through one of these links below :<br/>
2731
- https://obrymec.github.io/gitlab_home_page_clone
2832
- https://obrymec.gitlab.io/gitlab_home_page_clone
2933
- https://gitlab-home-page-clone.onrender.com
3034

31-
## Reference
35+
## Reference <a id = "ref"></a>
3236
The project can be found via the link below :<br/>
3337
- https://gitlab.com/obrymec/gitlab_home_page_clone
3438

35-
## Final result
39+
## Final result <a id = "result"></a>
3640
This is the final result of the project :<br/><br/>
37-
### Video
41+
### Video <a id = "video"></a>
3842
[![Watch the project's video](https://img.youtube.com/vi/j7LeZvGRDzQ/maxresdefault.jpg)](https://youtu.be/j7LeZvGRDzQ)
3943

40-
### Screenshots
44+
### Screenshots <a id = "images"></a>
4145
![First render](./assets/render/render_1.png)
4246
![Second render](./assets/render/render_2.png)
4347
![Third render](./assets/render/render_3.png)
4448
![Fourth render](./assets/render/render_4.png)
4549

46-
## Project Installation
50+
## Project installation <a id = "install"></a>
4751
⚠️ This project uses some nodejs packages for code
4852
minification, css purge and auto prefixer for his
4953
production phase.
@@ -54,7 +58,7 @@ sources code and also dependencies installation
5458
whether you want. Otherwise, <b><i>it's
5559
mandatory to follow the steps below</i></b>.
5660

57-
### <u>Nodejs Installation</u>
61+
### Nodejs installation <a id = "node-install"></a>
5862
```sh
5963
cd ~;\
6064
sudo apt install curl;\
@@ -67,19 +71,19 @@ npm install yarn --global;\
6771
yarn --version
6872
```
6973

70-
### <u>Sources code cloning</u>
74+
### Sources code cloning <a id = "cloning"></a>
7175
```sh
7276
git clone git@github.com:obrymec/gitlab_home_page_clone.git gitlab_home_page/
7377
```
7478

75-
### <u>Dependencies installation</u>
79+
### Dependencies installation <a id = "dev-install"></a>
7680
Go to the root folder of the project sources
7781
and run :
7882
```sh
7983
yarn install
8084
```
8185

82-
### <u>Project execution</u>
86+
### Project execution <a id = "running"></a>
8387
Whether the project sources is opening with
8488
<i><a href = "https://code.visualstudio.com/download">
8589
vscode</a></i>, follow the steps below :

0 commit comments

Comments
 (0)