Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
obrymec authored Oct 16, 2023
1 parent e5ea7c7 commit 8d25931
Showing 1 changed file with 27 additions and 23 deletions.
50 changes: 27 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
# GitLab Home Page Clone
![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![Nodemon](https://img.shields.io/badge/NODEMON-%23323330.svg?style=for-the-badge&logo=nodemon&logoColor=%BBDEAD)
![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
![Mocha](https://img.shields.io/badge/-mocha-%238D6748?style=for-the-badge&logo=mocha&logoColor=white)
![Redux](https://img.shields.io/badge/redux-%23593d88.svg?style=for-the-badge&logo=redux&logoColor=white)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
![PWA](https://img.shields.io/badge/PWA%20APP-8A2BE2?style=flat-square)
![Front-end Development](https://img.shields.io/badge/frontend%20development-%23404d59.svg?style=for-the-badge)
![Web Development](https://img.shields.io/badge/web%20development-%232671E5.svg?style=for-the-badge)
![Web Application](https://img.shields.io/badge/web%20application-6DA55F?style=for-the-badge)
![User Interface](https://img.shields.io/badge/user%20interface-%23323330.svg?style=for-the-badge)
![GitLab](https://img.shields.io/badge/gitlab-%23181717.svg?style=for-the-badge)

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

## Access links
## Table of contents
1. [Access links](#links)
2. [Reference](#ref)
3. [Final result](#result)
1. [Video](#video)
2. [Screenshots](#images)
5. [Project installation](#install)
1. [Nodejs installation](#node-install)
2. [Sources code cloning](#cloning)
3. [Dependencies installation](#dev-install)
4. [Project execution](#running)

## Access links <a id = "links"></a>
The project is already hosted on web and can be
accessible through one of these links below :<br/>
- https://obrymec.github.io/gitlab_home_page_clone
- https://obrymec.gitlab.io/gitlab_home_page_clone
- https://gitlab-home-page-clone.onrender.com

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

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

### Screenshots
### Screenshots <a id = "images"></a>
![First render](./assets/render/render_1.png)
![Second render](./assets/render/render_2.png)
![Third render](./assets/render/render_3.png)
![Fourth render](./assets/render/render_4.png)

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

### <u>Nodejs Installation</u>
### Nodejs installation <a id = "node-install"></a>
```sh
cd ~;\
sudo apt install curl;\
Expand All @@ -67,19 +71,19 @@ npm install yarn --global;\
yarn --version
```

### <u>Sources code cloning</u>
### Sources code cloning <a id = "cloning"></a>
```sh
git clone [email protected]:obrymec/gitlab_home_page_clone.git gitlab_home_page/
```

### <u>Dependencies installation</u>
### Dependencies installation <a id = "dev-install"></a>
Go to the root folder of the project sources
and run :
```sh
yarn install
```

### <u>Project execution</u>
### Project execution <a id = "running"></a>
Whether the project sources is opening with
<i><a href = "https://code.visualstudio.com/download">
vscode</a></i>, follow the steps below :
Expand Down

0 comments on commit 8d25931

Please sign in to comment.