UsamaBinKashif / shrinkly

More than just shorter links.

Shrinkly.

Architecture

Technologies

• Back end

  • Express- Nodejs framwork for building the REST Apis
  • Mongodb- Document oriented NoSQL database
  • Mongoose- MongoDB object modeling tool
  • Short-id- Short id generator

• Front end

  • Next JS - React JS Framework for building full stack user interfaces.
  • Redux - A Predictable State Container for JS Apps.
  • Tailwind CSS - Utility-first CSS framework for rapidly building modern websites without ever leaving your HTML.

Getting Started

Clone the project

# clone it
git clone https://github.com/UsamaBinKashif/shrinkly
cd shrinkly
# Make it your own
rm -rf .git && git init

Run back end

# Move to server folder
cd server/
# Install dependencies
npm install

# Start server
npm run dev

Run front end

# Move to client folder
cd client/
# Install dependencies
npm install
# Start  client
npm run dev

Design

☑ TODO

• Add User Authentication.
• Create API for shrinked links analytics.
• Writw documentation for API.