- Language: TypeScript
- Framework: ExpressJS
- Database: PostgreSQL
- Auth: JSON web token (JWT)
- Sign up
- Verify email (sent via elastic email)
- Login using JWT token
- See logged user's profile
- Swagger UI
- Node >= 18.0.0
- NPM >= 9.5.0
- Postgres >= 12.0.0
Prerequisites
- Clone the project:
git clone [email protected]:wildan3105/express-typescript-postgres-signup-login.git - Install dependencies:
npm i - Copy the environment variable and adjust the value accordingly:
cp .env.example .env - Create a postgre user and then database in which you have full access to that DB (could create extension). And then specify the credentials in the
.envfile asDATABASE_URL
DATABASE_URL='postgres://user:password@host:port/database'- Run the server
npm run start(it will watch anyTSfile changes and re-spawn it automatically)
- Build to JS files:
npm run build - Run the JS file:
node builds/src/server.js
TBD
npm run format:check -> to check format
npm run format -> to automatically format the codenpm run lint -> to check the lint error (prevent bugs early)
npm run lint:fix -> to fix the lint error if it's fixableStill WIP
npm run testPlease go here
├── docs
│ └── openapi.yaml
├── postman
├── src
│ ├── app.ts
│ ├── cmd
│ │ └── generate-error-map
│ │ ├── index.ts
│ │ └── schema-http-code.json
│ ├── config.ts
│ ├── controllers
│ │ ├── healthcheck.ts
│ │ ├── middlewares
│ │ │ ├── auth.ts
│ │ │ └── handle-error-code.ts
│ │ └── user.ts
│ ├── db-connect.ts
│ ├── domain
│ │ ├── errors.ts
│ │ ├── standard-error.ts
│ │ ├── user-entity.ts
│ │ ├── user-login.ts
│ │ └── user-verification-code-entity.ts
│ ├── events
│ │ ├── index.ts
│ │ └── listeners
│ │ └── user-event.ts
│ ├── init.ts
│ ├── interfaces
│ │ ├── user-verification-code.ts
│ │ └── user.ts
│ ├── libs
│ │ ├── env
│ │ │ └── index.ts
│ │ ├── sleep
│ │ │ └── index.ts
│ │ └── typeorm
│ │ ├── entities.ts
│ │ ├── migrations
│ │ │ ├── ... migration files
│ │ │ └── index.ts
│ │ ├── ormconfig-cli.ts
│ │ ├── ormconfig.ts
│ │ └── repository
│ │ ├── user-verification-code.ts
│ │ └── user.ts
│ ├── server.ts
│ ├── services
│ │ ├── external
│ │ │ └── email
│ │ │ ├── config.ts
│ │ │ ├── index.ts
│ │ │ ├── interface.ts
│ │ │ └── template.ts
│ │ ├── healthcheck.ts
│ │ └── user.ts
│ └── utils
│ └── index.ts
├── tests
│ ├── controllers
│ │ └── healthcheck.test.ts
│ └── utils
│ └── index.test.ts| Name | Description |
|---|---|
| docs/ | Store Open API spec. |
| src/ | Source files. |
| src/cmd/ | All CLI-based files are stored here. In this specific case, it will generate error code based on Open API definition. |
| src/controllers/ | REST API Controllers. |
| src/controllers/middlewares | Store middlewares that are used to intercept, validate, add data to request/response and or perform authentication to certain routes. |
| src/domain | Typescript classes to represent entities. |
| src/events/ | Event listeners. |
| src/interfaces/ | A collection of interfaces, especially for HTTP request-response. |
| src/libs/env/ | Library to inject environment variable from an .env file. |
| src/libs/sleep/ | Library to add delay for a certain amount of time. |
| src/libs/typeorm/ | All functionalities with regard to type ORM (SQL migration files, ORM config, and repository layer). |
| src/services/ | Service layer. Core business logics are stored here. |
| src/utils/ | This directory contains utility functions for generating random codes and validating strings against specific rules |
| tests/ | Test directory for both unit and integration tests. |
Please head over to this URL: swagger