Skip to content

cmropensource/toolsmith-backend

Repository files navigation

🚀 Toolsmith Backend

📜 Description

Toolsmith Backend is a project that implements Postgres Bulk Insert functionality, allowing for efficient batch insertion of data into PostgreSQL databases. This project aims to streamline data processing and enhance performance in scenarios requiring large-scale data imports.

🌟 Features

  • Bulk Insert Capabilities for PostgreSQL
  • Middleware Integration for enhanced data handling
  • Prisma Support for seamless database interactions
  • Route Management for structured data endpoints

📁 File Structure

Controller

  • UserController.ts
  • bulkInsert.ts
  • dataBasesController.ts
  • getQueryData.ts

Helper

  • BulkInsertHelpers.ts
  • structerData.ts

Middleware

  • AuthMiddleWare.ts
  • tablesMiddleware.ts

Prisma

  • migrations/
  • schema.prisma

Routes

  • UserRouter.ts
  • bulkInsertRouter.ts
  • dataBaseRouter.ts
  • queryRouter.ts

🛠️ Language

This project is developed using TypeScript.

⚙️ Installation Instructions

To set up the Toolsmith Backend project locally, follow these steps:

  1. Clone the repository: Use the following command to clone the repository to your local machine:

    git clone https://github.com/cmropensource/toolsmith-backend.git
  2. Navigate to the project directory: Change your working directory to the cloned repository:

    cd toolsmith-backend
  3. Install the dependencies: Run the command below to install all necessary dependencies:

    npm install
  4. Configure your database connection in the schema.prisma file.

  5. Start the application using the command:

    npm start
  6. Use the defined routes to perform bulk inserts and other database operations.

🤝 Contributing

Contributions are welcome! If you'd like to contribute to the project, please follow these steps:

  1. Fork the repository.

  2. Create a new branch for your feature or fix:

    git checkout -b feature/YourFeature
  3. Commit your changes:

    git commit -m 'Add some feature'
  4. Push to the branch:

    git push origin feature/YourFeature
  5. Open a pull request on GitHub.

📝 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.

📫 Contact

For questions or feedback, feel free to reach out:

🎉 Acknowledgments

Special thanks to the contributors and resources that helped in developing this project.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •