Welcome to TinyTrims, an advanced URL shortener project built with Next.js, MongoDB, NextAuth, and Shadcn UI. ๐ This project allows you to swiftly and securely shorten URLs, providing a sleek and intuitive user interface.
Follow these steps to set up and run the project locally:
-
Clone the repository:
git clone <repository-url> cd TinyTrims
-
Install dependencies:
npm install
-
Create a
.env.local
file in the root of the project and add the following environment variables:NEXT_PUBLIC_GOOGLE_CLIENT_ID=<your-google-client-id> NEXT_PUBLIC_GOOGLE_CLIENT_SECRET=<your-google-client-secret> MONGODB_URI=<your-mongodb-uri> NEXTAUTH_SECRET=use "openssl rand -base64 32" or use link below
Replace
<your-google-client-id>
,<your-google-client-secret>
, and<your-mongodb-uri>
with your actual Google API credentials and MongoDB connection details.NEXTAUTH_SECRET
is required for production only. Generate it here -
Run the development server:
npm run dev
Open http://localhost:3000 in your browser.
npm run dev
: Run the development server.npm run build
: Build the project for production.npm start
: Start the production server.npm run lint
: Run ESLint for code linting.
This project utilizes various libraries and packages, including (but not limited to):
For a complete list, refer to the dependencies
section in the package.json
file.
Feel free to contribute to the project by opening issues or creating pull requests. Your feedback and contributions are highly appreciated!
This project is licensed under the MIT License.
Happy URL shortening with Tiny Trims! ๐