https://github.com/arifulislam5577/keyzone-backend

https://github.com/arifulislam5577/keyzone-backend

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/arifulislam5577/keyzone-backend
• Owner: Arifulislam5577
• Created: 2024-09-08T14:47:48.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T15:35:36.000Z (2 months ago)
• Last Synced: 2024-10-12T05:06:11.863Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://keyzone-backend.vercel.app
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
## Keyzone backend

Live Link : https://keyzone-backend.vercel.app

## Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/Arifulislam5577/keyzone-backend.git

   cd keyzone-backend

   ```

2. Install the dependencies:

   ```bash

   npm install

   ```

3. Create a `.env` file in the root directory and configure your environment variables. Example:

   ```env

   NODE_ENV = DEVELOPMENT

   DATABASE_URL = YOUR_DATABASE_URL

   PORT = 5000

   CLOUD_NAME=CLOUDINARY_CLOUD_NAME

   CLOUD_API_KEY=CLOUDINARY_CLOUD_API_KEY

   CLOUD_API_SECRET=CLOUDINARY_CLOUD_API_KEY

   ```

## Scripts

### Build

Compile the TypeScript code to JavaScript:

```bash

npm run build

```

### Development

Run the application in development mode with hot-reloading:

```bash

npm run dev

```

### Linting

Lint the TypeScript files:

```bash

npm run lint

```

Automatically fix linting issues:

```bash

npm run lint --fix

```

### Formatting

Format the TypeScript files:

```bash

npm run format

```

---