nghuuquyen/express-starter

Simple starter boilerplate code for Node.js using Express, Vite, Tailwind CSS and Prisma ORM

Simple Express Starter

This project setup is a simple Express.js starter template with the following features:

• EJS templates for rendering HTML pages.
• Prisma ORM for database access.
• MySQL database.
• Environment variables using dotenv.
• Tailwind CSS for styling.
• ESLint and Prettier for code linting and formatting.
• Nodemon for auto-reloading the server during development.
• Winston for logging.
• Express-validator for request validation.
• Helmet for securing the app by setting various HTTP headers.
• Compression for compressing the response data.
• Morgan for logging HTTP requests.
• Vite for building the frontend assets. Support HMR (Hot Module Replacement) in development mode.
• Build the frontend assets with npm run build.

Prerequisites

Before running this project, ensure you have the following installed:

• Node.js
• MySQL
• Git

Project Structure

Here is an overview of the main directories and files in the project:

• /controllers: Contains the logic for handling requests and returning responses.
• /views: Contains the EJS templates for rendering HTML pages.
• /config: Holds configuration files for the database connection and environment variables.
• /public: Static files like CSS, JavaScript, and images.
• server.js: The main entry point of the application.
• package.json: Lists the project dependencies and scripts.

Setup Instructions

1. Clone the Repository

git clone https://github.com/nghuuquyen/express-starter.git

cd express-starter

2. Install Dependencies

Install all required dependencies using npm:

npm install

3. Database Setup

• Ensure MySQL is running on your machine.
• Create a new database called apps.
• Update the database configuration in environment variables (.env file).

Create .env like .env.example and set the values. For example:

PORT=3000
SITE_NAME="Express Starter"
NODE_ENV=development
DATABASE_URL="mysql://root:password@localhost:3306/apps"

4. Run Database Migrations

Run the migrations to set up the database schema:

npx prisma migrate dev

5. Seed the Database

Populate the database with initial data:

node prisma/seed.js

6. Start the Server

If you want to run the server in production mode, use:

npm start

If you want to run in development mode, use:

npm run dev

Reset Database

To reset the database, you could run the following command to undo all migrations and re-run them.

npx prisma migrate reset
node prisma/seed.js