Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pushpabrol/onfido-idv-verification-express-app
https://github.com/pushpabrol/onfido-idv-verification-express-app
Last synced: about 9 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/pushpabrol/onfido-idv-verification-express-app
- Owner: pushpabrol
- Created: 2023-08-29T22:15:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-25T02:15:47.000Z (about 1 year ago)
- Last Synced: 2023-09-25T03:07:59.259Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://onfido-idv-verification-express-app.vercel.app
- Size: 789 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project README
This README provides instructions for running the Node.js project included in this repository. The project uses the Express.js framework to create a web application with session management and routing for an Onfido integration. Follow the steps below to set up and run the project successfully.
## Prerequisites
Before you can run this project, ensure you have the following prerequisites installed on your system:
- [Node.js](https://nodejs.org/): Make sure you have Node.js installed on your machine.
- Make sure npm is installed on your machine
## Getting Started
1. **Clone the Repository:**
```bash
git clone
cd
```
2. **Install Dependencies:**
Open a terminal in the project directory and run the following command to install the required Node.js packages:
```bash
npm install
```
3. **Environment Variables:**
Create a `.env` file in the project root directory and configure the necessary environment variables. You can use the `.env.example` file as a template. Make sure to replace the placeholders with the actual values:
```dotenv
ONFIDO_API_TOKEN=
SECURE_COOKIE=true
SESSION_DURATION_MINUTES=
IDV_CHECK_INTERVAL= in ms
IDV_CHECK_TIMES_RUN=times to run status check
DEBUG=true
OKTA_URL=https://<>.okta.com
WORKFLOW_ID=onfido workflow id
ONFIDO_REGION=region
COOKIE_SESSION_SECRET=encryption for cookie
APP_SECRET=secret for app
ISSUER_BASE_URL=session token issuer
PORT=3539
ONFIDO_REFERRER_PATTERN=*://*/*
SELF_AUD=audience for session token
```
4. **Run the Application:**
Start the Node.js application by running the following command:
```bash
npm start
```
The application will start, and you should see a message in the console indicating that it's listening on the specified port (or the default port, 3000).
5. **Access the Application:**
Open a web browser and navigate to [http://localhost:3000/redirect-rule](http://localhost:3000/redirect-rule) to access the application.
## Project Structure
The project structure includes the following key components:
- `routes/onfido.js`: This file contains the route logic for Onfido integration.
- `views/`: This directory contains the Pug template files for rendering views.
- `public/`: Static assets like CSS, JavaScript, and images should be placed in this directory.
## Troubleshooting
If you encounter any issues while setting up or running the project, please check the following:
- Ensure that Node.js is installed correctly, and you have npm (Node Package Manager) available.
- Verify that the environment variables in the `.env` file are correctly set.
- Check for any error messages in the console output. Make sure the DEBUG=true in the .env file
## Contributing
If you would like to contribute to this project, please follow the standard GitHub workflow:
1. Fork the repository.
2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name`.
3. Make your changes and commit them with clear commit messages.
4. Push your branch to your fork: `git push origin feature/your-feature-name`.
5. Open a pull request to the main repository's `main` branch.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---