nexpress-api v1.0.1

Nexpress-API

a package or tool designed to create APIs using the Express framework in web application development with Node.js. This emphasizes the package's focus on building APIs using Express as a backend framework.

To get started using this project, follow the steps below:

Clone Repository: Get a copy of the project by running the following command:

 git clone https://github.com/ferlanferlani/nexpress-api.git

or you can install with npm

 npm install nexpress-api

Install Dependencies: Navigate to the project directory and run the following command to install dependencies:

 cd nexpress-api
 npm install

Configure Database:

Before running the application, you need to set a few things first:

1. App Password Gmail: This application uses nodemailer to authenticate with email verification. Beforehand, make sure to create an App Password on your Google account. You can do this by following these steps:

   a. Go to Google account settings.

   b. Select "Security" on the left side.

   c. Under "Signing in to Google," look for the "App Passwords" option.

   d. Click "Select application" and select "More."

   e. Give the application a name, for example "ProjectX Email Application".

   f. After getting the application password, please create a .env file or you can also duplicate .env.local, change it to .env then fill it in like this:

   EMAIL=youremail@gmail.com
   PASSWORD=yourpasswordapp

2. MongoDB Database: This application uses MongoDB as its database. You need to create a database first. You can create it in MongoDB Cloud. After you create it, go to the menu database->connect->drivers to take the database connection string, then paste it in the environment variable

   DATABASE_URL=youconnectionstring

3. Generate Database: Now, run the following command in your project terminal to generate the database. Here, Prisma ORM. used to interact with the database:

   npx prism generate

Make sure you have set all configurations correctly before running the application. If you have further questions, don't hesitate to ask in the issue section or click here!

Starting Application: Once the installation is complete, you can start the project by running the following command:

 npm run nexpress

still in the development stage