link-short

A simple easy to deploy Link Shorter using express.js as the webserver, passport.js for user authentication and vue.js for the frontend.

Docker

1. Change the environment variable in the Dockerfile (Optional)
2. Build the Docker image

docker build -t link-short .

3. Run the Docker image

Without envirement variables configured

docker run -d --name link-short \
 -e SESSION_SECRET=[your_session_secret] \
 -v link-short:/link-short/server/data/ \
 -p 3000:3000 \
 --restart unless-stopped \
 link-short

With envirement variables configured

docker run -d --name link-short \
 -p 3000:3000 \
 -v link-short:/link-short/server/data/ \
 --restart unless-stopped \
 link-short

Manual Install

1. Install dependencies
   • For production

npm ci

- For development

npm install

2. Configure the .env fille in the server directory (A sample is provided as .env.sample)

cp server/.env.sample server/.env

After copying the sample file don't forget to configure it 3. Start the server (make shure you are in the home directory of the application)

npm start

Then go to http://localhost:3000

Api

Endpoints without Authentication

• Redirect to link : GET /:id_of_link
• Create new link : POST /api/new

Endpoints for Authentication

• Create new user : POST /auth/register
• Login : POST /auth/login
• Logout

For every user

• Get if logged in : GET /auth/isloggedin/
• Remove user : DELETE /api/user/remove/me

For Admin

• List all users : GET /api/user/all
• Change user type : PATCH /api/user/alter/:user_id
• Remove user : DELETE /api/user/remove/:user_id

Endpoints with Authentication

• Delete link : DELETE /api/remove (Only links that I own)
• List my links : GET /api/my

Endpoints with Admin specific Authentication

• Delete link : DELETE /api/remove (Any links)
• List all links : GET /api/all

License

This project is covered under the MIT License