# Padawan
![NPM](https://img.shields.io/npm/l/@eventyret/padawan?style=for-the-badge) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/eventyret/padawan/develop?style=for-the-badge) ![npm](https://img.shields.io/npm/v/@eventyret/padawan?style=for-the-badge) ![Maintenance](https://img.shields.io/maintenance/yes/2020?style=for-the-badge) ## What does it do and what does it need to fulfil A nodeJS tool provided for students of Code Institute. The tool will create the boilerplate for your current milestone project. This will speed up development as you can can focus more on your code rather then how the folder structure etc is. ### Supported milestones - User Centric Frontend (Milestone 1) - Interactive Frontend (Milestone 2) - Data Centric Development (Milestone 3) - Full Stack Frameworks (Milestone 4) ## User Stories - As a student, I want a quick way to setup my project. - As a student, I want to create a boilerplate project. - As a student, I want to use Vscode as my Primary IDE - As a student, I want to use Gitpod as my Primary IDE ## Technologies Used - [Javascript](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics) - [NodeJS](https://www.nodejs.org) ## Requirements These are the requirements to run the tool. - [NodeJS 10+](https://www.nodejs.org) - [NPM 6.14.8](https://www.npmjs.com/package/npm/v/6.14.8) - [Python 3.x](https://www.python.org/) ### Running the tool 1. Please make sure you have python 3.x installed on your system. (You can test this by typing `python --version` in a terminal) 1. Please install the tool using npm `npm install -g @eventyret/padawan` 1. You can now use `padwan` or `padawan` to start the application ## Development If you wish to develop things please follow the guidelines in [Contribute](CONTRIBUTING.md) ## BUGS & TODO Please see [issues](https://github.com/Eventyret/Padawan/issues) ## [Contribute](CONTRIBUTING.md) ## Credits - Padwan Logo taken from [Wikipedia](https://upload.wikimedia.org/wikipedia/en/d/d7/Ahsoka_Tano.png) - Readme template from [Code Insitute](https://github.com/Code-Institute-Solutions/readme-template/blob/master/README.md)