REPOSITORY OVERVIEWLive repository statistics
★ 1Stars
⑂ 0Forks
◯ 0Open issues
◉ 1Watchers
41/100
OPENREPOHUB HEALTH SIGNALLimited signals
A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
10 Community adoption25% weight
0 Maintenance state20% weight
100 License clarity10% weight
100 Project information10% weight
75 This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
React UI for a URL Shortener
Description
This is a React UI that works with an API to generate a shortened URL.
This UI leverages my own starter UI made with React, Material UI or CSS Framework, and more... There is a Typescript supported branch, but still needs the current baseline components to be ported over to that branch.
Problem
The task is to build a front-end for a URL shortening web service. The should using the React framework, and incorporate whichever libraries, frameworks, tools, and development methodologies needed to complete a working front-end.
Product requirements
The front end should be a single page app that allows the user to:
- Input any URL to get a shortened version of it
- See a list of previously shortened URLs
- Expire/delete any previous URLs
The user should optionally be able to provide a custom slug to be used as the path in the shortened URL.
System Requirments
- Docker desktop or Mac, Windows or Linux - mine used MacOS and
Docker version 20.10.2, build 2291f61
- Nodejs/npm -
lts is defined in the docker container and no local install in needed outside of docker desktop but I have nodejs installed via nvm at v14.6.0 and npm at 6.14.6.
- All dependencies are defined in the
package.json, which includes React and leverages create-reaact-app tool and directory structure.
Installation
- Pull or download a copy of the UI repo
- Fill in the environment variable details to the
.env.example, for these are required to run the project.
- Run
docker-compose up, optionally with -d if you want the service to run as a daemon or without if you wish to view logs in real time.
- Go to
Run project locally, no docker container
- Pull down repo of the project.
- Run
npm install in the root directory of the project.
- Run
npm start
Run Tests
- Unfortunately, there is no container set up yet to run tests, but could easily be done - roadmapped
ALGORITHMICALLY RELATEDSimilar Open-Source Projects
Selected from shared topics, language and repository description—not editorial ratings.
Fork from Kong Template... but with Docker / Docker compose to make your life a little easier by not having to install Kong (and Konga) locally to test or start developing your own custom plugins in Lua or in JavaScript. This project have 2 custom plugins (one in Lua and the other in JS using kong-js-pdk) already configured and running in one route and is also using the newer 2.4.x kong release.
62/100 healthActive repository
LuaApache-2.0#docker#javascript#kong#kong-js-pdk
⑂ 5 forks◯ 0 issuesUpdated Mar 11, 2026
DEPRECATED: This is no longer used for my website. See https://github.com/ifd3f/seams for its replacement.
24/100 healthHas homepageArchived
PythonAGPL-3.0#blog#django#docker#docker-compose
⑂ 0 forks◯ 48 issuesUpdated Feb 21, 2024
Project homepage ↗