AliBigdeli / Django-URLSaver-App

A simple app to save your links and store them on your own host plus searching through it too

Django UrlSaver App

A simple urlsaver for storing your important urls

Overview

• Overview
• live demo
• Features
• Setup
• Getting ready
• options
• Reformat and check
• Heroku setup
  • development
  • production
• Database schema
• Todo
• Bugs or Opinion

live demo

http://myurlsaver.herokuapp.com/

Features

• Django LTS
• Class Based views (ApiView)
• Django RestFramework
• User authentication
• Black
• Flake8
• Responsive Design
• Bootstrap5
• heroku

Setup

To get this repository, run the following command inside your git enabled terminal

git clone https://github.com/alibigdeli/Django-UrlSaver-App

Getting ready

Create an enviroment in order to keep the repo dependencies seperated from your local machine.

python -m venv venv

Make sure to install the dependencies of the project through the requirements.txt file.

pip install -r requirements.txt

Once you have installed django and other packages, go to the cloned repo directory and run the following command

python manage.py makemigrations

This will create all the migrations file (database migrations) required to run this App.

Now, to apply this migrations run the following command

python manage.py migrate

options

Project it self has the user creation form but still in order to use the admin you need to create a super user.you can use the createsuperuser option to make a super user.

python manage.py createsuperuser

And lastly let's make the App run. We just need to start the server now and then we can start using our simple todo App. Start the server by following command

python manage.py runserver

Once the server is up and running, head over to http://127.0.0.1:8000 for the App.

Reformat and check

If you want your code to be check by pep8 and all the guide lines, there are two packages added to requirements in order to check and reformat code. you can use it by this command:

black -l 79 . && flake8

Heroku setup

1 - Create an account in heroku

• https://id.heroku.com/login

2 - Download and install heroku cli

• https://devcenter.heroku.com/articles/heroku-cli-

3 - login to your heroku account

• you will be redirected to heroku web page to login

heroku login

development

in linux you might run into problem with install psycopg2 and here is a fix to that, just install theses packages and then re install the python package.

Note: i am not sure if you will ran in to problem with windows or not but still linux is good to go.

sudo apt install python3-dev libpq-dev
pip install psycopg2

after installing all dependencies all you have to do is to run the server.

heroku local

or

you can simply run "manage.py runserver" as normal project but dont forget to install dependencies.

production

In order to use this repo for production in heroku service, you have to push the repo to your heroku app.

1- create an app:

heroku create APP_NAME

2- setup git directory for repo (go to your directory)

git init .
git add .

3 - deploy to heroku app

git commit -am "Initial commit"
git push heroku master

Note: you can use the one click deploy on the top of the readme too

Database schema

A simple view of the project model schema.

Todo

• add heroku config files
• complete the documentation
• add one click deploy mechanism
• create a video tutorial

Bugs or Opinion

Feel free to let me know if there are any problems or any request you have for this repo.

• Url field in modal doesn't get validated (Marzieh Izadi)
• Url field limited to 250 chars (now its 2000) (Mostafa Haghi)