@learninglocker/url-shortener
v1.5.5
Published
An xAPI URL shortenenr
Downloads
8
Keywords
Readme
xAPI URL Shortener
A server for xAPI URL shortener
Installation
- Clone the repository
git clone [email protected]:LearningLocker/url-shortener.git
. - Install dependencies
npm install
. - Build the code
npm run build
. - Run migrations
npm run migrate
. - Start the server
npm start
.
Development
- Follow the installation procedure.
- Make your changes to the "src" directory.
- Build the code
npm run build
. - Test the code
npm test
. - Run the server
npm start
. - Use the CLI
npm link
andxus --help
.
Docker
You can use the steps below to install and run the xAPI URL Shortener.
- Create a ".env" file using the ".env.example" file in this Github repository.
- Pull the image from DockerHub
docker pull learninglocker/url-shortener:master
. - Run the image in a container
docker run -d -p 8080:80 --name xus --env-file .env learninglocker/url-shortener:master
.
To use the CLI you can use the steps below.
- Enter the container
docker exec -it xus bash
. - Use the CLI
xus --help
.