YaraYara TS Node Express: A TypeScript Node Server Setup Script

Overview

YaraYara TS Node Express simplifies the setup process for a TypeScript Node.js server, automating everything from folder structure creation to Swagger documentation and Git initialization.

This script automates the setup process for a TypeScript Node.js server along with its folder structure, dependencies, API routes, Swagger documentation, Git initialization, and server startup.

Requirements

• Bash
• Git
• Node.js
• npm

Usage

1. Run git clone https://github.com/highb33kay/YaraYara in your shell or terminal.
2. Make it executable by running chmod +x yara.
3. Execute the script by running ./yara.
4. Follow the prompts to configure your project.
5. Watch the magic as it unfolds! ❤️🪄

Features

• Sets up a TypeScript Node server with Express framework.
• Creates a folder structure for controllers, database, interfaces, middlewares, routes, services, and utils.
• Installs necessary dependencies including TypeScript, Express, ts-node-dev, Swagger, and Morgan.
• Configures Swagger for API documentation.
• Setup a Greetings Endpoint for testing.
• Initializes Git and creates a .gitignore file.
• Starts the development server using npm run start:dev.

File Structure

• src: Contains source code for the project.
  • controllers: Controllers for handling API requests.
  • database: Database models and configurations.
  • interfaces: Interface definitions.
  • middlewares: Middleware functions.
  • routes: API routes.
  • services: Service layer for business logic.
  • utils: Utility functions.
  • swagger.ts: Swagger documentation setup.
  • server.ts: Server setup.
• .env: Environment variables configuration file.
• app.ts: Main application file.
• .gitignore: Git ignore file.
• package.json: Project metadata and dependencies.
• README.md: Project README.

Dependencies Installed

• Node.js
• TypeScript
• Express
• ts-node-dev
• Swagger UI Express
• Swagger JSDoc
• Morgan

After Setup

1. Edit the .env file to configure environment variables.
2. Run npm run start:dev to start the development server.
3. Visit http://localhost:3000/api-docs to view Swagger API documentation.
4. Visit http://localhost:3000/api/v1/greetings to test the Greetings Endpoint.
5. Edit the README.md file to document your project.
6. Edit the package.json file to add additional project metadata and dependencies.

⭐ Leave a star, share your suggestions for improvement! 🚀

Author and Contributors

• Ibukun Alesinloye (highb33kay)
• Oluwaseyi Ogunjuyigbe (seyiogunjuyigbe)

License

This script is licensed under the MIT License.