The Authentication System API is a robust authentication system REST API built in TypeScript, designed to provide seamless user authentication and session management for web applications. With a focus on security and usability, this API allows users to effortlessly create accounts using their email addresses and facilitates session management using JSON Web Tokens (JWT).
- TypeScript
- Node.js 20
- Express.js
- Prisma ORM (MySQL)
- AWS Secrets Manager
- User Account Management: Easily create user accounts using email addresses, providing a streamlined registration process for your application.
- Session Management with JWT: Manage user sessions securely using JSON Web Tokens, ensuring authenticated access to protected resources while minimizing vulnerabilities.
- Safe Modification of Credentials: Implement a safe and straightforward method for users to update their email addresses and passwords, maintaining the integrity and security of user accounts.
- Credential Storage: Passwords are securely encrypted through hashing in a MySQL Database, ensuring maximum protection against unauthorized access.
- Admin User Support: Administrators can efficiently manage user accounts and permissions, ensuring smooth operations and scalability for your application.
- Sensitive Application Data: Safeguard sensitive application data with AWS Secrets Manager for secure storage and management.
This step describes the prerequisites and install steps for the libraries needed to build and run the project.
First of all, you must clone this repository:
git clone https://github.com/andrewlod/authentication-api.gitThen install all dependencies:
cd authentication-api
npm install
npm run install-db
npm run migrate:devThis project uses environment variables on non-production environment and a mix of environment variables and AWS Secrets Manager secrets on production environment. In order to setup the development environment, create a .env file in the root of this project, paste the following configuration and fill in the blank variables:
# Environment Variables
SV_PORT=3000
NODE_ENV=development
LOG_STRATEGY=CONSOLE
SECRETS_CONNECTOR=AWS
# If this is not a production environment, the next variable may be left as blank
SECRETS_LIST=
# Secrets
PASSWORD_SALT=
JWT_SECRET=
JWT_EXPIRE_MINUTES=
JWT_COOKIE_KEY=
DATABASE_URL="mysql://<username>:<password>@localhost:3306/<schema_name>?schema=public"In order to run the application in your development environment, simply run the following command:
npm run start:devAny file changes will automatically reload the application
In order to build and run the application for production, run the following commands:
npm run build
npm run postbuild
npm run start:migrate:prodIn order to generate the Swagger documentation, run the following script before running the app:
npm run swagger-autogenThis project also support JSDoc documentation, provided by TypeDoc. In order to generate TypeDoc documentation, run the following script:
npm run generate-docsHTML documentation should be generated on the docs/ folder.
In order to run unit tests, simply run the following script:
npm testTerraform scripts are available for AWS deployment, as well as a GitHub action deploy-eks for deployment on AWS EKS.
For more instructions on how to deploy the Terraform infrastructure, check the Terraform instructions
This section describes features that are either work-in-progress or will be implemented in the future. Features are sorted by priority.
- 🚧: Work-in-progress
- ❌: Not yet started
| Feature | Status |
|---|---|
| CI/CD with AWS CodeBuild/CodePipeline | ❌ |
- Andre Wlodkovski - @andrewlod
This project is licensed under the MIT License - see the LICENSE file for details.