Welcome to my Nodejs-Refresh-Token starter kit for building applications with user authentication and token management features. My starter kit includes a set of pre-built code that you can use as a starting point for building your own application. It includes user authentication functionality, a database for storing user data, and refresh token management features to improve the security of your application.
With this starter kit, you can quickly and easily build secure and scalable Node.js applications with minimal setup and configuration. You can customize the code to fit your specific use case and security requirements, and add new features and functionalities as needed.
My starter kit includes the following features and benefits:
User authentication: The starter kit includes pre-built code for user authentication, including login, registration, and password reset functionality.
Database integration: The starter kit includes a database for storing user data, with support for popular databases such as MySQL, PostgreSQL.
Refresh token management: The starter kit includes refresh token management features, with support for rotating refresh tokens to improve the security of your authentication system.
Customizable configuration: The starter kit includes a range of customizable configuration options, such as token expiration times, token secret keys, and database settings. This allows you to tailor the code to your specific use case and security requirements.
Front-End integration: The starter kit includes a simple authentication form using react.
I hope that my starter kit can help simplify the process of building Node.js applications with authentication and token management features, and provide a solid foundation for your application development. Please feel free to use and customize the code, and share your feedback and contributions to the repository.
Figure 1 represents the authentication architecture of this sample implementation.
Figure 1: High Level Architecture
-
Node v14.15.1 (LTS) or more recent. While older versions can work it is advisable to keep node to latest LTS version
-
npm 6.14.8 (LTS) or more recent, Yarn can work but was not tested for this project
This project uses eslint
and prettier
. all configurations for this project inside package.json
file.
[1] Open postgres terminal with: psql postgres
1- CREATE DATABASE authentication;
2- CREATE ROLE admin WITH PASSWORD 'admin';
3- ALTER ROLE admin WITH SUPERUSER CREATEROLE CREATEDB LOGIN;
4- GRANT ALL PRIVILEGES ON DATABASE authentication TO admin;
[2] Second, to install the node_modules for the backend, navigate to the backend directory and run npm install
or yarn install
. After installation is done
migrate up the database table schema with npm run migrate:up
or yarn migrate:up
or run the script.sh
in sql
folder from root directory with ./script.sh
after that start the api in dev mode with npm run dev
or yarn dev
.
[3] Third, to install the node_modules for the frontend, navigate to the frontend directory and run npm install
or yarn install
. Once the installation is complete, start the frontend server in development mode by running npm run dev
or yarn dev
.
Unit test available using Jasmine with this command: npm run test
or yarn test
In the project backend directory, you can run:
Runs the app in the development mode. The page will reload automatically if you make edits.
Will format by prettier and will also see if any lint errors in the console.
Launches the test runner in the interactive watch mode. See the section about running tests for more information.
Builds the app for production to the dist folder. It's format TypeScript to JavaScript
Build and runs the app in the clients mode.
Migrate up the database tables
Migrate up the database tables