Repository files navigation

Shrunk is an open-source full-stack application primarily made to shorten URLs for faculty, staff, and professors of Rutgers University. It is written inPython 3.6 andTypeScript and usesMongoDB,React, andFlask.

• Shorten long URLs
• Create a collection of URLs onto a customizable webpage
• Supports Rutgers Central Authentication Service (CAS)
• Statistics on number of visits on a shortened URL with dynamic charts and geographic maps
• Share multiple shortened URLs via organizations
• Restricted permissions on certain actions

1. InstallDocker Desktop
2. Create a copy ofbackend/shrunk/config.py.example toconfig.py
3. Change the valueDB_HOST tomongodb in the backend's config file
4. Start the Docker containers:

docker-compose up

5. Start developing athttp://localhost:4343(click to learn more about this change)

If you want a more detailed set of instructions on how to build without Docker, clickhere for the build instructions.

We usepytest for our unit tests framework, you can run this command inside the backend directory to check if you've made regressive changes.

python -m pytest

We useblack for our backend's formatting, while using pylint, flake8, and mypy for linting in the GitLab CI/CD, you can run this command to make sure your code is up to standards. If you're using Visual Studio Code, it does this automatically.

black .

We also usePrettier for our frontend's formatting, you can run this command to make sure your code is up to standards. If you're using Visual Studio Code, it does this automatically.

prettier --write .

Make sure you're

• using Python 3.6.x
• inside a virtual environment
• runpip install poetry
• runpoetry cache clear --all pypi if you're having problems with poetry