Evolving-Software/url-shortener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A simple url shortener
7 commits 6 branches 0 tags 884 KiB
  • JavaScript 99.3%
  • CSS 0.7%
Find a file
Exact
Riley Seaburg 28d87088ec Downgrade NextJS Version Deployment Bug
2021-12-26 19:12:56 -05:00
.vscode Initial Commit 2021-12-19 00:43:26 -05:00
public Initial commit from Create Next App 2021-12-18 23:56:44 -05:00
src Update ENV files 2021-12-26 16:14:28 -05:00
test 1.0 Release 2021-12-26 15:10:21 -05:00
.env.development Update ENV files 2021-12-26 16:14:28 -05:00
.env.example Update ENV files 2021-12-26 16:14:28 -05:00
.env.production Update ENV files 2021-12-26 16:14:28 -05:00
.eslintrc.json Initial commit from Create Next App 2021-12-18 23:56:44 -05:00
.gitignore Downgrade NextJS Version Deployment Bug 2021-12-26 19:12:56 -05:00
LICENSE Add License 2021-12-26 15:11:55 -05:00
next.config.js 1.0 Release 2021-12-26 15:10:21 -05:00
package.json Downgrade NextJS Version Deployment Bug 2021-12-26 19:12:56 -05:00
postcss.config.js Initial Commit 2021-12-19 00:43:26 -05:00
README.md 1.0 Release 2021-12-26 15:10:21 -05:00
tailwind.config.js 1.0 Release 2021-12-26 15:10:21 -05:00
yarn.lock 1.0 Release 2021-12-26 15:10:21 -05:00

README.md

evolving-urls

Table of Contents

About

This is a url shortener for creating branded url's to share on social media.

This project will allow a user to sign in and add url's that they want to share.

As a bonus this application also keeps basic analytics on the url's and will eventually allow you to integrate with an ad platform (Like Facebook) and allow you to create custom audiences from those who click your url.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

NodeJS

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

git clone https://github.com/evolvingsoftware/evolving-urls

Navigate to directory

cd evolving-urls

Install Dependencies

yarn

Add Environment Variables

Add Mongo Connection URI

mongoURI="mongodb://127.0.0.1/url-shortener"

Update BaseURL

baseUrl="shorter.mydomain.com"

End with an example of getting some data out of the system or using it for a little demo.

Usage

Add notes about how to use the system.