/literate-eureka

First Repo to get to grips with github and run test etc

Primary LanguageHTML

This will be my practice to build my template readme

Project Title

{project title} is a .

Built With

Installation

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.

Folder Structure

.
├── .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

Badges

Code Climate issues

GitHub language count

Lines of code

add some badges in for the project - use https://shields.io/

Images

add screenshots & GIf to give some information about the project

Support

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.

Roadmap

If you have ideas for releases in the future,

  • @mentions, #refs, links, formatting, and tags supported
  • list syntax required (any unordered or ordered list supported)
  • this is a complete item
  • this is an incomplete item

Contributing

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

License

MIT

Project Status

Complete