ARR Links is a web application that allows users to shorten URLs, generate QR codes for the shortened links, and provides additional features like user authentication, click analytics, and more. This readme file provides an overview of the project and the technologies used.
- Features
- Technologies Used
- Screenshots
- Tech
- Run Locally
- Contributing
- FAQs
- Feedback
- Lessons I learn
- Authors
-
URL Shortening: Users can enter a long URL and generate a shortened version of it.
-
QR Code Generation: The application can generate QR codes for the shortened URLs, making it easier for users to share them by downloading it.
-
User Authentication: ARR Links provides user registration and login functionality to access additional features.
-
Forgot Password: Users who forget their passwords can initiate a password reset process, including OTP verification.
-
Stateless Authentication: ARR Links uses JSON Web Tokens (JWT) for stateless authentication, ensuring secure and efficient user authentication.
-
OTP Verification: During Sign up and forgot password processes, users are required to verify their email using a one-time password (OTP).
-
Special Dashboard: Logged-in users have access to a personalized dashboard with additional functionalities and settings. where user can track there URLs clicks and analytics, user can also update their profile details using dashboard.
-
URL Click Analytics: ARR Links tracks the number of clicks and provides analytics to the user for each shortened URL.
-
Responsive & user friendly Design: Layout of website is fully responsive and user friendly. support all size of screen
-
MongoDB: A NoSQL database used to store user information, shortened URLs, and click analytics data.
-
Node.js: A JavaScript runtime environment used to execute server-side code.
-
ExpressJS: A web application framework for Node.js used to build the backend of ARR Links.
-
Pug: A template engine for Node.js that simplifies HTML generation and allows for dynamic content rendering.
-
JavaScript: The programming language used for client-side scripting and interactions.
-
REST API: ARR Links uses RESTful APIs to communicate between the frontend and backend.
-
CSS3: The latest version of Cascading Style Sheets used for styling the web application.
-
JWT: JSON Web Tokens are used for stateless authentication.
Client: pugJS
Server: NodeJS, ExpressJS
Database: MongoDB
Clone the project
git clone https://github.com/amanrajrana/ARR-links.gitGo to the project directory
cd ARR-linksInstall dependencies
npm installCopy .env.example file make .env file and edit it as requirement
Following variable is needed
JWT_SECRET_KEYsecret key for Json web token signatureSENDER_EMAIL_IDEmail Address which is use to send emailEMAIL_PASSWORDPassword of emailDB_URIMongoDB uri
npm run startYou can use nodemon for auto restart the server
npm run devApp start on at PORT 3000 i.e http://127.0.0.1:3000
NOTE: Make sure you have preinstalled the following software in your local system
- NodeJS
- MongoDB
MongoDB server started on its default port i.e mongodb://127.0.0.1:27017
Start the server
We welcome contributions from developers who want to help improve my ARR links web app. To contribute, please follow these steps:
- Fork the repository on GitHub.
- Make your changes and commit them to your forked repository.
- Submit a pull request with a detailed explanation of your changes.
Yes, This is an open-source code so you can use it anywhere you want
If you have any feedback, please reach out to us via the following way
This is my first full-stack project. In this project, I Learned many things. A few of them are mentioned below
- Build Server
- Build API
- Server static files
- MVC pattern
- Deal with Database
- Define Schema
- PUG templating engine
- OTP verifications
- Stateless and Stateful authentication
- JWT token
- AJAX request
- DOM manipulation
- And many more things :)
Aman Raj Rana
MERN developer | ReactJS 🚀 MongoDB 📊 Express 🛠️ NodeJS 💻 | Clean code enthusiast | Agile methodologies | Let's build amazing web apps! 🌐