Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adsilb authored Sep 11, 2021
1 parent 4b1699b commit 5409d1d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ python .\manage.py runserver

You shouldn't need to modify `manage.py` at all.

There are two top level folders in the repository, `website` and `search`
There are three top level folders in the repository, `website`, `search`, and `import scripts`

`website/settings.py`: This is probably the only file under `website` that you might want to modify. The location of the database file is specified here. Currently, it is set to `../TargetLink.db`, which is one level up from the root directory of this repo. The reason for that is that it was too large to upload to Github.

Expand All @@ -25,3 +25,5 @@ There are two top level folders in the repository, `website` and `search`
`search/views.py`: This file is the back-end logic for the main views, currently called `index` (the landing page) and `gene_details` (what happens when the user highlights a particular gene)

`templates/search/index.html`: This file contains the HTML of the front end, with Django template code and javascript interspersed.

`import scripts`: This folder, not involved in the actual website, contains Python scripts for automatically creating TSV files and inserting the data into a SQLite database. It is not currently complete but should be easy to add to by copying and modifying the existing scripts.

0 comments on commit 5409d1d

Please sign in to comment.