This is a web service developed using Express.js.
- Getting Started
- Prerequisites
- Installation
- Usage
- Deployment
- Built With
- Contributing
- Versioning
- License
- Acknowledgments
These instructions will get you started with a copy of the project on your local machine for development and testing purposes.
You will need to have Node.js and npm installed on your machine.
After cloning the repository, navigate to the project directory and run: npm install
This will install all the necessary dependencies.
Create local postgres instance with command : docker run --name imitationdb -p 5432:5432 -e POSTGRES_PASSWORD=xxxxxx -e POSTGRES_DB=xxxxxx -d postgres:16-alpine
Create .env file to the root of the project with these values:
POSTGRES_USER=postgres
PASSWORD=(your local postgres password)
PORT=5432
HOST=localhost
DATABASE=(your local postgres schema)
SSL=true (leave this out if using local Docker database)
Run npm install
Start the service with node index.js
Add Language models to language_model table names and urls (found in keepass)
Run tests with command: npm run coverage
Add additional notes about how to deploy this on a live system.
If you're interested in contributing, feel free to send a pull request!
Not specified.
This project is licensed under the MIT License
- Acknowledge the works of others used/referred in the project.