Skip to content
/ jquery-starter Public template

πŸš€ A Starter Template for building single page applications with jquery and sass.

License

Notifications You must be signed in to change notification settings

BrinsilElias/jquery-starter

Repository files navigation

Logo

jQuery Starter

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

View Demo Β· Report Bug Β· Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Screenshot of Application

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

jQuery

HTML5

ESLint

Stylelint

(back to top)

β›³ Getting Started

Prerequisites

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

Setup

Clone starter-template into a new folder

mkdir new-project-name && cd $_
git clone --depth=1 https://github.com/BrinsilElias/jquery-starter.git && rm -rf ./.git

OR (essentially the same thing with npx + degit)

npx degit BrinsilElias/jquery-starter#main

Install tools and spin it up

  1. pnpm i or pnpm install - Install all dependencies
  2. pnpm start - Start the development Server
  3. pnpm 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/template.html: This file is your primary HTML template. Add your structural markup and content here.
  • src/main.css: Include your custom styles within this CSS 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/jquery-starter

Acknowledgements