https://github.com/naufan17/express-boilerplate
Express started to build REST API
https://github.com/naufan17/express-boilerplate
expressjs knex objection typescript
Last synced: about 2 months ago
JSON representation
Express started to build REST API
- Host: GitHub
- URL: https://github.com/naufan17/express-boilerplate
- Owner: naufan17
- License: mit
- Created: 2025-01-28T14:31:57.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-22T08:58:55.000Z (3 months ago)
- Last Synced: 2025-02-22T09:45:00.611Z (3 months ago)
- Topics: expressjs, knex, objection, typescript
- Language: TypeScript
- Homepage:
- Size: 459 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Boilerplate Express JS REST API
Minimalist project structure using express js to build REST API
## Table of Content
- [Preparation](#preparation)
- [Run Server](#run-server)
- [Feature](#feature)
- [Project Structure](#project-structure)
- [API Documentation](#api-documentation)
- [Default API Endpoint](#default-api-endpoint)
- [Response Format](#response-format)
## Preparation
- Clone this repository
```
git clone https://github.com/naufan17/express-boilerplate.git
```
- Enter directory project
```
cd express-boilerplate
```
- Delete git
```
rm -rf .git
```
- Fill and copy your environtment file in development or production to .env or change default import from environtment file
- Custom your project name
- Instal dependencies
```
npm install
```
- Migrate database
```
npm run migrate
```
- Seed database
```
npm run seed
```
# Run Script
- Build the project
```
npm run build
```
- Lint code
```
npm run lint
```
- Test code
```
npm run test
```
## Run Server
- Start the server in local development
```
npm run dev
```
- Start the server in production
```
npm run start
```
## Run Server in Docker
- Start the server
```
docker compose up --build
```
- Stop the server
```
docker compose down
```
## Feature
- **Database**: using https://knexjs.org/
- **ORM**: using https://vincit.github.io/objection.js/
- **Authentication**: using https://github.com/auth0/node-jsonwebtoken and https://github.com/passportjs/passport
- **Logging**: using https://github.com/expressjs/morgan and https://github.com/winstonjs/winston
- **Linting**: using https://eslint.org/
- **Validation**: https://express-validator.github.io/docs/
- **Rate Limit**: using https://github.com/expressjs/express-rate-limit
- **Security**: using https://helmetjs.github.io/
- **CORS**: using https://github.com/expressjs/cors
- **Compression**: using https://github.com/expressjs/compression
- **Environtment variables**: using https://github.com/motdotla/dotenv
- **Testing**: using https://github.com/jestjs/jest and https://supertest.js.org/
- **API Documentation**: using https://swagger.io/
- **Dependency management**: using https://www.npmjs.com/
## Project Structure
```
docs\ # Documentation files
src\
|--app\
|--api\
|--v1\
|--controllers\ # Request handler
|--middlewares\ # Middleware
|--models\ # Database models
|--repositories\ # Database queries
|--routes\ # API routes
|--services\ # Business logic
|--validators\ # Validation function
|--config\ # Config files
|--helper\ # Helper function
|--type\ # Typescript types
|--util\ # Utility function
|--app.ts # Main app entry point
|--database\
|--migrations\ # Database migrations
|--seeds\ # Database seeds
|--index.ts # Main entry point
test\
|--integration\ # Integration tests
```
## API Documentation
To view the API documentation, open the following link:
``GET /api-docs`` - API documentation
## Default API Endpoint
**Auth routes**:
``POST /api/v1/auth/register`` - Create new account
``POST /api/v1/auth/login`` - Login to existing account
``GET /api/v1/auth/refresh`` - Refresh access token
``GET /api/v1/auth/logout`` - Logout
**Account routes**:
``GET /api/v1/account/profile`` - Get current account profile
``GET /api/v1/account/session`` - Get current account session
``POST /api/v1/account/update-profile`` - Update current account profile
``POST /api/v1/account/update-password`` - Update current account password
## Response Format
- **Success Response**:
```
{
"statusCode": 200,
"message": "success message",
"data": {
"key": "value",
}
}
```
- **Error Response**:
```
{
"statusCode": 400,
"message": "error message",
}