Url Shortener

🧑🏻‍💻 Environment Settings

• For development, you need to have Node and Docker Compose installed.
• Create .env file based on .env.default file.

# Run the Docker Composer:
$ docker-compose up -d

# To create the database, run the command:
$ yarn prisma db pull

🚀 Get Started

# Clone this project and access the folder
$ git clone [email protected]:Quinhas/url-shortener.git && cd url-shortener

# Install the dependencies
$ yarn install

# Build the application
$ yarn build

# Start
$ yarn start

# Open http://localhost:3033 in your browser to see the application running!

🎮 Scripts

• dev: starts the application at localhost:3033
• build: creates an optimized production build of application
• start: starts the application in production mode at localhost:3033 (have run the build before)
• test: run the tests
• lint: run eslint in /src
• format: run prettier in /src
• commit: CLI to create a commit message in the conventional format

✨ Technologies

This project was developed using the following technologies:

• NodeJS
• Typescript
• Express
• Prisma
• PostgreSQL
• ESLint
• Prettier

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Lucas Santana

---