This project is a url shortener API build using Javascript with Typescript. The API is powered by Express as router, Mongoose for communication with database, MongoDB as the database, Swagger for API documentation and Jest for testing.
- Implementing an encoding to shorten urls to alphanumerics characters with length 6.
- Decouple code structure
- Using some design patters like adapter and factory
- Integrating Swagger for API documentation
- Implementing unit and integration tests to ensure API quality
You can check the documentation and perform tests to the API by visiting the live version hosted at .
To use this project, you need to follow these steps:
- Clone the repository:
git clone https://github.com/rodrigofmeneses/flash-link.git - Install the dependencies:
npm install - Configure .env with
MONGO_URLandPORT. - Build and run application:
npm run build && npm run dev
This project uses the following tools:
- Node + Typescript for backend development
- Express for route management
- Mongoose for database communication
- MongoDB as the database
- Swagger for API documentation and testing
After the API is running, you can use the Swagger UI to interact with the endpoints. The API can be accessed at http://localhost:$PORT/docs.
Default $PORT if not provided=7777.