Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ahmet-cetinkaya/acore-ts

Core TypeScript package with reusable implementations and helper code snippets for various software development needs.
https://github.com/ahmet-cetinkaya/acore-ts

async core crypto dependency-injection extensions helper i18n jsdos nodejs package store three-js typescript ui

Last synced: 11 days ago
JSON representation

Core TypeScript package with reusable implementations and helper code snippets for various software development needs.

Awesome Lists containing this project

README

        

# ![Software logo](https://github.com/user-attachments/assets/f05a6797-8a78-459e-858b-f733338b94ee) `acore-ts` ![GitHub stars](https://img.shields.io/github/stars/ahmet-cetinkaya/acore-ts?style=social) ![GitHub forks](https://img.shields.io/github/forks/ahmet-cetinkaya/acore-ts?style=social) [![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?&logo=buy-me-a-coffee&logoColor=black)](https://ahmetcetinkaya.me/donate)

This repository serves as a core package written in TypeScript, containing various implementations and helper code snippets that I frequently need while developing my projects. It aims to provide optimized and reusable solutions for different areas of software development.

## 💻 Technologies Used

This project is built using the following technologies:

[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/)
[![Bun](https://img.shields.io/badge/Bun-000000?style=for-the-badge&logo=bun&logoColor=white)](https://bun.sh/)

### Minimal Package Usage

This project minimizes the use of external packages. When necessary, implementations are written using core packages to ensure better control and optimization of the codebase.

## ⚡ Getting Started

This section explains how to get your project up and running.

### 📋 Requirements

- bun

### 🛠️ Installation

1. Clone the repository:
```bash
git clone https://github.com/ahmet-cetinkaya/acore-ts.git
```
2. Navigate into the project directory:
```bash
cd acore-ts
```
3. Install the dependencies:
```bash
bun install
```
4. Start the application:
```bash
bun start
```

## 📦 Adding as a Submodule

To add this repository as a submodule to another project, follow these steps:

1. Navigate to your project directory:
```bash
cd your-project-directory
```
2. Add the submodule:
```bash
git submodule add https://github.com/ahmet-cetinkaya/acore-ts.git path/to/submodule
```
3. Initialize and update the submodule:
```bash
git submodule update --init --recursive
```
4. Navigate into the submodule directory and install dependencies:
```bash
cd path/to/submodule
bun install
```

## 🤝 Contributing

If you'd like to contribute, please follow these steps:

1. Fork the repository
2. Create a new branch (`git checkout -b feat/feature-branch`)
3. Make your changes
4. Commit your changes (`git commit -m 'feat: add new feature'`)
5. Push to the branch (`git push origin feat/feature-branch`)
6. Open a Pull Request