Starter Template

A Starter Template that let's you build awesome single page applications with jquery and sass.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This template provides a powerful foundation for swiftly building slick, single-page web applications using modern development tools and technologies. Streamline your workflow and focus on core functionality and let the template handle the other stuff.

Built With

(back to top)

⛳ Getting Started

Prerequisites

Please ensure you have Node.js installed on your machine, version 18 or greater. You can download it from the official website NodeJs.

Setup

Clone starter-template into a new folder

mkdir new-project-name && cd $_

git clone --depth=1 https://github.com/BrinsilElias/starter-template.git && rm -rf ./.git

OR (essentially the same thing with npx + degit)

npx degit BrinsilElias/starter-template#main

Install tools and spin it up

1. npm i or npm install - Install all dependencies
2. npm start - Start the development Server
3. npm run build - Build static assets

(back to top)

⚒️ Usage

To get the most out of this template, follow these guidelines:

Core Structure

• src/: This is your primary development workspace. All modifications and additions should take place within this folder.
• src/app/templates/template.html: This file is your primary HTML template. Add your structural markup and content here.
• src/main.scss: Include your custom styles within this SCSS file.

Features

• Mixins and Utilities: The template provides pre-built mixins and utilities for easier styling. Explore them for a headstart.
• styles/variables/: Define your style variables within this folder for organized customization.
• styles/mixins/: Store your custom mixins within this folder for maintainability.
• styles/utilities/: Place your reusable utility classes in this folder.
• src/index.js: All public JavaScript functions should be called in this file.

(back to top)

🚧 Roadmap

See the open issues for a list of proposed features (and known issues).

(back to top)

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 License

Distributed under the MIT License. See LICENSE for more information.

📫 Contact

Brinsil Elias - @BrinsilE

Project Link: https://github.com/BrinsilElias/starter-template

Acknowledgements

• open-props
• Adam Argyle
• Andy Bell