Skip to content

Common scaffolding repository for starting a JavaScript project

License

Notifications You must be signed in to change notification settings

JaeYeopHan/js_common_scaffolding

Repository files navigation

Scaffolding Repository

License: MIT

Common scaffolding repository for starting a JavaScript project.

Install

$ git clone https://github.com/JaeYeopHan/js_common_scaffolding [project Name]
$ cd [project Name]
$ npm install
# and
$ npm test
$ npm start

Project Set up

1. Remove .git

  • Initialize git
$ rm -rf .git
$ git init
$ git add .
$ git commit -m "Initial commit"
$ git remote add [your github repository addrss]
$ git push -u origin master

2. Modify package.json

  • "name"
  • "description"
  • "repository"
  • address

3. Modify README.md

  • If you want following format, just remove this section, and modify below section.
  • Adding badges about project.

4. Start your project


[Project Name]

[badges]

[Project description]


[Live Demo]

SetUp


Usage


API Document


Development Installation


Bug Report


Contribute


LICENSE

About

Common scaffolding repository for starting a JavaScript project

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published