> For the complete documentation index, see [llms.txt](https://node-api.gitbook.io/nodpi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://node-api.gitbook.io/nodpi/create-a-new-project.md).

# Create a new project

The CLI tool will scaffold the project and install all the required dependencies. To create a new project, run the CLI as follows and answer the prompts

#### Create project with name \`nodeapi\` <a href="#starting-the-project" id="starting-the-project"></a>

```
nodpi p nodeapi
```

#### Starting the project <a href="#starting-the-project" id="starting-the-project"></a>

```
cd nodeapi
npm i
npm start
```

In a browser, visit [http://localhost:2020](http://localhost:2020/api) for api documentation

Project Folder Structure will look as follow

![Project Structure](https://3155355292-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M5FbtH8hXeIQb472XOp%2F-M5G0AV3OOlNss99-VQX%2F-M5GpG2nN4cZiiA34UjV%2FScreenshot%202020-04-19%20at%203.15.25%20PM.png?alt=media\&token=408cb16f-5a7d-4ee1-af46-0fc94fbb7408)

Please do changes in `config.js` file for admin credentials and gmail smtp credentials to send to mails

```
const config = {
    "dbname" : "nodpi",
    "port":2020,
    "admin_email":"admin@nodpi.com",
    "admin_password":"admin123",
    "email":"youremail@gmail.com",
    "password":"yourpassword",
    "api_url" : "http://localhost:2020/api/",
    "app_url" : "http://localhost.com:2020/"
}

module.exports = config;
```

#### Starting the project <a href="#starting-the-project" id="starting-the-project"></a>

```
cd nodeapi
npm i
npm start
```

In a browser, visit [http://localhost:2020](http://localhost:2020/api) for api documentation

![Swagger API Doc](https://3155355292-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M5FbtH8hXeIQb472XOp%2F-M5L68tbDm6yxtClpXhy%2F-M5L6mzlMsGpl67tFiPj%2Fapidoc.png?alt=media\&token=dceb2645-127f-47eb-8ea3-b70f7c8a4418)

Welcome Mail

![Welcome Mail](https://3155355292-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M5FbtH8hXeIQb472XOp%2F-M5L8KmnBiLBQUBfMSH3%2F-M5LAh4qcjR4G27AY-21%2Fwelcome.png?alt=media\&token=065e4590-85a4-4a9c-b5c9-ec860175bf5b)

Reset Password Mail

![Reset Password Mail Link](https://3155355292-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M5FbtH8hXeIQb472XOp%2F-M5L8KmnBiLBQUBfMSH3%2F-M5LAqjsfwacJ6npCxwg%2Freset.png?alt=media\&token=c7a968d7-975c-4826-920c-4ab40c19a8c8)

Change Password Form

![Change Password Link](https://3155355292-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M5FbtH8hXeIQb472XOp%2F-M5L8KmnBiLBQUBfMSH3%2F-M5LAwIZMhh9Q4K8fhVT%2Fchange.png?alt=media\&token=58a05433-fe10-4711-a8b0-b09553f9ba05)
