Skip to content

Commit 2af5f72

Browse files
Initial Commit
0 parents  commit 2af5f72

20 files changed

Lines changed: 2311 additions & 0 deletions

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/
2+
package-lock.json

README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# MinimaCSS ✨
2+
3+
MinimaCSS is a minimalist CSS framework designed for simplicity and ease of use. Born from an idea in 2017 and brought to life in 2018 for my personal projects, MinimaCSS is a reflection of a vision to create a foundational CSS framework that empowers new developers and suits projects that require just the basics.
4+
5+
While it may not cater to the complexities of large-scale applications, its streamlined approach is ideal for budding developers, simple projects, and anyone in need of a lightweight, straightforward starting point.
6+
7+
### Why MinimaCSS? 🤔
8+
9+
In a world where front-end frameworks are often bloated and overly complex, MinimaCSS stands as a testament to simplicity. It's a throwback to the roots of CSS design, offering just enough to get you started without overwhelming you with options.
10+
11+
### Features 🚀
12+
13+
- Grid System: A flexible, 12-column grid for layout management.
14+
- Typography: Clean, readable typography settings.
15+
- Buttons: Pre-styled buttons with basic interactivity.
16+
- Forms: Simple form elements for quick integration.
17+
- Utilities: Handy utility classes for spacing, visibility, backgrounds, text colors, and more.
18+
- Responsive: Built with a mobile-first approach.
19+
20+
### Examples 📚
21+
22+
Check out the directory called `/example` where all the components are used
23+
24+
## Installation 💾
25+
26+
To get started with MinimaCSS, you have two options: download the compiled CSS directly or download the project, customise it and build your own css.
27+
28+
### Direct Download 📦
29+
30+
Download the `minimacss.css` file from the `/dist` folder and include it in your project:
31+
32+
```html
33+
<link rel="stylesheet" href="path-to-minimacss/minimacss.css">
34+
35+
```
36+
37+
### Customization and Building 🛠️
38+
39+
MinimaCSS is designed to be easily customizable. To create a version tailored to your needs, follow these steps:
40+
41+
1. Clone the repository:
42+
43+
```bash
44+
git clone https://github.com/hardikforall/MinimaCSS.git
45+
```
46+
47+
2. Navigate to the project directory
48+
49+
3. Install the required dependencies:
50+
```bash
51+
npm install
52+
```
53+
4. Make your customizations: Edit the SCSS files in the /src directory to suit your project's needs. You can modify variables, adjust styles, or even add new components.
54+
55+
5. Build your custom CSS: Once you've made your changes, you can build your custom version of MinimaCSS by running:
56+
57+
```bash
58+
npm run build
59+
```
60+
This command compiles your SCSS files and outputs a minified CSS file in the /dist directory.
61+
And you're done! You now have a version of MinimaCSS that's tailored specifically to your project's requirements.
62+
63+
### About Documentation
64+
65+
As MinimaCSS originated as a personal project, extensive documentation was not a priority. Therefore, detailed documentation is not available at this time. The provided example is intended to be self-explanatory and should suffice for understanding how to use the framework effectively.
66+
67+
### Contributions
68+
69+
Contributions are welcome! If you'd like to improve MinimaCSS, feel free to fork the repository, make your changes, and submit a pull request.

0 commit comments

Comments
 (0)