emjimadhu / srts.pw

A URL Shortner.

srts.pw

A URL Shortner.

Website

Table of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Main Scripts
• Directory Structure
• Contact

About The Project

A URL Shortner for everyone. This project built using React.js, Vue.js, Nest.js, Typescript and NX Workspace.

Built With

• ReactJS
• TypeScript
• NX Workspace
• NodeJS
• Yarn
• Vue
• NestJS

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• node - v12.16.1
• npm - v6.14.5
• yarn - v1.22.4
• nx - v10.0.11
• vue - v4.5.4
• nest - v7.5.1

Installation

1. Clone the repo

# SSH
git clone [e-mail]:emjimadhu/srts.pw.git

# HTTPS
git clone https://github.com/emjimadhu/srts.pw.git

2. Install NPM packages

yarn # or yarn install

Main Scripts

• yarn start:client - Starts Development server for client react app,
• yarn start:admin - Starts Development server for client vue app,
• yarn start:server - Starts Development server for client nest app

Directory Structure

• root: Project root holds all the flies of the project
  • apps: Holds all the apps
    • client: Directory contains all the React app codes
    • admin: Directory contains all the Vue app codes
    • server: Directory contains all the Nest app codes
  • libs: Holds all the common library and codes you can share between apps
    • client: Holds all the components and services used in react app
    • server: Holds all the components and services used in nest app
  • repo-assets: Holds all the assets for README.

Contact

Em Ji Madhu -

Project Link: https://github.com/emjimadhu/srts.pw

Website Link: https://srts.pw/