Welcome to our API repository! This project is built using modern and efficient technologies to ensure high performance and scalability. 🚀
- 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. 🌍
- ✅ 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.
Follow these steps to get started:
git clone https://github.com/AxierPer/Api-Rest-TypeScript.git
Use the following command to install project dependencies:
bun install
Create a .env
file in the project root and add the following variables:
DATABASE_URL=your-turso-url
API_SECRET_KEY=your-secret-key
Run the local server with:
bun run dev
The server will be available at http://localhost:3000 🎉
📦 api-project
├── 📂 src
│ ├── 📂 database
│ │ └── database.ts
│ ├── 📂 routes
│ │ └── auth.route.ts
│ ├── 📂 schemasValidator
│ │ └── schema.validator.ts
│ ├── 📂 utils
│ │ └── config.utils.ts
│ └── index.ts
├── 📂 config
├── 📂 scripts
└── bunfig.toml
bun run dev
: Starts the server in development mode.bun run build
: Builds the project for production.bun run test
: Runs unit tests. 🧪
We would love your help to improve this project! Please follow these steps to contribute:
- Fork this repository.
- Create a new branch for your feature:
git checkout -b feature/my-feature
. - Make your changes and commit them:
git commit -m "Added new feature"
. - Push your branch:
git push origin feature/my-feature
. - Open a Pull Request. 💡
This project is licensed under the MIT License.
Thanks to all developers and tools that make projects like this possible. 🙌
For any inquiries or feedback, feel free to reach out:
- ✉️ Email: axierper2024@icloud.com
Thanks for visiting this project! 🎉