The Spacebar Node Module Template
To start your new project, follow these steps
1. Clone this repository
git clone https://github.com/SpacebarTech/node-module-template.git
2. Create a new repository for your project
Do this on github, or send Tim a request to have it done.
3. Remove template.git from your project
git remote remove origin
4. Add your repository to your project
git remote add origin https://github.com/SpacebarTech/[YOUR_PROJECT].git
5. Update your package.json so that all fields are filled out correctly
In your package.json, make sure that "name," "description," "repository," "bugs," and "homepage" are all the correct values for your repository, and not for template.git
6. Update webpack.config.js
Change entry prop to either main.js or main.vue
Change [MODULE_NAME] to the name you want\
7. Push up changes
git add .
git commit -m “Update from template”
git push origin master
8. Install all the packages
npm install
9. Set up semantic release
semantic-release-cli setup
Follow prompt.
Pick Travis CI
Do not make a new travis.yml file\
10. Setup main.js / main.vue file
Use either the main.js or main.vue file. Delete the other one.
11. Build dist
npm run build
Make sure there are no errors
12. Publish module
git add .
git-cz Follow the prompts
git push origin master
13. Update README.md
- Delete instructions
- use template below
[NAME OF MODULE]
[DESCRIPTION]
Installation
npm install @spacebartech/[NAME OF MODULE]
Usage
Tests
npm test