https://github.com/sherlock-project/api
Api for sherlock module
https://github.com/sherlock-project/api
Last synced: 2 months ago
JSON representation
Api for sherlock module
- Host: GitHub
- URL: https://github.com/sherlock-project/api
- Owner: sherlock-project
- License: mit
- Created: 2019-03-06T17:48:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-01T09:56:24.000Z (almost 4 years ago)
- Last Synced: 2025-03-21T05:04:10.401Z (3 months ago)
- Language: Python
- Size: 42 KB
- Stars: 67
- Watchers: 11
- Forks: 32
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sherlock API
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
Api for sherlock module.
## Prerequisites
This REST API is built on top of [Django REST Framework](https://www.django-rest-framework.org/)
(known as DRF). You would need at least the fundamental knowledge about DRF in
order to do development to this project.
### Installation
```sh
# clone the repo
$ git clone https://github.com/sherlock-project/api.git
# change the working directory to api
$ cd api
# install the requirements
$ python3 -m pip install -r requirements.txt
```
*P.S. Please use `python` instead of `python3` if you are on Windows system*
### Run API Server
```sh
# propagate modules
$ python3 manage.py migrate
# in the root of project diretory..
$ python3 manage.py runserver 0.0.0.0:8000
```
Start you browser and type [127.0.0.1:8000](http://127.0.0.1:8000/) in as
your target URL and hit return.
Now you should able to test your Sherlock API through DRF browser interface!
## License
MIT © Sherlock Project
Original Creator - [Shen, Jen-Chieh](https://github.com/jcs090218)