Skip to content

Latest commit

 

History

History
152 lines (71 loc) · 2.94 KB

File metadata and controls

152 lines (71 loc) · 2.94 KB

"project_name" - project_sub_title

version 0.1.0 or version badge

An app that ...

Getting Started

The app is ...

What the app should do?

Describe what the app should do

Why is this app useful?

Tell us why we should use this.

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

  • This project was generated with NextJS version 6.0.7.
  • React version #
  • NodeJS
  • BART API San Francisco Bay Area Rapid Transit "BART"

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 daughter! Without their love and support this would gone nowhere.
  • Gratitude is the attitude!

NOTES

  • Timeline: I started this project 2023-12-12 20:42:47. 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