Giter Club home page Giter Club logo

basic-files's Introduction

"Basic Files" - to include in most projects

version 0.1.0 or version badge

A repository that helps my new projects cover some basics that most poeple don't focus, unless they have to.

Getting Started

The repository is a great place to copy and paste what is helpful and learn more about project files you might want to include in every project.

What the app should do?

These files are a place to start. Not every project needs these files. I find myself wanting to have some part of each of these files once I have finished my first build of THE APP. The one APP I created that will rule the world and raise me up out of poverty!

  1. Preferred software License
  2. Basic ReadMe Outline.
  3. "How-To" Contribute to the code.
  4. Code of Conduct, good for in-person meetups.
  5. Vulnerabilities? "How-To" responsibly report security issues and flaws.
  6. Developer Journal, project notes.
  7. editorconfig
  8. exclude or gitignore
  9. Software Design Document

Why is this app useful?

You should think about these files because...

1 Without a license file someone will steal your intellectual property or not use your app because they don't legally know where they stand.

2 A good ReadMe file speaks to your user and can help devs go from 0 to 60 with your project. This helps folks get on board with your idea faster.

3 Remember all those folks that help you make the app the behemoth it is today.

4 Set a level playing field for anyone that wants to join the team. Plus this is one of the best ways to inclusive of others.

5 Security flaws will happen. Create a doorbell for the good samaritan to help out.

CREDIT

[Bishop Fox - Cybersecurity Style Guide - v1.1] (https://www.bishopfox.com/blog/2018/02/hello-world-introducing-the-bishop-fox-cybersecurity-style-guide/)

Built With

  • Markdown
  • Github

CONTRIBUTIONS

Solo project so far. Code and graphic design contributors are welcome and encouraged to help. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me. (I will copy their instructions when I get time, but for now ditto to what they say)

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

  • "I tip my hat to anyone whose code was used!" npm gives me a lot of people to thank!
  • Special thank you to my mom, wife, and daughters! Without their love and support this would gone nowhere.
  • Gratitude is the attitude!

NOTES

  • Timeline: I started this project 2023-12-12 20:59:41. The plan is to code on this every morning.

DEVELOPER SECTION (below)

Prerequesites

Installing

Tests

Coding Style

Deployment

Development server

Run npm run dev for a dev server. Navigate to http://localhost:3000/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run npx create-next-app@latest to generate a new project.

Build

Run npm run build to build the project.

Running unit tests

Run npm run test to execute the unit tests via Jest.

Running end-to-end tests

Run npm e2e to execute the end-to-end tests via cypress.

Linting

Further help

To get more help react read the docs and join Stack Overflow.


CUT & PASTE

"project_name" - project_sub_title

Getting Started

What the app should do?

CREDIT

Built With

Contributing

Versioning

Authors

License

Acknowledgments

NOTES


Development server

Code scaffolding

Build

Running unit tests

Running end-to-end tests

Linting

Further help

basic-files's People

Contributors

trewaters avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.