Skip to content

This project is an api created with TypeScript, using Bun and Hono, for the microservices and Drizzel as ORM, and Turso as intermediary for the DB.

License

Notifications You must be signed in to change notification settings

AxierPer/Api-Rest-TypeScript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌟 API with TypeScript, Bun, Hono, Drizzle, and Turso

Welcome to our API repository! This project is built using modern and efficient technologies to ensure high performance and scalability. 🚀


🛠️ Technologies Used

  • TypeScript: Static typing for JavaScript, increasing productivity and reducing errors. 📝
  • Bun: An ultra-fast runtime for JavaScript and TypeScript. ⚡
  • Hono: A minimalist and lightweight framework for building web APIs. 🌐
  • Drizzle ORM: A simple yet robust ORM for seamless SQL queries. 🗂️
  • Turso: A distributed database for unparalleled performance and low latency. 🌍

📋 Main Features

  • ✅ Ultra-fast API powered by Bun and Hono.
  • 🔐 Built-in security with robust error handling.
  • 📊 Efficient connection to distributed databases with Turso and Drizzle.
  • 🚀 Easy to deploy and scale.

🚀 Installation and Usage

Follow these steps to get started:

1️⃣ Clone the repository

git clone https://github.com/AxierPer/Api-Rest-TypeScript.git

2️⃣ Install dependencies

Use the following command to install project dependencies:

bun install

3️⃣ Configure environment variables

Create a .env file in the project root and add the following variables:

DATABASE_URL=your-turso-url
API_SECRET_KEY=your-secret-key

4️⃣ Start the server

Run the local server with:

bun run dev

The server will be available at http://localhost:3000 🎉


📂 Project Structure

📦 api-project
├── 📂 src
│   ├── 📂 database
│   │   └── database.ts
│   ├── 📂 routes
│   │   └── auth.route.ts
│   ├── 📂 schemasValidator
│   │   └── schema.validator.ts
│   ├── 📂 utils
│   │   └── config.utils.ts
│   └── index.ts
├── 📂 config
├── 📂 scripts
└── bunfig.toml

🧪 Available Scripts

  • bun run dev: Starts the server in development mode.
  • bun run build: Builds the project for production.
  • bun run test: Runs unit tests. 🧪

🤝 Contributions

We would love your help to improve this project! Please follow these steps to contribute:

  1. Fork this repository.
  2. Create a new branch for your feature: git checkout -b feature/my-feature.
  3. Make your changes and commit them: git commit -m "Added new feature".
  4. Push your branch: git push origin feature/my-feature.
  5. Open a Pull Request. 💡

📄 License

This project is licensed under the MIT License.


🌟 Acknowledgments

Thanks to all developers and tools that make projects like this possible. 🙌


📬 Contact

For any inquiries or feedback, feel free to reach out:

Thanks for visiting this project! 🎉

About

This project is an api created with TypeScript, using Bun and Hono, for the microservices and Drizzel as ORM, and Turso as intermediary for the DB.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published