About | Technologies | Requirements | Starting | Usage | License | Contributing | Author
A basic project template for little front-end projects using HTML, CSS and JS.
The following tools were used in this project:
Before starting 🏁, you need to have Git and Node installed.
To use the project as a template, I suggest you fork the project.
# Clone this project
$ git clone https://github.com/nicolaswalcker/basic-project-template
# Access
$ cd basic-project-template
# Install dependencies
$ yarn
Command | What it does? | Observation |
---|---|---|
yarn or yarn install |
Install required packages | Run this first! |
yarn start |
Start development | Access http://localhost:1234 |
yarn run build |
Build the site | Result in dist folder |
yarn run fix-styles |
Checks and fixes some errors based on stylelint | The command is only checking style files in the src folder. |
All improvements and feedback are welcome on this project. You can contribute by following these steps.
# First fork the project
# Clone your project
$ git clone https://github.com/{{yourUsername}}/basic-project-template
# Access
$ cd basic-project-template
# Install dependencies
$ yarn
# Add the origin repository
git remote add origin [email protected]:nicolaswalcker/basic-project-template.git
# Add your remote repository
git remote add {{yourRemoteName}} [email protected]:{{yourUsername}}/basic-project-template.git
# Create your change branch
git checkout -b myNewBranch
After these steps, you can work on your contribution and after completing it, you can make a pull request on github.
This project is under license from MIT. For more details, see the LICENSE file.
Nicolas Walcker |