This project is a backend API built using the Hono framework and Dreazzle, written in TypeScript, and integrated with a serverless Neon PostgreSQL database. The purpose of this project is to provide a robust, scalable, and maintainable backend service.
- Features
- Technologies Used
- Setup and Installation
- Configuration
- Running the Project
- API Endpoints
- Testing
- Contributing
- License
- RESTful API endpoints
- Serverless architecture
- Type-safe codebase using TypeScript
- PostgreSQL database integration with Neon
- Efficient routing and middleware handling with Hono
- Scalable and easy-to-deploy using Dreazzle
- Node.js (v14 or later)
- npm or yarn
- Neon PostgreSQL account
-
Clone the repository:
git clone https://github.com/sammy6378/back-end-API.git cd your-repo-name
-
Install the dependencies:
npm install # or yarn install
-
Set up the environment variables. Create a
.env
file in the root directory and add the following variables:DATABASE_URL=your_neon_database_url PORT=3000
Ensure you have a Neon PostgreSQL database set up and note the connection string (DATABASE_URL).
To start the development server, run:
npm run dev
# or
yarn dev