https://github.com/datasektionen/pico

Länkförkortare
https://github.com/datasektionen/pico

linkshortener mongodb nodejs react

Last synced: about 2 months ago
JSON representation

Länkförkortare

• Host: GitHub
• URL: https://github.com/datasektionen/pico
• Owner: datasektionen
• License: mit
• Created: 2021-10-06T08:41:28.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-28T13:26:33.000Z (10 months ago)
• Last Synced: 2024-04-11T19:17:54.665Z (9 months ago)
• Topics: linkshortener, mongodb, nodejs, react
• Language: JavaScript
• Homepage: https://dsekt.se/shorten
• Size: 26.3 MB
• Stars: 0
• Watchers: 32
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/blocklistproject/Lists/blob/master/everything.txt) lista (90 MB) används med [några ändringar](https://github.com/datasektionen/pico/commits/master/resources).

# API documentation

Available [here](https://duckumentation.datasektionen.se/pico)

# 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](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.

```sh

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

1. `nvm use` (you need to run this in each terminal window you open, unless you set the default version to 16.5.0)

1. Run `npm install` in root. Will install dependencies in both server and client.

1. Start database: `npm run dev:db`

1. Run `npm run dev` in project root

1. In another terminal, run `cd client && npm run start`

Server and client will hot reload when changes occurs