README.md

ShortLink

Bitly like project, made for a 6 months internship to learn :

• Django Rest Framework
• ReactJS & Redux
• JSON Web Token

How to use

For a DEBUG / DEV use

First create a postgreSQL Database with the name / username & password of your choosing.

Then you will need to create a ".env" file in the project root :

SECRET_KEY = your_secret_key

POSTGRES_USER=db_user
POSTGRES_PASSWORD=db_password
POSTGRES_DB=db_name

Once its done, install the requirements.txt (following command should work)

pip install -r requirements.txt

After that, you can run the server with those commands

./backend/manage.py migrate
./backend/manage.py runserver

See the README.md in the frontend directory for React

Actual progression:

ToDo List:

• User Registration

Done:

• Shorten link + Copy button
• Login / Logout (Token based authentication)
• Bind link to users when they shorten them (ManyToMany Relation.)
• Redirect after login / logout
• Basic error message for shorten link & login (backend data validation)
• Redirect to the full link
• Add redirect count
• Summary of user's link and redirect count

Partially Done:

• Private Route (Authenticated views)
• Refresh Token logic

Improvements:

• Client side data validation
• Improve CSS / Global look / Responsive
• Tests
• Use Docker
• Cleaner and more consistency code (refactoring => name convention, store/state...)
• More information on shortening link (date, ...)
• Add user's redirect count (global redirect count actually)