Skip to content

Commit

Permalink
chore(gitignore): update .gitignore to include .nvmrc and CHANGELOG.md
Browse files Browse the repository at this point in the history
build(nvmrc): add .nvmrc file to specify Node.js version 18.12.0

docs(changelog): add CHANGELOG.md to document project changes and updates

docs(README.md): update project name and simplify content for clarity

chore(package.json): remove unused @percy/script dependency to clean up project dependencies
  • Loading branch information
vergissberlin committed Dec 10, 2024
1 parent 4454bb2 commit 6e7c749
Show file tree
Hide file tree
Showing 6 changed files with 111 additions and 140 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@
!/docs
!/src
!/tests


!/.babelrc
!/.gitignore
!/.htmllinrc
!/.jshintrc
!/.nvmrc
!/.scss-lint.yml
!/CHANGELOG.md
!/gulpfile.js
!/LICENSE
!/README.md
Expand Down
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.12.0
37 changes: 37 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Changelog

## Fresh 3.0

* Upgraded to gulp 4 and nodejs 10.15.3
* Upgraded Bulma to 0.8.0
* Cleaned code and redesigned some of the features

## Fresh 2.1

* Improved page responsiveness particularly on tablet for both orientations, and mobile
* Fixed small layout issues
* Added a modal login form

## Fresh 2.0

* Everything is now handled by gulp and npm
* Bulma version upgraded to 0.7
* Bulma source sass is editable (note that the `@widescreen` variable has been set to false)
* Panel slider library has been removed. Sidebar completely rewritten without any plugin.
* Removed unused classes and refactored scss
* Added more scss partials for better code maintainability
* Introduced Panini templating engine. Learn more about Panini here: <https://github.com/zurb/panini>
* Fully automated build and watch process, integration with browser sync
* Navbar rework since deprecation of `.nav` element in favor of `.navbar`.
* Optimized responsive display for mobile and tablets.

## Open issues

If you've found an issue or a bug, you can report it in the issues section of this repository.
Please try to follow these simple guidelines to report your issue:

