This project is a boilerplate for building APIs with Express and Node.js. It follows best practices for organization and testing, making it a great starting point for your next project.
- Express: Fast, unopinionated, minimalist web framework for Node.js
- Authentication: Register, login, and protect routes using JWT
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Express - Fast, unopinionated, minimalist web framework for Node.js
- Nodemon - Automatically restart the node application when file changes in the directory are detected
- Bcrypt - A library to help you hash passwords
- Dotenv - Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env
- Express-validator - An express.js middleware for validator
- MySQL2 - MySQL client for Node.js with focus on performance. Supports prepared statements, non-utf8 encodings, binary log protocol, compression, ssl
- Sequelize - Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more
- Jsonwebtoken - An implementation of JSON Web Tokens
- Node.js
- npm
- Clone the repo
git clone https://github.com/Patzi275/express-typescript-api-boilerplate.git
- Install NPM packages
npm install
After installing the dependencies, you can start the development server by running:
npm run devThis will start the server at http://localhost:3000. The default port can be changed in the .env file.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.