Skip to content

dimpram/quickurl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo(2)

A Simple and easy to use url shortener made with React and expressjs.

Quickurl(1)

Getting started

Before you do anything create the following files:

client/.env

REACT_APP_BASE_URL=http//localhost:5000

and

server/.env

MONGO_DB_URI=mongodb://mongo:27017/quickurl
PORT=5000
HOST=http://localhost

Run for development

Make sure you have docker and docker-compose installed on your host machine and then run

make build-dev
make run-dev

You can then navigate to localhost:3000 and start making changes from our editor. Changes should be visible after you reload the page.

Run for production

For production you should have a server with docker ready to go.

First configure your build through the Makefile and the Caddyfile (Change domain etc) and copy the files to your server by running:

make copy-files

After that you can build and run the containers by executing:

make build-production
make run-production

IMPORTANT

These are not the best production practices and you should be very careful how you deploy projects on the internet. This project is not intended to replace tinyurl or bitly by any means and should not be used on a daily basis (at least not yet). It's just a proof of concept and a chance for me to sharpen my skills :)

License

View License here