Iftakharalamrizve/express-ts-api-starter

A starter template for API-based express applications with TypeScript enabled.

Express + TypeScript

[A Starter Template]

🔑 Key Features:

• Good ol' Express.
• Type-safety (TypeScript).
• ORM with schema migration (TypeORM).
• Session-based and Token-based Authentication (Passport).
• Logging (Winston + Morgan).
• Testing (Supertest + Jest).
• Mailing (Nodemailer).
• Request validation (Express Validator).
• Background job processing (Bull).
• Queue monitoring dashboard (Bull Board).

🏁 Getting Started:

• Generate a project based on this template.
• Create two postgres or mysql databases: express_ts and express_ts_test
• Clone the newly created repo and cd into the directory.
• Change the DB credentials accordingly in the .env.example and .env.test files. In the next step, a .env file will be generated based on these changes.
• Run npm run install or, yarn install if you're using yarn.
• Run npm run dev or, yarn dev.

🤖 Commands:

• npm run build: Compile all .ts source files and output the compiled files into /dist directory.
• npm run dev: Run the project in development mode. Changes will be picked up and server will be restarted automatically.
• npm run test: Run all the unit and integration tests located in /tests directory.
• npm run start: Compile the .ts source files and run the project by invoking the compiled source files.
• npm run fmt: Format the source code using the rules defined in .prettierrc.
• npm run entity:make: Create a migration file. Ex: npm run entity:make Post. An entity file will be created inside the /src/database/sql/entities directory.
• npm run migrate:make: Create a migration file. Ex: npm run migrate:make CreatePostsTable. A migration file with current timestamp will be created inside the /src/database/sql/migrations directory.
• npm run migrate: Migrate the database schema. This will apply all newly created migrations.
• npm run migrate:rollback: Undo the last run migration.
• To run more migration or seed-specific commands, consider installing the knex cli globally. Learn more.

🐳 Docker:

The project ships with some docker configs and a cli. You can interact with the docker containers using this cli. When the NODE_ENV variable is set to production, the cli will use the docker-compose.yml and docker-compose.prod.yml file, otherwise it will use the docker-compose.yml and docker-compose.dev.yml file.

• ./cli start to launch all the containers in detached mode. ./cli stop will stop and remove all the containers.
• ./cli yarn will invoke the yarn command from within the app container. For example, to compile the source code, you could run ./cli yarn build.
• When running in production, you might want to use a free SSL from LetsEncrypt. ./cli ssl will attempt to issue a certificate for the domains you've specified in your .env file. The SSL_STAGING=1 generates a dummy certificate, and SSL_STAGING=0 generates a real certificate and you will face an ACME challenge. Make sure your DNS record panel is open in another tab before you proceed with this operation. If the ACME challenge fails, try again with ./cli ssl.
• If the certificate has been generated successfully, you will need to run ./cli post-ssl to fetch the dhparam key file.
• Adjust the production specific nginx configs in the nginx.prod.conf file.

Do you have a significant feature in mind? Create an issue or send a pull request.

📝 Notes:

• Although this template comes with many components pre-installed, it does not impose any hard-bound rule on the project structure. Feel free to customize the directory structure and add or remove the components as you see fit for your project. Removing a module will be easier since we're using TypeScript. Any good text editor/IDE will help you track down a non-existing reference in the codebase.
• Kebab-case is used for the file names since it is the most compatible across all operating systems. If you don't like this convention, feel free to change.