sophiabrandt / NimUrlShortener

a Nim web application that allows you to shorten an URL

Nim URL Shortener

Nim URL Shortener is a web application that allows you to do shorten an URL - similar to popular services like bit.ly or TinyURL.

This is a learning project to improve my knowledge of Nim.

Note: Heroku nuked my free live demo because somebody misused it. Currently I don't plan to redeploy it.
If you are interested in this application, you can run it locally if you have Docker-Compose installed.

Built With

• Nim
• Jester

Installation

The project uses Docker and docker-compose. Developed on a Linux machine.

• docker-compose version 1.25.2
• Docker version 19.03

Clone the repository:

git clone [e-mail]:sophiabrandt/NimUrlShortener.git

Usage

Move into the cloned folder and spin up the docker containers:

cd NimUrlShortener
docker-compose up --build

Visit http://localhost:5001 in your browser.

Tests

Start the docker containers in the background, then run the test with nimble:

docker-compose up -d
docker-compose exec url-shortener nimble c -r tests/database_test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

© 2020 Sophia Brandt. Distributed under the MIT License. See LICENSE for details.

Contact

Twitter: @hisophiabrandt

Acknowledgements

• Nim Days by Ahmed Thabet
• Nim in Action by Dominik Picheta
• Front-End Challenges Club by Andy Bell