https://github.com/jdelauney/sass-swing-starter
Modele de démarrage pour le framework Sass Swing
https://github.com/jdelauney/sass-swing-starter
framework front-end-development semantic-web starter-kit
Last synced: 5 months ago
JSON representation
Modele de démarrage pour le framework Sass Swing
- Host: GitHub
- URL: https://github.com/jdelauney/sass-swing-starter
- Owner: jdelauney
- License: mit
- Created: 2022-09-11T06:28:55.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-27T17:56:18.000Z (over 3 years ago)
- Last Synced: 2025-07-01T06:43:22.712Z (12 months ago)
- Topics: framework, front-end-development, semantic-web, starter-kit
- Language: HTML
- Homepage:
- Size: 76.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
----
#
sass-swing-starter
Modèle de démarrage pour le framework SCSS/CSS Sass Swing
#
----
## Vue d'ensemble
Starter kit pour démarrer un nouveau projet front-end avec **Sass Swing**
Ce modèle vous fournit le minimum pour bien commencer.
Il contient le compilateur SASS pour les fichiers SCSS et le bundler ROLLUP
Si vous désirez utiliser un bundler tel que webpack, parcel ou autre, c'est à vous de les mettre en place et de les configurer.
----
Explorer le framework Sass Swing
Signaler un Bug
·
Proposer une Feature
## Présentation
### Structure du projet
La structure du projet se présente ainsi :
```
Mon-site-web/
|--dist/
| |--public
| |--assets
| | |--icons
| | |--images
| | |--fonts
| |--styles
| |--scripts
|--src
|--assets
| |--icons
| |--images
| |--fonts
|--styles
| |--scss
| |-index.scss
|--scripts
| |-script_index.js
|--index.html
```
De base le fichier `index.html` contient dans le `` toutes les balises **open graph** de base et tous les tags indispensables pour un **bon référencement SEO**.
## Installation
Téléchargez ou clonez les sources
```shell
> git clone https://github.com/jdelauney/sass-swing-starter.git
```
Installez des dépendances
```shell
> npm install
```
### Utilisation
Pour remplir facilement les tags de la balise `` vous aurez à remplacer les variables suivantes :
- `${title}`
- `${desc}`
- `${brand}`
- `${domain-url}` eg _site.com_
- `${app-name}` eg _le nom de votre produit_
- `${opengraph-thumb}` eg _page-thumb.jpg_
Le reste sera à remplir et/ou modifier selon vos besoins.
### Commandes
```sh
> npm run build:css
```
Cette commande compilera Cette commande compilera vos fichiers SCSS et minifiera le CSS dans le dossier `./dist/public/styles`.
```sh
> npm run build:js
```
Cette commande __bundlera__ et minifiera vos fichiers javascript dans le dossier `./dist/public/scripts`.
```sh
> npm run build
```
Cette commande compilera vos fichiers SCSS et minifiera le CSS dans le dossier `./dist/public/styles`.
Vos fichiers javascript seront __bundlés__ et minifiés dans le dossier `./dist/public/scripts`.
Enfin vos fichiers HTML et le dossier `./src/assets`.seront copiés dans le dossier `./dist`
## LICENCE
Sass Swing est distribué sous la licence MIT
Copyright (c) 2021-2022 Jérôme Delauney et autres contributeurs
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## CREDITS
👤 **Jérôme Delauney**
* Website: https://jdelauney.github.io
* Github: [@jdelauney](https://github.com/jdelauney)
* LinkedIn: [@Jérôme Delauney](https://www.linkedin.com/in/jérôme-delauney-802994bb/)
* Twitter: [#Jérôme Delauney](https://twitter.com/JeromeDelauney)
## SOUTENEZ NOUS
**Donnez nous une étoile** ⭐️ **si vous trouvez ce projet intéressant ou qu'il vous aide !**
## CONTRIBUEZ
Les contributions sont ce qui fait de la communauté open source un endroit incroyable pour apprendre, inspirer et créer.
**Toutes les contributions que vous faites sont grandement appréciées**.
Si vous avez une suggestion qui améliorerait cela, **veuillez "forker" le dépôt** et créer une "pull request". Vous pouvez également simplement ouvrir une "issue" avec la balise 'amélioration' ou autre.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/TheFeature`)
* Or switch to existing branch (`git checkout feature/TheFeatureToFix`)
3. Commit your Changes
* Commit a new feature (`git commit -m 'feat: do something'`)
* Or commit a fix (`git commit -m 'fix: Correct something'`)
4. Push to the Branch (`git push origin feature/TheFeature`)
5. Open a Pull Request
N'oubliez pas de mettre une étoile ⭐️ au projet !
Merci encore !
Développez vous avec ❤️