project : Neuronex ai

Live Site

Front-end: Neuronex Ai (neuronex-ai.vercel.app)

Back-end Api documentation: https://neuronex-server.vercel.app/

Git Repositories

• Github Client Repo
• Github Server Repo

Admin Login (Front-end)

Email: paradoxtechbd@outlook.com

Password: neuronex

Admin dashboard password: hero

Instruction Video

• Video Link

Technologies

• Open AI API
• Stripe
• React.js + Vite
• Tailwind CSS
• Express.js
• Node.js
• MongoDB
• Firebase
• Npm packages
• jwt
• mongoose
• swagger-ui

Introduction - The Project's Aim

The purpose of creating project Neuronex Ai is to help the students, educators, or general people at academic usage. It responses at step-by-step method or other method as instructed. The ai also gives suggestions based on previous search. It’s assistive and chat friendly response method gives user a better experience.

Project Features

• Ai usage with low cost & effective model.
• Historical chat remembering with better chat experience.
• Payment gateway with stripe.
• Better security: at authentication, authorization and api endpoint.
• Model management at admin dashboard.

Table of Contents

• AI manipulation
• Authentication, Authorization and Security
• Payment and token charge
• Ai Configuration

🤖 Feature1: AI manipulation.

Ai routes

we have two pages to interact with user to provide responses.

1. ai settings page

   purpose: to take settings info from the user

   

2. ai response page

   purpose: at this page, user will take the prompt from user and in response, it will give the result.

   

Business logic

• like chat-gpt, this response layout will have session feature. that means, for every session will have its unique session Id.
• If the session id changes, the application will create a call to the backend. Now there will be two cases.
  • If the session is found (exists), then the application will load it’s messages to front end.
  • If the session is not found, then a new session will be created. For both cases, the session data will be sent to the front-end.
• After receiving session data to the front-end, the info will be saved to the context-api.
• After that, for every new messages / query the message will be saved at the backend according to the session id.
• There is also a save 💖 icon. At clicking this, the session will be saved (as favourite).
• The application’s logic diagram is shown below.

Features of Ai

• The ai has used open ai’s one of the cheap model. Gpt-3.5-turbo model. It is super fast and cost effective (10X cheaper than text-davinchi model).
• The model which is used has given instruction to act as a tutor and tested to work perfectly.
• After generating the response, the ai gives search suggestions. The suggestions are related to the previous response. And another model is used to propose search suggestion.

• The user has freedom to save the session, delete it or print it.
• The ai model can currently remember last 2 responses. (This number can be increased at backend). Which lets the user ask about the old questions. As the model used for this (gpt-3.5-turbo) is itself a chat friendly model, which means it lets the user to have a nice chatting experience.
• There is also a voice writing feature.
• The ui/ ux used for this section has been improved.

🔐 Feature2: Authentication, Authorization and Security.

The application is developed with keeping zero tolerance security measurements. We kept in mind the concurrent cybersecurity issues and made it less vulnerable.

Aa a glance, the security features are:

1. Authentication is developed with firebase. (A renowned third party provider).
2. Authorization is protected with a secondary password. The password is saved at database at bcrypt hash. The admin needs to change his password at admin section which is initially (by default) blank.
3. The private and sensible api’s are protected with JWT token. The modular pattern of backend lets the developer to apply or remove the protection easily.

Business Logic:

Authentication:

• Authentication is build with firebase. Initially, at the front-end, the authentication will take part and then the data will be send to the backend.
• At registration period, the user info (name and image) will be updated

Authorization:

• An existing admin can add or remove another admin. (Except, super Admin).
• Authorization is protected with a secondary password. The password is saved at database at bcrypt hash. The admin needs to change his password at admin section which is initially (by default) blank.
• For only the sensible events, the admin will be prompted to input this secondary password.

Api protection:

• The api’s are protected with jwt token.
• When calling the protected api’s the developer will need to send the _id as parameter along with Bearer token at header.
• The full api documentation will be found here. api docs for neuroNex coders (neuronex-server.vercel.app)

Feature of this section:

1. Strong security.
2. Second layer verification of admin for sensible events.
3. Api protection with jwt token.
4. Admin’s freedom to control the whole website at admin dashboard.

💳 Feature3: Payment and token charge

Business Logic:

• The payment is applied with stripe. The transaction info is saved at the database. A user can visit his transactions and look for current balance at user dashboard.
• The payment is recognized as recharge. When the balance will be over, the user will be prompted to recharge. After recharge the new balance and duration will be added to existing balance/ duration.

Demo card: 4242 4242 4242 4242 | 05 | 25 | 125 | 54685

• (Admin can manage these recharge amount and duration).

• Admin can also control how much the token will be charged at backend. (Default: 0.002$/1K token).
• Admin can set how much credit a user might have when he first creates his account. Or not.

Features of payment:

1. As open Ai charges on api as pay-as-you go method. We have applied this recharge type payment system.
2. The admin will be able to set recharge amount and validity. As well as the service charge. The rest amount after deducting service charge will be added to the balance.
3. The amount will be deducted as the token usage method.

⏳ Feature4: Ai Configuration

• The admin can change the ai configuration at ai dashboard.
• The settings that can be modified are following:
  • The initial balance of a new user.
  • The packages to recharge.
  • The charge at 1K token usage.

Overall, these are the features.