ExpressTS-ReadySetGo

ExpressTS-ReadySetGo is an Express.js and TypeScript boilerplate equipped with ESLint, Prettier, Husky, Jest, Supertest, and Pino ready to kickstart your backend development.

Features

Express.js as the web framework
TypeScript for static typing
ESLint for linting
Prettier for code formatting
Husky for managing git hooks
Jest for testing
Supertest for HTTP assertions
Pino for logger

Getting Started

Follow these steps to get your project up and running.

Prerequisites

Make sure you have Node.js and npm installed on your machine.

Installation

Clone the repository:

git clone https://github.com/sanjaysah101/ExpressTS-ReadySetGo.git

Install dependencies:
```
cd TypeExpress-Starter
npm install
```
Usage
```
npm run dev
```
Testing
```
npm test
```

Contributing

Contributions are welcome! Please read the Contribution Guidelines

🐞 Reporting issues
💡 Suggesting new features
📚 Improving documentation
🐛 Fixing bugs
💻 Adding new code

License

This project is licensed under the MIT License. See the License file for details.

Automate package name replacement in package.json

Problem

Currently, the name field in the package.json file is static. When a user clones the boilerplate, they have to manually change the name field to their project's name. This can be a bit inconvenient and goes against the principle of a boilerplate, which should be ready to use out of the box.

Proposed Solution

We should automate the process of replacing the name field in the package.json file with the user's input name. This can be achieved by creating a setup script that prompts the user for their project name and automatically replaces the name field in the package.json file.

Here's a basic example of how this could be implemented in Node.js:

const fs = require('fs');
const prompt = require('prompt');

prompt.start();

prompt.get(['name'], function (err, result) {
    if (err) { return onErr(err); }
    let package = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
    package.name = result.name;
    fs.writeFileSync('./package.json', JSON.stringify(package, null, 2));
});

function onErr(err) {
    console.log(err);
    return 1;
}

This script uses the prompt module to ask the user for their project name, then reads the package.json file, replaces the name field with the user’s input, and writes the changes back to the package.json file.

Next Steps
Implement the setup script.
Update the README to include instructions for the setup script.
This will make the boilerplate more user-friendly and ready to use out of the box.

sanjaysah101 / expressts-readysetgo Goto Github PK