Like dotfiles but for projects.
Basic config files for majority of open source projects. From contributing.md to package.json and much more.
The focus of the project is on Javascript repos that are either private or can be ready to be published to NPM.
Since this project is JS-heavy, you're expected to have Node, NPM, and a few other dependencies.
All javascript projects require the following packages installed globally:
npm install -g eslint
For typescript projects install the following:
npm install -g typescript tslint typings
For front-end projects, make sure to install the following:
npm install -g bower
Other dependencies are driven by the editor used so look out for plugins for:
- eslint
- tslint and typescript
- editorconfig
Setup and installation is easy...there is none. Copy/paste from Github is just as acceptable as doing a manual mv
or cp
from the repository locally.
When starting a new project, the following is also acceptable:
git clone git@github.com:AntJanus/project-configs.git [name of new project]
cd [name of new project]
# and then delete files that aren't useful for the project with
rm uselessconfig.json .uselessdotfile
A summary changelog for smaller projects:
- 0.0.1 - project initialized