* Issue definition
* Expected behaviour
* Actual behaviour
* steps to reproduce
* Already tried fixes (if relevant)
207 changes: 69 additions & 138 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,148 +1,79 @@
# Fresh Landing page
![](https://cssninja.io/storage/app/media/external/fresh/fresh-hero-ui8.png)
# NULLzuEINS - Landing Page

Fresh is a one page landing page starter built by [Css Ninja Studio](https://cssninja.io). Fresh is licensed under the MIT license.

You can access the demo [here](https://cssninjastudio.github.io/fresh/).

## Details

Fresh is developed with the [Bulma css framework](https://bulma.io)

**Version 3.0.0**

## Usage
Fresh is now a Bulma starter fully bundled with **npm** and **gulp**. Bulma has been upgraded to the latest version **0.8.0**.

* Clone or download the repo
* Run `npm install`
* Run `gulp dev`

Most of the dependencies have been sanitized. However, **Panini** will keep throwing 2 npm warnings (low and moderatem, since Panini is only used during development, that shouldn't be a problem). We already got in touch with Zurb / Foundation to have this problem solved.

## Changelog

**Fresh 3.0**
* Upgraded to gulp 4 and nodejs 10.15.3
* Upgraded Bulma to 0.8.0
* Cleaned code and redesigned some of the features

**Fresh 2.1**
* Improved page responsiveness particularly on tablet for both orientations, and mobile
* Fixed small layout issues
* Added a modal login form

**Fresh 2.0**
* Everything is now handled by gulp and npm
* Bulma version upgraded to 0.7
* Bulma source sass is editable (note that the `@widescreen` variable has been set to false)
* Panel slider library has been removed. Sidebar completely rewritten without any plugin.
* Removed unused classes and refactored scss
* Added more scss partials for better code maintainability
* Introduced Panini templating engine. Learn more about Panini here: https://github.com/zurb/panini
* Fully automated build and watch process, integration with browser sync
* Navbar rework since deprecation of `.nav` element in favor of `.navbar`.
* Optimized responsive display for mobile and tablets.

## Issues

If you've found an issue or a bug, you can report it in the issues section of this repository. Please try to follow these simple guidelines to report your issue:

* Issue definition
* Expected behaviour
* Actual behaviour
* steps to reproduce
* Already tried fixes (if relevant)

## More

You liked Fresh? Find more premium bulma templates on [Css Ninja](https://cssninja.io/category/all).

Check also our premium Envato bulma themes [Css Ninja](https://cssninja.io/themes).

## About Us

Css Ninja is a web design studio. We build handcrafted and polished templates that will give some hype to your startup or to your next project.

### Note

Changes should be commited to `src/` files only.

### How to use

The template is built with Sass and Gulp build system with these features:

- Handlebars HTML templates with Panini– Panini is a super simple flat file generator for use with Gulp. It compiles a series of HTML pages using a common layout. These pages can also include HTML partials, external Handlebars helpers, or external data as JSON.
- Sass compilation, prefixing with Autoprefixer, and JavaScript concatenation
- Built-in BrowserSync server - Will automatically reload your page when files are changed. It also live-injects CSS changes when you save a Sass file. This task runs continuously. Defaults to localhost.
- For production builds - CSS compression, JavaScript compression, Image compression and more..


### Requirements
## Requirements

To use this template, your computer needs:

- Node.js is used to run the build processes. https://nodejs.org/en/download/
- Test: run ` node -v ` in the terminal
- Npm (Node comes with npm installed so you should have a version of npm.) Used to manage development dependencies.
- Test: run ` npm -v` in the terminal
- Gulp – task runner
`npm install -g gulp`
- Test: run `gulp -v ` in the terminal
* Node.js is used to run the build processes. <https://nodejs.org/en/download/>
* Test: run `node -v` in the terminal
* Npm (Node comes with npm installed so you should have a version of npm.) Used to manage development dependencies.
* Test: run `npm -v` in the terminal
* Gulp – task runner

### Installing:
```bash
yarn install -g gulp
```

- Install all node packages: `npm install`
- Run `gulp dev`
- Your site is now viewable at this URL: http://localhost:3000
* Test: run `gulp -v` in the terminal

### Installing

### Folder Structure:
* Install all node packages: `

- `dist/` - compiled distribution files
- `node_modules` - front-end dependencies
- `src/` - contains all of your core, working files—static assets, pages, templates, etc
- `src/assets/` - scss files, JS files, images, and fonts are here
- `src/data/` - external data
- `src/layouts/` - HTML layouts templates
- `src/pages/` - site pages
- `src/partials/` - handlebars partials files.
- `gulpfile.js` - all task definitions
- `package.json` - handles the front-end dependencies
- `.htmllintrc` - handles the HTML lint rules
- `.sass-lint.yml` - handles the SCSS lint rules
- `reports` - txt generated file for accessibility issues
```bash
yarn install --freeze-lockfile
```

### Gulp Plugins:
- [gulp-autoprefixer](https://www.npmjs.com/package/gulp-autoprefixer)
- [gulp-compile-handlebars](https://www.npmjs.com/package/gulp-compile-handlebars)
- [gulp-concat](https://www.npmjs.com/package/gulp-concat)
- [gulp-html-replace](https://www.npmjs.com/package/gulp-html-replace)
- [gulp-htmllint](https://www.npmjs.com/package/gulp-htmllint)
- [gulp-imagemin](https://www.npmjs.com/package/gulp-imagemin)
- [gulp-pretty-html](https://www.npmjs.com/package/gulp-pretty-html)
- [gulp-remove-code](https://www.npmjs.com/package/gulp-remove-code)
- [gulp-remove-logging](https://www.npmjs.com/package/gulp-remove-logging)
- [gulp-rename](https://www.npmjs.com/package/gulp-rename)
- [gulp-sass](https://www.npmjs.com/package/gulp-sass)
- [node-bourbon](https://www.npmjs.com/package/node-bourbon)
- [gulp-sass-lint](https://www.npmjs.com/package/gulp-sass-lint)
- [gulp-sourcemaps](https://www.npmjs.com/package/gulp-sourcemaps)
- [gulp-uglify](https://www.npmjs.com/package/gulp-uglify)
- [gulp-newer](https://www.npmjs.com/package/gulp-newer)
- [gulp-accessibility](https://www.npmjs.com/package/gulp-accessibility)
- [gulp-jshint](https://www.npmjs.com/package/gulp-jshint)
- [gulp-gulp-gh-pages](https://www.npmjs.com/package/gulp-gh-pages)
- [gulp-babel](https://www.npmjs.com/package/gulp-babel)
- [panini](https://www.npmjs.com/package/panini)
- [run-sequence](https://www.npmjs.com/package/run-sequence)
- [ansi-colors](https://www.npmjs.com/package/ansi-colors)
- [fancy-log](https://www.npmjs.com/package/fancy)


### Additional Resources:
- [Sass: Syntactically Awesome Style Sheets](http://sass-lang.com/)
- [Bulma](https://bulma.io/)
- [Handlebars](http://handlebarsjs.com/)
- [Panini](https://github.com/zurb/panini)
- [Gulp](https://gulpjs.org/getting-started)
* Run `gulp dev`
* Your site is now viewable at this URL: <http://localhost:3000>

### Folder Structure

* `dist/` - compiled distribution files
* `node_modules` - front-end dependencies
* `src/` - contains all of your core, working files—static assets, pages, templates, etc
* `src/assets/` - scss files, JS files, images, and fonts are here
* `src/data/` - external data
* `src/layouts/` - HTML layouts templates
* `src/pages/` - site pages
* `src/partials/` - handlebars partials files.
* `gulpfile.js` - all task definitions
* `package.json` - handles the front-end dependencies
* `.htmllintrc` - handles the HTML lint rules
* `.sass-lint.yml` - handles the SCSS lint rules
* `reports` - txt generated file for accessibility issues

### Gulp Plugins

* [gulp-autoprefixer](https://www.npmjs.com/package/gulp-autoprefixer)
* [gulp-compile-handlebars](https://www.npmjs.com/package/gulp-compile-handlebars)
* [gulp-concat](https://www.npmjs.com/package/gulp-concat)
* [gulp-html-replace](https://www.npmjs.com/package/gulp-html-replace)
* [gulp-htmllint](https://www.npmjs.com/package/gulp-htmllint)
* [gulp-imagemin](https://www.npmjs.com/package/gulp-imagemin)
* [gulp-pretty-html](https://www.npmjs.com/package/gulp-pretty-html)
* [gulp-remove-code](https://www.npmjs.com/package/gulp-remove-code)
* [gulp-remove-logging](https://www.npmjs.com/package/gulp-remove-logging)
* [gulp-rename](https://www.npmjs.com/package/gulp-rename)
* [gulp-sass](https://www.npmjs.com/package/gulp-sass)
* [node-bourbon](https://www.npmjs.com/package/node-bourbon)
* [gulp-sass-lint](https://www.npmjs.com/package/gulp-sass-lint)
* [gulp-sourcemaps](https://www.npmjs.com/package/gulp-sourcemaps)
* [gulp-uglify](https://www.npmjs.com/package/gulp-uglify)
* [gulp-newer](https://www.npmjs.com/package/gulp-newer)
* [gulp-accessibility](https://www.npmjs.com/package/gulp-accessibility)
* [gulp-jshint](https://www.npmjs.com/package/gulp-jshint)
* [gulp-gulp-gh-pages](https://www.npmjs.com/package/gulp-gh-pages)
* [gulp-babel](https://www.npmjs.com/package/gulp-babel)
* [panini](https://www.npmjs.com/package/panini)
* [run-sequence](https://www.npmjs.com/package/run-sequence)
* [ansi-colors](https://www.npmjs.com/package/ansi-colors)
* [fancy-log](https://www.npmjs.com/package/fancy)

### Additional Resources

* [Sass: Syntactically Awesome Style Sheets](http://sass-lang.com/)
* [Bulma](https://bulma.io/)
* [Handlebars](http://handlebarsjs.com/)
* [Panini](https://github.com/zurb/panini)
* [Gulp](https://gulpjs.org/getting-started)
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@
"zoom-vanilla.js": "^2.0.6"
},
"dependencies": {
"@percy/script": "^1.1.0",
"bulma": "^0.8.0",
"bulma-extensions": "^6.2.7",
"feather-icons": "^4.7.0",
Expand Down
1 change: 0 additions & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,6 @@
image-size "^0.8.2"
js-yaml "^3.13.1"
percy-client "^3.2.0"
puppeteer "^5.3.1"
retry-axios "^1.0.1"
which "^2.0.1"
winston "^3.0.0"
Expand Down

0 comments on commit 6e7c749

Please sign in to comment.