https://github.com/springload/frontend-starter-styles
The building blocks of CSS at Springload
https://github.com/springload/frontend-starter-styles
Last synced: 5 months ago
JSON representation
The building blocks of CSS at Springload
- Host: GitHub
- URL: https://github.com/springload/frontend-starter-styles
- Owner: springload
- License: mit
- Created: 2018-02-23T02:22:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T06:23:18.000Z (about 3 years ago)
- Last Synced: 2025-04-13T09:12:29.921Z (10 months ago)
- Language: SCSS
- Size: 675 KB
- Stars: 3
- Watchers: 14
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :warning: Old, do not use :warning: #
These styles quite are old and don't reflect what a modern CSS setup should look like.
The [Frontend starter kit](https://github.com/springload/frontend-starter-kit) contains much better starter CSS code. While you may not need everything in the starterkit for your particular project, the CSS reflects everything in this repo... but better.
# Frontend starter styles
> The building blocks of CSS at Springload
## Using the styles
> Clone the project on your computer, install [Node](https://nodejs.org) and [Yarn](https://yarnpkg.com/lang/en/docs/install/). This project also uses [nvm](https://github.com/creationix/nvm).
```sh
cd ~/Development/sites/
git clone git@github.com:springload/frontend-starter-styles.git
# Go to your project
cd YOUR_PROJECT_NAME
# Copy the sass folder's contents from the starter-styles to your project
# eg. cp -a source destination
cp -a ../PATH_TO_STARTER_STYLES/frontend-starter-styles/src/sass/. ./PATH_TO_YOUR_FOLDER_INSIDE_YOUR_PROJECT/sass
```
See the [css guidelines](https://github.com/springload/frontend-starter-kit/blob/master/docs/css.md) we follow here at springload. You can build on top of these styles in your project.
## Working on this project
#### Installation
From the command-line:
```sh
cd ~/Development/sites/
git clone git@github.com:springload/frontend-starter-styles.git
cd frontend-starter-styles
```
To install our dependencies:
```sh
nvm install
# Then, install all project dependencies.
yarn install
```
#### Start working
> Everything mentioned in the installation process should already be done.
This is the architectural base for css that we work with at Springload. Build on top of this as you wish, but here are the [css guidlines we follow](https://github.com/springload/frontend-starter-kit/blob/master/docs/css.md).
Should you choose to run any of this project's build tasks, it uses [node-sass](https://github.com/sass/node-sass) by way of [node-sass-chokidar](https://github.com/michaelwayman/node-sass-chokidar), and [PostCSS](https://github.com/postcss/postcss).
```sh
# Make sure you use the right node version.
nvm use
# Start the server and the development tools.
yarn start
# Builds stylesheet for development
yarn build
# Builds stylesheet for production
yarn dist
# Runs linting.
yarn lint
```
## Code linting
The project's code is linted with [Stylelint](https://github.com/stylelint/stylelint).
## Improvements
Add any improvements you think could be made here:
- [ ] Add an example / kitchen sink page with all the components.
- [ ] CSS grid as another grid object
- [ ] ...