Express.js Server Template

This project is an Express.js server template, designed to provide a robust and scalable foundation for building web applications. It leverages TypeScript for type safety and Prisma as an ORM for efficient database management.

Features

TypeScript Integration: Leverage the power of type safety and modern JavaScript features with TypeScript.
Prisma ORM: Efficiently manage and interact with your database using Prisma, a next-generation ORM.
Authentication: Secure API endpoints with built-in authentication mechanisms.
Middleware Support: Enhance your server with custom middleware for logging, error handling, and more.
Auto-Restart: Development made easier with Nodemon for automatic server restarts on file changes.
Database Migrations: Manage your database schema and migrations effortlessly with Prisma migrations.

Getting Started

Prerequisites

Node.js
npm or Yarn
A supported SQL database for Prisma (e.g., PostgreSQL, MySQL)

Installation

Clone the repository:

git clone https://github.com/takeshicamilo/expressjs-server-template.git

Install dependencies:
```
npm install or yarn install
```
Run database migration:
```
npx prisma migrate dev
```
Run server:
```
npm run dev
```

API Endpoints

Creating New APIs and Securing

To add a new API endpoint, follow these steps:

Create a new file under the src/api directory. For example, src/api/users.ts.

Define your route and handler in this file. Example:

import { Router } from 'express';

const router = Router();

router.get('/users', (req, res) => {
  res.json({ message: 'List of users' });
});

export default router;

Import the new route module at the top of your index.ts file. For example, if you created users.ts under the src/api directory, you would import it like this:
```
import userRoutes from './api/users';
app.use('/api', userRoutes);
```

Applying Middleware to a Route

Middleware functions in Express.js can be used for various purposes like authentication, logging, or modifying the request/response objects. Here's how you can apply middleware to a route in your Express.js application:

Example: Using Middleware in a Route

Assuming you have a middleware function already defined (named middleware in this case), you can apply it to your routes as shown in the following example:

import middleware from './path-to-middleware';

app.get("/", middleware, (req: CustomRequest, res: Response) => {
  console.log(req.user, 'asd'); // Example usage of a property set by the middleware
  res.send("Hello World!");
});

Environment Variables

The application uses environment variables for configuration. This allows you to set key parameters and secrets without hard-coding them into your application code. The .env file is the default place to store these settings.

Here's an explanation of the environment variables used in this project:

DATABASE_URL: This is the connection string for your database. It includes the username, password, host, port, and database name. For example:

DATABASE_URL="mysql://username:password@localhost:3306/database_name"

Replace username, password, localhost, 3306, and database_name with your actual database credentials and details.

JWT_SECRET: This is the secret key used for signing JSON Web Tokens (JWT). It's crucial for the security of your JWT implementation. For example:

JWT_SECRET="your_secret_key"

Ensure this key is kept secret and not exposed publicly.

EXPIRE_TIME: This defines the expiration time of the JWT. It determines how long a token remains valid after being issued. For example:

EXPIRE_TIME="1h"

This sets the token to expire in 1 hour. You can adjust the duration according to your requirements.

Setting Up the `.env` File

To set up your .env file:

Create a file named .env in the root directory of your project.
Add the environment variables listed above to the file with your specific settings.
Make sure to never commit this file to your version control system (e.g., Git). Add .env to your .gitignore file to prevent it from being shared publicly.

The application will load these settings at runtime, and they will be accessible in your code through process.env.VARIABLE_NAME.

Contributing

Contributions to improve this template are welcome. Please read our CONTRIBUTING.md for guidelines on how to contribute.

License

This project is licensed under the MIT License.

takeshicamilo/expressjs-server-template