Hacktoberfest 2020 with IEEE-VIT ❤️

Flaskly is a Python based URL shortener API . Users can authenticate and then create custom shortened URLs too.

Support open source software by participating in Hacktoberfest and get goodies and a free t-shirt! 💛

Please check all issues labelled as hacktoberfest to start contributing!

Kindly consider leaving a ⭐ if you like the repository and our organisation.

We are holding a virtual meetup, where we will be discussing OSS, GitHub and Hacktoberfest! Everyone's invited to join 😄

Getting Started

• Fork it.

• Clone your forked repo and move inside it:

git clone https://github.com/IEEE-VIT/flask.ly.git && cd flask.ly

• Checkout to a new branch to work on an issue:

git checkout -b my-amazing-feature

• To run the project locally:

  • Copy environment file from .env.template to .env
  • Change environment variables if necessary in .env
  • To setup, run pip install -r requirements.txt
  • To start the project run python app.py

• Once you're all done coding, it's time to open a PR :) Run the following commands from the root of the project directory:

git add .

git commit -m "A short description about the feature."

git push origin <my-amazing-feature>

Open your forked repo in your browser and then raise a PR to the master branch of this repository!

Contributing

To start contributing, check out CONTRIBUTING.md. New contributors are always welcome to support this project. If you want something gentle to start with, check out issues labelled as easy or good-first-issue. Check out issues labelled as hacktoberfest if you are up for some grabs! :)

License

This project is licensed under MIT.