improve-english-project is an express endpoint. This project is a web-based application built using Node.js, Express, and Prisma. Its purpose is to provide a platform for which users who want to improve their English reading effectively by providing a user-friendly interface, robust progress bar features, and integration with other productivity tools. Some of the key features include interesting content, categorization, reminders, and quiz. After using this application users can found them more confidence in English reading.
A list of technologies used within the project:
| Name | Description | Example |
|---|---|---|
| NODE_ENV | Env variable mode | production or development |
| PORT | Running project in which port | 5000 |
| JWT_SECRET | JWT token scret | "" |
| JWT_EXPIRES_IN | jwt token expired days | 90d |
| JWT_COOKIE_EXPIRES_IN | jwt token cookie expired | 90 |
| PROJECT_ID | GCP prject id for using gcp storage | "" |
| DATABASE_URL | Postgres db url | "" |
| PRODUCTION_API_URL | Production server api url | "" |
| LOCAL_HOST_API_URL | Local server api url | http://localhost:5000 |
| AAMAR_PAY_SANDBOX_URL | Payment getway sandbox url | https://sandbox.aamarpay.com/jsonpost.php |
| AAMAR_PAY_SANDBOX_STORE_ID | Payment getway store id | aamarpaytest |
| AAMAR_PAY_SANDBOX_SIGNATURE_KEY | Sandbox key | dbb74894e82415a2f7ff0ec3a97e4183 |
| AAMAR_PAY_PRODUCTION_URL | Production url | "" |
| AAMAR_PAY_PRODUCTION_STORE_ID | Production store id | "" |
| AAMAR_PAY_PRODUCTION_SIGNATURE_KEY | Production key | "" |
- Node.js and npm (Node Package Manager) installed on your system.
Clone this repository and navigate to the project directory:
git clone https://github.com/Firoz01/improve-english-project.git
cd improve-english-project
Install the required packages using npm:
npm install
Start the server by running the following command:
npm run start-dev
The server will be started at http://localhost:5000 by default. You can change the port number by setting the PORT environment variable.
The following API routes are available in this server:
Create New account with this sign up process
{
"first_name": "Firoz",
"last_name": "Suvrow",
"email": "firozsuvrow@gmail.com",
"password": "abcd1234",
"confirm_password": "abcd1234",
"phone": "01912345678"
}If successfully user created then response will be:
{
"status": "success",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAsImZpcnN0X25hbWUiOiJGaXJveiIsImxhc3RfbmFtZSI6IlN1dnJvdyIsImxldmVsIjoiYmVnaW5uZXIiLCJpYXQiOjE2NzU2Nzc4NzEsImV4cCI6MTY4MzQ1Mzg3MX0.VX6TyxoMoqqVhe2JOhUFGUANz5M46lddWu7fK2D7MVw"
}And token also set into the cookies for the further authentication process
Else if a user already created and trying to create again then the server will give a status fail response like this:
{
"status": "fail",
"message": "Duplicate fields value: email. Please use another value!"
}Sign in route
{
"email": "firozsuvrow@gmail.com",
"password": "abcd1234"
}{
"status": "success",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAsImZpcnN0X25hbWUiOiJGaXJveiIsImxhc3RfbmFtZSI6IlN1dnJvdyIsImxldmVsIjoiYmVnaW5uZXIiLCJpYXQiOjE2NzU2Nzg0MjYsImV4cCI6MTY4MzQ1NDQyNn0.LdHO5UmSX-L9xKDpugCOQ5L5SIhaDU1_u9mOh-h9Nuk"
}And token also set into the cookies for the further authentication process same as sign up
If user provide wrong password then server response will be:
{
"status": "fail",
"message": "Provided Wrong password"
}update password
{
"currentPassword": "abcd1234",
"password": "iloveu143",
"confirmPassword": "iloveu143"
}{
"status": "success",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAsImZpcnN0X25hbWUiOiJGaXJveiIsImxhc3RfbmFtZSI6IlN1dnJvdyIsImxldmVsIjoiYmVnaW5uZXIiLCJpYXQiOjE2NzU2Nzg4MjUsImV4cCI6MTY4MzQ1NDgyNX0.ohFi33brO72l6cKGQSCJCVKMlf_sbWsVC5rgZ5Wsm5w"
}If Current password provided wrong then response will be:
{
"status": "fail",
"message": "You current password is wrong."
}Any kind of user can log out from server using this api route
No need any body data just hit this api and you will be logout from the application
{
"status": "success"
}Create an Admin user
{
"first_name": "Moga",
"last_name": "alom",
"email": "mogaalom@gmail.com",
"password": "1234abcd",
"confirm_password": "1234abcd",
"role": "admin",
"phone": "01964941374"
}You can also able to create a moderator, b2b user using this route by changing role as a moderator or b2b. The main difference between user auth and admin auth is the defined role of an admin user And Response will be the same as user authentication response
{
"status": "success",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NiwiZmlyc3RfbmFtZSI6Im1vaGlkdWwiLCJsYXN0X25hbWUiOiJhbG9tIiwibGV2ZWwiOiJiZWdpbm5lciIsImlhdCI6MTY3NTY3OTY5OSwiZXhwIjoxNjgzNDU1Njk5fQ.FzvJCya-bBcUh2r_x6xkRmhnF4CJ2WZbBdmScJVD99s"
}Only a valid admin user can be able to create landing page data
| KEY | VALUE |
|---|---|
| images | Screenshot from 2023-01-04 14-37-45.png |
| heading | "" |
| sub_heading | Learning english with great fun |
| cta | cta button text |
| fa_cta | fa_cta button text |
| fa_heading | fa_heading text |
If user is not valid then server response will be:
{
"status": "fail",
"message": "You do not have permission to perform this action"
}If a landing page is created once then you can create a new one. You will only be able to update the previous landing page data:
statusCode : 409 Conflict
{
"status": "fail",
"message": "Landing Page already created"
}fetch the landing page data
{
"status": "success",
"message": "Landing page information found",
"data": {
"id": 1,
"heading": "english learning project",
"sub_heading": "this is english learning project api",
"cta": "this is english learning project cta",
"fa_heading": "this is fa heading",
"fa_cta": "this is fa button cta",
"landing_img1": "https://storage.googleapis.com/english learning project/Screenshot_from_2023-01-04_14-37-45.png",
"landing_img2": null,
"landing_img3": null,
"createdAt": "2023-02-01T12:42:44.993Z",
"updatedAt": "2023-02-01T12:42:44.993Z"
}
}Create package only by valid admin or moderator By default package status will be true. Later you can change the status to false if you decide not to use a particular package
{
"name": "testing",
"title": "Testing Effectively with me",
"currency": "BDT",
"price": 5000,
"discount": 999,
"expiration": 20
}then response will be
statusCode : 200
{
"status": "success",
"message": "Package Created Successfully"
}get all packages from database
{
"status": "success",
"message": "found all packages",
"data": [
{
"id": 1,
"name": "Easy english",
"title": "Learn English Effectively with Me",
"currency": "BDT",
"price": 2000,
"discount": 10,
"status": true,
"expiration": 1,
"createdAt": "2023-01-25T13:42:14.955Z",
"updatedAt": "2023-01-25T13:42:14.955Z"
},
{
"id": 2,
"name": "testing",
"title": "Testing Effectively with me",
"currency": "BDT",
"price": 5000,
"discount": 999,
"status": true,
"expiration": 20,
"createdAt": "2023-01-28T11:41:49.343Z",
"updatedAt": "2023-01-28T11:41:49.343Z"
},
{
"id": 3,
"name": "testing",
"title": "Testing Effectively with me",
"currency": "BDT",
"price": 5000,
"discount": 999,
"status": true,
"expiration": 20,
"createdAt": "2023-02-06T12:22:34.311Z",
"updatedAt": "2023-02-06T12:22:34.311Z"
}
]
}get a package by package id providing in url params
{
"status": "success",
"message": "Package found with that id:1",
"data": {
"id": 1,
"name": "Easy english",
"title": "Learn English Effectively with me",
"currency": "BDT",
"price": 2000,
"discount": 10,
"status": true,
"expiration": 1,
"createdAt": "2023-01-25T13:42:14.955Z",
"updatedAt": "2023-01-25T13:42:14.955Z"
}
}Update a package by package id providing in url params
{
"status": false
}You can choose one field or multiple field
{
"status": "success",
"message": "Package Updated Successfully with that id :1"
}Create a new post with this api
{
"lession_no": 30,
"title": " go",
"passage": "Baten vai zindabad, the Passage SDK also provides a way to securely manage your users. These functions require authentication using a Passage API key.",
"summary": "Baten bro",
"level": "beginner"
}{
"status": "success",
"message": "Passage created succussfully"
}Every time for creating a new passage you need to provide a unique lesson otherwise server throw an error:
{
"status": "fail",
"message": "Duplicate fields value: lession_no. Please use another value!"
}Get all passage from the database,To access this API you need to log in first otherwise it will show an authentication error
{
"status": "success",
"message": "Found all 9 passages",
"data": [
{
"lession_no": 0,
"level": "assessment",
"title": " go"
},
{
"lession_no": 1,
"level": "advanced",
"title": "Node Js learning"
},
{
"lession_no": 2,
"level": "advanced",
"title": " react Js learning"
},
{
"lession_no": 3,
"level": "advanced",
"title": " go"
},
{
"lession_no": 4,
"level": "advanced",
"title": " Php"
},
{
"lession_no": 29,
"level": "beginner",
"title": " go"
},
{
"lession_no": 30,
"level": "beginner",
"title": " go"
},
{
"lession_no": 31,
"level": "advanced",
"title": " go"
},
{
"lession_no": 32,
"level": "advanced",
"title": " go"
}
]
}you can access categorised passages like assessment, beginner, intermediate, advanced,
/api/v1/passages?level=advanced
{
"status": "success",
"message": "Found all 6 passages",
"data": [
{
"lession_no": 1,
"level": "advanced",
"title": "Node Js learning"
},
{
"lession_no": 2,
"level": "advanced",
"title": " react Js learning"
},
{
"lession_no": 3,
"level": "advanced",
"title": " go"
}
]
}If you are a authenticated user but your payment step did not complete then you get an error
{
"status": "fail",
"message": "No payment recond with that user id 13"
}Otherwise you will get passages
get assessment by this route
{
"status": "success",
"message": "Passage found with that lession no: 0",
"data": {
"id": 7,
"lession_no": 0,
"title": " go",
"passage": "Baten vai zindabad, the Passage SDK also provides a way to securely manage your users. These functions require authentication using a Passage API key.",
"passage_len": 24,
"summary": "Baten bro",
"level": "assessment",
"creator_id": 1,
"created_by": "firoz",
"createdAt": "2023-01-28T12:35:41.734Z",
"updatedAt": "2023-01-28T12:35:41.734Z",
"quiz": []
}
}Get a passage
When you are trying to get a passage for the user account server check your previous passage quiz and other markings. If you passed your previous passage quiz then you can access the next passage for example: Right now you want to access the lesson 29th passage server will check the marking of your 28th lesson if you passed then can access the 29th passage. This condition is only for the authenticated user not for admin users. Admin can access any passage without condition
{
"status": "success",
"message": "Passage found with that lession no: 29",
"data": {
"id": 13,
"lession_no": 29,
"title": " go",
"passage": "Baten vai zindabad, the Passage SDK also provides a way to securely manage your users. These functions require authentication using a Passage API key.",
"passage_len": 24,
"summary": "Baten bro",
"level": "beginner",
"creator_id": 12,
"created_by": "suvrow",
"createdAt": "2023-02-07T12:54:35.422Z",
"updatedAt": "2023-02-07T12:54:35.422Z",
"quiz": []
}
}{
"title": "Sea Dolphin"
}{
"status": "success",
"message": "Passage updated successfully with that id :29"
}{
"status": "success",
"message": "Passage deleted successfully with that id :30"
}