This will be my practice to build my template readme
{project title} is a .
if you dont have the project already, from your terminal:
git clone {projectURL}
This Command will copy a full project to your local environment
Install the node modules with:
npm install {project title}
or from within your package.json file open the terminal and run
npm install.
.
├── .github/ISSUE_TEMPLATE
├── doc # All Api doc and gif files
├── thisMyPCApp # Electron JS app folder
├── thisMyPCServer # Node JS MongoDB and Express JS server folder
├── thisMyPCWeb # Angular website folder
├── .gitignore
├── .gitlab-ci.yml
├── CODE_OF_CONDUCT.md
├── LICENSE
└── README.md
add screenshots & GIf to give some information about the project
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future,
- @mentions, #refs, links, formatting, and
tagssupported - list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
All Contributions are welcome. if you are unsure, please open an issue first to discuss what you would like to change and we can go through it.
check out our contributions page for help
Complete