PJ-TEMPLATES

Pre-built, development ready code templates at your fingertips.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Node Js

Installing

A step by step series of examples that tell you how to get a development env running

Follow the instructions mentioned below:

1. npm install pj-templates -g
2. code-template <template-name> <your-app-name>

End with an example of getting some data out of the system or using it for a little demo

Template Names

There are 3 type of template names

1. For low-end machines

a. redux-chakra-vite
b. redux-vite (work in progress)
c. redux-ts-vite (work in progress)
d. mern-chakra-vite
e. mern-vite (work in progress)
f. mern-ts-vite (work in progress)

2. For high-end machines

a. redux-cra
b. mern-cra (work in progress)
c. mern-ts-cra (work in progress)

3. For all machines

a. express-server

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Node Js - The web framework used
• fs-modules - Dependency to handle filesystem
• ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Prajwal Jaiswal - Initial work - PurpleBooth

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

• Hat tip to anyone whose code was used
• Inspiration
• etc