@learninglocker/url-shortener

xAPI URL Shortener

A server for xAPI URL shortener

Installation

1. Clone the repository git clone [e-mail]:LearningLocker/url-shortener.git.
2. Install dependencies npm install.
3. Build the code npm run build.
4. Run migrations npm run migrate.
5. Start the server npm start.

Development

1. Follow the installation procedure.
2. Make your changes to the "src" directory.
3. Build the code npm run build.
4. Test the code npm test.
5. Run the server npm start.
6. Use the CLI npm link and xus --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.