kevinshogun / url-shortener Goto Github PK

Welcome to our Single Page Application (SPA) dedicated to URL shortening, built with React, TypeScript, and Next.js. This application utilizes the powerful Next.js framework, specifically its version with the Pages Router, to handle routing seamlessly. We've incorporated Prisma for database management, PostgresSQL as our database, and Docker with Docker Compose to containerize and deploy our database effortlessly.

• React: Providing a robust foundation for building interactive user interfaces.
• TypeScript: Ensuring type safety and enhancing code maintainability.
• Next.js (with Pages Router): Simplifying routing and enabling efficient server-side rendering.
• Prisma: Streamlining database operations and management.
• PostgresSQL: Utilizing a reliable and scalable relational database management system.
• Docker (with Docker Compose): Containerizing our application and database for easy deployment.

To set up and run the application:

1. Clone the repository:

   git clone https://github.com/your-username/your-repo.git

2. Navigate to the project directory:

   cd your-repo

3. Install dependencies:

   yarn install

4. Start the application:

   yarn dev

5. Access the application via your browser at http://localhost:3000/.

To set up the PostgresSQL database using Docker Compose:

1. Ensure you have Docker installed on your system.

2. Navigate to the project directory.

3. Run the following command:

   docker-compose up

Make sure to configure Prisma to connect to your PostgresSQL database properly in the prisma/schema.prisma file.

Experience the convenience of URL shortening with our SPA. Generate short URLs effortlessly and manage them seamlessly.

For inquiries or collaboration opportunities, feel free to reach out via email at [email protected].

Simplify your URL management with our URL Shortener SPA, built with cutting-edge technologies for a seamless experience. Thank you for choosing our application! 🔗✂️🚀