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.
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.
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!
- Preferred software License
- Basic ReadMe Outline.
- "How-To" Contribute to the code.
- Code of Conduct, good for in-person meetups.
- Vulnerabilities? "How-To" responsibly report security issues and flaws.
- Developer Journal, project notes.
- editorconfig
- exclude or gitignore
- Software Design Document
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.
[Bishop Fox - Cybersecurity Style Guide - v1.1] (https://www.bishopfox.com/blog/2018/02/hello-world-introducing-the-bishop-fox-cybersecurity-style-guide/)
- Markdown
- Github
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)
- Tre' Grisby - Initial work - trewaters
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details.
- "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!
- Timeline: I started this project 2023-12-12 20:59:41. The plan is to code on this every morning.
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.
Run npx create-next-app@latest to generate a new project.
Run npm run build to build the project.
Run npm run test to execute the unit tests via Jest.
Run npm e2e to execute the end-to-end tests via cypress.
To get more help react read the docs and join Stack Overflow.
CUT & PASTE