Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 4.5 KB

README.md

File metadata and controls

84 lines (60 loc) · 4.5 KB
Raw

Pico - Länkförkortare

Trött på långa länkar? Då har vi systemet just för dig. Stoppa in din långa länk, klicka på "Förkorta" och vips har du en länk man lätt kommer ihåg.

Systemet är tänkt att endast användas i sektionsrelaterade ändamål för att exempelvis förkorta länkar till formulär och annat.

När man förkortar en länk kollar systemet om länken finns i svartlistan som innehåller länkar till porr, spam, malware etc. Denna lista (90 MB) används med några ändringar.

API documentation

Available here

Pls permissions

There are two pls permissions:

  • admin

  • custom-link

  • admin gives you access to manage all links, not only your own

  • custom-link gives you the right to create custom links.

Dependencies (Sektionens system)

Pico uses the following systems:

Login2 - login with KTH-account Pls - to check admin priveleges of users

Dependencies

  • npm
  • MongoDB

Environment variables

All necessary variables should be set automatically when running with docker compose.

Server

See configuration.ts

Name Default Description
MONGO_URL - Example: mongodb://localhost:27017/pico, follow the schema: mongodb://HOST:PORT/DB_NAME
PORT 8000 Server port
NODE_ENV development
LOGIN_API_URL https://login.datasektionen.se URL to login
LOGIN_API_KEY - Login key
PLS_API_URL https://pls.datasektionen.se/api URL to pls api
SHORT_URL_LENGTH 4

Client

These must be set when building, not when running the application. To do this when building with docker, use --build-arg KEY=VALUE (or --build-arg-file client/.env.local, but only works with podman)

Name Default Description
REACT_APP_API_URL http://localhost:8080 in development Used to fetch the API
REACT_APP_LOGIN_API_URL https://login.datasektionen.se Used to fetch the login token

How to run

Development

The easy way

Make sure you have either podman or docker with podman-compose or docker-compose installed. You need at least version 2.22 of docker-compose since that's when watch was added.

docker compose -f .docker/docker-compose-dev.yml watch

And go to http://localhost:3000. And that's it! Updating files in the frontend should update the corresponding file in the container which should make it hot-reload. Updating files in the backend triggers it to rebuild since i couldn't get it to work better (but i should...).

The better way

Make sure you use the node version specified in .nvmrc.

  1. Set up environment variables
  2. nvm use (you need to run this in each terminal window you open, unless you set the default version to 16.5.0)
  3. Run npm install in root. Will install dependencies in both server and client.
  4. Start database: npm run dev:db
  5. Run npm run dev in project root
  6. In another terminal, run cd client && npm run start

Server and client will hot reload when changes occurs