[gtk-web/new-website: 107/191] added script to restructure the website



commit 788ce0ee0bccde6e713ce3fd8f841ce9d8383ae7
Author: ravgeetdhillon <ravgeetdhillon gmail com>
Date:   Tue Jul 16 17:37:47 2019 +0530

    added script to restructure the website

 README.md      | 41 +++++++++++++++++++++++++++++++++--------
 structurize.sh |  7 +++++++
 2 files changed, 40 insertions(+), 8 deletions(-)
---
diff --git a/README.md b/README.md
index 3505fd6..3390517 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,7 @@ The data used by the site is stored in the form of following files:
     ├── _layouts                            #contains layout designs for site's pages
     │   └── documentation.html              #layout design for pages that belong to GTK documentation
     ├── _posts
+    ├── .gitlab
     ├── assets                              #contains site's valuable entities
     │   ├── css                             #contains site's stylesheets
     │   │   ├── colorful.css                #stylesheet for syntax highlighting
@@ -36,23 +37,26 @@ The data used by the site is stored in the form of following files:
     │   │   └── theme.css.map
     │   ├──img                              #contains site's images and illustrations
     │   ├── js                              #contains site's javascripts
-    │   ├── scss                            #contains site's preprocessor stylesheets
-    │   │   └── theme.scss
+    │   └── scss                            #contains site's preprocessor stylesheets
+    │       └── theme.scss
     ├── collections
     │   └── _docs
     ├── _config.yml                         #contains Jekyll settings for the site
     ├── .gitignore
     ├── .gitlab-ci.yml                      #for Gitlab Continuous Integration and Deployment
     ├── 404.html
+    ├── CODE_OF_CONDUCT.md
     ├── CONTRIBUTING.md
     ├── docs.html
     ├── features.html
     ├── Gemfile                             #contains gem dependencies for the site.
     ├── Gemfile.lock
     ├── index.html
+    ├── LICENSE.txt
     ├── package-lock.json
     ├── package.json                        #contains node dependencies for the site.
-    └── README.md
+    ├── README.md
+    └── structurize.sh                      #script to restructure the website after the dependencies are 
installed
 
 ## Contributing
 
@@ -60,14 +64,35 @@ We always welcome people who want to contribute towards our project. For suitabl
 
 ## Develop the website locally
 
-If you want to get the site up and running locally, here's the TLDR:
+To get the site up and running locally, follow the below steps:
 
+1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/).
+2. Install Jekyll and [bundler](https://jekyllrb.com/docs/ruby-101/#bundler) 
[gems](https://jekyllrb.com/docs/ruby-101/#gems).
 ```
-git clone https://gitlab.gnome.org/ravgeetdhillon/gtk-web.git
-cd gtk-web
-npm install
-bundle install
+$ gem install jekyll bundler
 ```
+3. Create a local clone of the website:
+```
+$ git clone https://gitlab.gnome.org/ravgeetdhillon/gtk-web.git
+```
+4. Change into the gtk-web directory
+```
+$ cd gtk-web
+```
+5. Install the NPM and Gem dependencies by running the following commands:
+```
+$ npm install
+$ bundle install
+```
+6. Perform the following commands to structure the website properly:
+```
+$ structurize.sh --trace
+```
+7. Build the site and make it available on a local server
+```
+$ bundle exec jekyll serve
+```
+8. Browse to [http://localhost:4000](http://localhost:4000) to view the website.
 
 ## Dependencies
 
diff --git a/structurize.sh b/structurize.sh
new file mode 100644
index 0000000..479fc01
--- /dev/null
+++ b/structurize.sh
@@ -0,0 +1,7 @@
+mv node_modules/bootstrap assets/ -f
+mv node_modules/jquery assets/ -f
+mv node_modules/popper.js assets/ -f
+mv node_modules/@fortawesome assets/ -f
+mv node_modules/slick-carousel assets/ -f
+rm -rf node_modules
+sass assets/scss/theme.scss assets/css/theme.css
\ No newline at end of file


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]