Awesome

Boilerplate Node.js Application with Authentication APIs and Swagger Documentation

Description

This project is a boilerplate Node.js application that leverages Sequelize for Object-Relational Mapping (ORM). It comes equipped with APIs for authentication and is comprehensively documented using Swagger.

Features

• ORM with Sequelize.
• Authentication feature APIs.
• Swagger documentation for API endpoints.

Getting Started

Prerequisites

• Node.js
• Yarn Package Manager

If you do not have Node.js and npm installed, follow these steps:

Installing Node.js and npm

1. Download Node.js from Node.js official website.
2. Follow the installation instructions for your operating system.
3. Install Yarn by running npm install --global yarn in your command line.
4. Verify the installation of Node.js and Yarn by running node -v and yarn -v. This will display the version of Node.js and Yarn installed.

Installation

Once Node.js and npm are installed, you can set up the project:

1. Clone the repository: git clone [repository link]
2. Navigate to the project directory: cd [project name]
3. Install dependencies using Yarn: yarn install

Running the Application

Run the application with the following command: yarn dev

Access the application at http://localhost:8000.

Using the APIs

Refer to the Swagger documentation included in the project for details on how to use the APIs by opening http://localhost:8000/api-docs in your browser.

Contributing

Feel free to fork this repository and submit pull requests to contribute to this project. Please ensure your code adheres to the project's coding standards.

Contact

For support or queries, please submit an issue in the GitHub repository.

Acknowledgements

• Node.js Community
• Sequelize Contributors